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

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

public class LaTag
extends LaBaseTag

This class can be used to generate any LaTeX tag. Although primarily designed for debugging and development it is useful for scripting and other applications. Every aspect of LaBaseTag can be set and there are no restrictions on the values. USE WITH CARE! The only thing that cannot be set to null or blank is the tag name; it is supplied with the constructor. The setter methods return a self-reference to allow method chaining.


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
LaTag(java.lang.String pName)
          Basic, default constructor.
 
Method Summary
 LaTag addContent(java.lang.String pContent)
          Add content to the tag, publicly.
 LaTag copyOf()
          This method provides a copy of a LaBaseTag subclass.
 LaTag copyOfSET()
          Create and return a copy of this tag with its end tag suppressed.
 LaTag setEndTag(java.lang.String pTag)
          Set or clear the end tag name.
 LaTag setEndTagEnabled(boolean pEnable)
          Enable/disable the end tag.
 LaTag setEnvironment(java.lang.String pEnv)
          Set or clear the initial environment.
 LaTag setEnvParams(java.lang.String... pParams)
          Set any extra curly-brace parameters.
 LaTag setOptions(java.lang.String pOpts)
          Set the square-brace options.
 
Methods inherited from class cox.jmatt.java.MathTools.markup.latex.LaBaseTag
_addContent, _addRawContent, _getContent, _setEndTagEnabled, _setETEn, getEndTag, hasEndTag, isEndTagEnabled, reset, setLabel, toString, toStringSET
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LaTag

public LaTag(java.lang.String pName)
Basic, default constructor. Calls super(pName, null, null, null).

Parameters:
pName - The tag name. This is the ONLY place it can be set and it still cannot be null or blank!
Method Detail

setEnvironment

public LaTag setEnvironment(java.lang.String pEnv)
Set or clear the initial environment.


addContent

public LaTag addContent(java.lang.String pContent)
Add content to the tag, publicly.


setOptions

public LaTag setOptions(java.lang.String pOpts)
Set the square-brace options.


setEnvParams

public LaTag setEnvParams(java.lang.String... pParams)
Set any extra curly-brace parameters.


setEndTag

public LaTag setEndTag(java.lang.String pTag)
Set or clear the end tag name.


setEndTagEnabled

public LaTag setEndTagEnabled(boolean pEnable)
Enable/disable the end tag.


copyOf

public LaTag copyOf()
Description copied from class: LaBaseTag
This method provides a copy of a LaBaseTag subclass. Each subclass casts its return value as its own type.

Specified by:
copyOf in class LaBaseTag

copyOfSET

public LaTag copyOfSET()
Description copied from class: LaBaseTag
Create and return a copy of this tag with its end tag suppressed.

Specified by:
copyOfSET in class LaBaseTag