Class SwipeEvent

Class that represents the gesture events.

Export

SwipeEvent

Hierarchy (View Summary)

AbstractGestureEvent
- SwipeEvent

Index

Constructors

Accessors

Methods

setCallbacks setEventListeners unsetTouchEvents setSwipeCallbacks setSwipeEvents

Constructors

constructor

new SwipeEvent(target: HTMLElement): SwipeEvent
Parameters
- target: HTMLElement
Returns SwipeEvent
Overrides AbstractGestureEvent.constructor
- Defined in OSFramework/OSUI/Event/GestureEvents/SwipeEvent.ts:22

Accessors

targetElement

get targetElement(): HTMLElement
Get the targetElement

Returns HTMLElement

Memberof
OSFramework.Event.GestureEvent.AbstractGestureEvent
Inherited from AbstractGestureEvent.targetElement
- Defined in OSFramework/OSUI/Event/GestureEvents/AbstractGestureEvent.ts:164

Methods

`Protected`setCallbacks

setCallbacks(
    onStartCallback?: Generic,
    onMoveCallback?: Generic,
    onEndCallback?: Generic,
): void
Protected
Method to set the callbacks
Parameters
- OptionalonStartCallback: Generic
- OptionalonMoveCallback: Generic
- OptionalonEndCallback: Generic
Returns void

Memberof
OSFramework.Event.GestureEvent.AbstractGestureEvent
Inherited from AbstractGestureEvent.setCallbacks
- Defined in OSFramework/OSUI/Event/GestureEvents/AbstractGestureEvent.ts:129

`Protected`setEventListeners

setEventListeners(): void
Protected
Method to add the event listeners to the targetElement, with the expected callbacks

Returns void

Memberof
OSFramework.Event.GestureEvent.AbstractGestureEvent
Inherited from AbstractGestureEvent.setEventListeners
- Defined in OSFramework/OSUI/Event/GestureEvents/AbstractGestureEvent.ts:149

unsetTouchEvents

unsetTouchEvents(): void
Method to remove the event listeners added to the targetElement and unset the callback

Returns void

Memberof
OSFramework.Event.GestureEvent.AbstractGestureEvent
Inherited from AbstractGestureEvent.unsetTouchEvents
- Defined in OSFramework/OSUI/Event/GestureEvents/AbstractGestureEvent.ts:173

`Protected`setSwipeCallbacks

setSwipeCallbacks(
    swipeDownCallback: Generic,
    swipeLeftCallback: Generic,
    swipeRightCallback: Generic,
    swipeUpCallback: Generic,
): void
Protected
Method to set the expected callbacks
Parameters
- swipeDownCallback: Generic
- swipeLeftCallback: Generic
- swipeRightCallback: Generic
- swipeUpCallback: Generic
Returns void

Memberof
OSFramework.Event.GestureEvent.SwipeEvent
- Defined in OSFramework/OSUI/Event/GestureEvents/SwipeEvent.ts:62

setSwipeEvents

setSwipeEvents(
    swipeDownCallback: SwipeDown,
    swipeLeftCallback: SwipeLeft,
    swipeRightCallback: SwipeRight,
    swipeUpCallback: SwipeUp,
): void
Method to set the expected callbacks and add eventListeners to the target element
Parameters
- swipeDownCallback: SwipeDown
- swipeLeftCallback: SwipeLeft
- swipeRightCallback: SwipeRight
- swipeUpCallback: SwipeUp
Returns void

Memberof
OSFramework.Event.GestureEvent.SwipeEvent
Overrides AbstractGestureEvent.setSwipeEvents
- Defined in OSFramework/OSUI/Event/GestureEvents/SwipeEvent.ts:85