de.saxsys.svgfx.core

Class SVGUtils

java.lang.Object

de.saxsys.svgfx.core.SVGUtils

public final class SVGUtils
extends Object

This class provides functionality related to svg processing Created by Xyanid on 02.11.2015.

Method Summary

Modifier and Type	Method and Description
static <TShape extends javafx.scene.shape.Shape> void	applyStyle(TShape shape, CssStyle style, SVGDataProvider dataProvider) Applies the basic style every Shape supports to the given shape.
static <TData> boolean	applyStyleDeclaration(CssStyle style, Enumerations.CssStyleProperty declaration, Consumer<TData> consumer, Function<String,TData> converter) Tries to get the Enumerations.CssStyleProperty from the given CssStyle.
static <TData> boolean	applyStyleDeclaration(CssStyle style, Enumerations.CssStyleProperty declaration, Consumer<TData> consumer, Function<String,TData> converter, Function<String,Boolean> validator) Tries to get the Enumerations.CssStyleProperty from the given CssStyle.
static javafx.scene.transform.Transform	getTransform(Enumerations.Matrix matrix, String data, boolean checkIfStartWithMatrix) Gets the Transform that is represented by the given data.
static javafx.scene.transform.Transform	getTransform(String data) Returns the combined transformations available in the given string.
static javafx.scene.paint.Paint	parseColor(String data, SVGDataProvider provider) Resolves the given data into a paint.

Methods inherited from class java.lang.Object

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

Method Detail

parseColor

public static javafx.scene.paint.Paint parseColor(String data,
                                                  SVGDataProvider provider)

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

Parameters:

data - data to be resolved

provider - the SVGDataProvider to be used

Returns:

Paint which represents the color

Throws:

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

applyStyleDeclaration

public static <TData> boolean applyStyleDeclaration(CssStyle style,
                                                    Enumerations.CssStyleProperty declaration,
                                                    Consumer<TData> consumer,
                                                    Function<String,TData> converter)

Tries to get the Enumerations.CssStyleProperty from the given CssStyle. The declaration is first converted and then consumed.

Type Parameters:

TData - type of the data

Parameters:

style - style which will provide tha data

declaration - declaration to be used

consumer - consumer which will use that converted data

converter - converter which will parse the provided data into the desired type

Returns:

true if the declaration is present in the style and was used

applyStyleDeclaration

public static <TData> boolean applyStyleDeclaration(CssStyle style,
                                                    Enumerations.CssStyleProperty declaration,
                                                    Consumer<TData> consumer,
                                                    Function<String,TData> converter,
                                                    Function<String,Boolean> validator)

Tries to get the Enumerations.CssStyleProperty from the given CssStyle. The declaration is first converted and then if need be validated and then consumed.

Type Parameters:

TData - type of the data

Parameters:

style - style which will provide tha data

declaration - declaration to be used

consumer - consumer which will use that converted data

converter - converter which will parse the provided data into the desired type

validator - validator to use, may be null if not needed in which case no validation is performed

Returns:

true if the declaration is present in the style

applyStyle

public static <TShape extends javafx.scene.shape.Shape> void applyStyle(TShape shape,
                                                                        CssStyle 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 - CssStyle to use, must not be null

dataProvider - the SVGDataProvider to be used

Throws:

IllegalArgumentException - if either shape or style is 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 Svg 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(Enumerations.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 Enumerations.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 Enumerations.Matrix#NONE.

checkIfStartWithMatrix - determines if the given data is to be checked if it starts with the Enumerations.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 Enumerations.Matrix#NONE.

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