de.saxsys.svgfx.core.elements

Class SVGUse

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<javafx.scene.Group>

de.saxsys.svgfx.core.elements.SVGUse

public class SVGUse
extends SVGNodeBase<javafx.scene.Group>

This class represents a use element from svg

Author:

Xyanid on 25.10.2015.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT_NAME Contains the name of this element in an svg file, used to identify the element when parsing.

Method Summary

Modifier and Type	Method and Description
protected javafx.scene.Group	createResult(StyleSupplier styleSupplier) Must be overwritten in the actual implementation to create a new result for this element based on the information available.
protected void	initializeResult(javafx.scene.Group node, StyleSupplier styleSupplier) This method will be called in the SVGElementBase.createAndInitializeResult(StyleSupplier) and allows to modify the result such as applying a style or transformations.

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

canConsumeResult, endProcessing, processCharacterData, rememberElement, startProcessing

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

createAndInitializeResult, 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

Field Detail

ELEMENT_NAME

public static final String ELEMENT_NAME

Contains the name of this element in an svg file, used to identify the element when parsing.

See Also:

Constant Field Values

Method Detail

createResult

protected javafx.scene.Group 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. Resolves the needed reference.

Specified by:

createResult in class SVGElementBase<javafx.scene.Group>

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 - if the XLinkAttributeMapper.XLINK_HREF is empty or null.

initializeResult

protected void initializeResult(javafx.scene.Group node,
                                StyleSupplier styleSupplier)
                         throws SVGException

Description copied from class: SVGNodeBase

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.

Overrides:

initializeResult in class SVGNodeBase<javafx.scene.Group>

Parameters:

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