Class PhantomAtom

java.lang.Object
org.scilab.forge.jlatexmath.Atom
org.scilab.forge.jlatexmath.PhantomAtom
All Implemented Interfaces:
Cloneable, Row

public class PhantomAtom extends Atom implements Row
An atom representing another atom that should be drawn invisibly.
  • Constructor Details

    • PhantomAtom

      public PhantomAtom(Atom el)
    • PhantomAtom

      public PhantomAtom(Atom el, boolean width, boolean height, boolean depth)
  • Method Details

    • 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
    • setPreviousAtom

      public void setPreviousAtom(Dummy prev)
      Description copied from interface: Row
      Sets the given dummy containing the atom that comes just before the first child atom of this "composed atom". This method will allways be called by another composed atom, so this composed atom will be a child of it (nested). This is necessary to determine the glue to insert between the first child atom of this nested composed atom and the atom that the dummy contains.
      Specified by:
      setPreviousAtom in interface Row
      Parameters:
      prev - the dummy that comes just before this "composed atom"