org.girod.javafx.svgimage

Class LoaderContext

java.lang.Object

org.girod.javafx.svgimage.LoaderContext

public class LoaderContext
extends Object

The context of a SVGLoader.

Version:

1.7.1

Field Summary

Fields

Modifier and Type	Field and Description
ClippingFactory	clippingFactory The clipping factory.
boolean	effectsSupported True if the effects are supported.
Map<String,FilterSpec>	filterSpecs The filters specifications.
Map<String,javafx.scene.paint.Paint>	gradients The gradients.
Map<String,GradientSpec>	gradientSpecs The gradients specifications.
Map<String,MarkerSpec>	markers The markers specifications.
LoaderParameters	params The loader parameters.
SVGImage	root The resulting group.
Styles	svgStyle The overall "styles" elements if it exists.
URL	url The SVG file url.
Stack<Viewport>	viewports The viewport.

Constructor Summary

Constructors

Constructor and Description
LoaderContext(SVGImage root, LoaderParameters params, URL url) Create a loader context.

Method Summary

Modifier and Type	Method and Description
void	addAnimations(List<javafx.animation.Animation> theAnimations) Add a list of animations.
void	addMarker(String id, MarkerSpec xmlNode) Add a marker node.
void	addNamedNode(String id, XMLNode xmlNode) Add a named node.
void	addSymbol(String id, SymbolSpec symbol) Add a symbol.
void	addTransition(javafx.animation.Animation animation) Add an animation.
List<javafx.animation.Animation>	getAnimations() Return the animations.
Viewport	getCurrentViewport() Rerurn the current viewport.
double	getDPI() Return the screen dpi.
MarkerSpec	getMarker(String id) Return the marker of a specified id.
XMLNode	getNamedNode(String id) Return the node of a specified id.
URL	getParentURL() Return the SVG file parent URL.
XMLNode	getReifiedNamedNode(String id) Return the node of a specified id.
SymbolSpec	getSymbol(String id) Return the symbol of a specified id.
URL	getURL() Return the SVG file URL.
boolean	hasAnimations() Return true if there are animations.
boolean	hasMarker(String id) Return true if there is a marker with a specified id.
boolean	hasMarkers() Return true if there is at least one marker.
boolean	hasNamedNode(String id) Return true if there is a node with a specified id.
boolean	hasReifiedNamedNode(String id) Return true if there is a node with a specified id.
boolean	hasSymbol(String id) Return true if there is a symbol with a specified id.
boolean	hasViewports() Return true if there are viewports.
void	playAnimations() Play the transitions.
Viewport	popViewport() Pop the viewport stack.
void	pushViewport(Viewport viewport) Push a viewport on the viewports stack.

Methods inherited from class java.lang.Object

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

Field Detail

root

public final SVGImage root

The resulting group.

params

public final LoaderParameters params

The loader parameters.

viewports

public Stack<Viewport> viewports

The viewport.

svgStyle

public Styles svgStyle

The overall "styles" elements if it exists.

url

public final URL url

The SVG file url.

clippingFactory

public final ClippingFactory clippingFactory

The clipping factory.

gradientSpecs

public final Map<String,GradientSpec> gradientSpecs

The gradients specifications.

filterSpecs

public final Map<String,FilterSpec> filterSpecs

The filters specifications.

gradients

public final Map<String,javafx.scene.paint.Paint> gradients

The gradients.

markers

public final Map<String,MarkerSpec> markers

The markers specifications.

effectsSupported

public boolean effectsSupported

True if the effects are supported.

Constructor Detail

LoaderContext

public LoaderContext(SVGImage root,
                     LoaderParameters params,
                     URL url)

Create a loader context.

Parameters:

root - the root image

params - the loader parameters

url - the SVG URL

Method Detail

getURL

public URL getURL()

Return the SVG file URL.

Returns:

the SVG file URL

getParentURL

public URL getParentURL()

Return the SVG file parent URL.

Returns:

the SVG file parent URL

hasViewports

public boolean hasViewports()

Return true if there are viewports.

Returns:

true if there are viewports

pushViewport

public void pushViewport(Viewport viewport)

Push a viewport on the viewports stack.

Parameters:

viewport - the viewport

getCurrentViewport

public Viewport getCurrentViewport()

Rerurn the current viewport.

Returns:

the current viewport

popViewport

public Viewport popViewport()

Pop the viewport stack.

Returns:

the new current viewport

getDPI

public double getDPI()

Return the screen dpi.

Returns:

the dpi

addNamedNode

public void addNamedNode(String id,
                         XMLNode xmlNode)

Add a named node.

Parameters:

id - the node id

xmlNode - the node

addMarker

public void addMarker(String id,
                      MarkerSpec xmlNode)

Add a marker node.

Parameters:

id - the node id

xmlNode - the node

hasMarkers

public boolean hasMarkers()

Return true if there is at least one marker.

Returns:

true if there is at least one marker

hasMarker

public boolean hasMarker(String id)

Return true if there is a marker with a specified id.

Parameters:

id - the marker id

Returns:

true if there is a marker with the specified id

getMarker

public MarkerSpec getMarker(String id)

Return the marker of a specified id.

Parameters:

id - the marker id

Returns:

the node

hasReifiedNamedNode

public boolean hasReifiedNamedNode(String id)

Return true if there is a node with a specified id.

Parameters:

id - the node id

Returns:

true if there is a node with the specified id

hasNamedNode

public boolean hasNamedNode(String id)

Return true if there is a node with a specified id.

Parameters:

id - the node id

Returns:

true if there is a node with the specified id

getReifiedNamedNode

public XMLNode getReifiedNamedNode(String id)

Return the node of a specified id.

Parameters:

id - the node id

Returns:

the node

getNamedNode

public XMLNode getNamedNode(String id)

Return the node of a specified id.

Parameters:

id - the node id

Returns:

the node

addSymbol

public void addSymbol(String id,
                      SymbolSpec symbol)

Add a symbol.

Parameters:

id - the symbols id

symbol - the symbol

hasSymbol

public boolean hasSymbol(String id)

Return true if there is a symbol with a specified id.

Parameters:

id - the symbols id

Returns:

true if there is a symbol with the specified id

getSymbol

public SymbolSpec getSymbol(String id)

Return the symbol of a specified id.

Parameters:

id - the symbols id

Returns:

the symbols

hasAnimations

public boolean hasAnimations()

Return true if there are animations.

Returns:

true if there are animations

getAnimations

public List<javafx.animation.Animation> getAnimations()

Return the animations.

Returns:

the animations

addTransition

public void addTransition(javafx.animation.Animation animation)

Add an animation.

Parameters:

animation - the animation.

addAnimations

public void addAnimations(List<javafx.animation.Animation> theAnimations)

Add a list of animations.

Parameters:

theAnimations - the animations.

playAnimations

public void playAnimations()

Play the transitions.