Class SectionIndexItem

Class that implements the SectionIndexItem 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.AbstractChild<SectionIndexItemConfig, ISectionIndex>
- SectionIndexItem

Implements

ISectionIndexItem

Methods

`Protected` notifyParent

notifyParent(actionType: string): void
Method used to notify parent about the action that was performed

Memberof
OSFramework.Patterns.AbstractChild
Parameters
- actionType: string
  
  Action Type name (Should be based on an Enum)
Returns void
Inherited from AbstractChild.notifyParent
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:36

`Protected` setParentInfo

setParentInfo(parentSelector: string, getPatternByIdAPI: Function, canBeOrphan?: boolean): void
Protected
Method that will Get and Set parent element info.

Memberof
OSFramework.Patterns.AbstractChild
Parameters
- parentSelector: string
  
  Selector to find for parent Element
- getPatternByIdAPI: Function
  
  API reference method from Parent Pattern that will return the PatternById
- Optional canBeOrphan: boolean
  
  option for patterns that can work without a parent
Returns void
Inherited from AbstractChild.setParentInfo
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:50

`Protected` finishBuild

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractChild.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 AbstractChild.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 AbstractChild.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 AbstractChild.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 ISectionIndexItem.equalsToID

Inherited from AbstractChild.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 ISectionIndexItem.registerCallback

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

`Private` _onKeyboardPressed

_onKeyboardPressed(event: KeyboardEvent): void
Parameters
- event: KeyboardEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/SectionIndexItem/SectionIndexItem.ts:33

`Private` _onScreenScroll

_onScreenScroll(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/SectionIndexItem/SectionIndexItem.ts:44

`Private` _onSelected

_onSelected(event: Event): void
Parameters
- event: Event
Returns void
- Defined in OSFramework/OSUI/Pattern/SectionIndexItem/SectionIndexItem.ts:72

`Protected` setA11YProperties

setA11YProperties(): void
Protected
Method to add the A11Y attributes values

Memberof
OSFramework.Patterns.SectionIndexItem.SectionIndexItem

Returns void
Overrides AbstractChild.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/SectionIndexItem/SectionIndexItem.ts:150

`Protected` setCallbacks

setCallbacks(): void
Protected
Method to set the callbacks and event listeners

Memberof
OSFramework.Patterns.SectionIndexItem.SectionIndexItem

Returns void
Overrides AbstractChild.setCallbacks
- Defined in OSFramework/OSUI/Pattern/SectionIndexItem/SectionIndexItem.ts:163

`Protected` setHtmlElements

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

Memberof
OSFramework.Patterns.SectionIndexItem.SectionIndexItem

Returns void
Overrides AbstractChild.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/SectionIndexItem/SectionIndexItem.ts:175

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Removes the listeners that were added in the code and unsets the callbacks.

Memberof
OSFramework.Patterns.SectionIndexItem.SectionIndexItem

Returns void
Overrides AbstractChild.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/SectionIndexItem/SectionIndexItem.ts:200

`Protected` unsetHtmlElements

unsetHtmlElements(): void
Protected
Method to unset the html elements used

Memberof
OSFramework.Patterns.SectionIndexItem.SectionIndexItem

Returns void
Overrides AbstractChild.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/SectionIndexItem/SectionIndexItem.ts:214

build

build(): void
Method to build the SectionIndexItem.

Memberof
OSFramework.Patterns.SectionIndexItem.SectionIndexItem

Returns void
Implementation of ISectionIndexItem.build

Overrides AbstractChild.build
- Defined in OSFramework/OSUI/Pattern/SectionIndexItem/SectionIndexItem.ts:224

changeProperty

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

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

Overrides AbstractChild.changeProperty
- Defined in OSFramework/OSUI/Pattern/SectionIndexItem/SectionIndexItem.ts:255

dispose

dispose(): void
Disposes the current pattern.

Memberof
OSFramework.Patterns.SectionIndexItem.SectionIndexItem

Returns void
Implementation of ISectionIndexItem.dispose

Overrides AbstractChild.dispose
- Defined in OSFramework/OSUI/Pattern/SectionIndexItem/SectionIndexItem.ts:274

setIsActive

setIsActive(): void
Adds active class from pattern.

Memberof
OSFramework.Patterns.SectionIndexItem.SectionIndexItem

Returns void
Implementation of ISectionIndexItem.setIsActive
- Defined in OSFramework/OSUI/Pattern/SectionIndexItem/SectionIndexItem.ts:291

setTargetScrollMargin

setTargetScrollMargin(margin: string | number): void
Set the scroll margin, that acts as scrollIntoView offset

Memberof
SectionIndexItem
Parameters
- margin: string | number
Returns void
- Defined in OSFramework/OSUI/Pattern/SectionIndexItem/SectionIndexItem.ts:304

unsetIsActive

unsetIsActive(): void
Removes active class from pattern.

Memberof
OSFramework.Patterns.SectionIndexItem.SectionIndexItem

Returns void
Implementation of ISectionIndexItem.unsetIsActive
- Defined in OSFramework/OSUI/Pattern/SectionIndexItem/SectionIndexItem.ts:314

Accessors

isFirstChild

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

Memberof
OSFramework.Patterns.AbstractChild

Returns boolean
Implementation of ISectionIndexItem.isFirstChild

Inherited from AbstractChild.isFirstChild
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:77

isLastChild

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

Memberof
OSFramework.Patterns.AbstractChild

Returns boolean
Implementation of ISectionIndexItem.isLastChild

Inherited from AbstractChild.isLastChild
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:97
set isLastChild(value: boolean): void
Setter that allows to define it's the last child.

Memberof
OSFramework.Patterns.AbstractChild
Parameters
- value: boolean
Returns void
Implementation of ISectionIndexItem.isLastChild

Inherited from AbstractChild.isLastChild
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:106

parentId

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

Memberof
OSFramework.Patterns.AbstractChild

Returns string
Inherited from AbstractChild.parentId
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:117

parentObject

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

Memberof
OSFramework.Patterns.AbstractChild

Returns PT
Inherited from AbstractChild.parentObject
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:128

`Protected` _enableAccessibility

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Inherited from AbstractChild._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 ISectionIndexItem.selfElement

Inherited from AbstractChild.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 ISectionIndexItem.isBuilt

Inherited from AbstractChild.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 AbstractChild.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 ISectionIndexItem.uniqueId

Inherited from AbstractChild.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 ISectionIndexItem.widgetId

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

IsSelected

get IsSelected(): boolean
Readable property to get the active state of the element

Memberof
OSFramework.Patterns.SectionIndexItem.SectionIndexItem

Returns boolean
Implementation of ISectionIndexItem.IsSelected
- Defined in OSFramework/OSUI/Pattern/SectionIndexItem/SectionIndexItem.ts:328

TargetElement

get TargetElement(): HTMLElement
Readable property to get targetElement object

Memberof
OSFramework.Patterns.SectionIndexItem.SectionIndexItem

Returns HTMLElement
Implementation of ISectionIndexItem.TargetElement
- Defined in OSFramework/OSUI/Pattern/SectionIndexItem/SectionIndexItem.ts:339

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

`Private` _eventOnClick

_eventOnClick: Generic

`Private` _eventOnScreenScroll

_eventOnScreenScroll: Generic

`Private` _eventOnkeyBoardPress

_eventOnkeyBoardPress: Generic

`Private` _isActive

_isActive: boolean = false

`Private` _mainScrollContainerElement

_mainScrollContainerElement: HTMLElement

`Private` _targetElement

_targetElement: HTMLElement = undefined

Constructors

constructor

new SectionIndexItem(uniqueId: string, configs: JSON): OSFramework.OSUI.Patterns.SectionIndexItem.SectionIndexItem
Parameters
- uniqueId: string
- configs: JSON
Returns OSFramework.OSUI.Patterns.SectionIndexItem.SectionIndexItem
Overrides AbstractChild.constructor
- Defined in OSFramework/OSUI/Pattern/SectionIndexItem/SectionIndexItem.ts:28

Class SectionIndexItem

Export

Implements

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Methods

Accessors

Properties

Constructors

Methods

Protected notifyParent

Memberof

Parameters

actionType: string

Returns void

Protected setParentInfo

Memberof

Parameters

parentSelector: string

getPatternByIdAPI: Function

Optional canBeOrphan: boolean

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

equalsToID

Returns

Memberof

Parameters

patternId: string

Returns boolean

registerCallback

Abstract

Memberof

Parameters

eventName: string

callback: OSGeneric

Returns void

Private _onKeyboardPressed

Parameters

event: KeyboardEvent

Returns void

Private _onScreenScroll

Returns void

Private _onSelected

Parameters

event: Event

Returns void

Private _removeEvents

Returns void

Private _setLinkAttribute

Returns void

Private _setTargetAttributes

Returns void

Private _setTargetElement

Returns void

Private _setUpEvents

Returns void

Private _unsetTargetAttributes

Returns void

Protected setA11YProperties

Memberof

Returns void

Protected setCallbacks

Memberof

`Protected` notifyParent

`Protected` setParentInfo

`Optional` canBeOrphan: boolean

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Private` _onKeyboardPressed

`Private` _onScreenScroll

`Private` _onSelected

`Private` _removeEvents

`Private` _setLinkAttribute

`Private` _setTargetAttributes

`Private` _setTargetElement

`Private` _setUpEvents

`Private` _unsetTargetAttributes

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` unsetCallbacks

`Protected` unsetHtmlElements

`Protected` _enableAccessibility