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>

Constructors

constructor

new AbstractProviderPattern<P, C>(uniqueId: string, configs: C): OSFramework.Patterns.AbstractProviderPattern<P, C>
Type Parameters
- P
- C extends AbstractConfiguration<C>
Parameters
- uniqueId: string
- configs: C
Returns OSFramework.Patterns.AbstractProviderPattern<P, C>
Inherited from AbstractPattern.constructor
- Defined in OSFramework/Pattern/AbstractPattern.ts:24

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/Pattern/AbstractPattern.ts:50

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/Pattern/AbstractPattern.ts:72

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/Pattern/AbstractPattern.ts:115

`Private` _getEventIndexFromArray

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

`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/Pattern/AbstractProviderPattern.ts:46

`Protected` redraw

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

Memberof
OSFramework.Patterns.AbstractProviderPattern

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

`Protected` triggerPlatformEventInitialized

triggerPlatformEventInitialized(platFormCallback: OSGeneric): void
Trigger platform's InstanceIntializedHandler client Action

Memberof
OSFramework.Patterns.AbstractProviderPattern
Parameters
- platFormCallback: OSGeneric
Returns void
- Defined in OSFramework/Pattern/AbstractProviderPattern.ts:111

build

build(): void
Build the Pattern

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
Implementation of IProviderPattern.build

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

checkAddedProviderEvents

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

Memberof
OSFramework.Patterns.AbstractProviderPattern

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

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/Pattern/AbstractProviderPattern.ts:151

dispose

dispose(): void
Method to destroy created instance

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
Implementation of IProviderPattern.dispose

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

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/Pattern/AbstractProviderPattern.ts:181

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/Pattern/AbstractProviderPattern.ts:214

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/Pattern/AbstractProviderPattern.ts:241

`Protected` `Abstract` prepareConfigs

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

`Abstract` registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Enables to register simple callbacks for the platform. Internal use.

Memberof
OSFramework.Interface.IProviderPattern
Parameters
- eventName: string
- callback: OSGeneric
Returns void
Implementation of IProviderPattern.registerCallback
- Defined in OSFramework/Pattern/AbstractProviderPattern.ts:299

`Abstract` setProviderConfigs

setProviderConfigs(providerConfigs: any): void
Method to enable extensibility to provider supported configs

Memberof
OSFramework.Interface.IProviderPattern
Parameters
- providerConfigs: any
Returns void
Implementation of IProviderPattern.setProviderConfigs
- Defined in OSFramework/Pattern/AbstractProviderPattern.ts:300

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/Pattern/AbstractPattern.ts:128

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/Pattern/AbstractPattern.ts:139

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/Pattern/AbstractPattern.ts:150

configs

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

Memberof
OSFramework.Patterns.AbstractPattern

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

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/Pattern/AbstractPattern.ts:172

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/Pattern/AbstractPattern.ts:183

providerInfo

get providerInfo(): ProviderInfo
ProviderInfo getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

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

provider

get provider(): P
Provider getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

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

Properties

`Protected` _provider

_provider: P

`Protected` _providerInfo

_providerInfo: ProviderInfo

`Protected` providerEventsManagerInstance

providerEventsManagerInstance: IProviderEventManager

Class AbstractProviderPattern<P, C>Abstract

Export

Abstract

Implements

Type Parameters

P

C extends AbstractConfiguration

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Constructors

Methods

Accessors

Properties

Constructors

constructor

Type Parameters

P

C extends AbstractConfiguration<C>

Parameters

uniqueId: string

configs: C

Returns OSFramework.Patterns.AbstractProviderPattern<P, C>

Methods

Protected finishBuild

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 unsetCallbacks

Returns void

Protected Abstract unsetHtmlElements

Returns void

Private _getEventIndexFromArray

Parameters

event: IProviderEvent

Returns number

Private _handleProviderEventsAPI

Parameters

eventName: string

callback: Generic

addEvent: boolean

Optional event: IProviderEvent

Returns void

Protected redraw

Memberof

Returns void

Protected triggerPlatformEventInitialized

Memberof

Parameters

platFormCallback: OSGeneric

Returns void

build

Memberof

Returns void

checkAddedProviderEvents

Memberof

Returns void

checkPendingProviderEvents

Memberof

Returns void

dispose

Class AbstractProviderPattern<P, C>`Abstract`

`Protected` finishBuild

`Protected` `Abstract` setA11YProperties

`Protected` `Abstract` setCallbacks

`Protected` `Abstract` setHtmlElements

`Protected` `Abstract` unsetCallbacks

`Protected` `Abstract` unsetHtmlElements

`Private` _getEventIndexFromArray

`Private` _handleProviderEventsAPI

`Optional` event: IProviderEvent

`Protected` redraw

`Protected` triggerPlatformEventInitialized

`Optional` saveEvent: boolean = true

`Protected` `Abstract` prepareConfigs

`Abstract` registerCallback

`Abstract` setProviderConfigs

`Protected` _enableAccessibility

`Protected` _provider

`Protected` _providerInfo

`Protected` providerEventsManagerInstance