Class ScriptsAtom

  • All Implemented Interfaces:
    java.lang.Cloneable

    public class ScriptsAtom
    extends Atom
    An atom representing scripts to be attached to another atom.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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 org.scilab.forge.jlatexmath.Atom

        clone
      • Methods inherited from class java.lang.Object

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

      • ScriptsAtom

        public ScriptsAtom​(Atom base,
                           Atom sub,
                           Atom sup)
      • ScriptsAtom

        public ScriptsAtom​(Atom base,
                           Atom sub,
                           Atom sup,
                           boolean left)
    • Method Detail

      • createBox

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

        public int getLeftType()
        Description copied from class: Atom
        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.
        Overrides:
        getLeftType in class Atom
        Returns:
        the type of the leftermost child atom
      • getRightType

        public int getRightType()
        Description copied from class: Atom
        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.
        Overrides:
        getRightType in class Atom
        Returns:
        the type of the rightermost child atom