Class SectionIndex

Class that implements the SectionIndex pattern.

Export

Implements

Hierarchy-Diagram

Legend

class

abstract class

interface

public property

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

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

Implements

ISectionIndex

Methods

`Protected` getChild

getChild(childId: string): ISectionIndexItem
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 ISectionIndexItem
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

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

Returns
Index value

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

`Protected` setChild

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

Memberof
OSFramework.Patterns.AbstractParent
Parameters
- childItem: ISectionIndexItem
  
  Reference to be added
Returns void
Inherited from AbstractParent.setChild
- 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
Inherited from AbstractParent.unsetChild
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:121

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!

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 ISectionIndexItem[]
Inherited from AbstractParent.getChildItems
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:186

`Protected` finishBuild

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

Memberof
OSFramework.Patterns.AbstractPattern

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

Memberof
AbstractProviderPattern
Parameters
- platFormCallback: OSGeneric
- Rest ...args: unknown[]
Returns void
Inherited from AbstractParent.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 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

Memberof
OSFramework.Patterns.AbstractPattern

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

Returns
{boolean}

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

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

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

`Private` _addSectionIndexItem

_addSectionIndexItem(childItem: OSFramework.OSUI.Patterns.SectionIndexItem.SectionIndexItem): void
Parameters
- childItem: OSFramework.OSUI.Patterns.SectionIndexItem.SectionIndexItem
Returns void
- Defined in OSFramework/OSUI/Pattern/SectionIndex/SectionIndex.ts:41

`Private` _childItemHasBeenClicked

_childItemHasBeenClicked(childId: string): void
Parameters
- childId: string
Returns void
- Defined in OSFramework/OSUI/Pattern/SectionIndex/SectionIndex.ts:53

`Private` _getContentPaddingTop

_getContentPaddingTop(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/SectionIndex/SectionIndex.ts:67

`Private` _getHeaderSize

_getHeaderSize(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/SectionIndex/SectionIndex.ts:77

`Private` _removeSectionIndexItem

_removeSectionIndexItem(childId: string): void
Parameters
- childId: string
Returns void
- Defined in OSFramework/OSUI/Pattern/SectionIndex/SectionIndex.ts:88

`Protected` setA11YProperties

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

Memberof
OSFramework.Patterns.SectionIndex.SectionIndex

Returns void
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!

Memberof
OSFramework.Patterns.SectionIndex.SectionIndex

Returns void
Overrides AbstractParent.setCallbacks
- Defined in OSFramework/OSUI/Pattern/SectionIndex/SectionIndex.ts:190

`Protected` setHtmlElements

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

Memberof
OSFramework.Patterns.SectionIndex.SectionIndex

Returns void
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!

Memberof
OSFramework.Patterns.SectionIndex.SectionIndex

Returns void
Overrides AbstractParent.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/SectionIndex/SectionIndex.ts:225

`Protected` unsetHtmlElements

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

Memberof
OSFramework.Patterns.SectionIndex.SectionIndex

Returns void
Overrides AbstractParent.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/SectionIndex/SectionIndex.ts:235

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

Memberof
OSFramework.Patterns.SectionIndex.SectionIndex
Parameters
- childItem: OSFramework.OSUI.Patterns.SectionIndexItem.SectionIndexItem
- notifiedTo: OSFramework.OSUI.Patterns.SectionIndex.Enum.ChildNotifyActionType
  
  {Enum.ChildNotifyActionType} triggered notification type
Returns void
Implementation of ISectionIndex.beNotifiedByChild

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

build

build(): void
Method to build the SectionIndex.

Memberof
OSFramework.Patterns.SectionIndex.SectionIndex

Returns void
Implementation of ISectionIndex.build

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

changeProperty

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

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

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

dispose

dispose(): void
Disposes the current pattern.

Memberof
OSFramework.Patterns.SectionIndex.SectionIndex

Returns void
Implementation of ISectionIndex.dispose

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

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

`Private` _activeSectionIndexItem

_activeSectionIndexItem: ISectionIndexItem

`Private` _contentPaddingTop

_contentPaddingTop: string | number

`Private` _headerHeight

_headerHeight: number

`Private` _headerIsFixed

_headerIsFixed: boolean = true

`Private` _mainScrollContainerElement

_mainScrollContainerElement: HTMLElement

`Private` _navigateOnClick

_navigateOnClick: boolean = false

`Private` _scrollTimeout

_scrollTimeout: number

scrollOptions

scrollOptions: ScrollIntoViewOptions = ...

Accessors

`Protected` _enableAccessibility

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Inherited from AbstractParent._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 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.

Memberof
OSFramework.Patterns.AbstractPattern

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns C
Inherited from AbstractParent.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 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.

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of ISectionIndex.widgetId

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

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

Class SectionIndex

Export

Implements

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Methods

Properties

Accessors

Constructors

Methods

Protected getChild

Returns

Memberof

Parameters

childId: string

Returns ISectionIndexItem

Protected getChildByIndex

Returns

Memberof

Parameters

index: number

Optional childType: string

Returns ISectionIndexItem

Protected getChildIndex

Returns

Memberof

Parameters

childId: string

Returns number

Protected setChild

Memberof

Parameters

childItem: ISectionIndexItem

Returns void

Protected unsetChild

Memberof

Parameters

childId: string

Returns void

getChildItems

Returns

Memberof

Parameters

Optional type: string

Returns ISectionIndexItem[]

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

equalsToID

Returns

Memberof

Parameters

patternId: string

Returns boolean

registerCallback

Abstract

Memberof

Parameters

eventName: string

callback: OSGeneric

Returns void

Private _addSectionIndexItem

Parameters

childItem: OSFramework.OSUI.Patterns.SectionIndexItem.SectionIndexItem

Returns void

`Protected` getChild

`Protected` getChildByIndex

`Optional` childType: string

`Protected` getChildIndex

`Protected` setChild

`Protected` unsetChild

`Optional` type: string

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Private` _addSectionIndexItem

`Private` _childItemHasBeenClicked

`Private` _getContentPaddingTop

`Private` _getHeaderSize

`Private` _removeSectionIndexItem

`Private` _setActiveChildOnClick

`Private` _setActiveChildOnScroll

`Private` _toggleIsFixed

`Private` _updateActiveItem

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` unsetCallbacks

`Protected` unsetHtmlElements

`Protected` isProviderBased

`Private` _activeSectionIndexItem

`Private` _contentPaddingTop

`Private` _headerHeight

`Private` _headerIsFixed

`Private` _mainScrollContainerElement

`Private` _navigateOnClick

`Private` _scrollTimeout