Class SwipeEvents

Defines the interface for OutSystemsUI Patterns

Hierarchy (View Summary)

AbstractPattern<SwipeEventsConfig>
- SwipeEvents

Implements

ISwipeEvents

Constructors

constructor

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

Properties

`Protected`isProviderBased

isProviderBased: boolean = false

Accessors

`Protected`_enableAccessibility

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

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractPattern._enableAccessibility
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:207

selfElement

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

Returns HTMLElement

Memberof
OSFramework.Patterns.AbstractPattern
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.

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
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.

Returns C

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractPattern.configs
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:240

uniqueId

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

Returns string

Memberof
OSFramework.Patterns.AbstractPattern
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.

Returns string

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of ISwipeEvents.widgetId

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

Methods

`Protected`finishBuild

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

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
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.
Parameters
- platFormCallback: OSGeneric
- ...args: unknown[]
Returns void

Memberof
AbstractProviderPattern
Inherited from AbstractPattern.triggerPlatformEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:81

`Protected`triggerPlatformInitializedEventCallback

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

Returns void

Memberof
AbstractPattern
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

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
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.
Parameters
- propertyName: string
- propertyValue: unknown
Returns void

Memberof
OSFramework.Patterns.AbstractPattern
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.
Parameters
- patternId: string
Returns boolean
{boolean}

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of ISwipeEvents.equalsToID

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

`Protected`setA11YProperties

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

Returns void

Memberof
OSFramework.Patterns.SwipeEvents.SwipeEvents
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.

Returns void

Memberof
OSFramework.Patterns.SwipeEvents.SwipeEvents
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

Returns void

Memberof
OSFramework.Patterns.SwipeEvents.SwipeEvents
Overrides AbstractPattern.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/SwipeEvents/SwipeEvents.ts:105

`Protected`unsetCallbacks

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

Returns void

Memberof
OSFramework.Patterns.SwipeEvents.SwipeEvents
Overrides AbstractPattern.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/SwipeEvents/SwipeEvents.ts:115

`Protected`unsetHtmlElements

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

Returns void

Memberof
OSFramework.Patterns.SwipeEvents.SwipeEvents
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
Parameters
- offsetX: number
- offsetY: number
- timeTaken: number
Returns void

Memberof
OSFramework.Patterns.SwipeEvents.SwipeEvents
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
Parameters
- event: TouchEvent
Returns void

Memberof
OSFramework.Patterns.SwipeEvents.SwipeEvents
Implementation of ISwipeEvents.EventGestureMove
- Defined in OSFramework/OSUI/Pattern/SwipeEvents/SwipeEvents.ts:167

build

build(): void
Method to build the SwipeEvents

Returns void

Memberof
OSFramework.Patterns.SwipeEvents.SwipeEvents
Implementation of ISwipeEvents.build

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

dispose

dispose(): void
Destroy SwipeEvents

Returns void

Memberof
OSFramework.Patterns.SwipeEvents.SwipeEvents
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
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

Memberof
OSFramework.Patterns.SwipeEvents.SwipeEvents
Implementation of ISwipeEvents.registerCallback

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

Class SwipeEvents

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OSFramework.OSUI.Patterns.SwipeEvents.SwipeEvents

Properties

ProtectedisProviderBased

Accessors

Protected_enableAccessibility

Returns boolean

Memberof

selfElement

Returns HTMLElement

Memberof

isBuilt

Returns boolean

Memberof

configs

Returns C

Memberof

uniqueId

Returns string

Memberof

widgetId

Returns string

Memberof

Methods

ProtectedfinishBuild

Returns void

Memberof

ProtectedtriggerPlatformEventCallback

Parameters

Returns void

Memberof

ProtectedtriggerPlatformInitializedEventCallback

Returns void

Memberof

ProtectedunsetGlobalCallbacks

Returns void

Memberof

changeProperty

Parameters

Returns void

Memberof

equalsToID

Parameters

Returns boolean

Memberof

ProtectedsetA11YProperties

Returns void

Memberof

ProtectedsetCallbacks

Returns void

Memberof

ProtectedsetHtmlElements

Returns void

Memberof

ProtectedunsetCallbacks

Returns void

Memberof

ProtectedunsetHtmlElements

Returns void

Memberof

EventGestureEnd

Parameters

Returns void

Memberof

EventGestureMove

Parameters

Returns void

Memberof

build

Returns void

`Protected`isProviderBased

`Protected`_enableAccessibility

`Protected`finishBuild

`Protected`triggerPlatformEventCallback

`Protected`triggerPlatformInitializedEventCallback

`Protected`unsetGlobalCallbacks

`Protected`setA11YProperties

`Protected`setCallbacks

`Protected`setHtmlElements

`Protected`unsetCallbacks

`Protected`unsetHtmlElements