org.girod.javafx.svgimage.xml.parsers

Class ParserUtils

java.lang.Object

org.girod.javafx.svgimage.xml.parsers.ParserUtils

All Implemented Interfaces:

SVGTags

public class ParserUtils
extends java.lang.Object
implements SVGTags

Several utilities for shape parsing.

Field Summary

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

Method Summary

Modifier and Type	Method and Description
static java.util.List<javafx.scene.Node>	createNodeList(javafx.scene.Node node) Wrap a node into a list when non-null.
static javafx.scene.effect.Effect	expressFilter(java.util.Map<java.lang.String,FilterSpec> filterSpecs, javafx.scene.Node node, java.lang.String value) Apply the appropriate filter on a node.
static javafx.scene.paint.Paint	expressPaint(java.util.Map<java.lang.String,javafx.scene.paint.Paint> gradients, java.lang.String value) Resolve a paint value without a context node.
static javafx.scene.paint.Paint	expressPaint(javafx.scene.Node contextNode, java.util.Map<java.lang.String,javafx.scene.paint.Paint> gradients, java.lang.String value) Resolve a paint value, handling context and gradients.
static double	getAngleDegrees(java.lang.String value) Return an angle value in degrees.
static javafx.scene.shape.FillRule	getClipRule(XMLNode node) Return the clip rule defined on a node.
static javafx.scene.paint.Color	getColor(java.lang.String value) Return the color with a specified String value.
static javafx.scene.paint.Color	getColor(java.lang.String value, double opacity) Return the color for a value with explicit opacity.
static javafx.scene.shape.FillRule	getFillRule(XMLNode node) Return the fill rule defined on a node.
static javafx.scene.image.Image	getImage(java.net.URL url, java.lang.String href, double width, double height) Load an image from a URL or a data URI.
static boolean	getPreserveAspectRatio(java.lang.String value) Return true if the aspect ratio is preserved.
static java.util.Map<java.lang.String,java.lang.String>	getStyles(XMLNode node) Extract the style map from a style attribute.
static java.lang.String	getURL(java.lang.String value) Return the color with a specified String value.
static boolean	hasXPosition(ElementNode node) Return true if the node specifies an x position.
static boolean	isPercent(XMLNode xmlNode, java.lang.String attrname) Return true if the attribute value is expressed as a percent.
static java.lang.String	mergeStyles(java.util.Map<java.lang.String,java.lang.String> styles, ElementNode node) Merge a style map with styles from the node and return a style string.
static java.util.List<java.lang.Double>	parseDashArray(java.lang.String value, Viewport viewport) Parse a stroke-dasharray attribute into a list of lengths.
static double	parseDoubleProtected(java.lang.String valueS) Parse a double value with error handling.
static java.lang.String	parseFirstArgument(java.lang.String value) Return the first token in a space-separated argument list.
static double	parseFontSize(java.lang.String valueS) Parse a font size value with optional unit conversion.
static int	parseIntProtected(java.lang.String valueS) Parse an integer value with error handling.
static void	parseLengthValue(java.util.List<java.lang.Double> args, java.lang.String value, boolean isWidth, javafx.geometry.Bounds bounds, Viewport viewport) Parse a length value and append it to the list.
static double	parseLengthValue(java.lang.String valueS, boolean isWidth, javafx.geometry.Bounds bounds, Viewport viewport) Parse a length value.
static double	parseLineWidth(java.lang.String value, Viewport viewport) Parse a line width value.
static Viewbox	parseMarkerViewbox(XMLNode xmlNode, Viewport viewport) Parse a marker viewbox from marker attributes.
static double	parseOpacity(java.lang.String value) Parse an opacity value, supporting percent values.
static double	parsePositionValue(java.lang.String valueS, boolean isWidth, javafx.geometry.Bounds bounds, Viewport viewport) Parse a position value.
static Viewbox	parseViewbox(XMLNode xmlNode, Viewport viewport) Parse a viewbox from width/height and viewBox attributes.
static Viewport	parseViewport(XMLNode xmlNode) Parse the viewport from the root SVG node.
static boolean	parseVisibility(java.lang.String value) Parse a visibility value.
static void	propagateStyleAttributes(XMLNode parentNode, XMLNode childNode) Propagate style attributes from a parent to a child node.
static void	setBaselineShift(javafx.scene.Node node, java.lang.String value) Apply a baseline shift to a node or its text children.
static void	setBaselineShift(javafx.scene.text.Text text, java.lang.String value) Apply a baseline shift to a text node.
static void	setFillOpacity(javafx.scene.Node node, double fillOpacity) Apply a fill opacity override on a node.
static void	setOpacity(javafx.scene.Node node, ElementNode elementNode) Apply opacity and fill opacity attributes to a node.
static boolean	setVisibility(javafx.scene.Node node, ElementNode elementNode) Apply visibility from an element node to a JavaFX node.

Methods inherited from class java.lang.Object

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

Method Detail

getColor

public static javafx.scene.paint.Color getColor(java.lang.String value)

Return the color with a specified String value. Color specified as "none" will return a null color.

Parameters:

value - the color value

Returns:

the color

getAngleDegrees

public static double getAngleDegrees(java.lang.String value)

Return an angle value in degrees.

Parameters:

value - the angle value as a sgring

Returns:

the angle value in degrees

getImage

public static javafx.scene.image.Image getImage(java.net.URL url,
                                                java.lang.String href,
                                                double width,
                                                double height)

Load an image from a URL or a data URI.

Parameters:

url - the base URL

href - the href value

width - the target width

height - the target height

Returns:

the loaded image, or null on error

getURL

public static java.lang.String getURL(java.lang.String value)

Return the color with a specified String value.

Parameters:

value - the color value

Returns:

the color

expressPaint

public static javafx.scene.paint.Paint expressPaint(javafx.scene.Node contextNode,
                                                    java.util.Map<java.lang.String,javafx.scene.paint.Paint> gradients,
                                                    java.lang.String value)

Resolve a paint value, handling context and gradients.

Parameters:

contextNode - the context node for context-* paints

gradients - the gradients map

value - the paint value

Returns:

the resolved paint, or null for none

expressPaint

public static javafx.scene.paint.Paint expressPaint(java.util.Map<java.lang.String,javafx.scene.paint.Paint> gradients,
                                                    java.lang.String value)

Resolve a paint value without a context node.

Parameters:

gradients - the gradients map

value - the paint value

Returns:

the resolved paint, or null for none

getClipRule

public static javafx.scene.shape.FillRule getClipRule(XMLNode node)

Return the clip rule defined on a node.

Parameters:

node - the XML node

Returns:

the clip rule, or null if not defined

getFillRule

public static javafx.scene.shape.FillRule getFillRule(XMLNode node)

Return the fill rule defined on a node.

Parameters:

node - the XML node

Returns:

the fill rule, or null if not defined

parseDashArray

public static java.util.List<java.lang.Double> parseDashArray(java.lang.String value,
                                                              Viewport viewport)

Parse a stroke-dasharray attribute into a list of lengths.

Parameters:

value - the dash array string

viewport - the viewport

Returns:

the list of dash lengths, or null if none

getColor

public static javafx.scene.paint.Color getColor(java.lang.String value,
                                                double opacity)

Return the color for a value with explicit opacity.

Parameters:

value - the color value

opacity - the opacity

Returns:

the color, or null on error

parseVisibility

public static boolean parseVisibility(java.lang.String value)

Parse a visibility value.

Parameters:

value - the visibility value

Returns:

true if visible

parseOpacity

public static double parseOpacity(java.lang.String value)

Parse an opacity value, supporting percent values.

Parameters:

value - the opacity value

Returns:

the opacity value, or -1 on error

setFillOpacity

public static void setFillOpacity(javafx.scene.Node node,
                                  double fillOpacity)

Apply a fill opacity override on a node.

Parameters:

node - the node to update

fillOpacity - the fill opacity

parseFirstArgument

public static java.lang.String parseFirstArgument(java.lang.String value)

Return the first token in a space-separated argument list.

Parameters:

value - the argument string

Returns:

the first token

parseIntProtected

public static int parseIntProtected(java.lang.String valueS)

Parse an integer value with error handling.

Parameters:

valueS - the string value

Returns:

the parsed integer, or 0 on error

parseDoubleProtected

public static double parseDoubleProtected(java.lang.String valueS)

Parse a double value with error handling.

Parameters:

valueS - the string value

Returns:

the parsed double, or 0 on error

parseFontSize

public static double parseFontSize(java.lang.String valueS)

Parse a font size value with optional unit conversion.

Parameters:

valueS - the font size string

Returns:

the font size in pixels

parsePositionValue

public static double parsePositionValue(java.lang.String valueS,
                                        boolean isWidth,
                                        javafx.geometry.Bounds bounds,
                                        Viewport viewport)

Parse a position value.

Parameters:

valueS - thre value as a string

isWidth - true if the position represents a width

bounds - the optional bounds of the figure for which it is relative to

viewport - the viewport

Returns:

the distance

parseLengthValue

public static double parseLengthValue(java.lang.String valueS,
                                      boolean isWidth,
                                      javafx.geometry.Bounds bounds,
                                      Viewport viewport)

Parse a length value.

Parameters:

valueS - thre value as a string

isWidth - true if the distance represents a width

bounds - the optional bounds of the figure for which it is relative to

viewport - the viewport

Returns:

the distance

parseLengthValue

public static void parseLengthValue(java.util.List<java.lang.Double> args,
                                    java.lang.String value,
                                    boolean isWidth,
                                    javafx.geometry.Bounds bounds,
                                    Viewport viewport)

Parse a length value and append it to the list.

Parameters:

args - the list to append to

value - the length string

isWidth - true if the value represents a width

bounds - the optional bounds

viewport - the viewport

parseLineWidth

public static double parseLineWidth(java.lang.String value,
                                    Viewport viewport)

Parse a line width value.

Parameters:

value - the line width string

viewport - the viewport

Returns:

the line width

expressFilter

public static javafx.scene.effect.Effect expressFilter(java.util.Map<java.lang.String,FilterSpec> filterSpecs,
                                                       javafx.scene.Node node,
                                                       java.lang.String value)

Apply the appropriate filter on a node.

Parameters:

filterSpecs - the filters specifications

node - the node

value - the filter value

Returns:

the effect to apply

setBaselineShift

public static void setBaselineShift(javafx.scene.Node node,
                                    java.lang.String value)

Apply a baseline shift to a node or its text children.

Parameters:

node - the node to update

value - the baseline-shift value

setBaselineShift

public static void setBaselineShift(javafx.scene.text.Text text,
                                    java.lang.String value)

Apply a baseline shift to a text node.

Parameters:

text - the text node

value - the baseline-shift value

hasXPosition

public static boolean hasXPosition(ElementNode node)

Return true if the node specifies an x position.

Parameters:

node - the element node

Returns:

true if x or dx is defined

getStyles

public static java.util.Map<java.lang.String,java.lang.String> getStyles(XMLNode node)

Extract the style map from a style attribute.

Parameters:

node - the XML node

Returns:

the style map

mergeStyles

public static java.lang.String mergeStyles(java.util.Map<java.lang.String,java.lang.String> styles,
                                           ElementNode node)

Merge a style map with styles from the node and return a style string.

Parameters:

styles - the base styles

node - the element node

Returns:

the merged style string

propagateStyleAttributes

public static void propagateStyleAttributes(XMLNode parentNode,
                                            XMLNode childNode)

Propagate style attributes from a parent to a child node.

Parameters:

parentNode - the parent node

childNode - the child node

setVisibility

public static boolean setVisibility(javafx.scene.Node node,
                                    ElementNode elementNode)

Apply visibility from an element node to a JavaFX node.

Parameters:

node - the JavaFX node

elementNode - the element node

Returns:

true if the node should remain visible

setOpacity

public static void setOpacity(javafx.scene.Node node,
                              ElementNode elementNode)

Apply opacity and fill opacity attributes to a node.

Parameters:

node - the JavaFX node

elementNode - the element node

parseViewport

public static Viewport parseViewport(XMLNode xmlNode)

Parse the viewport from the root SVG node.

Parameters:

xmlNode - the SVG root node

Returns:

the viewport

getPreserveAspectRatio

public static boolean getPreserveAspectRatio(java.lang.String value)

Return true if the aspect ratio is preserved. It corresponds to a value different from NONE.

Parameters:

value - the attribute value

Returns:

true if the aspect ratio is preserved

parseViewbox

public static Viewbox parseViewbox(XMLNode xmlNode,
                                   Viewport viewport)

Parse a viewbox from width/height and viewBox attributes.

Parameters:

xmlNode - the XML node

viewport - the viewport

Returns:

the viewbox, or null if not available

parseMarkerViewbox

public static Viewbox parseMarkerViewbox(XMLNode xmlNode,
                                         Viewport viewport)

Parse a marker viewbox from marker attributes.

Parameters:

xmlNode - the XML node

viewport - the viewport

Returns:

the marker viewbox, or null if not available

isPercent

public static boolean isPercent(XMLNode xmlNode,
                                java.lang.String attrname)

Return true if the attribute value is expressed as a percent.

Parameters:

xmlNode - the XML node

attrname - the attribute name

Returns:

true if a percent value is defined

createNodeList

public static java.util.List<javafx.scene.Node> createNodeList(javafx.scene.Node node)

Wrap a node into a list when non-null.

Parameters:

node - the node

Returns:

a list containing the node, or null if node is null