de.saxsys.svgfx.core.attributes.type

Class SVGAttributeTypePaint

java.lang.Object

de.saxsys.svgfx.xml.core.AttributeWrapper

de.saxsys.svgfx.core.attributes.type.SVGAttributeType<javafx.scene.paint.Paint,Void>

de.saxsys.svgfx.core.attributes.type.SVGAttributeTypePaint

public class SVGAttributeTypePaint
extends SVGAttributeType<javafx.scene.paint.Paint,Void>

Represents a Paint used to color fill and strokes, the default value is Color.TRANSPARENT.

Author:

Xyanid on 29.10.2015.

Field Summary

Fields

Modifier and Type	Field and Description
static javafx.scene.paint.Paint	DEFAULT_VALUE Determines the default color to use for a SVGAttributeTypePaint.

Constructor Summary

Constructors

Constructor and Description
SVGAttributeTypePaint(SVGDocumentDataProvider dataProvider) Creates new instance with a default value of Color.BLACK.

Method Summary

Modifier and Type	Method and Description
boolean	getIsCurrentColor()
javafx.scene.paint.Paint	getValue(SVGShapeBase<?> shape) Resolves the given data into a paint.
javafx.util.Pair<javafx.scene.paint.Paint,Void>	getValueAndUnit(String text) This will be called if actual data is present in the css text, this is the case if the cssText is not SVGAttributeType.INHERIT_INDICATOR or SVGAttributeType.NONE_INDICATOR.

Methods inherited from class de.saxsys.svgfx.core.attributes.type.SVGAttributeType

getDocumentDataProvider, getIsInherited, getIsNone, getUnit, getValue, getValueAndUnit, hasUnit, setText, useDefaultValue

Methods inherited from class de.saxsys.svgfx.xml.core.AttributeWrapper

equals, getText, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_VALUE

public static final javafx.scene.paint.Paint DEFAULT_VALUE

Determines the default color to use for a SVGAttributeTypePaint.

Constructor Detail

SVGAttributeTypePaint

public SVGAttributeTypePaint(SVGDocumentDataProvider dataProvider)

Creates new instance with a default value of Color.BLACK.

Parameters:

dataProvider - the SVGDocumentDataProvider to use when data is needed.

Method Detail

getIsCurrentColor

public boolean getIsCurrentColor()
                          throws SVGException

Returns:

The isCurrentColor.

Throws:

SVGException - when an error occurs during the retrieval of the value.

getValueAndUnit

public javafx.util.Pair<javafx.scene.paint.Paint,Void> getValueAndUnit(String text)
                                                                throws SVGException

Description copied from class: SVGAttributeType

This will be called if actual data is present in the css text, this is the case if the cssText is not SVGAttributeType.INHERIT_INDICATOR or SVGAttributeType.NONE_INDICATOR.

Specified by:

getValueAndUnit in class SVGAttributeType<javafx.scene.paint.Paint,Void>

Parameters:

text - cssText which is not equal to SVGAttributeType.INHERIT_INDICATOR or SVGAttributeType.NONE_INDICATOR.

Returns:

a Pair which contains the value as the key and the value as the value.

Throws:

SVGException - when any error occurs during the consumption of the given text.

getValue

public javafx.scene.paint.Paint getValue(SVGShapeBase<?> shape)
                                  throws SVGException

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 into a SVGGradientBase.

Parameters:

shape - the element for which this paint is

Returns:

Paint which represents the color

Throws:

SVGException -

• if the paint is actually a reference to a SVGGradientBase that was not found.