Class SectionIndex

Class that implements the SectionIndex pattern.

Export

SectionIndex

Implements

Hierarchy (View Summary)

OSFramework.OSUI.Patterns.AbstractParent<SectionIndexConfig, ISectionIndexItem>
- SectionIndex

Implements

ISectionIndex

Constructors

constructor

new SectionIndex(
uniqueId: string,
configs: JSON,
): OSFramework.OSUI.Patterns.SectionIndex.SectionIndex
Parameters
- uniqueId: string
- configs: JSON
Returns OSFramework.OSUI.Patterns.SectionIndex.SectionIndex
Overrides AbstractParent.constructor
- Defined in OSFramework/OSUI/Pattern/SectionIndex/SectionIndex.ts:36

Properties

`Protected`isProviderBased

isProviderBased: boolean = false

scrollOptions

scrollOptions: ScrollIntoViewOptions = ...

Accessors

`Protected`_enableAccessibility

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

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractParent._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 ISectionIndex.selfElement

Inherited from AbstractParent.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 ISectionIndex.isBuilt

Inherited from AbstractParent.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 AbstractParent.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 ISectionIndex.uniqueId

Inherited from AbstractParent.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 ISectionIndex.widgetId

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

Methods

`Protected`getChild

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

Memberof
OSFramework.Patterns.AbstractParent
Inherited from AbstractParent.getChild
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:32

`Protected`getChildByIndex

getChildByIndex(index: number, childType?: string): ISectionIndexItem
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 ISectionIndexItem
Child Reference

Memberof
OSFramework.Patterns.AbstractParent
Inherited from AbstractParent.getChildByIndex
- 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
Inherited from AbstractParent.getChildIndex
- 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
Inherited from AbstractParent.notifyChildren
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:87

`Protected`setChild

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

Memberof
OSFramework.Patterns.AbstractParent
Inherited from AbstractParent.setChild
- 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
Inherited from AbstractParent.unsetChild
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:134

getChildItems

getChildItems(type?: string): ISectionIndexItem[]
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 ISectionIndexItem[]

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

`Protected`finishBuild

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

Returns void

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

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

Inherited from AbstractParent.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 ISectionIndex.registerCallback

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

`Protected`setA11YProperties

setA11YProperties(): void
Protected
This method has no implementation on this pattern context!

Returns void

Memberof
OSFramework.Patterns.SectionIndex.SectionIndex
Overrides AbstractParent.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/SectionIndex/SectionIndex.ts:180

`Protected`setCallbacks

setCallbacks(): void
Protected
This method has no implementation on this pattern context!

Returns void

Memberof
OSFramework.Patterns.SectionIndex.SectionIndex
Overrides AbstractParent.setCallbacks
- Defined in OSFramework/OSUI/Pattern/SectionIndex/SectionIndex.ts:190

`Protected`setHtmlElements

setHtmlElements(): void
Protected
Method to set the HTMLElements used

Returns void

Memberof
OSFramework.Patterns.SectionIndex.SectionIndex
Overrides AbstractParent.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/SectionIndex/SectionIndex.ts:200

`Protected`unsetCallbacks

unsetCallbacks(): void
Protected
This method has no implementation on this pattern context!

Returns void

Memberof
OSFramework.Patterns.SectionIndex.SectionIndex
Overrides AbstractParent.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/SectionIndex/SectionIndex.ts:226

`Protected`unsetHtmlElements

unsetHtmlElements(): void
Protected
Method to unset the HTMLElements used

Returns void

Memberof
OSFramework.Patterns.SectionIndex.SectionIndex
Overrides AbstractParent.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/SectionIndex/SectionIndex.ts:236

beNotifiedByChild

beNotifiedByChild(
childItem: OSFramework.OSUI.Patterns.SectionIndexItem.SectionIndexItem,
notifiedTo: OSFramework.OSUI.Patterns.SectionIndex.Enum.ChildNotifyActionType,
): void
Method used to be notified by a given ChildId about a given action and act accordingly
Parameters
- childItem: OSFramework.OSUI.Patterns.SectionIndexItem.SectionIndexItem
- notifiedTo: OSFramework.OSUI.Patterns.SectionIndex.Enum.ChildNotifyActionType
  {Enum.ChildNotifyActionType} triggered notification type
Returns void

Memberof
OSFramework.Patterns.SectionIndex.SectionIndex
Implementation of ISectionIndex.beNotifiedByChild

Overrides AbstractParent.beNotifiedByChild
- Defined in OSFramework/OSUI/Pattern/SectionIndex/SectionIndex.ts:247

build

build(): void
Method to build the SectionIndex.

Returns void

Memberof
OSFramework.Patterns.SectionIndex.SectionIndex
Implementation of ISectionIndex.build

Overrides AbstractParent.build
- Defined in OSFramework/OSUI/Pattern/SectionIndex/SectionIndex.ts:276

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Applies the changes of state/value of the configurations.
Parameters
- propertyName: string
- propertyValue: unknown
Returns void

Memberof
OSFramework.Patterns.SectionIndex.SectionIndex
Implementation of ISectionIndex.changeProperty

Overrides AbstractParent.changeProperty
- Defined in OSFramework/OSUI/Pattern/SectionIndex/SectionIndex.ts:297

dispose

dispose(): void
Disposes the current pattern.

Returns void

Memberof
OSFramework.Patterns.SectionIndex.SectionIndex
Implementation of ISectionIndex.dispose

Overrides AbstractParent.dispose
- Defined in OSFramework/OSUI/Pattern/SectionIndex/SectionIndex.ts:317

Class SectionIndex

Export

Implements

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OSFramework.OSUI.Patterns.SectionIndex.SectionIndex

Properties

ProtectedisProviderBased

scrollOptions

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 ISectionIndexItem

Memberof

ProtectedgetChildByIndex

Parameters

Returns ISectionIndexItem

Memberof

ProtectedgetChildIndex

Parameters

Returns number

Memberof

ProtectednotifyChildren

Parameters

Returns void

Memberof

ProtectedsetChild

Parameters

Returns void

Memberof

ProtectedunsetChild

Parameters

Returns void

Memberof

getChildItems

Parameters

Returns ISectionIndexItem[]

Memberof

ProtectedfinishBuild

Returns void

Memberof

ProtectedtriggerPlatformEventCallback

Parameters

Returns void

Memberof

ProtectedtriggerPlatformInitializedEventCallback

Returns void

Memberof

ProtectedunsetGlobalCallbacks

Returns void

Memberof

equalsToID

Parameters

`Protected`isProviderBased

`Protected`_enableAccessibility

`Protected`getChild

`Protected`getChildByIndex

`Protected`getChildIndex

`Protected`notifyChildren

`Protected`setChild

`Protected`unsetChild

`Protected`finishBuild

`Protected`triggerPlatformEventCallback

`Protected`triggerPlatformInitializedEventCallback

`Protected`unsetGlobalCallbacks

`Abstract`registerCallback

`Protected`setA11YProperties

`Protected`setCallbacks

`Protected`setHtmlElements

`Protected`unsetCallbacks

`Protected`unsetHtmlElements