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

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

public class LaListTag
extends LaBaseTag

This class provides LaTeX list blocks, both '{itemize}' and '{enumerate}'. By default an unordered list is created but the 'setEnumerate()' method changes between the two types as needed.


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
LaListTag()
          All the necessary information is internal.
 
Method Summary
 LaListTag addItem(java.lang.String pContent)
          Convenience method for addItem(null, pContent).
 LaListTag addItem(java.lang.String pBullet, java.lang.String pContent)
          Add an item to the list, full-power version.
 LaListTag addItems(java.lang.String pBullet, java.lang.String[] pItems)
          Add a String[] array of items to the list.
 LaListTag copyOf()
          Return a copy of this tag at its CURRENT state.
 LaListTag copyOfSET()
          Return a copy of this tag with end tag disabled.
 void reset()
          Overridden to reset the list type to unordered as well as clear the content.
 LaListTag setEnumerate(boolean pEnumerate)
          Switch between '{itemize}' and '{enumerate}' modes.
 
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

LaListTag

public LaListTag()
All the necessary information is internal.

Method Detail

setEnumerate

public LaListTag setEnumerate(boolean pEnumerate)
Switch between '{itemize}' and '{enumerate}' modes. The change takes place immediately and is not graven in stone until a 'toString...' method is called. A self-reference is returned to allow chaining.

Parameters:
pEnumerate - true for 'enumerate,' false for 'itemize.'

addItem

public LaListTag addItem(java.lang.String pBullet,
                         java.lang.String pContent)
Add an item to the list, full-power version. This method allows both the bullet character AND the item text to be specified. A null or blank bullet String is disregarded and the item is added. If the item content is null or blank it is silently ignored. If an item is successfully added a newline is appended at the end.

Parameters:
pBullet - The bullet symbol to use. If null or blank a standard '/item{}' tag is created.
pContent - The content of the item. NOTHING is done if this is null or blank.

addItems

public LaListTag addItems(java.lang.String pBullet,
                          java.lang.String[] pItems)
Add a String[] array of items to the list. Each element is added singly with the bullet character if one is provided.


reset

public void reset()
Overridden to reset the list type to unordered as well as clear the content.

Overrides:
reset in class LaBaseTag

addItem

public LaListTag addItem(java.lang.String pContent)
Convenience method for addItem(null, pContent).


copyOf

public LaListTag copyOf()
Return a copy of this tag at its CURRENT state.

Specified by:
copyOf in class LaBaseTag

copyOfSET

public LaListTag copyOfSET()
Return a copy of this tag with end tag disabled.

Specified by:
copyOfSET in class LaBaseTag