Class AbstractParent<C, CT>`Abstract`

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

Export

AbstractParent

Implements

Template

Type Parameters

C extends AbstractConfiguration
CT extends IChild

Hierarchy (View Summary)

Implements

IParent

Constructors

constructor

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

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

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
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.

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

Returns string

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IParent.widgetId

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

Methods

`Protected`getChild

getChild(childId: string): CT
Protected
Get the child reference based on given Id
Parameters
- childId: string
  Child Id of the element to be found
Returns CT
Child Reference

Memberof
OSFramework.Patterns.AbstractParent
- 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
Parameters
- index: number
  Index of the item to be returned
- OptionalchildType: string
  To be based on childType childs collection, otherwise will assume parent only contains one child type!
Returns CT
Child Reference

Memberof
OSFramework.Patterns.AbstractParent
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:53

`Protected`getChildIndex

getChildIndex(childId: string): number
Protected
Get a child index from a given child Id
Parameters
- childId: string
  Child id where index will be found
Returns number
Index value

Memberof
OSFramework.Patterns.AbstractParent
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:72

`Protected`notifyChildren

notifyChildren(notificationType: string): void
Method used to notify all children about a given notification type
Parameters
- notificationType: string
  Notification type
Returns void

Memberof
OSFramework.Patterns.AbstractParent
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:87

`Protected`setChild

setChild(childItem: CT): void
Protected
Method that is used to set a given child as a Parent child.
Parameters
- childItem: CT
  Reference to be added
Returns void

Memberof
OSFramework.Patterns.AbstractParent
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:102

`Protected`unsetChild

unsetChild(childId: string): void
Protected
Method that will remove Child by given Id
Parameters
- childId: string
  Id of the item that will be removed
Returns void

Memberof
OSFramework.Patterns.AbstractParent
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:134

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!
Parameters
- Optionaltype: string
  To be based on childType childs collection, otherwise will assume parent only contains one child type!
Returns CT[]

Memberof
OSFramework.Patterns.AbstractParent
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:199

`Abstract`beNotifiedByChild

beNotifiedByChild(childItem: CT, notifiedTo: string): void
Method used to be notified by a given ChildId about a given action and act accordingly
Parameters
- childItem: CT
  Child Item
- notifiedTo: string
  Notification name (Should be based on an Enum)
Returns void

Memberof
OSFramework.Patterns.AbstractParent
Implementation of IParent.beNotifiedByChild
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:218

`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 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.
Parameters
- propertyName: string
- propertyValue: unknown
Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IParent.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 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.
Parameters
- patternId: string
Returns boolean
{boolean}

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IParent.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 IParent.registerCallback

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

Class AbstractParent<C, CT>Abstract

Export

Implements

Template

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns OSFramework.OSUI.Patterns.AbstractParent<C, CT>

Memberof

Properties

ProtectedisProviderBased

Accessors

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

ProtectedgetChild

Parameters

Returns CT

Memberof

ProtectedgetChildByIndex

Parameters

Returns CT

Memberof

ProtectedgetChildIndex

Parameters

Returns number

Memberof

ProtectednotifyChildren

Parameters

Returns void

Memberof

ProtectedsetChild

Parameters

Returns void

Memberof

ProtectedunsetChild

Parameters

Returns void

Memberof

getChildItems

Parameters

Returns CT[]

Memberof

AbstractbeNotifiedByChild

Parameters

Returns void

Memberof

ProtectedfinishBuild

Returns void

Memberof

ProtectedtriggerPlatformEventCallback

Parameters

Returns void

Memberof

ProtectedtriggerPlatformInitializedEventCallback

Class AbstractParent<C, CT>`Abstract`

`Protected`isProviderBased

`Protected`_enableAccessibility

`Protected`getChild

`Protected`getChildByIndex

`Protected`getChildIndex

`Protected`notifyChildren

`Protected`setChild

`Protected`unsetChild

`Abstract`beNotifiedByChild

`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