Class DropdownServerSideItem

Class that implements the DropdownServerSideItem pattern.

Export

Implements

Hierarchy-Diagram

UML class diagram of DropdownServerSideItem

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<DropdownServerSideItemConfig, IDropdownServerSide>
- DropdownServerSideItem

Implements

IDropdownServerSideItem

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

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

`Private` _onKeyboardPressed

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

`Private` _onSelected

_onSelected(event: MouseEvent | KeyboardEvent): void
Parameters
- event: MouseEvent | KeyboardEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:71

`Private` _removeEvents

_removeEvents(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:83

`Private` _setUpEvents

_setUpEvents(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:89

`Private` _updateSelectedStatus

_updateSelectedStatus(status: boolean): void
Parameters
- status: boolean
Returns void
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:95

`Protected` setA11YProperties

setA11YProperties(): void
Protected
Add the Accessibility Attributes values

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem

Returns void
Overrides AbstractChild.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:115

`Protected` setCallbacks

setCallbacks(): void
Protected
Sets the callbacks to be used with the provider.

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem

Returns void
Overrides AbstractChild.setCallbacks
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:130

`Protected` setHtmlElements

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

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem

Returns void
Overrides AbstractChild.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:141

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
Unset callbacks that has been assigned to the element

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem

Returns void
Overrides AbstractChild.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:151

`Protected` unsetHtmlElements

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

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem

Returns void
Overrides AbstractChild.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:163

build

build(): void
Method to build the DropdownServerSideItem.

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem

Returns void
Implementation of IDropdownServerSideItem.build

Overrides AbstractChild.build
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:172

changeProperty

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

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

Overrides AbstractChild.changeProperty
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:201

dispose

dispose(): void
Disposes the current pattern.

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem

Returns void
Implementation of IDropdownServerSideItem.dispose

Overrides AbstractChild.dispose
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:218

registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Method used to register the callback

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem
Parameters
- eventName: string
  
  Event name that will be assigned
- callback: OSGeneric
  
  Function name that will be passed as a callback function to the event above
Returns void
Implementation of IDropdownServerSideItem.registerCallback

Overrides AbstractChild.registerCallback
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:238

setBlur

setBlur(): void
Method used to set item as blur state

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem

Returns void
Implementation of IDropdownServerSideItem.setBlur
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:255

setFocus

setFocus(): void
Method used to set item as focus state

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem

Returns void
Implementation of IDropdownServerSideItem.setFocus
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:264

setTabindex

setTabindex(): void
Method used to set the tabindex attribute

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem

Returns void
Implementation of IDropdownServerSideItem.setTabindex
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:273

toggleSelected

toggleSelected(triggerCallback?: boolean): void
Method used to update the selected status

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem
Parameters
- triggerCallback: boolean = true
  
  True by default, used to block the callback when needed
Returns void
Implementation of IDropdownServerSideItem.toggleSelected
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:283

unsetTabindex

unsetTabindex(): void
Method used to unset the tabindex attribute

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem

Returns void
Implementation of IDropdownServerSideItem.unsetTabindex
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:298

Accessors

isFirstChild

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

Memberof
OSFramework.Patterns.AbstractChild

Returns boolean
Implementation of IDropdownServerSideItem.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 IDropdownServerSideItem.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 IDropdownServerSideItem.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 IDropdownServerSideItem.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 IDropdownServerSideItem.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 IDropdownServerSideItem.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 IDropdownServerSideItem.widgetId

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

IsSelected

get IsSelected(): boolean
Getter that allows to obtain the IsSelectd status value.

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem

Returns boolean
Implementation of IDropdownServerSideItem.IsSelected
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:309

ItemId

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

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem

Returns string
Implementation of IDropdownServerSideItem.ItemId
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:320

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

`Private` _eventOnClick

_eventOnClick: Generic

`Private` _eventOnkeyboardPress

_eventOnkeyboardPress: Generic

`Private` _platformEventOnClickCallback

_platformEventOnClickCallback: OSFramework.OSUI.Patterns.DropdownServerSideItem.Callbacks.OSOnSelectEvent

keyboardTriggeredKey

keyboardTriggeredKey: string

Key used to trigger the notification into Dropdown parent

Memberof

OSFramework.Patterns.DropdownServerSideItem.IDropdownServerSideItem

Constructors

constructor

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

Class DropdownServerSideItem

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

Private _onKeyboardPressed

Parameters

event: KeyboardEvent

Returns void

Private _onSelected

Parameters

event: MouseEvent | KeyboardEvent

Returns void

Private _removeEvents

Returns void

Private _setUpEvents

Returns void

Private _updateSelectedStatus

Parameters

status: boolean

Returns void

Protected setA11YProperties

Memberof

Returns void

Protected setCallbacks

Memberof

Returns void

Protected setHtmlElements

Memberof

Returns void

Protected unsetCallbacks

Memberof

Returns void

Protected unsetHtmlElements

Memberof

Returns void

build

Memberof

Returns void

`Protected` notifyParent

`Protected` setParentInfo

`Optional` canBeOrphan: boolean

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Private` _onKeyboardPressed

`Private` _onSelected

`Private` _removeEvents

`Private` _setUpEvents

`Private` _updateSelectedStatus

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` unsetCallbacks

`Protected` unsetHtmlElements

`Protected` _enableAccessibility