de.saxsys.svgfx.core.elements

Class SVGStop

java.lang.Object

de.saxsys.svgfx.xml.elements.ElementBase<SVGDataProvider,TResult,SVGElementBase<?>>

de.saxsys.svgfx.core.elements.SVGElementBase<javafx.scene.paint.Stop>

de.saxsys.svgfx.core.elements.SVGStop

public class SVGStop
extends SVGElementBase<javafx.scene.paint.Stop>

This class represents a stop element from svg

Author:

Xyanid on 25.10.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
SVGStop(String name, Attributes attributes, SVGElementBase<?> parent, SVGDataProvider dataProvider) Creates a new instance of he element using the given attributes and the parent.

Method Summary

Modifier and Type	Method and Description
protected javafx.scene.paint.Stop	createResult(SVGCssStyle style) Must be overwritten in the actual implementation to create a new result for this element based on the information available.
protected void	initializeResult(javafx.scene.paint.Stop stop, SVGCssStyle inheritanceResolver) 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, 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

SVGStop

public SVGStop(String name,
               Attributes attributes,
               SVGElementBase<?> parent,
               SVGDataProvider dataProvider)

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

Parameters:

name - value of the element

attributes - attributes of the element

parent - parent of the element

dataProvider - dataprovider to be used

Method Detail

createResult

protected final javafx.scene.paint.Stop createResult(SVGCssStyle style)
                                              throws SVGException

Must be overwritten in the actual implementation to create a new result for this element based on the information available.. This stop used both the SVGCssStyle.PresentationAttribute.STOP_COLOR and SVGCssStyle.PresentationAttribute.COLOR, however the SVGCssStyle.PresentationAttribute.STOP_COLOR is preferred if both are present. Furthermore if an SVGCssStyle.PresentationAttribute.STOP_OPACITY is present, then it will overwrite the opacity of the original color.

Specified by:

createResult in class SVGElementBase<javafx.scene.paint.Stop>

Parameters:

style - the element to use when data is needed.

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

initializeResult

protected final void initializeResult(javafx.scene.paint.Stop stop,
                                      SVGCssStyle inheritanceResolver)
                               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<javafx.scene.paint.Stop>

Parameters:

stop - the result which should be modified.

inheritanceResolver - the SVGCssStyle to use when data is needed.

Throws:

SVGException - will be thrown when an error during modification