APIdia Launch Partner
Top Description Fields Constructors Methods
javafx.scene

public Class SnapshotResult

extends Object
Class Inheritance
Imports
javafx.scene.image.WritableImage
This class holds the result of a snapshot operation.
Since
JavaFX 2.2

Field Summary

Modifier and TypeField and Description
private WritableImage
image

private SnapshotParameters
params

private Object
source

Constructor Summary

AccessConstructor and Description
pack-priv
SnapshotResult(WritableImage image, Object source, SnapshotParameters params)

Method Summary

Modifier and TypeMethod and Description
public WritableImage

Returns:

the generated image
getImage()

Gets the image generated by the snapshot operation.

public SnapshotParameters

Returns:

a copy of the SnapshotParameters used to perform the snapshot, or null
getSnapshotParameters()

Gets a copy of the SnapshotParameters used to generate the snapshot.

public Object

Returns:

the source of the snapshot
getSource()

Gets the source Node or Scene on which the snapshot was called.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

imageback to summary
private WritableImage image
paramsback to summary
private SnapshotParameters params
sourceback to summary
private Object source

Constructor Detail

SnapshotResultback to summary
pack-priv SnapshotResult(WritableImage image, Object source, SnapshotParameters params)

Method Detail

getImageback to summary
public WritableImage getImage()

Gets the image generated by the snapshot operation.

Returns:WritableImage

the generated image

getSnapshotParametersback to summary
public SnapshotParameters getSnapshotParameters()

Gets a copy of the SnapshotParameters used to generate the snapshot. This will be null in the case of snapshot being called on a Scene.

Returns:SnapshotParameters

a copy of the SnapshotParameters used to perform the snapshot, or null

getSourceback to summary
public Object getSource()

Gets the source Node or Scene on which the snapshot was called.

Returns:Object

the source of the snapshot