de.saxsys.svgfx.core.elements

Class SVGElementBase<TResult>

java.lang.Object

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

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

Type Parameters:

TResult - The type of the result this element will provide @author Xyanid on 28.10.2015.

Direct Known Subclasses:

SVGDefinitions, SVGGradientBase, SVGNodeBase, SVGRoot, SVGStop, SVGStyle

public abstract class SVGElementBase<TResult>
extends ElementBase<SVGAttributeType,SVGAttributeHolder,SVGDocumentDataProvider,TResult,SVGElementBase<?>>

This class represents a basic scg element, which provides some basic functionality to get the style of the class.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SVGElementBase(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
TResult	createAndInitializeResult(SVGCssStyle parentStyle, javafx.scene.transform.Transform parentTransform) Creates a result represented by this element and uses the given supplier in order to fetch data needed to initialize the result
protected abstract TResult	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.
void	endProcessing() Will be called when the end of the element was been reached and thus the processing is finished.
TResult	getResult() Returns the result for the current element.
protected Optional<javafx.scene.transform.Transform>	getTransformation()
protected abstract void	initializeResult(TResult result, SVGCssStyle ownStyle, javafx.scene.transform.Transform ownTransform) This method will be called in the createAndInitializeResult(SVGCssStyle, Transform) and allows to modify the result such as applying a style or transformations.
void	startProcessing() Will be called when an element is started that represents this element.

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

getAttributeHolder, getAttributes, getDocumentDataProvider, getName, getUnmodifiableChildren, keepElement, processCharacterData, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SVGElementBase

protected SVGElementBase(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

getResult

public final TResult getResult()
                        throws SAXException

Returns the result for the current element.

Specified by:

getResult in class ElementBase<SVGAttributeType,SVGAttributeHolder,SVGDocumentDataProvider,TResult,SVGElementBase<?>>

Returns:

result for the element

Throws:

SAXException - will be thrown when an error occurs retrieving the result

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,TResult,SVGElementBase<?>>

Throws:

SAXException - will be thrown when an error occurs during processing

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,TResult,SVGElementBase<?>>

Throws:

SAXException - will be thrown when an error occurs during processing

createAndInitializeResult

public final TResult createAndInitializeResult(SVGCssStyle parentStyle,
                                               javafx.scene.transform.Transform parentTransform)
                                        throws SVGException

Creates a result represented by this element and uses the given supplier in order to fetch data needed to initialize the result

Parameters:

parentStyle - the SVGCssStyle to use, which is the parent style of this element. May be null if this element does not have a parent.

parentTransform - the transform of the parent of this element.

Returns:

the result produced by this element.

Throws:

SVGException - thrown when an exception during creation occurs.

getTransformation

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

Returns:

the transformation to be applied to this element if the CoreAttributeMapper.TRANSFORM is present. otherwise null.

Throws:

SVGException - if there is a transformation which has invalid data for its matrix.

createResult

protected abstract TResult createResult(SVGCssStyle ownStyle,
                                        javafx.scene.transform.Transform ownTransform)
                                 throws SVGException

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

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

initializeResult

protected abstract void initializeResult(TResult result,
                                         SVGCssStyle ownStyle,
                                         javafx.scene.transform.Transform ownTransform)
                                  throws SVGException

This method will be called in the 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.

Parameters:

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