Documentation of 'japlot.jaxodraw.JaxoAxodraw' Java class
JaxoAxodraw
japlot.jaxodraw

Class JaxoAxodraw



  • public class JaxoAxodraw
    extends java.lang.Object
    Defines a number of axodraw LaTeX commands and all the methods to convert them into JaxoObjects. This is responsible for the import option.
    • Constructor Summary

      Constructors 
      Constructor and Description
      JaxoAxodraw()
      Constructor: Initializes the list of Latex packages (axodraw and color).
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void checkRequired(java.lang.String newString)
      Checks whether the given string starts with one of "\documentclass", "\begin{document}" or "\begin{picture}".
      java.lang.String getComment()
      Returns the comment (description) of this axodraw object.
      JaObject getJaxoObject(java.lang.String newString)
      Returns a JaObject corresponding to a axodraw command.
      java.util.ArrayList getPackages()
      Returns the current list of LaTeX packages included in the graph.
      boolean[] getValid()
      Returns an array that indicates which required LaTeX commands were found.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • JaxoAxodraw

        public JaxoAxodraw()
        Constructor: Initializes the list of Latex packages (axodraw and color).
    • Method Detail

      • getJaxoObject

        public final JaObject getJaxoObject(java.lang.String newString)
        Returns a JaObject corresponding to a axodraw command.
        Parameters:
        newString - One line of a latex file
        Returns:
        A JaObject the corresponds to the axodraw command of the input line, or null, if nothing corresponds
      • checkRequired

        public final void checkRequired(java.lang.String newString)
        Checks whether the given string starts with one of "\documentclass", "\begin{document}" or "\begin{picture}".
        Parameters:
        newString - The input string.
      • getValid

        public final boolean[] getValid()
        Returns an array that indicates which required LaTeX commands were found.
        Returns:
        An array of three boolean variables, the first is true if "\documentclass" was found, the second is true if "\begin{document}" was found, the third is true if "\begin{picture}" was found
      • getPackages

        public final java.util.ArrayList getPackages()
        Returns the current list of LaTeX packages included in the graph.
        Returns:
        A vector that contains strings of packages, "axodraw" and "color" are always included
      • getComment

        public final java.lang.String getComment()
        Returns the comment (description) of this axodraw object.
        Returns:
        The axodraw comment

DMelt 3.0 © DataMelt by jWork.ORG

You see the box below because you did not login.