de.saxsys.svgfx.core.utils

Class SVGUtils

java.lang.Object

de.saxsys.svgfx.core.utils.SVGUtils

public final class SVGUtils
extends Object

This class provides functionality related to svg processing

Author:

by Xyanid on 02.11.2015.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SVGUtils.SplitConsumer This interface allows that split(String, List, SplitConsumer) to consume data an indicate whether to further add new characters or consume the currentData.

Method Summary

Modifier and Type	Method and Description
static <TShape extends javafx.scene.shape.Shape> void	applyStyle(TShape shape, SVGCssStyle style, SVGDataProvider dataProvider) Applies the basic style every Shape supports to the given shape.
static void	combineStylesAndResolveInheritance(SVGCssStyle style, SVGCssStyle otherStyle) This method will use the properties of the given style, if any property uses inheritance, the given otherStyle will be used to resolve it.
static javafx.scene.transform.Transform	getTransform(String data) Returns the combined transformations available in the given string.
static javafx.scene.transform.Transform	getTransform(SVGElementBase.Matrix matrix, String data, boolean checkIfStartWithMatrix) Gets the Transform that is represented by the given data.
static javafx.scene.paint.Paint	parseColor(String data, SVGDataProvider dataProvider) Resolves the given data into a paint.
static <TSVGElementBase extends SVGElementBase<?>> TSVGElementBase	resolveIRI(String data, SVGDataProvider dataProvider, Class<TSVGElementBase> clazz) Returns the element which might be referenced by the given data.
static List<String>	split(String toSplit, List<Character> delimiters, SVGUtils.SplitConsumer dataConsumer) This method will iterate through the given toSplit and call the dataConsumer Function when the current character in toSplit is contained in the delimiters.
static String	stripIRIIdentifiers(String data) Strips the given String from the IRI identifiers if any.

Methods inherited from class java.lang.Object

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

Method Detail

stripIRIIdentifiers

public static String stripIRIIdentifiers(String data)
                                  throws IllegalArgumentException

Strips the given String from the IRI identifiers if any.

Parameters:

data - the String to be stripped, must not be null or empty.

Returns:

the data striped of its IRI identifiers or null the string does not contain any IRI identifiers.

Throws:

IllegalArgumentException - if data is null or empty.

resolveIRI

public static <TSVGElementBase extends SVGElementBase<?>> TSVGElementBase resolveIRI(String data,
                                                                                     SVGDataProvider dataProvider,
                                                                                     Class<TSVGElementBase> clazz)
                                                                              throws SVGException,
                                                                                     IllegalArgumentException

Returns the element which might be referenced by the given data. The data will need to start with the Constants.IRI_IDENTIFIER in order to be resolved as a reference.

Type Parameters:

TSVGElementBase - the type of element which is expected.

Parameters:

data - the string which contains the reference to resolve.

dataProvider - the SVGDataProvider which contains the data which is referenced.

clazz - the class of the element that is expected.

Returns:

the SVGElementBase which is referenced by the data or null if the data does not reference an element.

Throws:

SVGException - if the data references a resource which is not contained in the SVGDataProvider.

IllegalArgumentException - if either the data is null or empty, the dataProvider is null or the clazz is null.

parseColor

public static javafx.scene.paint.Paint parseColor(String data,
                                                  SVGDataProvider dataProvider)
                                           throws SVGException,
                                                  IllegalArgumentException

Resolves the given data into a paint. The data must either be valid hex web color (e.g. #00FF00FF) or a reference which can be resolved by the given data dataProvider.

Parameters:

data - data to be resolved

dataProvider - the SVGDataProvider to be used, must not be null

Returns:

Paint which represents the color

Throws:

SVGException - if the data references another element which is not found in the given data dataProvider.

IllegalArgumentException - if the the data is empty, the dataProvider is null.

applyStyle

public static <TShape extends javafx.scene.shape.Shape> void applyStyle(TShape shape,
                                                                        SVGCssStyle style,
                                                                        SVGDataProvider dataProvider)
                                                                 throws IllegalArgumentException

Applies the basic style every Shape supports to the given shape.

Type Parameters:

TShape - type of the shape to be used

Parameters:

shape - Shape to which the the styles should be applied, must not be null

style - SVGCssStyle to use, must not be null

dataProvider - the SVGDataProvider to be used

Throws:

IllegalArgumentException - if either shape or style is null

combineStylesAndResolveInheritance

public static void combineStylesAndResolveInheritance(SVGCssStyle style,
                                                      SVGCssStyle otherStyle)
                                               throws IllegalArgumentException

This method will use the properties of the given style, if any property uses inheritance, the given otherStyle will be used to resolve it. If the otherStyle does not contain a value for the inherited property, then the default value will be used.

Parameters:

style - SVGCssStyle which contains the properties which are to be set, must not be null.

otherStyle - the SVGCssStyle to use as a parent in order to resolve the inheritance, must not be null.

Throws:

IllegalArgumentException - if either style or inheritanceResolver are null.

getTransform

public static javafx.scene.transform.Transform getTransform(String data)
                                                     throws SVGException

Returns the combined transformations available in the given string. The string must be contain data corresponding to the SVGRoot specification for the transform attribute.

Parameters:

data - the string which contains the transformation data.

Returns:

the transformation which was gathered from the data or null if no data was gathered.

Throws:

SVGException - if there is an error in the transformation data of the given string.

getTransform

public static javafx.scene.transform.Transform getTransform(SVGElementBase.Matrix matrix,
                                                            String data,
                                                            boolean checkIfStartWithMatrix)
                                                     throws SVGException

Gets the Transform that is represented by the given data. The data must meet the following requirements. Data can start with the name of the provide SVGElementBase.Matrix, in which case checkIfStartWithMatrix must be true, otherwise an exception will occur when the actual data is processed. Data must contain the values separated with a coma (e.g. 1,2,3). Optionally the values can be embraces with ().

Parameters:

matrix - the matrix to use

data - the data to be used, must not be null or empty or SVGElementBase.Matrix#NONE.

checkIfStartWithMatrix - determines if the given data is to be checked if it starts with the SVGElementBase.Matrix#name

Returns:

a new Transform which contains the transformation represented by the data.

Throws:

IllegalArgumentException - if the given data is empty or matrix is SVGElementBase.Matrix#NONE.

SVGException - if there is an error in the transformation data of the given string.

split

public static List<String> split(String toSplit,
                                 List<Character> delimiters,
                                 SVGUtils.SplitConsumer dataConsumer)
                          throws SVGException,
                                 IllegalArgumentException

This method will iterate through the given toSplit and call the dataConsumer Function when the current character in toSplit is contained in the delimiters. The String passed to the dataConsumer will contain all the characters read in the String that are NOT considered delimiters. When the dataConsumer returns true, the passed String will be added to the list of results. A new call to the dataConsumer will then contain a new String.

Parameters:

toSplit - the String which is to be parsed, must not be null or empty.

delimiters - the characters which indicate a delimiter in the toSplit, must not be null or empty.

dataConsumer - the Function to be called when a character that is a delimiter is read, must not be null.

Returns:

the list of Strings which are between the delimiters of the toSplit if any or an empty list.

Throws:

SVGException - is rethrown by the dataConsumer

IllegalArgumentException - if either toSplit, delimiter or dataConsumer are null or empty.