de.saxsys.svgfx.core.elements

Class SVGStop

java.lang.Object

de.saxsys.svgfx.xml.core.ElementBase<SVGAttributeType,SVGAttributeHolder,SVGDocumentDataProvider,TResult,SVGElementBase<?>,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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT_NAME Contains the name of this element in an svg file, used to identify the element when parsing.

Method Summary

Modifier and Type	Method and Description
boolean	canConsumeResult() Determines whether the result of this element will be requested or not.
protected javafx.scene.paint.Stop	createResult(StyleSupplier styleSupplier) Must be overwritten in the actual implementation to create a new result for this element based on the information available.
void	endProcessing() Will be called when the end of the element was been reached and thus the processing is finished.
protected void	initializeResult(javafx.scene.paint.Stop stop, 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, 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

Field Detail

ELEMENT_NAME

public static final String ELEMENT_NAME

Contains the name of this element in an svg file, used to identify the element when parsing.

See Also:

Constant Field Values

Method Detail

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,javafx.scene.paint.Stop,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,javafx.scene.paint.Stop,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,javafx.scene.paint.Stop,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,javafx.scene.paint.Stop,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,javafx.scene.paint.Stop,SVGElementBase<?>,SVGElementBase<?>>

Returns:

true if the element not not inside a SVGClipPath or SVGGroup, otherwise false.

createResult

protected final javafx.scene.paint.Stop createResult(StyleSupplier styleSupplier)
                                              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 PresentationAttributeMapper.STOP_COLOR and PresentationAttributeMapper.COLOR, however the PresentationAttributeMapper.STOP_COLOR is preferred if both are present. Furthermore if an PresentationAttributeMapper.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:

styleSupplier - the StyleSupplier to use when a SVGCssStyle 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,
                                      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<javafx.scene.paint.Stop>

Parameters:

stop - 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