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<?>,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, SVGElementBase<?> parent, SVGDocumentDataProvider dataProvider) Creates a new instance of he element using the given attributes, parent and dataProvider.

Method Summary

Modifier and Type	Method and Description
boolean	canConsumeResult() Determines whether the result of this element will be requested or not.
abstract TPaint	createResult(SVGShapeBase<?> shape) This method can be used to create a result, that depends on the provided SVGElementBase.
void	endProcessing() Will be called when the end of the element was been reached and thus the processing is finished.
List<javafx.scene.paint.Stop>	getStops() Gets the stops related to this gradient.
protected void	initializeResult(TPaint paint, StyleSupplier styleSupplier) This method will be called in the SVGElementBase.createAndInitializeResult(StyleSupplier) and allows to modify the result such as applying a style or transformations.
void	processCharacterData(char[] ch, int start, int length) Will be called when character data (CDATA) is read for an element.
boolean	rememberElement() 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	startProcessing() Will be called when an element is started that represents this element.

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

createAndInitializeResult, createResult, getClipPath, getResult, getStyle, getStyleAndResolveInheritance, getTransformation, storeElementInDocumentDataProvider

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

getAttributeHolder, getAttributes, getDocumentDataProvider, getName, getParent, 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,
                          SVGElementBase<?> parent,
                          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

parent - parent of the element

dataProvider - dataprovider to be used

Throws:

IllegalArgumentException - if either value or dataProvider are null

Method Detail

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.

rememberElement

public boolean rememberElement()

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:

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

Returns:

true if the element will be kept, otherwise false.

startProcessing

public void startProcessing()
                     throws SAXException

Description copied from class: ElementBase

Will be called when an element is started that represents this element.

Specified by:

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

Throws:

SAXException - will be thrown when an error occurs during processing

processCharacterData

public 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<?>,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

endProcessing

public void endProcessing()
                   throws SAXException

Description copied from class: ElementBase

Will be called when the end of the element was been reached and thus the processing is finished.

Specified by:

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

Throws:

SAXException - will be thrown when an error occurs during processing

canConsumeResult

public boolean canConsumeResult()

Determines whether the result of this element will be requested or not. A call to this method should be made prior to the ElementBase.getResult().

Specified by:

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

Returns:

false always.

initializeResult

protected final void initializeResult(TPaint paint,
                                      StyleSupplier styleSupplier)
                               throws SVGException

Description copied from class: SVGElementBase

This method will be called in the SVGElementBase.createAndInitializeResult(StyleSupplier) 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.

styleSupplier - the StyleSupplier to use when a SVGCssStyle is needed.

Throws:

SVGException - will be thrown when an error during modification

createResult

public abstract TPaint createResult(SVGShapeBase<?> shape)
                             throws SVGException

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

Parameters:

shape - the SVGShapeBase requesting this gradient.

Returns:

a new TPaint.

Throws:

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