de.saxsys.svgfx.core.elements

Class SVGGradientBase<TPaint extends javafx.scene.paint.Paint>

java.lang.Object

de.saxsys.svgfx.xml.core.ElementBase<SVGAttributeType,SVGAttributeHolder,SVGDocumentDataProvider,TResult,SVGElementBase<?>>

de.saxsys.svgfx.core.elements.SVGElementBase<TPaint>

de.saxsys.svgfx.core.elements.SVGGradientBase<TPaint>

Type Parameters:

TPaint - the type of the paint need

Direct Known Subclasses:

SVGLinearGradient, SVGRadialGradient

public abstract class SVGGradientBase<TPaint extends javafx.scene.paint.Paint>
extends SVGElementBase<TPaint>

Contains basic functionality to handle gradients of svg.

Author:

Xyanid on 06.11.2015.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SVGGradientBase(String name, Attributes attributes, SVGDocumentDataProvider dataProvider) Creates a new instance of he element using the given attributes, parent and dataProvider.

Method Summary

Modifier and Type	Method and Description
protected void	convertToAbsoluteCoordinates(javafx.scene.shape.Rectangle boundingBox, List<Wrapper<javafx.geometry.Point2D>> points) Converts the given coordinates into absolute coordinates based on the given bounding box.
protected void	convertToRelativeCoordinates(javafx.scene.shape.Rectangle boundingBox, List<Wrapper<javafx.geometry.Point2D>> points) Converts the given coordinates into relative coordinates based on the given bounding box.
abstract TPaint	createResult(SVGAttributeTypeRectangle.SVGTypeRectangle elementBoundingBox, javafx.scene.transform.Transform elementTransform) This method can be used to create a result, that depends on the provided SVGElementBase.
protected TPaint	createResult(SVGCssStyle ownStyle, javafx.scene.transform.Transform ownTransform) Must be overwritten in the actual implementation to create a new result for this element based on the information available.
protected Optional<javafx.scene.transform.Transform>	getCombinedTransform(javafx.scene.transform.Transform elementTransform) Will be used to get the correct transformation for the gradient if any.
protected Optional<javafx.scene.transform.Transform>	getGradientTransform() Returns a Optional containing the CoreAttributeMapper.GRADIENT_TRANSFORM of this gradient if present or Optional.empty().
List<javafx.scene.paint.Stop>	getStops() Gets the stops related to this gradient.
protected void	initializeResult(TPaint paint, SVGCssStyle ownStyle, javafx.scene.transform.Transform ownTransform) This method will be called in the SVGElementBase.createAndInitializeResult(SVGCssStyle, Transform) and allows to modify the result such as applying a style or transformations.
boolean	keepElement() Determines if the element will be kept, meaning it will be kept in memory and is available as a parent for all its children.
void	processCharacterData(char[] ch, int start, int length) Will be called when character data (CDATA) is read for an element.
protected javafx.scene.shape.Rectangle	transformBoundingBox(SVGAttributeTypeRectangle.SVGTypeRectangle boundingBox, javafx.scene.transform.Transform transform) Creates an adjusted Rectangle that is the given SVGAttributeTypeRectangle.SVGTypeRectangle which has the given Transform applied.

Methods inherited from class de.saxsys.svgfx.core.elements.SVGElementBase

createAndInitializeResult, endProcessing, getResult, getTransformation, startProcessing

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

getAttributeHolder, getAttributes, getDocumentDataProvider, getName, getUnmodifiableChildren, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SVGGradientBase

protected SVGGradientBase(String name,
                          Attributes attributes,
                          SVGDocumentDataProvider dataProvider)
                   throws IllegalArgumentException

Creates a new instance of he element using the given attributes, parent and dataProvider.

Parameters:

name - value of the element

attributes - attributes of the element

dataProvider - dataprovider to be used

Throws:

IllegalArgumentException - if either value or dataProvider are null

Method Detail

keepElement

public final boolean keepElement()

Description copied from class: ElementBase

Determines if the element will be kept, meaning it will be kept in memory and is available as a parent for all its children.

Specified by:

keepElement in class ElementBase<SVGAttributeType,SVGAttributeHolder,SVGDocumentDataProvider,TPaint extends javafx.scene.paint.Paint,SVGElementBase<?>>

Returns:

true if the element will be kept, otherwise false.

processCharacterData

public final void processCharacterData(char[] ch,
                                       int start,
                                       int length)
                                throws SAXException

Description copied from class: ElementBase

Will be called when character data (CDATA) is read for an element.

Specified by:

processCharacterData in class ElementBase<SVGAttributeType,SVGAttributeHolder,SVGDocumentDataProvider,TPaint extends javafx.scene.paint.Paint,SVGElementBase<?>>

Parameters:

ch - The characters.

start - The start position in the character array.

length - The number of characters to use from the character array.

Throws:

SAXException - will be thrown when an error occurs during processing the characters

initializeResult

protected final void initializeResult(TPaint paint,
                                      SVGCssStyle ownStyle,
                                      javafx.scene.transform.Transform ownTransform)
                               throws SVGException

Description copied from class: SVGElementBase

This method will be called in the SVGElementBase.createAndInitializeResult(SVGCssStyle, Transform) and allows to modify the result such as applying a style or transformations. The given inheritanceResolver should be used to retrieve such data, this simply is needed because some elements can actually be referenced e.g. SVGUse and their actual parent is not the one from which the inherited style attributes can be retrieved.

Specified by:

initializeResult in class SVGElementBase<TPaint extends javafx.scene.paint.Paint>

Parameters:

paint - the result which should be modified.

ownStyle - the SVGCssStyle to use, which represents this elements style which is already resolved of inheritance and collision

ownTransform - the Transform of this element.

Throws:

SVGException - will be thrown when an error during modification

getStops

public final List<javafx.scene.paint.Stop> getStops()
                                             throws SVGException

Gets the stops related to this gradient.

Returns:

the stops which this gradient needs

Throws:

SVGException - if an error occurs during the retrieval of the stops.

convertToRelativeCoordinates

protected final void convertToRelativeCoordinates(javafx.scene.shape.Rectangle boundingBox,
                                                  List<Wrapper<javafx.geometry.Point2D>> points)
                                           throws SVGException

Converts the given coordinates into relative coordinates based on the given bounding box.

Parameters:

boundingBox - the bounding box to be use.

points - the points to transform.

Throws:

SVGException - if an error occurs during the transformation.

convertToAbsoluteCoordinates

protected final void convertToAbsoluteCoordinates(javafx.scene.shape.Rectangle boundingBox,
                                                  List<Wrapper<javafx.geometry.Point2D>> points)
                                           throws SVGException

Converts the given coordinates into absolute coordinates based on the given bounding box.

Parameters:

boundingBox - the bounding box to be use.

points - the points to transform.

Throws:

SVGException - if an error occurs during the transformation.

transformBoundingBox

protected final javafx.scene.shape.Rectangle transformBoundingBox(SVGAttributeTypeRectangle.SVGTypeRectangle boundingBox,
                                                                  javafx.scene.transform.Transform transform)
                                                           throws SVGException

Creates an adjusted Rectangle that is the given SVGAttributeTypeRectangle.SVGTypeRectangle which has the given Transform applied.

Parameters:

boundingBox - the SVGAttributeTypeRectangle.SVGTypeRectangle that represents the bounding box.

transform - the Transform the transform to apply.

Returns:

a new Rectangle representing the transformed bounding box.

Throws:

SVGException - if an error occurs during the creation.

getGradientTransform

protected Optional<javafx.scene.transform.Transform> getGradientTransform()
                                                                   throws SVGException

Returns a Optional containing the CoreAttributeMapper.GRADIENT_TRANSFORM of this gradient if present or Optional.empty().

Returns:

a new Optional containing the CoreAttributeMapper.GRADIENT_TRANSFORM of this gradient if present or Optional.empty().

Throws:

SVGException - if an error occurs during the retrieval of the transform cause by an incorrect matrix.

getCombinedTransform

protected Optional<javafx.scene.transform.Transform> getCombinedTransform(javafx.scene.transform.Transform elementTransform)
                                                                   throws SVGException

Will be used to get the correct transformation for the gradient if any.

Parameters:

elementTransform - the Transform supplied by the element that uses this gradient.

Returns:

a new Optional with the correct Transform or Optional.empty() if there is no transform.

Throws:

SVGException - if an error occurs during the retrieval of the transform cause by an incorrect matrix.

createResult

protected final TPaint createResult(SVGCssStyle ownStyle,
                                    javafx.scene.transform.Transform ownTransform)
                             throws SVGException

Description copied from class: SVGElementBase

Must be overwritten in the actual implementation to create a new result for this element based on the information available.

Specified by:

createResult in class SVGElementBase<TPaint extends javafx.scene.paint.Paint>

Parameters:

ownStyle - the SVGCssStyle to use, which represents this elements style which is already resolved of inheritance and collision.

ownTransform - the Transform of this element.

Returns:

a new instance of the result or null of no result was created

Throws:

SVGException - will be thrown when an error during creation occurs

createResult

public abstract TPaint createResult(SVGAttributeTypeRectangle.SVGTypeRectangle elementBoundingBox,
                                    javafx.scene.transform.Transform elementTransform)
                             throws SVGException

This method can be used to create a result, that depends on the provided SVGElementBase.

Parameters:

elementBoundingBox - the bounding box of the element .

elementTransform - the Transform to apply.

Returns:

a new TPaint.

Throws:

SVGException - if an error occurs during the creation of the result.