javafx.scene

Class SnapshotResult

java.lang.Object

javafx.scene.SnapshotResult

public class SnapshotResult
extends java.lang.Object

This class holds the result of a snapshot operation.

Since:

JavaFX 2.2

Field Summary

Fields

Modifier and Type	Field and Description
private WritableImage	image
private SnapshotParameters	params
private java.lang.Object	source

Constructor Summary

Constructors

Constructor and Description
SnapshotResult(WritableImage image, java.lang.Object source, SnapshotParameters params)

Method Summary

Modifier and Type	Method and Description
WritableImage	getImage() Gets the image generated by the snapshot operation.
SnapshotParameters	getSnapshotParameters() Gets a copy of the SnapshotParameters used to generate the snapshot.
java.lang.Object	getSource() Gets the source Node or Scene on which the snapshot was called.

Methods inherited from class java.lang.Object

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

Field Detail

image

private WritableImage image

source

private java.lang.Object source

params

private SnapshotParameters params

Constructor Detail

SnapshotResult

SnapshotResult(WritableImage image,
               java.lang.Object source,
               SnapshotParameters params)

Method Detail

getImage

public WritableImage getImage()

Gets the image generated by the snapshot operation.

Returns:

the generated image

getSource

public java.lang.Object getSource()

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

Returns:

the source of the snapshot

getSnapshotParameters

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:

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