Class AbstractChild<C, PT>`Abstract`

Defines the Default props and methods for Patterns that will be added into other Patterns as its childs

Export

AbstractChild

Implements

Template

Type Parameters

C extends AbstractConfiguration
PT extends IParent

Implements

IChild

Constructors

constructor

new AbstractChild<C extends AbstractConfiguration, PT extends IParent>(
uniqueId: string,
configs: C,
): OSFramework.OSUI.Patterns.AbstractChild<C, PT>
Creates an instance of AbstractPattern.
Type Parameters
- C extends AbstractConfiguration
- PT extends IParent
Parameters
- uniqueId: string
- configs: C
Returns OSFramework.OSUI.Patterns.AbstractChild<C, PT>

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

Properties

`Protected`isProviderBased

isProviderBased: boolean = false

Accessors

isFirstChild

get isFirstChild(): boolean
Getter that allows to check if it's the first child.

Returns boolean

Memberof
OSFramework.Patterns.AbstractChild
Implementation of Interface.IChild.isFirstChild
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:80

isLastChild

get isLastChild(): boolean
Getter that allows to check if it's the last child.

Returns boolean

Memberof
OSFramework.Patterns.AbstractChild
Implementation of Interface.IChild.isLastChild
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:100
set isLastChild(value: boolean): void
Setter that allows to define it's the last child.
Parameters
- value: boolean
Returns void

Memberof
OSFramework.Patterns.AbstractChild
Implementation of Interface.IChild.isLastChild
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:109

parentId

get parentId(): string
Getter that allows to obtain the parentId.

Returns string

Memberof
OSFramework.Patterns.AbstractChild
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:120

parentObject

get parentObject(): PT
Getter that allows to obtain the parent reference.

Returns PT

Memberof
OSFramework.Patterns.AbstractChild
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:131

`Protected`_enableAccessibility

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

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractPattern._enableAccessibility
- 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 IChild.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.

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IChild.isBuilt

Inherited from AbstractPattern.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
Inherited from AbstractPattern.configs
- 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 IChild.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.

Returns string

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IChild.widgetId

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

Methods

`Protected`notifyParent

notifyParent(actionType: string): void
Method used to notify parent about the action that was performed
Parameters
- actionType: string
  Action Type name (Should be based on an Enum)
Returns void

Memberof
OSFramework.Patterns.AbstractChild
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:36

`Protected`setParentInfo

setParentInfo(
    parentSelector: string,
    getPatternByIdAPI: (patternId: string) => PT,
    canBeOrphan?: boolean,
): void
Protected
Method that will Get and Set parent element info.
Parameters
- parentSelector: string
  Selector to find for parent Element
- getPatternByIdAPI: (patternId: string) => PT
  API reference method from Parent Pattern that will return the PatternById
- OptionalcanBeOrphan: boolean
  option for patterns that can work without a parent
Returns void

Memberof
OSFramework.Patterns.AbstractChild
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:49

`Protected`finishBuild

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

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
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.
Parameters
- platFormCallback: OSGeneric
- ...args: unknown[]
Returns void

Memberof
AbstractProviderPattern
Inherited from AbstractPattern.triggerPlatformEventCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:81

`Protected`triggerPlatformInitializedEventCallback

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

Returns void

Memberof
AbstractPattern
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

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractPattern.unsetGlobalCallbacks
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:107

build

build(): void
Builds the pattern.

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IChild.build

Inherited from AbstractPattern.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 IChild.changeProperty

Inherited from AbstractPattern.changeProperty
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:128

dispose

dispose(): void
Disposes the pattern.

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IChild.dispose

Inherited from AbstractPattern.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 IChild.equalsToID

Inherited from AbstractPattern.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 IChild.registerCallback

Inherited from AbstractPattern.registerCallback
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:184

Class AbstractChild<C, PT>Abstract

Export

Implements

Template

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns OSFramework.OSUI.Patterns.AbstractChild<C, PT>

Memberof

Properties

ProtectedisProviderBased

Accessors

isFirstChild

Returns boolean

Memberof

isLastChild

Returns boolean

Memberof

Parameters

Returns void

Memberof

parentId

Returns string

Memberof

parentObject

Returns PT

Memberof

Protected_enableAccessibility

Returns boolean

Memberof

selfElement

Returns HTMLElement

Memberof

isBuilt

Returns boolean

Memberof

configs

Returns C

Memberof

uniqueId

Returns string

Memberof

widgetId

Returns string

Memberof

Methods

ProtectednotifyParent

Parameters

Returns void

Memberof

ProtectedsetParentInfo

Parameters

Returns void

Memberof

ProtectedfinishBuild

Returns void

Memberof

ProtectedtriggerPlatformEventCallback

Parameters

Returns void

Memberof

ProtectedtriggerPlatformInitializedEventCallback

Returns void

Memberof

ProtectedunsetGlobalCallbacks

Returns void

Memberof

build

Returns void

Memberof

changeProperty

Class AbstractChild<C, PT>`Abstract`

`Protected`isProviderBased

`Protected`_enableAccessibility

`Protected`notifyParent

`Protected`setParentInfo

`Protected`finishBuild

`Protected`triggerPlatformEventCallback

`Protected`triggerPlatformInitializedEventCallback

`Protected`unsetGlobalCallbacks

`Abstract`registerCallback

`Protected` `Abstract`setA11YProperties

`Protected` `Abstract`setCallbacks

`Protected` `Abstract`setHtmlElements

`Protected` `Abstract`unsetCallbacks

`Protected` `Abstract`unsetHtmlElements