cox.jmatt.java.MathTools.markup.latex
Class LEquation

java.lang.Object
  extended by cox.jmatt.java.MathTools.markup.latex.LaBaseTag
      extended by cox.jmatt.java.MathTools.markup.latex.LEquation

public class LEquation
extends LaBaseTag

This class provides the '{equation}' and '{eqnarray}' blocks. Equation numbering can be enabled (default) or disabled. There is also a method to add '/label...' tags.


Field Summary
 
Fields inherited from class cox.jmatt.java.MathTools.markup.latex.LaBaseTag
BS, DBS, DBSN, myAuthor, myDate, myEndTag, myEnvironment, myEnvParams, myOptions, myPicHasOrigin, myPicX, myPicXOrigin, myPicY, myPicYOrigin, mySectionLabel, myTagName, myTitle
 
Constructor Summary
LEquation()
          Standard constructor.
 
Method Summary
 LEquation add(java.lang.String pEquation, java.lang.String pLabel)
          Add an equation and optional label.
 LEquation copyOf()
          Return an exact copy of this tag.
 LEquation copyOfSET()
          Copy this tag with end tag disabled.
 void reset()
          Overridden to reset to 'equation' and enable numbering.
 LEquation setArray(boolean pArray)
          Toggle between 'equation' and 'eqnarray'.
 LEquation setNumbered(boolean pNumbered)
          Enable/disable equation numbering.
 
Methods inherited from class cox.jmatt.java.MathTools.markup.latex.LaBaseTag
_addContent, _addRawContent, _getContent, _setEndTagEnabled, _setETEn, getEndTag, hasEndTag, isEndTagEnabled, setLabel, toString, toStringSET
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LEquation

public LEquation()
Standard constructor. All information is internal.

Method Detail

setArray

public LEquation setArray(boolean pArray)
Toggle between 'equation' and 'eqnarray'. Set pArray to 'true' to enable an equation array. Returns a self-reference.


setNumbered

public LEquation setNumbered(boolean pNumbered)
Enable/disable equation numbering. It is on (true) by default.


add

public LEquation add(java.lang.String pEquation,
                     java.lang.String pLabel)
Add an equation and optional label. If the equation is null or blank nothing happens. If the label is null or blank it is ignored.


reset

public void reset()
Overridden to reset to 'equation' and enable numbering.

Overrides:
reset in class LaBaseTag

copyOf

public LEquation copyOf()
Return an exact copy of this tag.

Specified by:
copyOf in class LaBaseTag

copyOfSET

public LEquation copyOfSET()
Copy this tag with end tag disabled.

Specified by:
copyOfSET in class LaBaseTag