org.scilab.forge.jlatexmath
Class RowAtom

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

public class RowAtom
extends Atom
implements Row

An atom representing a horizontal row of other atoms, to be seperated by glue. It's also responsible for inserting kerns and ligatures.


Field Summary
protected  java.util.LinkedList<Atom> elements
           
 boolean lookAtLastAtom
           
 
Fields inherited from class org.scilab.forge.jlatexmath.Atom
alignment, type, type_limits
 
Constructor Summary
protected RowAtom()
           
  RowAtom(Atom el)
           
 
Method Summary
 void add(Atom el)
           
 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, ...
 Atom getLastAtom()
           
 int getLeftType()
          Get the type of the leftermost child atom.
 int getRightType()
          Get the type of the rightermost child atom.
 void setPreviousAtom(Dummy prev)
          Sets the given dummy containing the atom that comes just before the first child atom of this "composed 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
 

Field Detail

elements

protected java.util.LinkedList<Atom> elements

lookAtLastAtom

public boolean lookAtLastAtom
Constructor Detail

RowAtom

protected RowAtom()

RowAtom

public RowAtom(Atom el)
Method Detail

getLastAtom

public Atom getLastAtom()

add

public final void add(Atom el)

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.

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"

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