Class AbstractPattern<C>`Abstract`

Defines the Default props and methods for OutSystemsUI Patterns

Export

AbstractPattern

Implements

Type Parameters

C extends AbstractConfiguration

Hierarchy (View Summary)

AbstractPattern

Implements

IPattern

Constructors

constructor

new AbstractPattern<C extends AbstractConfiguration>(
uniqueId: string,
configs: C,
): AbstractPattern<C>
Creates an instance of AbstractPattern.
Type Parameters
- C extends AbstractConfiguration
Parameters
- uniqueId: string
- configs: C
Returns AbstractPattern<C>

Memberof
OSFramework.Patterns.AbstractPattern
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:35

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
- 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 IPattern.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 IPattern.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
- 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 IPattern.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 IPattern.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
- 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
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:81

`Protected`triggerPlatformInitializedEventCallback

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

Returns void

Memberof
AbstractPattern
- 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
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:107

build

build(): void
Builds the pattern.

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IPattern.build
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:116

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 IPattern.changeProperty
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:128

dispose

dispose(): void
Disposes the pattern.

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IPattern.dispose
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:158

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 IPattern.equalsToID
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:172

`Abstract`registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Register a given callback event handler.
Parameters
- eventName: string
- callback: OSGeneric
Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IPattern.registerCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:184

`Protected` `Abstract`setA11YProperties

setA11YProperties(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:267

`Protected` `Abstract`setCallbacks

setCallbacks(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:268

`Protected` `Abstract`setHtmlElements

setHtmlElements(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:269

`Protected` `Abstract`unsetCallbacks

unsetCallbacks(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:270

`Protected` `Abstract`unsetHtmlElements

unsetHtmlElements(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:271