Class SwipeEvents

Defines the interface for OutSystemsUI Patterns

Hierarchy-Diagram

Legend

class

abstract class

interface

public property

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractPattern<SwipeEventsConfig>
- SwipeEvents

Implements

ISwipeEvents

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

`Private` _gestureMoveEvent

_gestureMoveEvent: Generic

`Private` _gestureStartEvent

_gestureStartEvent: Generic

`Private` _swipableElement

_swipableElement: HTMLElement

`Private` _swipeDownCallback

_swipeDownCallback: Generic

`Private` _swipeLeftCallback

_swipeLeftCallback: Generic

`Private` _swipeRightCallback

_swipeRightCallback: Generic

`Private` _swipeUpCallback

_swipeUpCallback: Generic

`Private` _threshold

_threshold: number

`Private` _velocity

_velocity: number

Methods

`Protected` finishBuild

finishBuild(): void
Protected
Marks the built as being finished.

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractPattern.finishBuild
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:61

`Protected` triggerPlatformEventCallback

triggerPlatformEventCallback(platFormCallback: OSGeneric, ...args: unknown[]): void
Protected
Triggers a generic platform event.

Memberof
AbstractProviderPattern
Parameters
- platFormCallback: OSGeneric
- Rest ...args: unknown[]
Returns void
Inherited from AbstractPattern.triggerPlatformEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:81

`Protected` triggerPlatformInitializedEventCallback

triggerPlatformInitializedEventCallback(): void
Protected
Trigger the Initialized callback platform event.

Memberof
AbstractPattern

Returns void
Inherited from AbstractPattern.triggerPlatformInitializedEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:93

`Protected` unsetGlobalCallbacks

unsetGlobalCallbacks(): void
Protected
Unsets the global callbacks. This naming is used to prevent overriding the unsetCallback method on all patterns

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractPattern.unsetGlobalCallbacks
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:107

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Changes the value of the properties in the configurations and if changes are to a common property, applies the changes.

Memberof
OSFramework.Patterns.AbstractPattern
Parameters
- propertyName: string
- propertyValue: unknown
Returns void
Implementation of ISwipeEvents.changeProperty

Inherited from AbstractPattern.changeProperty
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:128

equalsToID

equalsToID(patternId: string): boolean
Enables to uniquely identify the pattern in all ways.

Returns
{boolean}

Memberof
OSFramework.Patterns.AbstractPattern
Parameters
- patternId: string
Returns boolean
Implementation of ISwipeEvents.equalsToID

Inherited from AbstractPattern.equalsToID
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:172

`Private` _removeEventListeners

_removeEventListeners(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/SwipeEvents/SwipeEvents.ts:33

`Protected` setA11YProperties

setA11YProperties(): void
Protected
This method has no implementation on this pattern context!

Memberof
OSFramework.Patterns.SwipeEvents.SwipeEvents

Returns void
Overrides AbstractPattern.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/SwipeEvents/SwipeEvents.ts:82

`Protected` setCallbacks

setCallbacks(): void
Protected
Sets the callbacks to be used in the pattern.

Memberof
OSFramework.Patterns.SwipeEvents.SwipeEvents

Returns void
Overrides AbstractPattern.setCallbacks
- Defined in OSFramework/OSUI/Pattern/SwipeEvents/SwipeEvents.ts:92

`Protected` setHtmlElements

setHtmlElements(): void
Protected
Set the html references that will be used to manage the cssClasses and atribute properties

Memberof
OSFramework.Patterns.SwipeEvents.SwipeEvents

Returns void
Overrides AbstractPattern.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/SwipeEvents/SwipeEvents.ts:105

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Removes event listeners and callbacks.

Memberof
OSFramework.Patterns.SwipeEvents.SwipeEvents

Returns void
Overrides AbstractPattern.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/SwipeEvents/SwipeEvents.ts:115

`Protected` unsetHtmlElements

unsetHtmlElements(): void
Protected
Release references to HTML elements.

Memberof
OSFramework.Patterns.SwipeEvents.SwipeEvents

Returns void
Overrides AbstractPattern.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/SwipeEvents/SwipeEvents.ts:128

EventGestureEnd

EventGestureEnd(offsetX: number, offsetY: number, timeTaken: number): void
Based on the offset, this method triggers the methods on the platform

Memberof
OSFramework.Patterns.SwipeEvents.SwipeEvents
Parameters
- offsetX: number
- offsetY: number
- timeTaken: number
Returns void
Implementation of ISwipeEvents.EventGestureEnd
- Defined in OSFramework/OSUI/Pattern/SwipeEvents/SwipeEvents.ts:139

EventGestureMove

EventGestureMove(event: TouchEvent): void
Block the default behaviour of the GestureMove

Memberof
OSFramework.Patterns.SwipeEvents.SwipeEvents
Parameters
- event: TouchEvent
Returns void
Implementation of ISwipeEvents.EventGestureMove
- Defined in OSFramework/OSUI/Pattern/SwipeEvents/SwipeEvents.ts:167

build

build(): void
Method to build the SwipeEvents

Memberof
OSFramework.Patterns.SwipeEvents.SwipeEvents

Returns void
Implementation of ISwipeEvents.build

Overrides AbstractPattern.build
- Defined in OSFramework/OSUI/Pattern/SwipeEvents/SwipeEvents.ts:178

dispose

dispose(): void
Destroy SwipeEvents

Memberof
OSFramework.Patterns.SwipeEvents.SwipeEvents

Returns void
Implementation of ISwipeEvents.dispose

Overrides AbstractPattern.dispose
- Defined in OSFramework/OSUI/Pattern/SwipeEvents/SwipeEvents.ts:190

registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Method used to register the provider callback

Memberof
OSFramework.Patterns.SwipeEvents.SwipeEvents
Parameters
- eventName: string
  
  Event name that will be assigned
- callback: OSGeneric
  
  Function name that will be passed as a callback function to the event above
Returns void
Implementation of ISwipeEvents.registerCallback

Overrides AbstractPattern.registerCallback
- Defined in OSFramework/OSUI/Pattern/SwipeEvents/SwipeEvents.ts:203

Accessors

`Protected` _enableAccessibility

get _enableAccessibility(): boolean
Protected
Getter that allows to obtain the accessibility is enabled.

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Inherited from AbstractPattern._enableAccessibility
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:207

selfElement

get selfElement(): HTMLElement
Getter that allows to obtain the self element.

Memberof
OSFramework.Patterns.AbstractPattern

Returns HTMLElement
Implementation of ISwipeEvents.selfElement

Inherited from AbstractPattern.selfElement
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:218

isBuilt

get isBuilt(): boolean
Getter that tells if the pattern is already built.

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Implementation of ISwipeEvents.isBuilt

Inherited from AbstractPattern.isBuilt
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:229

configs

get configs(): C
Current configurations/state of the pattern.

Memberof
OSFramework.Patterns.AbstractPattern

Returns C
Inherited from AbstractPattern.configs
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:240

uniqueId

get uniqueId(): string
Unique id of the pattern. Internal use only.

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of ISwipeEvents.uniqueId

Inherited from AbstractPattern.uniqueId
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:251

widgetId

get widgetId(): string
Id of the pattern known by the developer. External use only.

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of ISwipeEvents.widgetId

Inherited from AbstractPattern.widgetId
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:262

Constructors

constructor

new SwipeEvents(uniqueId: string, configs: JSON): SwipeEvents
Parameters
- uniqueId: string
- configs: JSON
Returns SwipeEvents
Overrides AbstractPattern.constructor
- Defined in OSFramework/OSUI/Pattern/SwipeEvents/SwipeEvents.ts:26

Class SwipeEvents

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Properties

Methods

Accessors

Constructors

Properties

Protected isProviderBased

Private _gestureMoveEvent

Private _gestureStartEvent

Private _swipableElement

Private _swipeDownCallback

Private _swipeLeftCallback

Private _swipeRightCallback

Private _swipeUpCallback

Private _threshold

Private _velocity

Methods

Protected finishBuild

Memberof

Returns void

Protected triggerPlatformEventCallback

Memberof

Parameters

platFormCallback: OSGeneric

Rest ...args: unknown[]

Returns void

Protected triggerPlatformInitializedEventCallback

Memberof

Returns void

Protected unsetGlobalCallbacks

Memberof

Returns void

changeProperty

Memberof

Parameters

propertyName: string

propertyValue: unknown

Returns void

equalsToID

Returns

Memberof

Parameters

patternId: string

Returns boolean

Private _removeEventListeners

Returns void

Private _setEventListeners

Returns void

Private _triggerSwipeDown

Returns void

Private _triggerSwipeLeft

Returns void

Private _triggerSwipeRight

Returns void

Private _triggerSwipeUp

Returns void

Protected setA11YProperties

Memberof

Returns void

Protected setCallbacks

Memberof

Returns void

Protected setHtmlElements

Memberof

Returns void

Protected unsetCallbacks

Memberof

Returns void

Protected unsetHtmlElements

Memberof

Returns void

EventGestureEnd

Memberof

Parameters

offsetX: number

`Protected` isProviderBased

`Private` _gestureMoveEvent

`Private` _gestureStartEvent

`Private` _swipableElement

`Private` _swipeDownCallback

`Private` _swipeLeftCallback

`Private` _swipeRightCallback

`Private` _swipeUpCallback

`Private` _threshold

`Private` _velocity

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Private` _removeEventListeners

`Private` _setEventListeners

`Private` _triggerSwipeDown

`Private` _triggerSwipeLeft

`Private` _triggerSwipeRight

`Private` _triggerSwipeUp

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` unsetCallbacks

`Protected` unsetHtmlElements

`Protected` _enableAccessibility