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

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.ClipTag

public class ClipTag
extends DrawableContainerTag

This class implements the <clipPath> tag. It lives inside the <defs> block and is used to describe a clipping path applied to another graphic. Because of this a valid ID is mandatory. There is no public constructor and the factory method will NOT build a tag around a null or blank ID.


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
 
Method Summary
 void configureTag(java.lang.String pPrefix, java.util.Properties pPizza)
          Configure this tag.
static ClipTag 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.
 ClipTag setClipPathUnits(boolean pUserSpace)
          Set the unit spec for this tag.
 void setID(java.lang.String pID)
          Overridden to ensure the ID set is valid.
 
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
 

Method Detail

newInstance

public static ClipTag 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.


setClipPathUnits

public ClipTag setClipPathUnits(boolean pUserSpace)
Set the unit spec for this tag. This is 'objectBoundingBox' or 'userSpaceOnUse'.

See Also:
DrawableContainerTag._setOBUS(java.lang.String, boolean)

configureTag

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

Configure this tag. The only class-unique key it recognizes is 'markup.svg.Clip.pathUnits' which accepts a value of 'true' or 'false'. Of course the StyleTag keys may also be set.

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