Class Atom

    • Field Summary

      Fields 
      Modifier and Type Field Description
      int alignment  
      int type
      The type of the atom (default value: ordinary atom)
      int type_limits  
    • Constructor Summary

      Constructors 
      Constructor Description
      Atom()  
    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      Atom clone()  
      abstract Box createBox​(TeXEnvironment env)
      Convert this atom into a Box, using properties set by "parent" atoms, like the TeX style, the last used font, color settings, ...
      int getLeftType()
      Get the type of the leftermost child atom.
      int getRightType()
      Get the type of the rightermost child atom.
      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • type

        public int type
        The type of the atom (default value: ordinary atom)
      • type_limits

        public int type_limits
      • alignment

        public int alignment
    • Constructor Detail

      • Atom

        public Atom()
    • Method Detail

      • createBox

        public abstract Box createBox​(TeXEnvironment env)
        Convert this atom into a Box, using properties set by "parent" atoms, like the TeX style, the last used font, color settings, ...
        Parameters:
        env - the current environment settings
        Returns:
        the resulting box.
      • getLeftType

        public int getLeftType()
        Get the type of the leftermost child atom. Most atoms have no child atoms, so the "left type" and the "right type" are the same: the atom's type. This also is the default implementation. But Some atoms are composed of child atoms put one after another in a horizontal row. These atoms must override this method.
        Returns:
        the type of the leftermost child atom
      • getRightType

        public int getRightType()
        Get the type of the rightermost child atom. Most atoms have no child atoms, so the "left type" and the "right type" are the same: the atom's type. This also is the default implementation. But Some atoms are composed of child atoms put one after another in a horizontal row. These atoms must override this method.
        Returns:
        the type of the rightermost child atom
      • clone

        public Atom clone()
        Overrides:
        clone in class java.lang.Object