org.girod.javafx.svgimage.xml.specs

Class GradientSpec

java.lang.Object

org.girod.javafx.svgimage.xml.specs.GradientSpec

All Implemented Interfaces:

SVGTags

Direct Known Subclasses:

LinearGradientSpec, RadialGradientSpec

public abstract class GradientSpec
extends java.lang.Object
implements SVGTags

Contains the specification for a radial or linear gradient.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	GradientSpec.Coord Coordinate value with optional proportional flag.
static class	GradientSpec.StopSpec Stop specification for a gradient.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	href Optional reference to another gradient spec.
protected java.lang.String	id Gradient identifier.
protected boolean	isResolved True once the gradient has been resolved.
protected java.util.List<GradientSpec.StopSpec>	specStops List of stops defined for this gradient.
protected java.util.List<javafx.scene.transform.Transform>	transformList Optional list of transforms applied to the gradient.
protected XMLNode	xmlNode Source XML node for this gradient.

Fields inherited from interface org.girod.javafx.svgimage.xml.parsers.SVGTags

ADDITIVE, ANIMATE, ANIMATE_MOTION, ANIMATE_TRANSFORM, ATTRIBUTE_NAME, AZIMUTH, BASELINE_SHIFT, BASELINE_SUB, BASELINE_SUPER, BEGIN, BEVEL, BOLD, BOLDER, BUTT, CIRCLE, CLASS, CLIP_PATH, CLIP_PATH_SPEC, CLIP_PATH_UNITS, CLIP_RULE, CONTEXT_FILL, CONTEXT_STROKE, CX, CY, D, DEFS, DIFFUSE_CONSTANT, DILATE, DUR, DX, DY, ELEVATION, ELLIPSE, END, EVEN_ODD, FE_COMPOSITE, FE_DIFFUSE_LIGHTING, FE_DISTANT_LIGHT, FE_DROP_SHADOW, FE_FLOOD, FE_GAUSSIAN_BLUR, FE_IMAGE, FE_MERGE, FE_MERGE_NODE, FE_MORPHOLOGY, FE_OFFSET, FE_POINT_LIGHT, FE_SPECULAR_LIGHTING, FE_SPOT_LIGHT, FILL, FILL_OPACITY, FILL_RULE, FILTER, FLOOD_COLOR, FLOOD_OPACITY, FONT_FAMILY, FONT_SIZE, FONT_STYLE, FONT_WEIGHT, FROM, FX, FY, G, GRADIENT_TRANSFORM, GRADIENT_UNITS, HEIGHT, HIDDEN, HREF, ID, IMAGE, IN, IN2, INDEFINITE, ITALIC, LIGHTER, LIGHTING_COLOR, LINE, LINE_THROUGH, LINEAR_GRADIENT, MARKER, MARKER_END, MARKER_HEIGHT, MARKER_MID, MARKER_START, MARKER_WIDTH, MASK, MIDDLE, MITER, NON_ZERO, NONE, NORMAL, OBJECT_BOUNDINGBOX, OBLIQUE, OFFSET, OPACITY, OPERATOR, OPERATOR_ARITHMETIC, OPERATOR_ATOP, OPERATOR_IN, OPERATOR_OUT, OPERATOR_OVER, OPERATOR_XOR, ORIENT, ORIENT_AUTO, ORIENT_AUTO_REVERSE, PATH, POINT_AT_X, POINT_AT_Y, POINT_AT_Z, POINTS, POLYGON, POLYLINE, PRESERVE_ASPECT_RATIO, R, RADIAL_GRADIENT, RADIUS, RECT, REFX, REFY, REPEAT_COUNT, RESULT, ROTATE, ROUND, RX, RY, SCALE, SET, SKEW_X, SKEW_Y, SOURCE_ALPHA, SOURCE_GRAPHIC, SPECULAR_CONSTANT, SPECULAR_EXPONENT, SPREAD_METHOD, SPREAD_PAD, SPREAD_REFLECT, SPREAD_REPEAT, SQUARE, START, STD_DEVIATION, STOP, STOP_COLOR, STOP_OPACITY, STROKE, STROKE_DASHARRAY, STROKE_DASHOFFSET, STROKE_LINECAP, STROKE_LINEJOIN, STROKE_MITERLIMIT, STROKE_WIDTH, STYLE, SURFACE_SCALE, SVG, SYMBOL, TEXT, TEXT_ANCHOR, TEXT_DECORATION, TO, TRANSFORM, TRANSLATE, TSPAN, TYPE, UNDERLINE, USE, USERSPACE_ON_USE, VALUES, VIEWBOX, VISIBILITY, VISIBLE, WIDTH, X, X1, X2, XLINK_HREF, Y, Y1, Y2, Z

Constructor Summary

Constructors

Constructor and Description
GradientSpec(XMLNode node) Create a gradient spec from an XML node.
GradientSpec(XMLNode node, java.lang.String href) Create a gradient spec from an XML node with a reference href.

Method Summary

Modifier and Type	Method and Description
GradientSpec.StopSpec	addStop(double offset, double opacity, javafx.scene.paint.Color color) Add a stop to this gradient.
protected java.util.List<GradientSpec.StopSpec>	buildStops(GradientSpec spec, XMLNode xmlNode, java.lang.String kindOfGradient) Build stop specs from XML stop children.
protected java.util.List<javafx.scene.paint.Stop>	convertStops(java.util.List<GradientSpec.StopSpec> specstops) Convert stop specs to JavaFX stops.
protected javafx.scene.paint.CycleMethod	getCycleMethod(java.lang.String value) Map a spread method string to a JavaFX cycle method.
protected double	getGradientPos(XMLNode xmlNode, java.lang.String id) Parse a gradient position attribute value.
java.lang.String	getID() Return the gradient id.
XMLNode	getNode() Return the backing XML node.
abstract javafx.scene.paint.Paint	getPaint() Return the resolved JavaFX paint.
java.util.List<GradientSpec.StopSpec>	getStops() Return the list of stop specifications.
java.util.List<javafx.scene.transform.Transform>	getTransformList() Return the gradient transform list.
boolean	isResolved() Return true if the gradient has been resolved.
abstract void	resolve(java.util.Map<java.lang.String,GradientSpec> gradients, Viewport viewport) Resolve the gradient using referenced gradients and viewport.
void	setID(java.lang.String id) Set the gradient id.
void	setTransformList(java.util.List<javafx.scene.transform.Transform> transformList) Set the gradient transform list.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

href

protected java.lang.String href

Optional reference to another gradient spec.

id

protected java.lang.String id

Gradient identifier.

xmlNode

protected XMLNode xmlNode

Source XML node for this gradient.

isResolved

protected boolean isResolved

True once the gradient has been resolved.

specStops

protected java.util.List<GradientSpec.StopSpec> specStops

List of stops defined for this gradient.

transformList

protected java.util.List<javafx.scene.transform.Transform> transformList

Optional list of transforms applied to the gradient.

Constructor Detail

GradientSpec

public GradientSpec(XMLNode node)

Create a gradient spec from an XML node.

Parameters:

node - the gradient XML node

GradientSpec

public GradientSpec(XMLNode node,
                    java.lang.String href)

Create a gradient spec from an XML node with a reference href.

Parameters:

node - the gradient XML node

href - the referenced gradient id

Method Detail

setID

public void setID(java.lang.String id)

Set the gradient id.

Parameters:

id - the gradient id

getID

public java.lang.String getID()

Return the gradient id.

Returns:

the gradient id

getNode

public XMLNode getNode()

Return the backing XML node.

Returns:

the XML node

isResolved

public boolean isResolved()

Return true if the gradient has been resolved.

Returns:

true if resolved

getPaint

public abstract javafx.scene.paint.Paint getPaint()

Return the resolved JavaFX paint.

Returns:

the paint

resolve

public abstract void resolve(java.util.Map<java.lang.String,GradientSpec> gradients,
                             Viewport viewport)

Resolve the gradient using referenced gradients and viewport.

Parameters:

gradients - the gradient map by id

viewport - the viewport

setTransformList

public void setTransformList(java.util.List<javafx.scene.transform.Transform> transformList)

Set the gradient transform list.

Parameters:

transformList - the transform list

getTransformList

public java.util.List<javafx.scene.transform.Transform> getTransformList()

Return the gradient transform list.

Returns:

the transform list

getGradientPos

protected double getGradientPos(XMLNode xmlNode,
                                java.lang.String id)

Parse a gradient position attribute value.

Parameters:

xmlNode - the gradient node

id - the attribute name

Returns:

the parsed position

getCycleMethod

protected javafx.scene.paint.CycleMethod getCycleMethod(java.lang.String value)

Map a spread method string to a JavaFX cycle method.

Parameters:

value - the spread method value

Returns:

the cycle method

addStop

public GradientSpec.StopSpec addStop(double offset,
                                     double opacity,
                                     javafx.scene.paint.Color color)

Add a stop to this gradient.

Parameters:

offset - the stop offset

opacity - the stop opacity

color - the stop color

Returns:

the created stop spec

getStops

public java.util.List<GradientSpec.StopSpec> getStops()

Return the list of stop specifications.

Returns:

the stop specs

convertStops

protected java.util.List<javafx.scene.paint.Stop> convertStops(java.util.List<GradientSpec.StopSpec> specstops)

Convert stop specs to JavaFX stops.

Parameters:

specstops - the stop specs

Returns:

the JavaFX stops

buildStops

protected java.util.List<GradientSpec.StopSpec> buildStops(GradientSpec spec,
                                                           XMLNode xmlNode,
                                                           java.lang.String kindOfGradient)

Build stop specs from XML stop children.

Parameters:

spec - the gradient spec to populate

xmlNode - the gradient XML node

kindOfGradient - the gradient element name

Returns:

the stop specs