javafx.scene.input

Class SwipeEvent

java.lang.Object

java.util.EventObject

javafx.event.Event

javafx.scene.input.InputEvent

javafx.scene.input.GestureEvent

javafx.scene.input.SwipeEvent

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public 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:

2.2

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static EventType<SwipeEvent>	ANY Common supertype for all swipe event types.
static EventType<SwipeEvent>	SWIPE_DOWN This event occurs when user performs downward swipe gesture.
static EventType<SwipeEvent>	SWIPE_LEFT This event occurs when user performs leftward swipe gesture.
static EventType<SwipeEvent>	SWIPE_RIGHT This event occurs when user performs rightward swipe gesture.
static EventType<SwipeEvent>	SWIPE_UP This event occurs when user performs upward swipe gesture.

Fields inherited from class javafx.event.Event

consumed, eventType, NULL_SOURCE_TARGET, target

Fields inherited from class java.util.EventObject

source

Method Summary

Methods

Modifier and Type	Method and Description
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

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

Methods inherited from class javafx.event.Event

clone, consume, fireEvent, getEventType, getTarget, isConsumed

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Field Detail

ANY

public static final EventType<SwipeEvent> ANY

Common supertype for all swipe event types.

SWIPE_LEFT

public static final EventType<SwipeEvent> SWIPE_LEFT

This event occurs when user performs leftward swipe gesture.

SWIPE_RIGHT

public static final EventType<SwipeEvent> SWIPE_RIGHT

This event occurs when user performs rightward swipe gesture.

SWIPE_UP

public static final EventType<SwipeEvent> SWIPE_UP

This event occurs when user performs upward swipe gesture.

SWIPE_DOWN

public static final EventType<SwipeEvent> SWIPE_DOWN

This event occurs when user performs downward swipe gesture.

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.