de.saxsys.svgfx.core.elements

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

java.lang.Object

de.saxsys.svgfx.xml.elements.ElementBase<SVGDataProvider,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.

Nested Class Summary

Nested classes/interfaces inherited from class de.saxsys.svgfx.core.elements.SVGElementBase

SVGElementBase.CoreAttribute, SVGElementBase.Matrix, SVGElementBase.XLinkAttribute

Constructor Summary

Constructors

Constructor and Description
SVGGradientBase(String name, Attributes attributes, SVGElementBase<?> parent, SVGDataProvider dataProvider) Creates a new instance of he element using the given attributes, parent and dataProvider.

Method Summary

Modifier and Type	Method and Description
List<javafx.scene.paint.Stop>	getStops() Gets the stops related to this gradient.
protected void	initializeResult(TPaint paint, SVGCssStyle style) This method will be called in the SVGElementBase.createAndInitializeResult(SVGCssStyle) and allows to modify the result such as applying a style or transformations.

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

createAndInitializeResult, createAndInitializeResult, createResult, endProcessing, getClipPath, getClipPath, getCssStyle, getCssStyleAndResolveInheritance, getCssStyleAndResolveInheritance, getOwnStyle, getPresentationCssStyle, getReferencedStyle, getResult, getResult, getTransformation, processCharacterData, startProcessing

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

getAttribute, getAttributes, getChildren, getDataProvider, getName, getParent, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SVGGradientBase

public SVGGradientBase(String name,
                       Attributes attributes,
                       SVGElementBase<?> parent,
                       SVGDataProvider 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()

Gets the stops related to this gradient.

Returns:

the stops which this gradient needs

initializeResult

protected final void initializeResult(TPaint paint,
                                      SVGCssStyle style)
                               throws SVGException

Description copied from class: SVGElementBase

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

style - the SVGCssStyle to use when data is needed.

Throws:

SVGException - will be thrown when an error during modification