org.girod.javafx.svgimage

Class SVGSnapshotParameters

java.lang.Object

org.girod.javafx.svgimage.SVGSnapshotParameters

public class SVGSnapshotParameters
extends java.lang.Object

THis is used to specify the parameters to save the SVGImage as an image.

Since:

1.5

Field Summary

Fields

Modifier and Type	Field and Description
static short	USE_BEST_VIEWPORT_SIZE This type specifies that the resulting image will use the best size define din the viewpoer.
static short	USE_CONTENT_SIZE This type specifies that the resulting image will use the content size.

Constructor Summary

Constructors

Constructor and Description
SVGSnapshotParameters() Constructor.
SVGSnapshotParameters(javafx.scene.SnapshotParameters snapshotParameters) Constructor.

Method Summary

Modifier and Type	Method and Description
javafx.scene.SnapshotParameters	applyViewportType(SVGImage image) Apply the getViewportType() to the image for which we want to generate the snapshort.
javafx.scene.SnapshotParameters	getSnapshotParameters() Return the JavaFX snapshot parameters
short	getViewportType() Return the viewport type.
void	setViewportType(short viewportType) Set the viewport type.

Methods inherited from class java.lang.Object

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

Field Detail

USE_CONTENT_SIZE

public static final short USE_CONTENT_SIZE

This type specifies that the resulting image will use the content size.

See Also:

Constant Field Values

USE_BEST_VIEWPORT_SIZE

public static final short USE_BEST_VIEWPORT_SIZE

This type specifies that the resulting image will use the best size define din the viewpoer.

See Also:

Constant Field Values

Constructor Detail

SVGSnapshotParameters

public SVGSnapshotParameters()

Constructor.

SVGSnapshotParameters

public SVGSnapshotParameters(javafx.scene.SnapshotParameters snapshotParameters)

Constructor.

Parameters:

snapshotParameters - the JavaFX snapshort parameters

Method Detail

setViewportType

public void setViewportType(short viewportType)

Set the viewport type.

Parameters:

viewportType - the viewport type

getViewportType

public short getViewportType()

Return the viewport type.

Returns:

the viewport type

getSnapshotParameters

public javafx.scene.SnapshotParameters getSnapshotParameters()

Return the JavaFX snapshot parameters

Returns:

the JavaFX snapshot parameters

applyViewportType

public javafx.scene.SnapshotParameters applyViewportType(SVGImage image)

Apply the getViewportType() to the image for which we want to generate the snapshort.

Parameters:

image - the image

Returns:

the JavaFX snapshot parameters. Will retur getSnapshotParameters()