de.saxsys.svgfx.core.elements

Class SVGElementBase<TResult>

java.lang.Object

de.saxsys.svgfx.xml.core.ElementBase<SVGAttributeType,SVGAttributeHolder,SVGDocumentDataProvider,TResult,SVGElementBase<?>,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<?>,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, 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
TResult	createAndInitializeResult(StyleSupplier styleSupplier) 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(StyleSupplier styleSupplier) Must be overwritten in the actual implementation to create a new result for this element based on the information available.
protected javafx.scene.Node	getClipPath(StyleSupplier styleSupplier) Returns a node which represents the clip path to be applied to this element.
TResult	getResult() Returns the result for the current element.
SVGCssStyle	getStyle() Gets the elements own style and resolves its inheritance, also removed any self references.
SVGCssStyle	getStyleAndResolveInheritance(SVGCssStyle otherStyle) Gets the elements own SVGCssStyle and combines it with the given SVGCssStyle
protected javafx.scene.transform.Transform	getTransformation()
protected abstract void	initializeResult(TResult result, StyleSupplier styleSupplier) This method will be called in the createAndInitializeResult(StyleSupplier) and allows to modify the result such as applying a style or transformations.
protected void	storeElementInDocumentDataProvider() Checks if the element is inside a SVGDefinitions and store it inside the ElementBase.documentDataProvider if so.

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

canConsumeResult, endProcessing, getAttributeHolder, getAttributes, getDocumentDataProvider, getName, getParent, getUnmodifiableChildren, processCharacterData, rememberElement, startProcessing, 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,
                         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

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

Returns:

result for the element

Throws:

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

createAndInitializeResult

public final TResult createAndInitializeResult(StyleSupplier styleSupplier)
                                        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:

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

Returns:

the result produced by this element.

Throws:

SVGException - thrown when an exception during creation occurs.

getStyle

public final SVGCssStyle getStyle()
                           throws SVGException

Gets the elements own style and resolves its inheritance, also removed any self references.

Returns:

this elements own style.

Throws:

SVGException

getStyleAndResolveInheritance

public final SVGCssStyle getStyleAndResolveInheritance(SVGCssStyle otherStyle)
                                                throws SVGException

Gets the elements own SVGCssStyle and combines it with the given SVGCssStyle

Parameters:

otherStyle - the other SVGCssStyle the own style shall be combined with, can be null in which case combineStylesAndResolveInheritance(SVGCssStyle, SVGCssStyle) is not invoked, hence it will only return its own style.

Returns:

the SVGCssStyle if this element combined and resolved with the given SVGCssStyle.

Throws:

SVGException - when an error occurs during the retrieval of the style.

getTransformation

protected final 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.

getClipPath

protected final javafx.scene.Node getClipPath(StyleSupplier styleSupplier)
                                       throws SVGException

Returns a node which represents the clip path to be applied to this element.

Parameters:

styleSupplier - the StyleSupplier to be used when there is a SVGClipPath defined for the element and it needs a style.

Returns:

the clip path to use or null if this element does not have a clip path.

Throws:

SVGException - when there is a SVGClipPath referenced but the reference can not be found in the ElementBase.documentDataProvider.

IllegalArgumentException - if the referenced SVGClipPath is an empty string.

storeElementInDocumentDataProvider

protected final void storeElementInDocumentDataProvider()
                                                 throws SVGException

Checks if the element is inside a SVGDefinitions and store it inside the ElementBase.documentDataProvider if so.

Throws:

SVGException - if an error occurs during the retrieval of the id.

createResult

protected abstract TResult 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.

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 abstract void initializeResult(TResult result,
                                         StyleSupplier styleSupplier)
                                  throws SVGException

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

Parameters:

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