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

java.lang.Object
  extended by cox.jmatt.java.MathTools.markup.svg.MathDrawSVG

public class MathDrawSVG
extends java.lang.Object

This class furnishes instances of SVG tag classes. It can also be used to set default values. MathDrawSVG serves the same purpose as the graphing.GraphEngine class except that it's a part of the SVG package and not graphing.*. The various 'get()' methods echo the relevant constructors for the classes they furnish.


Constructor Summary
MathDrawSVG()
          Scripting constructor and the only one needed.
 
Method Summary
 CircleTag getCircleTag()
          Fetch a default CircleTag.
 CircleTag getCircleTag(java.lang.Double X1, java.lang.Double Y1, java.lang.Double rad)
          Create a CircleTag with all specific data specified.
 ClipTag getClipTag(java.lang.String pID)
          Create a <clipPath> tag with the ID given.
 EllipseTag getEllipseTag()
          Fetch a default EllipseTag.
 EllipseTag getEllipseTag(java.lang.Double X1, java.lang.Double Y1, java.lang.Double X2, java.lang.Double Y2)
          Create a EllipseTag with all specific data specified.
 GroupTag getGroupTag(java.lang.String pID)
          Create a group tag ('<g>').
 SVGTag getLetter()
          Create a letter-sized SVG root tag with the viewport set for 100 units per inch in both directions.
 GradientTag getLinearGradient()
          Create and return a standard (linear) GradientTag.
 LineTag getLineTag()
          Fetch a default LineTag.
 LineTag getLineTag(java.lang.Double X1, java.lang.Double Y1, java.lang.Double X2, java.lang.Double Y2)
          Create a LineTag with all specific data specified.
 MarkerPen getMarkerPen()
          Create a plain unnamed MarkerPen.
 MarkerPen getMarkerPen(int pNum)
          Create a new numbered MarkerPen.
 MarkerTag getMarkerTag(java.lang.String pID)
          Create a <marker> tag.
 MaskTag getMaskTag(java.lang.String pID)
          Create a <mask> tag with the ID given.
 PathTag getPathTag()
          Fetch a default PathTag.
 PatternTag getPatternTag(java.lang.String pID)
          Create a <pattern> tag.
 java.lang.String getPoint(double pX, double pY)
          Create a point at (pX, pY).
 PolygonTag getPolygonTag()
          Fetch a default PolygonTag.
 PolygonTag getPolylineTag()
          Create a PolylineTag.
 GradientTag getRadialGradient()
          Create and return a radial GradientTag.
 RectangleTag getRectangleTag()
          Fetch a default RectangleTag.
 RectangleTag getRectangleTag(java.lang.Double X1, java.lang.Double Y1, java.lang.Double pWidth, java.lang.Double pHeight)
          Create a sharp-cornered RectangleTag with all specific data specified.
 RectangleTag getRectangleTag(java.lang.Double X1, java.lang.Double Y1, java.lang.Double pWidth, java.lang.Double pHeight, java.lang.Double radX, java.lang.Double radY)
          Create a rounded RectangleTag.
 StylePen getStylePen()
          Create a plain StylePen, unnamed (unnumbered).
 StylePen getStylePen(int pNum)
          Create a new numbered StylePen.
 SVGTag getSVGTag(java.lang.String pWidth, java.lang.String pHeight)
          Create a standard, no-frills root <svg> tag, ready for use.
 SymbolTag getSymbolTag(java.lang.String pID)
          Create a <symbol>') tag.
 TextPen getTextPen()
          Create a plain unnamed TextPen.
 TextPen getTextPen(int pNum)
          Create a new numbered TextPen.
 TextTag getTextTag()
          Fetch a default TextTag.
 TextTag getTextTag(java.lang.Double X1, java.lang.Double Y1, java.lang.String pContent)
          Create a TextTag with all specific data specified.
 TransformPen getTransformPen()
          Create a TransformPen.
 TSpanTag getTSpanTag()
          Create and return a TSpanTag with nothing pre-set.
 TSpanTag getTSpanTag(java.lang.String pText)
          Create a TSpanTag around a String of text.
 UseTag getUseTag(java.lang.String HREF)
          Fetch a UseTag instance.
 void setCirclePen(int pPen)
          Set the default pen number for subsequent CircleTag instances.
 void setCircleStyle(StylePen pPen)
          Set the default StylePen for subsequent CircleTag instances.
 void setCircleTransform(TransformPen pPen)
          Set the default transforms for subsequent CircleTags.
 void setConfigPizza(java.lang.String pPrefix, java.util.Properties pPizza)
          Set or clear a Properties object for tag configuration.
 void setEllipsePen(int pPen)
          Set the default pen number for subsequent EllipseTag instances.
 void setEllipseStyle(StylePen pPen)
          Set the default StylePen for subsequent EllipseTag instances.
 void setEllipseTransform(TransformPen pPen)
          Set the default transforms for subsequent EllipseTags.
 void setLinePen(int pPen)
          Set the default pen number for subsequent LineTag instances.
 void setLineStyle(StylePen pPen)
          Set the default StylePen for subsequent LineTag instances.
 void setLineTransform(TransformPen pPen)
          Set the default transforms for subsequent LineTags.
 void setPathPen(int pPen)
          Set the default pen number for subsequent PathTag instances.
 void setPathStyle(StylePen pPen)
          Set the default StylePen for subsequent PathTag instances.
 void setPathTransform(TransformPen pPen)
          Set the default transforms for subsequent PathTags.
 void setPointData(double pSize, java.lang.String pColor)
          (Re-)Set the configuration data for points.
 void setPolygonPen(int pPen)
          Set the default pen number for subsequent PolygonTag instances.
 void setPolygonStyle(StylePen pPen)
          Set the default StylePen for subsequent PolygonTag instances.
 void setPolygonTransform(TransformPen pPen)
          Set the default transforms for subsequent PolygonTags.
 void setRectanglePen(int pPen)
          Set the default pen number for subsequent RectangleTag instances.
 void setRectangleStyle(StylePen pPen)
          Set the default StylePen for subsequent RectangleTag instances.
 void setRectangleTransform(TransformPen pPen)
          Set the default transforms for subsequent RectangleTags.
 void setTextPen(int pPen)
          Set the default pen number for subsequent TextTag instances.
 void setTextStyle(StylePen pPen)
          Set the default StylePen for subsequent TextTag instances.
 void setTextTransform(TransformPen pPen)
          Set the default transforms for subsequent TextTags.
 void setUseTagPen(int pPen)
          Set the default pen number for subsequent UseTag instances.
 void setUseTagStyle(StylePen pPen)
          Set the default StylePen for subsequent UseTag instances.
 void setUseTagTransform(TransformPen pPen)
          Set the default transforms for subsequent UseTags.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MathDrawSVG

public MathDrawSVG()
Scripting constructor and the only one needed. Ever!

Method Detail

setConfigPizza

public void setConfigPizza(java.lang.String pPrefix,
                           java.util.Properties pPizza)
Set or clear a Properties object for tag configuration. If not null this pizza is used to configure all generated tag classes and pens with the exception of TransformPen. Setting null clears it and empty instances are ignored.

Parameters:
pPrefix - The configuration key prefix if desired.
pPizza - The configuration properties for all generated tags and pens. Null clears it.

getLineTag

public LineTag getLineTag()
Fetch a default LineTag.


getLineTag

public LineTag getLineTag(java.lang.Double X1,
                          java.lang.Double Y1,
                          java.lang.Double X2,
                          java.lang.Double Y2)
Create a LineTag with all specific data specified.


setLinePen

public void setLinePen(int pPen)
Set the default pen number for subsequent LineTag instances.


setLineStyle

public void setLineStyle(StylePen pPen)
Set the default StylePen for subsequent LineTag instances.


setLineTransform

public void setLineTransform(TransformPen pPen)
Set the default transforms for subsequent LineTags.


getCircleTag

public CircleTag getCircleTag()
Fetch a default CircleTag.


getCircleTag

public CircleTag getCircleTag(java.lang.Double X1,
                              java.lang.Double Y1,
                              java.lang.Double rad)
Create a CircleTag with all specific data specified.


setCirclePen

public void setCirclePen(int pPen)
Set the default pen number for subsequent CircleTag instances.


setCircleStyle

public void setCircleStyle(StylePen pPen)
Set the default StylePen for subsequent CircleTag instances.


setCircleTransform

public void setCircleTransform(TransformPen pPen)
Set the default transforms for subsequent CircleTags.


setPointData

public void setPointData(double pSize,
                         java.lang.String pColor)
(Re-)Set the configuration data for points.


getPoint

public java.lang.String getPoint(double pX,
                                 double pY)
Create a point at (pX, pY).


getEllipseTag

public EllipseTag getEllipseTag()
Fetch a default EllipseTag.


getEllipseTag

public EllipseTag getEllipseTag(java.lang.Double X1,
                                java.lang.Double Y1,
                                java.lang.Double X2,
                                java.lang.Double Y2)
Create a EllipseTag with all specific data specified.


setEllipsePen

public void setEllipsePen(int pPen)
Set the default pen number for subsequent EllipseTag instances.


setEllipseStyle

public void setEllipseStyle(StylePen pPen)
Set the default StylePen for subsequent EllipseTag instances.


setEllipseTransform

public void setEllipseTransform(TransformPen pPen)
Set the default transforms for subsequent EllipseTags.


getRectangleTag

public RectangleTag getRectangleTag()
Fetch a default RectangleTag.


getRectangleTag

public RectangleTag getRectangleTag(java.lang.Double X1,
                                    java.lang.Double Y1,
                                    java.lang.Double pWidth,
                                    java.lang.Double pHeight)
Create a sharp-cornered RectangleTag with all specific data specified.


getRectangleTag

public RectangleTag getRectangleTag(java.lang.Double X1,
                                    java.lang.Double Y1,
                                    java.lang.Double pWidth,
                                    java.lang.Double pHeight,
                                    java.lang.Double radX,
                                    java.lang.Double radY)
Create a rounded RectangleTag.


setRectanglePen

public void setRectanglePen(int pPen)
Set the default pen number for subsequent RectangleTag instances.


setRectangleStyle

public void setRectangleStyle(StylePen pPen)
Set the default StylePen for subsequent RectangleTag instances.


setRectangleTransform

public void setRectangleTransform(TransformPen pPen)
Set the default transforms for subsequent RectangleTags.


getPolygonTag

public PolygonTag getPolygonTag()
Fetch a default PolygonTag.


getPolylineTag

public PolygonTag getPolylineTag()
Create a PolylineTag. It will not be closed: setPolygon(false).


setPolygonPen

public void setPolygonPen(int pPen)
Set the default pen number for subsequent PolygonTag instances.


setPolygonStyle

public void setPolygonStyle(StylePen pPen)
Set the default StylePen for subsequent PolygonTag instances.


setPolygonTransform

public void setPolygonTransform(TransformPen pPen)
Set the default transforms for subsequent PolygonTags.


getTextTag

public TextTag getTextTag()
Fetch a default TextTag.


getTextTag

public TextTag getTextTag(java.lang.Double X1,
                          java.lang.Double Y1,
                          java.lang.String pContent)
Create a TextTag with all specific data specified.


setTextPen

public void setTextPen(int pPen)
Set the default pen number for subsequent TextTag instances.


setTextStyle

public void setTextStyle(StylePen pPen)
Set the default StylePen for subsequent TextTag instances.


setTextTransform

public void setTextTransform(TransformPen pPen)
Set the default transforms for subsequent TextTags.


getTSpanTag

public TSpanTag getTSpanTag()
Create and return a TSpanTag with nothing pre-set.


getTSpanTag

public TSpanTag getTSpanTag(java.lang.String pText)
Create a TSpanTag around a String of text. Since this is automatically a part of a <text> tag it has no methods for setting default values for styling or transformation; these must be handled on a per-instance basis!


getUseTag

public UseTag getUseTag(java.lang.String HREF)
Fetch a UseTag instance. The HREF is mandatory and must not be null or blank.


setUseTagPen

public void setUseTagPen(int pPen)
Set the default pen number for subsequent UseTag instances.


setUseTagStyle

public void setUseTagStyle(StylePen pPen)
Set the default StylePen for subsequent UseTag instances.


setUseTagTransform

public void setUseTagTransform(TransformPen pPen)
Set the default transforms for subsequent UseTags.


getPathTag

public PathTag getPathTag()
Fetch a default PathTag.


setPathPen

public void setPathPen(int pPen)
Set the default pen number for subsequent PathTag instances.


setPathStyle

public void setPathStyle(StylePen pPen)
Set the default StylePen for subsequent PathTag instances.


setPathTransform

public void setPathTransform(TransformPen pPen)
Set the default transforms for subsequent PathTags.


getClipTag

public ClipTag getClipTag(java.lang.String pID)
Create a <clipPath> tag with the ID given. The ID must not be blank or null otherwise the return value will be null.


getMaskTag

public MaskTag getMaskTag(java.lang.String pID)
Create a <mask> tag with the ID given. If the ID is blank or null the return value will be null.


getMarkerTag

public MarkerTag getMarkerTag(java.lang.String pID)
Create a <marker> tag. If the ID is null or blank the return value will be null.


getPatternTag

public PatternTag getPatternTag(java.lang.String pID)
Create a <pattern> tag. If the ID is null or blank the return value will be null.


getGroupTag

public GroupTag getGroupTag(java.lang.String pID)
Create a group tag ('<g>'). A non-null, non-blank ID is mandatory.


getSymbolTag

public SymbolTag getSymbolTag(java.lang.String pID)
Create a <symbol>') tag. Must have a non-null, non-blank ID.


getLinearGradient

public GradientTag getLinearGradient()
Create and return a standard (linear) GradientTag.


getRadialGradient

public GradientTag getRadialGradient()
Create and return a radial GradientTag.


getSVGTag

public SVGTag getSVGTag(java.lang.String pWidth,
                        java.lang.String pHeight)
Create a standard, no-frills root <svg> tag, ready for use. Must have valid width and height.


getLetter

public SVGTag getLetter()
Create a letter-sized SVG root tag with the viewport set for 100 units per inch in both directions.


getStylePen

public StylePen getStylePen()
Create a plain StylePen, unnamed (unnumbered).


getStylePen

public StylePen getStylePen(int pNum)
Create a new numbered StylePen.


getMarkerPen

public MarkerPen getMarkerPen()
Create a plain unnamed MarkerPen.


getMarkerPen

public MarkerPen getMarkerPen(int pNum)
Create a new numbered MarkerPen.


getTextPen

public TextPen getTextPen()
Create a plain unnamed TextPen.


getTextPen

public TextPen getTextPen(int pNum)
Create a new numbered TextPen.


getTransformPen

public TransformPen getTransformPen()
Create a TransformPen.