Olympe SDK

Interface: HasGestureEvents

olympe.ui.events. HasGestureEvents

Mouse events interface for the CoreThread Note: All callbacks must be executed with the same node than the one which registered the callback

Methods

<abstract> getEventHorizontalPan()

Gets the 'Horizontal Pan' events.

Horizontal Pan is a touch move / mousedown+mousemove performed horizontally

Returns:

Data flow of gesture events

Type
olympe.df.Proxy.<olympe.ui.events.GestureEvent> | olympe.ui.events.GestureEvent

<abstract> getEventHorizontalSwipe()

Gets the 'Horizontal Swipe' events.

Horizontal Swipe is quick touch move + released / mouse move + released performed horizontally.

Returns:

Data flow of gesture events

Type
olympe.df.Proxy.<olympe.ui.events.GestureEvent> | olympe.ui.events.GestureEvent

<abstract> getEventLongPress( [time])

Gets the 'Long Press' events.

LongPress gesture is a long mouse down or a long touch down (250ms).

Parameters:
Name Type Argument Default Description
time number <optional>
 250

Time needed to press before emitting the event.
Returns:

Data flow of gesture events

Type
olympe.df.Proxy.<olympe.ui.events.GestureEvent> | olympe.ui.events.GestureEvent

<abstract> getEventLongPressUp()

Gets the 'Long Press Up' events.

Long Press Up event is a touch down performed during 250ms on this element and released.

Returns:

Data flow of gesture events

Type
olympe.df.Proxy.<olympe.ui.events.GestureEvent> | olympe.ui.events.GestureEvent

<abstract> getEventPinch()

Gets the 'Pinch' events.

Pinch gesture is a two fingers touchdown typically used to zoom in or out.

Returns:

Data flow of gesture events

Type
olympe.df.Proxy.<olympe.ui.events.GestureEvent> | olympe.ui.events.GestureEvent

<abstract> getEventRotate()

Gets the 'Rotate' events.

Rotate gesture is a two fingers touchdown rotation.

Returns:

Data flow of gesture events

Type
olympe.df.Proxy.<olympe.ui.events.GestureEvent> | olympe.ui.events.GestureEvent

<abstract> getEventVerticalPan()

Gets the 'Vertical Pan' events.

Vertical Pan is a touch move / mousedown+mousemove performed vertically

Returns:

Data flow of gesture events

Type
olympe.df.Proxy.<olympe.ui.events.GestureEvent> | olympe.ui.events.GestureEvent

<abstract> getEventVerticalSwipe()

Gets the 'Vertical Swipe' events.

Vertical Swipe is quick touch move + released / mouse move + released performed vertically.

Returns:

Data flow of gesture events

Type
olympe.df.Proxy.<olympe.ui.events.GestureEvent> | olympe.ui.events.GestureEvent

offHorizontalPan(id)

Unregisters a callback from the 'Horizontal Pan' events.

Parameters:
Name Type Description
id string

ID of callback (returned by onHorizontalPan)

<abstract> offHorizontalSwipe(id)

Unregisters a callback from the 'Horizontal Swipe' events.

Parameters:
Name Type Description
id string

ID of callback (returned by onHorizontalSwipe)

<abstract> offLongPress(id)

Unregisters a callback from the 'Long Press' events.

Parameters:
Name Type Description
id string

ID of callback (returned by onLongPress)

<abstract> offLongPressUp(id)

Unregisters a callback from the 'Long Press Up' events.

Parameters:
Name Type Description
id string

ID of callback (returned by onLongPressUp)

<abstract> offPinch(id)

Unregisters a callback from the 'Pinch' events.

Parameters:
Name Type Description
id string

ID of callback (returned by onPinch)

<abstract> offRotate(id)

Unregisters a callback from the 'Rotate' events.

Parameters:
Name Type Description
id string

ID of callback (returned by onRotate)

offVerticalPan(id)

Unregisters a callback from the 'Vertical Pan' events.

Parameters:
Name Type Description
id string

ID of callback (returned by onVerticalPan)

<abstract> offVerticalSwipe(id)

Unregisters a callback from the 'Vertical Swipe' events.

Parameters:
Name Type Description
id string

ID of callback (returned by onVerticalSwipe)

<abstract> onHorizontalPan(callback [, id] [, priority])

Registers a callback for the 'Horizontal Pan' events.

Parameters:
Name Type Argument Default Description
callback olympe.ui.events.OnGestureEventCallback
id string <optional>

Id of event auto-generated if omitted, necessary to unregister
priority number <optional>
 0

Priority of event (higher number = higher priority)
See:
Returns:

Id of the callback

Type
string

<abstract> onHorizontalSwipe(callback [, id] [, priority])

Registers a callback for the 'Horizontal Swipe' events.

Parameters:
Name Type Argument Default Description
callback olympe.ui.events.OnGestureEventCallback
id string <optional>

Id of event auto-generated if omitted, necessary to unregister
priority number <optional>
 0

Priority of event (higher number = higher priority)
See:
Returns:

Id of the callback

Type
string

<abstract> onLongPress(callback [, id] [, priority] [, time])

Registers a callback for 'Long Press' events.

Parameters:
Name Type Argument Default Description
callback olympe.ui.events.OnGestureEventCallback
id string <optional>

Id of event auto-generated if omitted, necessary to unregister
priority number <optional>
 0

Priority of event (higher number = higher priority)
time number <optional>
 250

Time needed to press before emitting the event.
See:
Returns:

Id of the callback

Type
string

<abstract> onLongPressUp(callback [, id] [, priority])

Registers a callback for 'Long Press Up' events.

Parameters:
Name Type Argument Default Description
callback olympe.ui.events.OnGestureEventCallback
id string <optional>

Id of event auto-generated if omitted, necessary to unregister
priority number <optional>
 0

Priority of event (higher number = higher priority)
See:
Returns:

Id of the callback

Type
string

<abstract> onPinch(callback [, id] [, priority])

Registers a callback for 'Pinch' events.

Parameters:
Name Type Argument Default Description
callback olympe.ui.events.OnGestureEventCallback
id string <optional>

Id of event auto-generated if omitted, necessary to unregister
priority number <optional>
 0

Priority of event (higher number = higher priority)
See:
Returns:

Id of the callback

Type
string

<abstract> onRotate(callback [, id] [, priority])

Registers a callback for 'Rotate' events.

Parameters:
Name Type Argument Default Description
callback olympe.ui.events.OnGestureEventCallback
id string <optional>

Id of event auto-generated if omitted, necessary to unregister
priority number <optional>
 0

Priority of event (higher number = higher priority)
See:
Returns:

Id of the callback

Type
string

<abstract> onVerticalPan(callback [, id] [, priority])

Registers a callback for the 'Vertical Pan' events.

Parameters:
Name Type Argument Default Description
callback olympe.ui.events.OnGestureEventCallback
id string <optional>

Id of event auto-generated if omitted, necessary to unregister
priority number <optional>
 0

Priority of event (higher number = higher priority)
See:
Returns:

Id of the callback

Type
string

<abstract> onVerticalSwipe(callback [, id] [, priority])

Registers a callback for the 'Vertical Swipe' events.

Parameters:
Name Type Argument Default Description
callback olympe.ui.events.OnGestureEventCallback
id string <optional>

Id of event auto-generated if omitted, necessary to unregister
priority number <optional>
 0

Priority of event (higher number = higher priority)
See:
  • getEventVerticalSwipe
Returns:

Id of the callback

Type
string