org.scilab.forge.jlatexmath
Class BigOperatorAtom

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

public class BigOperatorAtom
extends Atom

An atom representing a "big operator" (or an atom that acts as one) together with its limits.


Field Summary
protected  Atom base
           
 
Fields inherited from class org.scilab.forge.jlatexmath.Atom
type, type_limits
 
Constructor Summary
BigOperatorAtom(Atom base, Atom under, Atom over)
          Creates a new BigOperatorAtom from the given atoms.
BigOperatorAtom(Atom base, Atom under, Atom over, boolean limits)
          Creates a new BigOperatorAtom from the given atoms.
 
Method Summary
 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, ...
 
Methods inherited from class org.scilab.forge.jlatexmath.Atom
clone, getLeftType, getRightType
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

base

protected Atom base
Constructor Detail

BigOperatorAtom

public BigOperatorAtom(Atom base,
                       Atom under,
                       Atom over)
Creates a new BigOperatorAtom from the given atoms. The default rules the positioning of the limits will be applied.

Parameters:
base - atom representing the big operator
under - atom representing the under limit
over - atom representing the over limit

BigOperatorAtom

public BigOperatorAtom(Atom base,
                       Atom under,
                       Atom over,
                       boolean limits)
Creates a new BigOperatorAtom from the given atoms. Limits will be drawn according to the "limits"-value

Parameters:
base - atom representing the big operator
under - atom representing the under limit
over - atom representing the over limit
limits - whether limits should be drawn over and under the base (<-> as scripts)
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.