Class AbstractProviderPattern<P, C>`Abstract`

Defines the Default props and methods for OutSystemsUI Patterns

Export

Abstract

Implements

Type Parameters

P
C extends AbstractConfiguration

Hierarchy-Diagram

UML class diagram of AbstractProviderPattern

Legend

abstract class

interface

public property

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractPattern<C>
- AbstractProviderPattern

Implements

IProviderPattern<P>

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

`Private` _asyncInvocationId

_asyncInvocationId: number = 0

`Private` _platformEventProviderConfigsAppliedCallback

_platformEventProviderConfigsAppliedCallback: OSGeneric

`Private` _provider

_provider: P

`Private` _providerInfo

_providerInfo: ProviderInfo

`Private` _redrawCallback

_redrawCallback: Generic

`Protected` providerEventsManagerInstance

providerEventsManagerInstance: IProviderEventManager

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 IProviderPattern.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 IProviderPattern.equalsToID

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

`Private` _getEventIndexFromArray

_getEventIndexFromArray(event: IProviderEvent): number
Parameters
- event: IProviderEvent
Returns number
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:50

`Private` _handleProviderEventsAPI

_handleProviderEventsAPI(eventName: string, callback: Generic, addEvent: boolean, event?: IProviderEvent): void
Parameters
- eventName: string
- callback: Generic
- addEvent: boolean
- Optional event: IProviderEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:72

`Private` _handleRedraw

_handleRedraw(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:113

`Protected` redraw

redraw(): void
Protected
Method that will be responsible to redraw pattern when needed

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:132

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Unsets the callbacks.

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
Overrides AbstractPattern.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:149

build

build(): void
Method to build the pattern

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
Implementation of IProviderPattern.build

Overrides AbstractPattern.build
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:158

checkAddedProviderEvents

checkAddedProviderEvents(): void
Method to check for pending events to be added

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:181

checkPendingProviderEvents

checkPendingProviderEvents(): void
Method to check for saved events to be added after a destroy/init cycle

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:195

dispose

dispose(): void
Method to destroy created instance

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
Implementation of IProviderPattern.dispose

Overrides AbstractPattern.dispose
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:210

registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Register the default events for provider based patterns.

Abstract

Memberof
AbstractProviderPattern
Parameters
- eventName: string
- callback: OSGeneric
Returns void
Implementation of IProviderPattern.registerCallback

Overrides AbstractPattern.registerCallback
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:229

setProviderConfigs

setProviderConfigs(providerConfigs: unknown): void
Method used to set all the provider configs. In the AbstractProviderPattern, it will simply trigger the callback to warn that the configs have been applied to the provider.

Memberof
AbstractProviderPattern
Parameters
- providerConfigs: unknown
Returns void
Implementation of IProviderPattern.setProviderConfigs
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:248

setProviderEvent

setProviderEvent(eventName: string, callback: Generic, uniqueId: string, saveEvent??: boolean): void
Method to add a provider event using extensibility

Returns
{void}

Memberof
OSFramework.Patterns.AbstractProviderPattern
Parameters
- eventName: string
- callback: Generic
- uniqueId: string
- Optional saveEvent: boolean = true
Returns void
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:262

unsetProviderEvent

unsetProviderEvent(eventId: string): void
Method to remove a provider event using extensibility

Returns
{void}

Memberof
OSFramework.Patterns.AbstractProviderPattern
Parameters
- eventId: string
Returns void
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:295

updateProviderEvents

updateProviderEvents(providerInfo: ProviderInfo): void
Method to update the provider events API instance and save/pending events

Memberof
OSFramework.Patterns.AbstractProviderPattern
Parameters
- providerInfo: ProviderInfo
Returns void
Implementation of IProviderPattern.updateProviderEvents
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:322

`Protected` `Abstract` prepareConfigs

prepareConfigs(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:379

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

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

providerInfo

get providerInfo(): ProviderInfo
ProviderInfo getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns ProviderInfo
Implementation of IProviderPattern.providerInfo
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:345

provider

get provider(): P
Provider getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns P
Implementation of IProviderPattern.provider
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:374

Constructors

constructor

new AbstractProviderPattern<P, C>(uniqueId: string, configs: C): OSFramework.OSUI.Patterns.AbstractProviderPattern<P, C>
Creates an instance of AbstractProviderPattern.

Memberof
OSFramework.Patterns.AbstractProviderPattern
Type Parameters
- P
- C extends AbstractConfiguration<C>
Parameters
- uniqueId: string
- configs: C
Returns OSFramework.OSUI.Patterns.AbstractProviderPattern<P, C>
Overrides AbstractPattern.constructor
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:36

Class AbstractProviderPattern<P, C>Abstract

Export

Abstract

Implements

Type Parameters

P

C extends AbstractConfiguration

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Properties

Methods

Accessors

Constructors

Properties

Protected isProviderBased

Private _asyncInvocationId

Private _platformEventProviderConfigsAppliedCallback

Private _provider

Private _providerInfo

Private _redrawCallback

Protected providerEventsManagerInstance

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

Protected Abstract setA11YProperties

Returns void

Protected Abstract setCallbacks

Returns void

Protected Abstract setHtmlElements

Returns void

Protected Abstract unsetHtmlElements

Returns void

Private _cancelRedraw

Returns void

Private _getEventIndexFromArray

Parameters

event: IProviderEvent

Returns number

Private _handleProviderEventsAPI

Parameters

eventName: string

callback: Generic

addEvent: boolean

Optional event: IProviderEvent

Returns void

Private _handleRedraw

Returns void

Protected redraw

Memberof

Returns void

Protected unsetCallbacks

Memberof

Class AbstractProviderPattern<P, C>`Abstract`

`Protected` isProviderBased

`Private` _asyncInvocationId

`Private` _platformEventProviderConfigsAppliedCallback

`Private` _provider

`Private` _providerInfo

`Private` _redrawCallback

`Protected` providerEventsManagerInstance

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Protected` `Abstract` setA11YProperties

`Protected` `Abstract` setCallbacks

`Protected` `Abstract` setHtmlElements

`Protected` `Abstract` unsetHtmlElements

`Private` _cancelRedraw

`Private` _getEventIndexFromArray

`Private` _handleProviderEventsAPI

`Optional` event: IProviderEvent

`Private` _handleRedraw

`Protected` redraw

`Protected` unsetCallbacks

`Optional` saveEvent: boolean = true

`Protected` `Abstract` prepareConfigs

`Protected` _enableAccessibility