Class TouchEvents

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<TouchEventsConfig>
- TouchEvents

Implements

ITouchEvents

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

`Private` _currentX

_currentX: number

`Private` _currentY

_currentY: number

`Private` _endEvent

_endEvent: Generic

`Private` _endEventCallback

_endEventCallback: Generic

`Private` _eventMoveCallback

_eventMoveCallback: Generic

`Private` _eventStartCallback

_eventStartCallback: Generic

`Private` _moveEvent

_moveEvent: Generic

`Private` _startEvent

_startEvent: Generic

`Private` _startTime

_startTime: number

`Private` _startX

_startX: number

`Private` _startY

_startY: number

`Private` _timeTaken

_timeTaken: number

`Private` _touchingElement

_touchingElement: boolean

`Private` _trackableElement

_trackableElement: HTMLElement

`Private` _translateX

_translateX: number

`Private` _translateY

_translateY: 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 ITouchEvents.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 ITouchEvents.equalsToID

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

`Private` _eventTouchEnd

_eventTouchEnd(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/TouchEvents/TouchEvents.ts:48

`Private` _eventTouchMove

_eventTouchMove(evt: TouchEvent): void
Parameters
- evt: TouchEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/TouchEvents/TouchEvents.ts:61

`Private` _eventTouchStart

_eventTouchStart(evt: TouchEvent): void
Parameters
- evt: TouchEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/TouchEvents/TouchEvents.ts:73

`Private` _removeEventListeners

_removeEventListeners(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/TouchEvents/TouchEvents.ts:87

`Private` _setEventListeners

_setEventListeners(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/TouchEvents/TouchEvents.ts:96

`Private` _triggerTouchEnd

_triggerTouchEnd(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/TouchEvents/TouchEvents.ts:105

`Private` _triggerTouchMove

_triggerTouchMove(event: TouchEvent): void
Parameters
- event: TouchEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/TouchEvents/TouchEvents.ts:119

`Private` _triggerTouchStart

_triggerTouchStart(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/TouchEvents/TouchEvents.ts:133

`Protected` setA11YProperties

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

Memberof
OSFramework.Patterns.TouchEvents.TouchEvents

Returns void
Overrides AbstractPattern.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/TouchEvents/TouchEvents.ts:145

`Protected` setCallbacks

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

Memberof
OSFramework.Patterns.TouchEvents.TouchEvents

Returns void
Overrides AbstractPattern.setCallbacks
- Defined in OSFramework/OSUI/Pattern/TouchEvents/TouchEvents.ts:155

`Protected` setHtmlElements

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

Memberof
OSFramework.Patterns.TouchEvents.TouchEvents

Returns void
Overrides AbstractPattern.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/TouchEvents/TouchEvents.ts:169

`Protected` unsetCallbacks

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

Memberof
OSFramework.Patterns.TouchEvents.TouchEvents

Returns void
Overrides AbstractPattern.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/TouchEvents/TouchEvents.ts:179

`Protected` unsetHtmlElements

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

Memberof
OSFramework.Patterns.TouchEvents.TouchEvents

Returns void
Overrides AbstractPattern.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/TouchEvents/TouchEvents.ts:193

build

build(): void
Method to build the TouchEvents

Memberof
OSFramework.Patterns.TouchEvents.TouchEvents

Returns void
Implementation of ITouchEvents.build

Overrides AbstractPattern.build
- Defined in OSFramework/OSUI/Pattern/TouchEvents/TouchEvents.ts:202

dispose

dispose(): void
Destroy TouchEvents

Memberof
OSFramework.Patterns.TouchEvents.TouchEvents

Returns void
Implementation of ITouchEvents.dispose

Overrides AbstractPattern.dispose
- Defined in OSFramework/OSUI/Pattern/TouchEvents/TouchEvents.ts:214

registerCallback

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

Memberof
OSFramework.Patterns.TouchEvents.TouchEvents
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 ITouchEvents.registerCallback

Overrides AbstractPattern.registerCallback
- Defined in OSFramework/OSUI/Pattern/TouchEvents/TouchEvents.ts:227

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 ITouchEvents.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 ITouchEvents.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 ITouchEvents.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 ITouchEvents.widgetId

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

Constructors

constructor

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

Class TouchEvents

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Properties

Methods

Accessors

Constructors

Properties

Protected isProviderBased

Private _currentX

Private _currentY

Private _endEvent

Private _endEventCallback

Private _eventMoveCallback

Private _eventStartCallback

Private _moveEvent

Private _startEvent

Private _startTime

Private _startX

Private _startY

Private _timeTaken

Private _touchingElement

Private _trackableElement

Private _translateX

Private _translateY

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 _eventTouchEnd

Returns void

Private _eventTouchMove

Parameters

evt: TouchEvent

Returns void

Private _eventTouchStart

Parameters

evt: TouchEvent

Returns void

Private _removeEventListeners

Returns void

Private _setEventListeners

Returns void

Private _triggerTouchEnd

Returns void

Private _triggerTouchMove

Parameters

event: TouchEvent

Returns void

Private _triggerTouchStart

Returns void

Protected setA11YProperties

Memberof

`Protected` isProviderBased

`Private` _currentX

`Private` _currentY

`Private` _endEvent

`Private` _endEventCallback

`Private` _eventMoveCallback

`Private` _eventStartCallback

`Private` _moveEvent

`Private` _startEvent

`Private` _startTime

`Private` _startX

`Private` _startY

`Private` _timeTaken

`Private` _touchingElement

`Private` _trackableElement

`Private` _translateX

`Private` _translateY

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Private` _eventTouchEnd

`Private` _eventTouchMove

`Private` _eventTouchStart

`Private` _removeEventListeners

`Private` _setEventListeners

`Private` _triggerTouchEnd

`Private` _triggerTouchMove

`Private` _triggerTouchStart

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` unsetCallbacks

`Protected` unsetHtmlElements

`Protected` _enableAccessibility