Class UnderOverAtom

  • All Implemented Interfaces:
    java.lang.Cloneable

    public class UnderOverAtom
    extends Atom
    An atom representing another atom with an atom above it (if not null) seperated by a kern and in a smaller size depending on "overScriptSize" and/or an atom under it (if not null) seperated by a kern and in a smaller size depending on "underScriptSize"
    • Constructor Summary

      Constructors 
      Constructor Description
      UnderOverAtom​(Atom base, Atom underOver, int underOverUnit, float underOverSpace, boolean underOverScriptSize, boolean over)  
      UnderOverAtom​(Atom base, Atom under, int underUnit, float underSpace, boolean underScriptSize, Atom over, int overUnit, float overSpace, boolean overScriptSize)  
    • 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

      • UnderOverAtom

        public UnderOverAtom​(Atom base,
                             Atom underOver,
                             int underOverUnit,
                             float underOverSpace,
                             boolean underOverScriptSize,
                             boolean over)
    • 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