Class AbstractParent<C, CT>`Abstract`

Defines the Default props and methods for Patterns that will have other Patterns as its childs

Export

Abstract

Implements

Template

Type Parameters

C extends AbstractConfiguration
CT extends IChild

Hierarchy-Diagram

Legend

class

abstract class

interface

public property

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractPattern<C>
- AbstractParent

Implements

IParent

Properties

`Private` _childIdsByType

_childIdsByType: Map<string, string> = ...

`Private` _childItemsByType

_childItemsByType: {} = {}

Type declaration

`Protected` isProviderBased

isProviderBased: boolean = false

Methods

`Protected` getChild

getChild(childId: string): CT
Protected
Get the child reference based on given Id

Returns
Child Reference

Memberof
OSFramework.Patterns.AbstractParent
Parameters
- childId: string
  
  Child Id of the element to be found
Returns CT
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:32

`Protected` getChildByIndex

getChildByIndex(index: number, childType?: string): CT
Protected
Get a child reference by a given Index position

Returns
Child Reference

Memberof
OSFramework.Patterns.AbstractParent
Parameters
- index: number
  
  Index of the item to be returned
- Optional childType: string
  
  To be based on childType childs collection, otherwise will assume parent only contains one child type!
Returns CT
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:53

`Protected` getChildIndex

getChildIndex(childId: string): number
Protected
Get a child index from a given child Id

Returns
Index value

Memberof
OSFramework.Patterns.AbstractParent
Parameters
- childId: string
  
  Child id where index will be found
Returns number
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:72

`Protected` setChild

setChild(childItem: CT): void
Protected
Method that is used to set a given child as a Parent child.

Memberof
OSFramework.Patterns.AbstractParent
Parameters
- childItem: CT
  
  Reference to be added
Returns void
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:89

`Protected` unsetChild

unsetChild(childId: string): void
Protected
Method that will remove Child by given Id

Memberof
OSFramework.Patterns.AbstractParent
Parameters
- childId: string
  
  Id of the item that will be removed
Returns void
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:121

getChildItems

getChildItems(type?: string): CT[]
Getter that allows to obtain all the childs when parent only contains childs of one type, otherwise a type must be passed in order to return all child of the given type!

Returns

Memberof
OSFramework.Patterns.AbstractParent
Parameters
- Optional type: string
  
  To be based on childType childs collection, otherwise will assume parent only contains one child type!
Returns CT[]
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:186

`Abstract` beNotifiedByChild

beNotifiedByChild(childItem: CT, notifiedTo: string): void
Method used to be notified by a given ChildId about a given action and act accordingly

Abstract

Memberof
OSFramework.Patterns.AbstractParent
Parameters
- childItem: CT
  
  Child Item
- notifiedTo: string
  
  Notification name (Should be based on an Enum)
Returns void
Implementation of IParent.beNotifiedByChild
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:205

`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

build

build(): void
Builds the pattern.

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Implementation of IParent.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.

Memberof
OSFramework.Patterns.AbstractPattern
Parameters
- propertyName: string
- propertyValue: unknown
Returns void
Implementation of IParent.changeProperty

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

dispose

dispose(): void
Disposes the pattern.

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Implementation of IParent.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.

Returns
{boolean}

Memberof
OSFramework.Patterns.AbstractPattern
Parameters
- patternId: string
Returns boolean
Implementation of IParent.equalsToID

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

registerCallback

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

Abstract

Memberof
OSFramework.Patterns.AbstractPattern
Parameters
- eventName: string
- callback: OSGeneric
Returns void
Implementation of IParent.registerCallback

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

Constructors

constructor

new AbstractParent<C, CT>(uniqueId: string, configs: C): OSFramework.OSUI.Patterns.AbstractParent<C, CT>
Creates an instance of AbstractPattern.

Memberof
OSFramework.Patterns.AbstractPattern
Type Parameters
- C extends AbstractConfiguration<C>
- CT extends IChild
Parameters
- uniqueId: string
- configs: C
Returns OSFramework.OSUI.Patterns.AbstractParent<C, CT>
Inherited from AbstractPattern.constructor
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:35

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

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

Class AbstractParent<C, CT>Abstract

Export

Abstract

Implements

Template

Type Parameters

C extends AbstractConfiguration

CT extends IChild

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Properties

Methods

Constructors

Accessors

Properties

Private _childIdsByType

Private _childItemsByType

Type declaration

Protected isProviderBased

Methods

Protected getChild

Returns

Memberof

Parameters

childId: string

Returns CT

Protected getChildByIndex

Returns

Memberof

Parameters

index: number

Optional childType: string

Returns CT

Protected getChildIndex

Returns

Memberof

Parameters

childId: string

Returns number

Protected setChild

Memberof

Parameters

childItem: CT

Returns void

Protected unsetChild

Memberof

Parameters

childId: string

Returns void

getChildItems

Returns

Memberof

Parameters

Optional type: string

Returns CT[]

Abstract beNotifiedByChild

Abstract

Memberof

Parameters

childItem: CT

notifiedTo: string

Returns void

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

Class AbstractParent<C, CT>`Abstract`

`Private` _childIdsByType

`Private` _childItemsByType

`Protected` isProviderBased

`Protected` getChild

`Protected` getChildByIndex

`Optional` childType: string

`Protected` getChildIndex

`Protected` setChild

`Protected` unsetChild

`Optional` type: string

`Abstract` beNotifiedByChild

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Protected` `Abstract` setA11YProperties

`Protected` `Abstract` setCallbacks

`Protected` `Abstract` setHtmlElements

`Protected` `Abstract` unsetCallbacks

`Protected` `Abstract` unsetHtmlElements

`Protected` _enableAccessibility