org.girod.javafx.svgimage

Class SVGImage

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.Group

org.girod.javafx.svgimage.SVGImage

All Implemented Interfaces:

Cloneable, javafx.css.Styleable, javafx.event.EventTarget

public class SVGImage
extends javafx.scene.Group
implements Cloneable

The resulting SVG image. It is a JavaFX Nodes tree.

Version:

1.7

Field Summary

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor and Description
SVGImage() Constructor.
SVGImage(SVGContent content) Constructor.

Method Summary

Modifier and Type	Method and Description
SVGImage	clone() Clone the SVGImage.
SVGImageRegion	createRegion() Create a region containing this image.
double	getContentHeight() Return the height of the image content.
double	getContentWidth() Return the width of the image content.
static SVGSnapshotParameters	getDefaultSnapshotParameters() Return the default SnapshotParameters used when creating a snapshot.
File	getFile() Return the image associated file (can be null).
double	getHeight() Return the height of the image.
javafx.scene.Node	getNode(String id) Return the Node indicated by id.
double	getScaledHeight() Return the height of the image, taking into account the scaling of the svg image.
double	getScaledWidth() Return the width of the image, taking into account the scaling of the svg image.
SVGContent	getSVGContent() Return the SVG content origin.
List<URL>	getSVGStylesheets() Return the stylesheets of the SVG content.
Viewport	getViewport() Return the viewport of the SVG content.
double	getViewportHeight() Return the height of the image viewort.
double	getViewportWidth() Return the width of the image viewort.
double	getWidth() Return the width of the image.
boolean	hasNode(String id) Return true if there is a Node indicated by an id.
boolean	isPlayingAnimations() Return true if the animations are playing.
void	playAnimations() Play the animations.
SVGImage	scale(double scale) Scale the image.
SVGImage	scale(double scale, boolean createNew) Scale the image.
SVGImage	scaleTo(double width) Scale the image to a specified width.
SVGImage	scaleTo(double width, boolean createNew) Scale the image to a specified width.
static void	setDefaultSnapshotParameters(javafx.scene.SnapshotParameters params) Set the default SnapshotParameters to use when creating snapshots.
static void	setDefaultSnapshotParameters(SVGSnapshotParameters params) Set the default SnapshotParameters to use when creating snapshots.
void	setFile(File file) Set the image associated file (can be null).
void	setSVGStylesheets(List<URL> stylesheets) Set the stylesheets of the SVG content.
void	setViewport(Viewport viewport) Set the viewport of the SVG content.
boolean	snapshot(javafx.scene.SnapshotParameters params, String format, File file) Saves a snapshot of the image.
boolean	snapshot(String format, File file) Saves a snapshot of the image.
void	stopAnimations() Stop the animations.
javafx.scene.image.Image	toImage() Convert the Node tree to an image, without applying a scale.
javafx.scene.image.Image	toImage(double width) Convert the Node tree to an image, specifying the resulting width and preserving the image ratio.
javafx.scene.image.Image	toImage(short quality, double width) Convert the Node tree to an image, specifying the resulting width and preserving the image ratio.
javafx.scene.image.Image	toImage(javafx.scene.SnapshotParameters params) Convert the Node tree to an image.
javafx.scene.image.Image	toImage(SVGSnapshotParameters params) Convert the Node tree to an image.
javafx.scene.image.Image	toImageScaled(double scale) Convert the Node tree to an image.
javafx.scene.image.Image	toImageScaled(double scaleX, double scaleY) Convert the Node tree to a scaled image.
javafx.scene.image.Image	toImageScaled(short quality, double scaleX, double scaleY) Convert the Node tree to a scaled image.

Methods inherited from class javafx.scene.Group

autoSizeChildrenProperty, getChildren, impl_computeLayoutBounds, isAutoSizeChildren, layoutChildren, minHeight, minWidth, prefHeight, prefWidth, setAutoSizeChildren

Methods inherited from class javafx.scene.Parent

computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, getBaselineOffset, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_computeContains, impl_computeGeomBounds, impl_createPeer, impl_getAllParentStylesheets, impl_pickNodeLocal, impl_processCSS, impl_processMXNode, impl_traversalEngineProperty, impl_updatePeer, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestLayout, requestParentLayout, setImpl_traversalEngine, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClassCssMetaData, getClip, getContentBias, getCssMetaData, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_cssGetFocusTraversableInitialValue, impl_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_notifyLayoutBoundsChanged, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isResizable, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, maxHeight, maxWidth, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resize, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, toString, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

SVGImage

public SVGImage()

Constructor.

SVGImage

public SVGImage(SVGContent content)

Constructor.

Parameters:

content - the SVG content

Method Detail

setFile

public void setFile(File file)

Set the image associated file (can be null).

Parameters:

file - the file

getFile

public File getFile()

Return the image associated file (can be null).

Returns:

the file

setSVGStylesheets

public void setSVGStylesheets(List<URL> stylesheets)

Set the stylesheets of the SVG content.

Parameters:

stylesheets - the stylesheets

getSVGStylesheets

public List<URL> getSVGStylesheets()

Return the stylesheets of the SVG content.

Returns:

the stylesheets

setViewport

public void setViewport(Viewport viewport)

Set the viewport of the SVG content.

Parameters:

viewport - the viewport

getViewport

public Viewport getViewport()

Return the viewport of the SVG content.

Returns:

the viewport

createRegion

public SVGImageRegion createRegion()

Create a region containing this image. Note that the region will only be created once. This region will allow to use the image in a layout (for example a BorderPane, or a StackPane), and redimension the image accordingly.

Returns:

the region

getSVGContent

public SVGContent getSVGContent()

Return the SVG content origin.

Returns:

the SVG content

setDefaultSnapshotParameters

public static void setDefaultSnapshotParameters(javafx.scene.SnapshotParameters params)

Set the default SnapshotParameters to use when creating snapshots. The default is null, which means that a default SnapshotParameters will be created when creating a snapshot.

Parameters:

params - the default SnapshotParameters

setDefaultSnapshotParameters

public static void setDefaultSnapshotParameters(SVGSnapshotParameters params)

Set the default SnapshotParameters to use when creating snapshots. The default is null, which means that a default SnapshotParameters will be created when creating a snapshot.

Parameters:

params - the default SnapshotParameters

getDefaultSnapshotParameters

public static SVGSnapshotParameters getDefaultSnapshotParameters()

Return the default SnapshotParameters used when creating a snapshot.

Returns:

the default SnapshotParameters

hasNode

public boolean hasNode(String id)

Return true if there is a Node indicated by an id.

Parameters:

id - the name of the Node

Returns:

true if there is a Node indicated by the id

getNode

public javafx.scene.Node getNode(String id)

Return the Node indicated by id.

Parameters:

id - the name of the Node

Returns:

the Node

playAnimations

public void playAnimations()

Play the animations.

isPlayingAnimations

public boolean isPlayingAnimations()

Return true if the animations are playing.

Returns:

true if the animations are playing

stopAnimations

public void stopAnimations()

Stop the animations.

getViewportWidth

public double getViewportWidth()

Return the width of the image viewort. It will use the viewport to get the width if the viewport exists, else it willl get the width of the content.

Returns:

the width

getWidth

public double getWidth()

Return the width of the image. Defer to Viewport.getBestWidth().

Returns:

the width

getContentWidth

public double getContentWidth()

Return the width of the image content.

Returns:

the width

getScaledWidth

public double getScaledWidth()

Return the width of the image, taking into account the scaling of the svg image.

Returns:

the width

getHeight

public double getHeight()

Return the height of the image. Defer to Viewport.getBestHeight().

Returns:

the height

getViewportHeight

public double getViewportHeight()

Return the height of the image viewort. It will use the viewport to get the height if the viewport exists, else it willl get the height of the content.

Returns:

the height

getContentHeight

public double getContentHeight()

Return the height of the image content.

Returns:

the height

getScaledHeight

public double getScaledHeight()

Return the height of the image, taking into account the scaling of the svg image.

Returns:

the height

toImageScaled

public javafx.scene.image.Image toImageScaled(double scale)

Convert the Node tree to an image.

Parameters:

scale - the scale

Returns:

the Image

toImageScaled

public javafx.scene.image.Image toImageScaled(short quality,
                                              double scaleX,
                                              double scaleY)

Convert the Node tree to a scaled image.

Parameters:

quality - the scaling quality

scaleX - the X scale

scaleY - the Y scale

Returns:

the Image

See Also:

ScaleQuality

toImageScaled

public javafx.scene.image.Image toImageScaled(double scaleX,
                                              double scaleY)

Convert the Node tree to a scaled image.

Parameters:

scaleX - the X scale

scaleY - the Y scale

Returns:

the Image

toImage

public javafx.scene.image.Image toImage(short quality,
                                        double width)

Convert the Node tree to an image, specifying the resulting width and preserving the image ratio.

Parameters:

quality - the scaling quality

width - the resulting width

Returns:

the Image

See Also:

ScaleQuality

toImage

public javafx.scene.image.Image toImage(double width)

Convert the Node tree to an image, specifying the resulting width and preserving the image ratio.

Parameters:

width - the resulting width

Returns:

the Image

toImage

public javafx.scene.image.Image toImage()

Convert the Node tree to an image, without applying a scale.

Returns:

the Image

toImage

public javafx.scene.image.Image toImage(SVGSnapshotParameters params)

Convert the Node tree to an image.

Parameters:

params - the parameters

Returns:

the Image

toImage

public javafx.scene.image.Image toImage(javafx.scene.SnapshotParameters params)

Convert the Node tree to an image.

Parameters:

params - the parameters

Returns:

the Image

clone

public SVGImage clone()

Clone the SVGImage. Will call scale(double, boolean) with a scale of 1 and crrte a new image.

Overrides:

clone in class Object

Returns:

the cloned SVGImage

scale

public SVGImage scale(double scale)

Scale the image. Return the initial SVGImage.

Parameters:

scale - the scale factor

Returns:

the new image

scale

public SVGImage scale(double scale,
                      boolean createNew)

Scale the image. If createNew is true, then return the initial SVGImage.

Parameters:

scale - the scale factor

createNew - true to create a new image

Returns:

the new image

scaleTo

public SVGImage scaleTo(double width)

Scale the image to a specified width. Return the initial SVGImage.

Parameters:

width - the width of the scaled image

Returns:

the new image

scaleTo

public SVGImage scaleTo(double width,
                        boolean createNew)

Scale the image to a specified width. If createNew is true, then return the initial SVGImage.

Parameters:

width - the width of the scaled image

createNew - true to creata a new image

Returns:

the new image

snapshot

public boolean snapshot(javafx.scene.SnapshotParameters params,
                        String format,
                        File file)
                 throws SVGLibraryException

Saves a snapshot of the image. This method will throw a SVGLibraryException if the snapshot generation generated an exception and GlobalConfig.getExceptionsHandling() is set to ExceptionsHandling.RETROW_EXCEPTION. It means that by default the method will simply return false if it could not save the snapshot. Reasons for the save to not being able to generate the snapshot are the directory being read-only, or swing not available.

Parameters:

params - the parameters

format - the format

file - the file

Returns:

true if the save was successful

Throws:

SVGLibraryException

snapshot

public boolean snapshot(String format,
                        File file)
                 throws SVGLibraryException

Saves a snapshot of the image. This method will throw a SVGLibraryException if the snapshot generation generated an exception and GlobalConfig.getExceptionsHandling() is set to ExceptionsHandling.RETROW_EXCEPTION. It means that by default the method will simply return false if it could not save the snapshot. Reasons for the save to not being able to generate the snapshot are the directory being read-only, or swing not available.

Parameters:

format - the format

file - the file

Returns:

true if the save was successful

Throws:

SVGLibraryException