Class DropdownServerSideItem

Class that implements the DropdownServerSideItem pattern.

Export

DropdownServerSideItem

Implements

Hierarchy (View Summary)

OSFramework.OSUI.Patterns.AbstractChild<
DropdownServerSideItemConfig,
IDropdownServerSide,
>
- DropdownServerSideItem

Implements

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

Properties

`Protected`isProviderBased

isProviderBased: boolean = false

keyboardTriggeredKey

keyboardTriggeredKey: string

Key used to trigger the notification into Dropdown parent

Memberof

OSFramework.Patterns.DropdownServerSideItem.IDropdownServerSideItem

Accessors

isFirstChild

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

Returns boolean

Memberof
OSFramework.Patterns.AbstractChild
Implementation of IDropdownServerSideItem.isFirstChild

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

isLastChild

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

Returns boolean

Memberof
OSFramework.Patterns.AbstractChild
Implementation of IDropdownServerSideItem.isLastChild

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

Memberof
OSFramework.Patterns.AbstractChild
Implementation of IDropdownServerSideItem.isLastChild

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

parentId

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

Returns string

Memberof
OSFramework.Patterns.AbstractChild
Inherited from AbstractChild.parentId
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:120

parentObject

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

Returns PT

Memberof
OSFramework.Patterns.AbstractChild
Inherited from AbstractChild.parentObject
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:131

`Protected`_enableAccessibility

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

Returns boolean

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

Returns boolean

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

Returns C

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

Returns string

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

Returns boolean

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem
Implementation of IDropdownServerSideItem.IsSelected
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:316

ItemId

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

Returns string

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem
Implementation of IDropdownServerSideItem.ItemId
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:327

Methods

`Protected`notifyParent

notifyParent(actionType: string): void
Method used to notify parent about the action that was performed
Parameters
- actionType: string
  Action Type name (Should be based on an Enum)
Returns void

Memberof
OSFramework.Patterns.AbstractChild
Inherited from AbstractChild.notifyParent
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:36

`Protected`setParentInfo

setParentInfo(
    parentSelector: string,
    getPatternByIdAPI: (patternId: string) => IDropdownServerSide,
    canBeOrphan?: boolean,
): void
Protected
Method that will Get and Set parent element info.
Parameters
- parentSelector: string
  Selector to find for parent Element
- getPatternByIdAPI: (patternId: string) => IDropdownServerSide
  API reference method from Parent Pattern that will return the PatternById
- OptionalcanBeOrphan: boolean
  option for patterns that can work without a parent
Returns void

Memberof
OSFramework.Patterns.AbstractChild
Inherited from AbstractChild.setParentInfo
- Defined in OSFramework/OSUI/Pattern/AbstractChild.ts:49

`Protected`finishBuild

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

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
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.
Parameters
- platFormCallback: OSGeneric
- ...args: unknown[]
Returns void

Memberof
AbstractProviderPattern
Inherited from AbstractChild.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 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

Returns void

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

Memberof
OSFramework.Patterns.AbstractPattern
Implementation of IDropdownServerSideItem.equalsToID

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

`Protected`setA11YProperties

setA11YProperties(): void
Protected
Add the Accessibility Attributes values

Returns void

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

Returns void

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

Returns void

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

Returns void

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

Returns void

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem
Overrides AbstractChild.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:163

build

build(): void
Method to build the DropdownServerSideItem.

Returns void

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem
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.
Parameters
- propertyName: string
- propertyValue: unknown
Returns void

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem
Implementation of IDropdownServerSideItem.changeProperty

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

dispose

dispose(): void
Disposes the current pattern.

Returns void

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem
Implementation of IDropdownServerSideItem.dispose

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

registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Method used to register the callback
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

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem
Implementation of IDropdownServerSideItem.registerCallback

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

setBlur

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

Returns void

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem
Implementation of IDropdownServerSideItem.setBlur
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:258

setFocus

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

Returns void

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem
Implementation of IDropdownServerSideItem.setFocus
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:267

setTabindex

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

Returns void

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem
Implementation of IDropdownServerSideItem.setTabindex
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:276

toggleSelected

toggleSelected(triggerCallback?: boolean): void
Method used to update the selected status
Parameters
- triggerCallback: boolean = true
  True by default, used to block the callback when needed
Returns void

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem
Implementation of IDropdownServerSideItem.toggleSelected
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:286

unsetTabindex

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

Returns void

Memberof
OSFramework.Patterns.DropdownServerSideItem.DropdownServerSideItem
Implementation of IDropdownServerSideItem.unsetTabindex
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/DropdownServerSideItem.ts:305

Class DropdownServerSideItem

Export

Implements

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OSFramework.OSUI.Patterns.DropdownServerSideItem.DropdownServerSideItem

Properties

ProtectedisProviderBased

keyboardTriggeredKey

Memberof

Accessors

isFirstChild

Returns boolean

Memberof

isLastChild

Returns boolean

Memberof

Parameters

Returns void

Memberof

parentId

Returns string

Memberof

parentObject

Returns PT

Memberof

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

IsSelected

Returns boolean

Memberof

ItemId

Returns string

Memberof

Methods

ProtectednotifyParent

Parameters

Returns void

Memberof

ProtectedsetParentInfo

Parameters

Returns void

Memberof

ProtectedfinishBuild

Returns void

Memberof

ProtectedtriggerPlatformEventCallback

Parameters

Returns void

Memberof

ProtectedtriggerPlatformInitializedEventCallback

Returns void

Memberof

ProtectedunsetGlobalCallbacks

Returns void

Memberof

`Protected`isProviderBased

`Protected`_enableAccessibility

`Protected`notifyParent

`Protected`setParentInfo

`Protected`finishBuild

`Protected`triggerPlatformEventCallback

`Protected`triggerPlatformInitializedEventCallback

`Protected`unsetGlobalCallbacks

`Protected`setA11YProperties

`Protected`setCallbacks

`Protected`setHtmlElements

`Protected`unsetCallbacks

`Protected`unsetHtmlElements