javafx.scene.input

Class GestureEvent

java.lang.Object

Event

javafx.scene.input.InputEvent

javafx.scene.input.GestureEvent

Direct Known Subclasses:

RotateEvent, ScrollEvent, SwipeEvent, ZoomEvent

public class GestureEvent
extends InputEvent

An event indicating gesture input. Gestures are typically caused by direct (touch screen) or indirect (track pad) touch events.

Delivery of gestures is dependent on the capabilities of the underlying platform and connected input devices. For instance on a PC with mouse and keyboard there is no way of producing a rotating gesture.

Since:

JavaFX 2.2

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	altDown
static <any>	ANY Common supertype for all gestures.
private boolean	controlDown
private boolean	direct
private boolean	inertia
private boolean	metaDown
private PickResult	pickResult Information about the pick if the picked Node is a Shape3D node and its pickOnBounds is false.
private double	sceneX
private double	sceneY
private double	screenX
private double	screenY
private static long	serialVersionUID
private boolean	shiftDown
private double	x
private double	y
private double	z Depth z position of the event relative to the origin of the MouseEvent's node.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GestureEvent(<any> eventType) Deprecated. Do not use this constructor. Constructs empty event.
protected	GestureEvent(<any> eventType, double x, double y, double screenX, double screenY, boolean shiftDown, boolean controlDown, boolean altDown, boolean metaDown, boolean direct, boolean inertia, PickResult pickResult) Constructs new GestureEvent event with empty source and target
protected	GestureEvent(java.lang.Object source, EventTarget target, <any> eventType) Deprecated. Do not use this constructor. Constructs empty event.
protected	GestureEvent(java.lang.Object source, EventTarget target, <any> eventType, double x, double y, double screenX, double screenY, boolean shiftDown, boolean controlDown, boolean altDown, boolean metaDown, boolean direct, boolean inertia, PickResult pickResult) Constructs new GestureEvent event.

Method Summary

Modifier and Type	Method and Description
GestureEvent	copyFor(java.lang.Object newSource, EventTarget newTarget)
<any>	getEventType()
PickResult	getPickResult() Returns information about the pick.
double	getSceneX() Gets the horizontal position of the event relative to the origin of the Scene that contains the event's source.
double	getSceneY() Gets the vertical position of the event relative to the origin of the Scene that contains the event's source.
double	getScreenX() Gets the absolute horizontal position of the event.
double	getScreenY() Gets the absolute vertical position of the event.
double	getX() Gets the horizontal position of the event relative to the origin of the event's source.
double	getY() Gets the vertical position of the event relative to the origin of the event's source.
double	getZ() Depth position of the event relative to the origin of the MouseEvent's source.
boolean	isAltDown() Indicates whether or not the Alt modifier is down on this event.
boolean	isControlDown() Indicates whether or not the Control modifier is down on this event.
boolean	isDirect() Indicates whether this gesture is caused by a direct or indirect input device.
boolean	isInertia() Indicates if this event represents an inertia of an already finished gesture.
boolean	isMetaDown() Indicates whether or not the Meta modifier is down on this event.
boolean	isShiftDown() Indicates whether or not the Shift modifier is down on this event.
boolean	isShortcutDown() Indicates whether or not the host platform common shortcut modifier is down on this event.
private void	readObject(java.io.ObjectInputStream in)
private void	recomputeCoordinatesToSource(GestureEvent newEvent, java.lang.Object newSource) Fills the given event by this event's coordinates recomputed to the given source object.
java.lang.String	toString() Returns a string representation of this GestureEvent object.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

ANY

public static final <any> ANY

Common supertype for all gestures.

x

private transient double x

y

private transient double y

z

private transient double z

Depth z position of the event relative to the origin of the MouseEvent's node.

screenX

private final double screenX

screenY

private final double screenY

sceneX

private final double sceneX

sceneY

private final double sceneY

shiftDown

private final boolean shiftDown

controlDown

private final boolean controlDown

altDown

private final boolean altDown

metaDown

private final boolean metaDown

direct

private final boolean direct

inertia

private final boolean inertia

pickResult

private PickResult pickResult

Information about the pick if the picked Node is a Shape3D node and its pickOnBounds is false.

Constructor Detail

GestureEvent

@Deprecated
protected GestureEvent(<any> eventType)

Deprecated. Do not use this constructor. Constructs empty event.

Creates a new instance of GestureEvent.

Parameters:

eventType - Type of the event

GestureEvent

@Deprecated
protected GestureEvent(java.lang.Object source,
                                   EventTarget target,
                                   <any> eventType)

Deprecated. Do not use this constructor. Constructs empty event.

Creates a new instance of GestureEvent.

Parameters:

source - Event source

target - Event target

eventType - Type of the event

GestureEvent

protected GestureEvent(java.lang.Object source,
                       EventTarget target,
                       <any> eventType,
                       double x,
                       double y,
                       double screenX,
                       double screenY,
                       boolean shiftDown,
                       boolean controlDown,
                       boolean altDown,
                       boolean metaDown,
                       boolean direct,
                       boolean inertia,
                       PickResult pickResult)

Constructs new GestureEvent event.

Parameters:

source - the source of the event. Can be null.

target - the target of the event. Can be null.

eventType - The type of the event.

x - The x with respect to the scene.

y - The y with respect to the scene.

screenX - The x coordinate relative to screen.

screenY - The y coordinate relative to screen.

shiftDown - true if shift modifier was pressed.

controlDown - true if control modifier was pressed.

altDown - true if alt modifier was pressed.

metaDown - true if meta modifier was pressed.

direct - true if the event was caused by direct input device. See isDirect()

inertia - if represents inertia of an already finished gesture.

pickResult - pick result. Can be null, in this case a 2D pick result without any further values is constructed based on the scene coordinates and the target

Since:

JavaFX 8.0

GestureEvent

protected GestureEvent(<any> eventType,
                       double x,
                       double y,
                       double screenX,
                       double screenY,
                       boolean shiftDown,
                       boolean controlDown,
                       boolean altDown,
                       boolean metaDown,
                       boolean direct,
                       boolean inertia,
                       PickResult pickResult)

Constructs new GestureEvent event with empty source and target

Parameters:

eventType - The type of the event.

x - The x with respect to the scene.

y - The y with respect to the scene.

screenX - The x coordinate relative to screen.

screenY - The y coordinate relative to screen.

shiftDown - true if shift modifier was pressed.

controlDown - true if control modifier was pressed.

altDown - true if alt modifier was pressed.

metaDown - true if meta modifier was pressed.

direct - true if the event was caused by direct input device. See isDirect()

inertia - if represents inertia of an already finished gesture.

pickResult - pick result. Can be null, in this case a 2D pick result without any further values is constructed based on the scene coordinates

Since:

JavaFX 8.0

Method Detail

recomputeCoordinatesToSource

private void recomputeCoordinatesToSource(GestureEvent newEvent,
                                          java.lang.Object newSource)

Fills the given event by this event's coordinates recomputed to the given source object.

Parameters:

newEvent - Event whose coordinates are to be filled

newSource - Source object to compute coordinates for

copyFor

public GestureEvent copyFor(java.lang.Object newSource,
                            EventTarget newTarget)

getX

public final double getX()

Gets the horizontal position of the event relative to the origin of the event's source.

Returns:

the horizontal position of the event relative to the origin of the event's source.

See Also:

isDirect()

getY

public final double getY()

Gets the vertical position of the event relative to the origin of the event's source.

Returns:

the vertical position of the event relative to the origin of the event's source.

See Also:

isDirect()

getZ

public final double getZ()

Depth position of the event relative to the origin of the MouseEvent's source.

Returns:

depth position of the event relative to the origin of the MouseEvent's source.

Since:

JavaFX 8.0

getScreenX

public final double getScreenX()

Gets the absolute horizontal position of the event.

Returns:

the absolute horizontal position of the event

See Also:

isDirect()

getScreenY

public final double getScreenY()

Gets the absolute vertical position of the event.

Returns:

the absolute vertical position of the event

See Also:

isDirect()

getSceneX

public final double getSceneX()

Gets the horizontal position of the event relative to the origin of the Scene that contains the event's source. If the node is not in a Scene, then the value is relative to the boundsInParent of the root-most parent of the event's node. Note that in 3D scene, this represents the flat coordinates after applying the projection transformations.

Returns:

the horizontal position of the event relative to the origin of the Scene that contains the event's source

See Also:

isDirect()

getSceneY

public final double getSceneY()

Gets the vertical position of the event relative to the origin of the Scene that contains the event's source. If the node is not in a Scene, then the value is relative to the boundsInParent of the root-most parent of the event's node. Note that in 3D scene, this represents the flat coordinates after applying the projection transformations.

Returns:

the vertical position of the event relative to the origin of the Scene that contains the event's source

See Also:

isDirect()

isShiftDown

public final boolean isShiftDown()

Indicates whether or not the Shift modifier is down on this event.

Returns:

true if the Shift modifier is down on this event

isControlDown

public final boolean isControlDown()

Indicates whether or not the Control modifier is down on this event.

Returns:

true if the Control modifier is down on this event

isAltDown

public final boolean isAltDown()

Indicates whether or not the Alt modifier is down on this event.

Returns:

true if the Alt modifier is down on this event

isMetaDown

public final boolean isMetaDown()

Indicates whether or not the Meta modifier is down on this event.

Returns:

true if the Meta modifier is down on this event

isDirect

public final boolean isDirect()

Indicates whether this gesture is caused by a direct or indirect input device. With direct input device the gestures are performed directly at the concrete coordinates, a typical example would be a touch screen. With indirect device the gestures are performed indirectly and usually mouse cursor position is used as the gesture coordinates, a typical example would be a track pad.

Returns:

true if this event is caused by a direct input device

isInertia

public boolean isInertia()

Indicates if this event represents an inertia of an already finished gesture.

Returns:

true if this is an inertia event

getPickResult

public final PickResult getPickResult()

Returns information about the pick.

Returns:

new PickResult object that contains information about the pick

Since:

JavaFX 8.0

isShortcutDown

public final boolean isShortcutDown()

Indicates whether or not the host platform common shortcut modifier is down on this event. This common shortcut modifier is a modifier key which is used commonly in shortcuts on the host platform. It is for example control on Windows and meta (command key) on Mac.

Returns:

true if the shortcut modifier is down, false otherwise

toString

public java.lang.String toString()

Returns a string representation of this GestureEvent object.

Returns:

a string representation of this GestureEvent object.

readObject

private void readObject(java.io.ObjectInputStream in)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

getEventType

public <any> getEventType()

Overrides:

getEventType in class InputEvent