Class AbstractPattern<C>`Abstract`

Defines the Default props and methods for OutSystemsUI Patterns

Export

Abstract

Implements

Type Parameters

C extends AbstractConfiguration

Hierarchy-Diagram

UML class diagram of AbstractPattern

Legend

icon for a class in the UML class diagram

class

icon for an abstract class in the UML class diagram

abstract class

icon for an interface in the UML class diagram

interface

icon for a public property in the UML class diagram

public property

icon for a protected property in the UML class diagram

protected property

icon for a private property in the UML class diagram

private property

icon for a public method in the UML class diagram

public method

icon for a protected method in the UML class diagram

protected method

icon for a private method in the UML class diagram

private method

italic abstract property/method

Implements

IPattern

Index

Properties

_configs _isBuilt _selfElem _uniqueId _widgetId

Constructors

Methods

_setCommonHtmlElements _unsetCommonHtmlElements finishBuild build changeProperty dispose equalsToID setA11YProperties setCallbacks setHtmlElements unsetCallbacks unsetHtmlElements

Accessors

_enableAccessibility selfElement isBuilt configs uniqueId widgetId

Properties

`Private` _configs

_configs: C

`Private` _isBuilt

_isBuilt: boolean = false

`Private` _selfElem

_selfElem: HTMLElement

`Private` _uniqueId

_uniqueId: string

`Private` _widgetId

_widgetId: string

Constructors

constructor

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

Methods

`Private` _setCommonHtmlElements

_setCommonHtmlElements(): void
Returns void
- Defined in OSFramework/Pattern/AbstractPattern.ts:30

`Private` _unsetCommonHtmlElements

_unsetCommonHtmlElements(): void
Returns void
- Defined in OSFramework/Pattern/AbstractPattern.ts:40

`Protected` finishBuild

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
- Defined in OSFramework/Pattern/AbstractPattern.ts:50

build

build(): void
Builds the pattern.

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Implementation of IPattern.build
- Defined in OSFramework/Pattern/AbstractPattern.ts:60

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

dispose

dispose(): void
Disposes the pattern.

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Implementation of IPattern.dispose
- Defined in OSFramework/Pattern/AbstractPattern.ts:102

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

`Protected` `Abstract` setA11YProperties

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

`Protected` `Abstract` setCallbacks

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

`Protected` `Abstract` setHtmlElements

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

`Protected` `Abstract` unsetCallbacks

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

`Protected` `Abstract` unsetHtmlElements

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

Accessors

`Protected` _enableAccessibility

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
- 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 IPattern.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 IPattern.isBuilt
- Defined in OSFramework/Pattern/AbstractPattern.ts:150

configs

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns C
- 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 IPattern.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 IPattern.widgetId
- Defined in OSFramework/Pattern/AbstractPattern.ts:183