javafx.scene.input

Class SwipeEvent

java.lang.Object

Event

javafx.scene.input.InputEvent

javafx.scene.input.GestureEvent

javafx.scene.input.SwipeEvent

public final class SwipeEvent
extends GestureEvent

Swipe event indicates that user performed a swipe gesture such as dragging a finger in one direction on touch screen.

Unlike some other gestures, the swipe gesture is not continual - the whole gesture produces only one event. The event is delivered to the top-most node picked on the gesture coordinates.

The swipe gesture has four types according to the movement direction. The gesture can be performed by any number of touch points, the number is provided by getTouchCount() method.

Note that swipe and scroll gestures are not exclusive. A single touch screen action can result in both gestures being delivered.

Note that the capability to produce swipes is dependent on the used input devices and underlying platform's capabilities and settings (especially without touch-screen user's possibilities of producing swipes are significantly reduced).

As all gestures, swipe can be direct (performed directly at the concrete coordinates as on touch screen - the center of the gesture is used as gesture coordinates) or indirect (performed indirectly as on track pad - the mouse cursor location is usually used as the gesture coordinates in this case).

Since:

JavaFX 2.2

Field Summary

Fields

Modifier and Type	Field and Description
static <any>	ANY Common supertype for all swipe event types.
private static long	serialVersionUID
static <any>	SWIPE_DOWN This event occurs when user performs downward swipe gesture.
static <any>	SWIPE_LEFT This event occurs when user performs leftward swipe gesture.
static <any>	SWIPE_RIGHT This event occurs when user performs rightward swipe gesture.
static <any>	SWIPE_UP This event occurs when user performs upward swipe gesture.
private int	touchCount

Constructor Summary

Constructors

Constructor and Description
SwipeEvent(<any> eventType, double x, double y, double screenX, double screenY, boolean shiftDown, boolean controlDown, boolean altDown, boolean metaDown, boolean direct, int touchCount, PickResult pickResult) Constructs new SwipeEvent event with null source and target.
SwipeEvent(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, int touchCount, PickResult pickResult) Constructs new SwipeEvent event.

Method Summary

Modifier and Type	Method and Description
SwipeEvent	copyFor(java.lang.Object newSource, EventTarget newTarget)
SwipeEvent	copyFor(java.lang.Object newSource, EventTarget newTarget, <any> type) Creates a copy of the given event with the given fields substituted.
<any>	getEventType()
int	getTouchCount() Gets number of touch points that caused this event.
java.lang.String	toString() Returns a string representation of this SwipeEvent object.

Methods inherited from class javafx.scene.input.GestureEvent

getPickResult, getSceneX, getSceneY, getScreenX, getScreenY, getX, getY, getZ, isAltDown, isControlDown, isDirect, isInertia, isMetaDown, isShiftDown, isShortcutDown

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 swipe event types.

SWIPE_LEFT

public static final <any> SWIPE_LEFT

This event occurs when user performs leftward swipe gesture.

SWIPE_RIGHT

public static final <any> SWIPE_RIGHT

This event occurs when user performs rightward swipe gesture.

SWIPE_UP

public static final <any> SWIPE_UP

This event occurs when user performs upward swipe gesture.

SWIPE_DOWN

public static final <any> SWIPE_DOWN

This event occurs when user performs downward swipe gesture.

touchCount

private final int touchCount

Constructor Detail

SwipeEvent

public SwipeEvent(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,
                  int touchCount,
                  PickResult pickResult)

Constructs new SwipeEvent 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 GestureEvent.isDirect()

touchCount - number of touch points

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

SwipeEvent

public SwipeEvent(<any> eventType,
                  double x,
                  double y,
                  double screenX,
                  double screenY,
                  boolean shiftDown,
                  boolean controlDown,
                  boolean altDown,
                  boolean metaDown,
                  boolean direct,
                  int touchCount,
                  PickResult pickResult)

Constructs new SwipeEvent event with null 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 GestureEvent.isDirect()

touchCount - number of touch points

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

getTouchCount

public int getTouchCount()

Gets number of touch points that caused this event.

Returns:

Number of touch points that caused this event

toString

public java.lang.String toString()

Returns a string representation of this SwipeEvent object.

Overrides:

toString in class GestureEvent

Returns:

a string representation of this SwipeEvent object.

copyFor

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

Description copied from class: GestureEvent

Overrides:

copyFor in class GestureEvent

copyFor

public SwipeEvent copyFor(java.lang.Object newSource,
                          EventTarget newTarget,
                          <any> type)

Creates a copy of the given event with the given fields substituted.

Parameters:

newSource - the new source of the copied event

newTarget - the new target of the copied event

type - the new eventType

Returns:

the event copy with the fields substituted

Since:

JavaFX 8.0

getEventType

public <any> getEventType()

Overrides:

getEventType in class GestureEvent