de.saxsys.svgfx.core.attributes.type

Class SVGAttributeType<TValue,TUnit>

java.lang.Object

de.saxsys.svgfx.xml.core.AttributeWrapper

de.saxsys.svgfx.core.attributes.type.SVGAttributeType<TValue,TUnit>

Type Parameters:

TValue - type of the value.

TUnit - the type of the unit if any.

Direct Known Subclasses:

SVGAttributeTypeCycleMethod, SVGAttributeTypeDouble, SVGAttributeTypeFillRule, SVGAttributeTypeGradientUnits, SVGAttributeTypeLength, SVGAttributeTypePaint, SVGAttributeTypePoint, SVGAttributeTypePoints, SVGAttributeTypeRectangle, SVGAttributeTypeString, SVGAttributeTypeStrokeDashArray, SVGAttributeTypeStrokeLineCap, SVGAttributeTypeStrokeLineJoin, SVGAttributeTypeStrokeType, SVGAttributeTypeStyle, SVGAttributeTypeTransform

public abstract class SVGAttributeType<TValue,TUnit>
extends AttributeWrapper

This class is the base class for svg content used either in css oder by attributes of an SVGElementBase.

Author:

Xyanid on 29.10.2015.

Constructor Summary

Constructors

Constructor and Description
SVGAttributeType(TValue defaultValue, SVGDocumentDataProvider dataProvider) Creates new instance.

Method Summary

Modifier and Type	Method and Description
SVGDocumentDataProvider	getDocumentDataProvider()
boolean	getIsInherited()
boolean	getIsNone()
TUnit	getUnit() Returns the valueAndUnits value.
TValue	getValue() Returns the valueAndUnits key.
javafx.util.Pair<TValue,TUnit>	getValueAndUnit() Returns the valueAndUnit.
protected abstract javafx.util.Pair<TValue,TUnit>	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 INHERIT_INDICATOR or NONE_INDICATOR.
boolean	hasUnit(TUnit unit) Determines if this length value has the provided unit.
void	setText(String text)
void	useDefaultValue() Set the default value

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

Constructor Detail

SVGAttributeType

public SVGAttributeType(TValue defaultValue,
                        SVGDocumentDataProvider dataProvider)

Creates new instance.

Parameters:

defaultValue - the default value of this to use.

dataProvider - the SVGDocumentDataProvider to use when data is needed.

Method Detail

getDocumentDataProvider

public final SVGDocumentDataProvider getDocumentDataProvider()

Returns:

The dataProvider.

getIsInherited

public final boolean getIsInherited()

Returns:

The isInherited.

getIsNone

public final boolean getIsNone()

Returns:

The isNone.

getValue

public final TValue getValue()
                      throws SVGException

Returns the valueAndUnits key.

Returns:

valueAndUnits key.

Throws:

SVGException - when an error occurs during the initialization of the value and unit.

getUnit

public final TUnit getUnit()
                    throws SVGException

Returns the valueAndUnits value.

Returns:

The valueAndUnits value.

Throws:

SVGException - when an error occurs during the initialization of the value and unit.

hasUnit

public boolean hasUnit(TUnit unit)
                throws SVGException

Determines if this length value has the provided unit.

Parameters:

unit - the SVGAttributeTypeLength.Unit that is expected.

Returns:

true if the unit of this attribute is equals to th expected one, otherwise false.

Throws:

SVGException - if a problem occurs during the retrieval of the unit and value of this attribute.

getValueAndUnit

public final javafx.util.Pair<TValue,TUnit> getValueAndUnit()
                                                     throws SVGException

Returns the valueAndUnit.

Returns:

the valueAndUnit.

Throws:

SVGException

useDefaultValue

public final void useDefaultValue()

Set the default value

setText

public final void setText(String text)

Overrides:

setText in class AttributeWrapper

getValueAndUnit

protected abstract javafx.util.Pair<TValue,TUnit> getValueAndUnit(String text)
                                                           throws SVGException

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

Parameters:

text - cssText which is not equal to INHERIT_INDICATOR or 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.