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<?>,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, SVGElementBase<?> parent, SVGDocumentDataProvider documentDataProvider) Creates a new instance of he element using the given attributes and the parent.

Method Summary

Modifier and Type	Method and Description
boolean	canConsumeResult() Determines whether the result of this element will be requested or not.
void	endProcessing() Will be called when the end of the element was been reached and thus the processing is finished.
protected void	initializeResult(TNode node, StyleSupplier supplier) 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, createResult, 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

Constructor Detail

SVGNodeBase

protected SVGNodeBase(String name,
                      Attributes attributes,
                      SVGElementBase<?> parent,
                      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

parent - parent of the element

documentDataProvider - dataprovider to be used

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

Returns:

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

initializeResult

protected void initializeResult(TNode node,
                                StyleSupplier supplier)
                         throws SVGException

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.Will apply the transformation to the element.

Specified by:

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

Parameters:

node - the result which should be modified.

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

Throws:

SVGException - will be thrown when an error during modification