de.saxsys.svgfx.core

Class SVGElementBase<TResult>

java.lang.Object

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

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

Type Parameters:

TResult - The type of the result this element will provide Created by Xyanid on 28.10.2015.

Direct Known Subclasses:

Defs, Stop, Style, Svg, SVGGradientBase, SVGNodeBase, Use

public abstract class SVGElementBase<TResult>
extends ElementBase<SVGDataProvider,TResult,SVGElementBase<SVGDataProvider>>

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

Constructor Summary

Constructors

Constructor and Description
SVGElementBase(String name, Attributes attributes, SVGElementBase<SVGDataProvider> 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
TResult	createResult()
protected abstract TResult	createResultInternal() 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.
CssStyle	getCssStyle() Returns the CssStyle of this element, which is either a reference to an existing style or the element itself has a style.
TResult	getResult() Returns the result for the current element.
javafx.scene.transform.Transform	getTransformation()
protected abstract void	initializeResult(TResult result) This method will be called in the createResult() 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.
void	startProcessing() Will be called when an element is started that represents this element.

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

getAttribute, getAttributes, getChildren, getDataProvider, getName, getParent

Methods inherited from class java.lang.Object

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

Constructor Detail

SVGElementBase

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

getCssStyle

public final CssStyle getCssStyle()

Returns the CssStyle of this element, which is either a reference to an existing style or the element itself has a style. If the element itself does not provide a style then the style of the ElementBase.parent will be used if it exist. This is a cascading call meaning that at worst case the last ElementBase.parent that has a style will be called

Returns:

the CssStyle of this element or first style in the ElementBase.parent tree

getTransformation

public final javafx.scene.transform.Transform getTransformation()
                                                         throws SVGException

Returns:

the transformation to be applied to this element if the Enumerations.SvgAttribute#TRANSFORM is present. otherwise null.

Throws:

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

createResultInternal

protected abstract TResult createResultInternal()
                                         throws SVGException

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

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)
                                  throws SVGException

This method will be called in the createResult() and allows to modify the result such as applying a style or transformations.

Parameters:

result - the result which should be modified.

Throws:

SVGException - will be thrown when an error during modification

createResult

public final TResult createResult()
                           throws SVGException

Throws:

SVGException

getResult

public final TResult getResult()
                        throws SVGException

Returns the result for the current element.

Specified by:

getResult in class ElementBase<SVGDataProvider,TResult,SVGElementBase<SVGDataProvider>>

Returns:

result for the element

Throws:

SVGException

startProcessing

public void startProcessing()
                     throws SVGException

Will be called when an element is started that represents this element.

Specified by:

startProcessing in class ElementBase<SVGDataProvider,TResult,SVGElementBase<SVGDataProvider>>

Throws:

SVGException

processCharacterData

public void processCharacterData(char[] ch,
                                 int start,
                                 int length)
                          throws SVGException

Will be called when character data (CDATA) is read for an element.

Specified by:

processCharacterData in class ElementBase<SVGDataProvider,TResult,SVGElementBase<SVGDataProvider>>

Parameters:

ch - The characters.

start - The start position in the character array.

length - The number of characters to use from the character array.

Throws:

SVGException

endProcessing

public void endProcessing()
                   throws SVGException

Will be called when the end of the element was been reached and thus the processing is finished.

Specified by:

endProcessing in class ElementBase<SVGDataProvider,TResult,SVGElementBase<SVGDataProvider>>

Throws:

SVGException