de.saxsys.svgfx.core.elements

Class SVGNodeBase<TNode extends javafx.scene.Node>

java.lang.Object

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

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

de.saxsys.svgfx.core.elements.SVGNodeBase<TNode>

Type Parameters:

TNode - type of the shape represented by this element

Direct Known Subclasses:

SVGClipPath, SVGGroup, SVGShapeBase, SVGUse

public abstract class SVGNodeBase<TNode extends javafx.scene.Node>
extends SVGElementBase<TNode>

This class represents a base class which contains shape element from svg.

Author:

Xyanid on 25.10.2015.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SVGNodeBase(String name, Attributes attributes, SVGDocumentDataProvider documentDataProvider) Creates a new instance of he element using the given attributes and the parent.

Method Summary

Modifier and Type	Method and Description
protected void	initializeResult(TNode result, SVGCssStyle ownStyle, javafx.scene.transform.Transform ownTransform) This method will be called in the SVGElementBase.createAndInitializeResult(SVGCssStyle, Transform) and allows to modify the result such as applying a style or transformations.
boolean	keepElement() 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	processCharacterData(char[] ch, int start, int length) Will be called when character data (CDATA) is read for an element.

Methods inherited from class de.saxsys.svgfx.core.elements.SVGElementBase

createAndInitializeResult, createResult, endProcessing, getResult, getTransformation, startProcessing

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

getAttributeHolder, getAttributes, getDocumentDataProvider, getName, getUnmodifiableChildren, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SVGNodeBase

protected SVGNodeBase(String name,
                      Attributes attributes,
                      SVGDocumentDataProvider documentDataProvider)

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

Parameters:

name - the name of the element

attributes - attributes of the element

documentDataProvider - dataprovider to be used

Method Detail

keepElement

public boolean keepElement()

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:

keepElement in class ElementBase<SVGAttributeType,SVGAttributeHolder,SVGDocumentDataProvider,TNode extends javafx.scene.Node,SVGElementBase<?>>

Returns:

true if the element will be kept, otherwise false.

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,TNode extends javafx.scene.Node,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

initializeResult

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

This method will be called in the SVGElementBase.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.Will apply the transformation to the element and add clipPath if available.

Specified by:

initializeResult in class SVGElementBase<TNode extends javafx.scene.Node>

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