cox.jmatt.java.MathTools.markup.svg
Class GroupTag

java.lang.Object
  extended by cox.jmatt.java.MathTools.markup.Tag
      extended by cox.jmatt.java.MathTools.markup.svg.StyleTag
          extended by cox.jmatt.java.MathTools.markup.svg.DrawableContainerTag
              extended by cox.jmatt.java.MathTools.markup.svg.GroupTag
Direct Known Subclasses:
SymbolTag

public class GroupTag
extends DrawableContainerTag

This class implements the group tag, <g>. Although this tag can appear in the body of a document MathTools considers it <defs>-only. For that reason the constructor is private and the factory method requires a valid ID before it will create an instance. To add a GroupTag outside the <defs> block call addRaw(groupTagInstance.toString()) on this tag's container. Better yet, let things go where they should and create a UseTag to reference the group!


Nested Class Summary
 
Nested classes/interfaces inherited from class cox.jmatt.java.MathTools.markup.svg.StyleTag
StyleTag.TagKeys
 
Field Summary
 
Fields inherited from class cox.jmatt.java.MathTools.markup.Tag
myTagName
 
Constructor Summary
protected GroupTag(StyleTag.TagKeys pKey)
          Constructor provided for subclasses.
 
Method Summary
 void configureTag(java.lang.String pPrefix, java.util.Properties pPizza)
          Pizza-configure this tag.
static GroupTag newInstance(java.lang.String pTagID)
          This is the only way to construct an instance of this class.
 void reset()
          Overridden to preserve the ID.
 void reset(java.lang.String newID)
          Call this method to clear data and re-set the ID in one fell swoop.
 GroupTag setDesc(java.lang.String pDescription)
          Set or clear the description of this tag.
 void setID(java.lang.String pID)
          Overridden to ensure the ID set is valid.
 GroupTag setTitle(java.lang.String pTitle)
          Set or clear the title of this tag.
 
Methods inherited from class cox.jmatt.java.MathTools.markup.svg.DrawableContainerTag
_addContent, _addCSS, _addDef, _content, _setContent, _setDesc, _setOBUS, _setPAR, _setTitle, _setViewBox, add, addRaw, drawCircle, drawEllipse, drawLine, drawPath, drawPoint, drawPolygon, drawPolyline, drawRectangle, drawRectangle, drawText
 
Methods inherited from class cox.jmatt.java.MathTools.markup.svg.StyleTag
_configureTag, _enableCopy, canHaveDefs, isInDefs, setDefaultPen, setDefaultStyle, setDefaultTransform, setPen, setStyle, setTransform
 
Methods inherited from class cox.jmatt.java.MathTools.markup.Tag
_addAttribute, _addAttributes, _addNAttribute, _asBoolean, _asDouble, _asInt, _attributes, _clampNAttribute, _clampNAttribute, _fixKey, _setEnableXMLTag, badPizza, closeTag, configureTagFromGlobalPizza, makeTag, openTag, toString, validString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GroupTag

protected GroupTag(StyleTag.TagKeys pKey)
Constructor provided for subclasses.

Method Detail

newInstance

public static GroupTag newInstance(java.lang.String pTagID)
This is the only way to construct an instance of this class. If the ID argument is null or blank the return value is null!


setID

public void setID(java.lang.String pID)
Overridden to ensure the ID set is valid.

Overrides:
setID in class Tag

reset

public void reset()
Overridden to preserve the ID. To change it use reset(String) or re-set manually afterward.

Overrides:
reset in class Tag

reset

public void reset(java.lang.String newID)
Call this method to clear data and re-set the ID in one fell swoop.


setTitle

public GroupTag setTitle(java.lang.String pTitle)
Set or clear the title of this tag.


setDesc

public GroupTag setDesc(java.lang.String pDescription)
Set or clear the description of this tag.


configureTag

public void configureTag(java.lang.String pPrefix,
                         java.util.Properties pPizza)

Pizza-configure this tag. The prefix is 'svg.markup.Group' and the two settable keys are '.title' for the title and '.desc' for the description.

Overrides:
configureTag in class Tag
pPizza - A Properties object holding configuration data for the subclass instance.