Class OSUIDropdownServerSide

Defines the interface for OSFramework.Patterns.Dropdown > DropdownServerSide Pattern

Hierarchy-Diagram

UML class diagram of OSUIDropdownServerSide

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<OSUIDropdownServerSideConfig, IDropdownServerSideItem>
- OSUIDropdownServerSide

Implements

IDropdownServerSide

Index

Methods

`Protected` getChild

getChild(childId: string): IDropdownServerSideItem
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 IDropdownServerSideItem
Inherited from AbstractParent.getChild
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:32

`Protected` getChildByIndex

getChildByIndex(index: number, childType?: string): IDropdownServerSideItem
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 IDropdownServerSideItem
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: IDropdownServerSideItem): void
Protected
Method that is used to set a given child as a Parent child.

Memberof
OSFramework.Patterns.AbstractParent
Parameters
- childItem: IDropdownServerSideItem
  
  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): IDropdownServerSideItem[]
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 IDropdownServerSideItem[]
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 IDropdownServerSide.equalsToID

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

`Private` _addErrorMessage

_addErrorMessage(text: string): void
Parameters
- text: string
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:86

`Private` _close

_close(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:104

`Private` _endOfCloseAnimation

_endOfCloseAnimation(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:132

`Private` _getRecommendedPosition

_getRecommendedPosition(isIntersecting: boolean, boundingClientRect: DOMRect): void
Parameters
- isIntersecting: boolean
- boundingClientRect: DOMRect
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:154

`Private` _handleFocusTrap

_handleFocusTrap(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:189

`Private` _hasNoImplementation

_hasNoImplementation(): string
Returns string
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:200

`Private` _moveBallonElement

_moveBallonElement(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:207

`Private` _onBodyClick

_onBodyClick(_eventType: string, event: MouseEvent): void
Parameters
- _eventType: string
- event: MouseEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:212

`Private` _onKeyboardPressed

_onKeyboardPressed(event: KeyboardEvent): void
Parameters
- event: KeyboardEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:236

`Private` _onOrientationChange

_onOrientationChange(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:300

`Private` _onScreenScroll

_onScreenScroll(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:307

`Private` _onSearchInputBlur

_onSearchInputBlur(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:322

`Private` _onSearchInputClicked

_onSearchInputClicked(event: MouseEvent): void
Parameters
- event: MouseEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:327

`Private` _onSearchInputFocus

_onSearchInputFocus(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:332

`Private` _onSelectValuesWrapperClicked

_onSelectValuesWrapperClicked(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:337

`Private` _onSpanElementFocus

_onSpanElementFocus(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:345

`Private` _onTouchMove

_onTouchMove(event: TouchEvent): void
Parameters
- event: TouchEvent
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:351

`Private` _onWindowResize

_onWindowResize(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:358

`Private` _open

_open(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:370

`Private` _optionItemHasBeenClicked

_optionItemHasBeenClicked(optionItemId: string): void
Parameters
- optionItemId: string
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:398

`Private` _optionItemKeyPressed

_optionItemKeyPressed(optionItemId: string): void
Parameters
- optionItemId: string
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:426

`Private` _setBalloonCoordinates

_setBalloonCoordinates(lookAtXPosition?: boolean): void
Parameters
- lookAtXPosition: boolean = true
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:499

`Private` _setBalloonWrapperExtendedClass

_setBalloonWrapperExtendedClass(newExtendedClass: string, preExtendedClass?: string): void
Parameters
- newExtendedClass: string
- preExtendedClass: string = ''
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:550

`Private` _setCssClasses

_setCssClasses(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:556

`Private` _setInitialOptions

_setInitialOptions(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:570

`Private` _setNewOptionItem

_setNewOptionItem(optionItem: OSFramework.OSUI.Patterns.DropdownServerSideItem.DropdownServerSideItem): void
Parameters
- optionItem: OSFramework.OSUI.Patterns.DropdownServerSideItem.DropdownServerSideItem
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:577

`Private` _setObserver

_setObserver(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:590

`Private` _setUpEvents

_setUpEvents(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:612

`Private` _touchMove

_touchMove(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:678

`Private` _triggerToogleCalbackEvent

_triggerToogleCalbackEvent(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:696

`Private` _unsetEvents

_unsetEvents(isUpdate?: boolean): void
Parameters
- isUpdate: boolean = false
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:701

`Private` _unsetNewOptionItem

_unsetNewOptionItem(optionItemId: string): void
Parameters
- optionItemId: string
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:752

`Private` _unsetObserver

_unsetObserver(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:765

`Private` _updateBalloonAccessibilityElements

_updateBalloonAccessibilityElements(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:773

`Private` _updateOptionItemFocuStateOnKeyPress

_updateOptionItemFocuStateOnKeyPress(optionItem: IDropdownServerSideItem, itemIndex: number): void
Parameters
- optionItem: IDropdownServerSideItem
- itemIndex: number
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:828

`Private` _updatePatternState

_updatePatternState(): void
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:847

`Protected` setA11YProperties

setA11YProperties(): void
Protected
Add the Accessibility Attributes values

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide

Returns void
Overrides AbstractParent.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:888

`Protected` setCallbacks

setCallbacks(): void
Protected
Method to set the calbacks

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide

Returns void
Overrides AbstractParent.setCallbacks
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:919

`Protected` setHtmlElements

setHtmlElements(): void
Protected
Method to set the html elements used

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide

Returns void
Overrides AbstractParent.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:940

`Protected` unsetCallbacks

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

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide

Returns void
Overrides AbstractParent.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:999

`Protected` unsetHtmlElements

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

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide

Returns void
Overrides AbstractParent.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:1021

beNotifiedByChild

beNotifiedByChild(childItem: OSFramework.OSUI.Patterns.DropdownServerSideItem.DropdownServerSideItem, notifiedTo: OSFramework.OSUI.Patterns.Dropdown.ServerSide.Enum.ChildNotifyActionType): void
Method used to be notified by a given dropdownOptionId about a given action and act accordingly

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide
Parameters
- childItem: OSFramework.OSUI.Patterns.DropdownServerSideItem.DropdownServerSideItem
- notifiedTo: OSFramework.OSUI.Patterns.Dropdown.ServerSide.Enum.ChildNotifyActionType
  
  {Enum.ChildNotifyActionType} triggered notification type
Returns void
Implementation of IDropdownServerSide.beNotifiedByChild

Overrides AbstractParent.beNotifiedByChild
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:1044

build

build(): void
Method to build the DropdownServerSide

Memberof
OSUIDropdownServerSide

Returns void
Implementation of IDropdownServerSide.build

Overrides AbstractParent.build
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:1073

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Update property value from a given property name at OnParametersChange

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide
Parameters
- propertyName: string
  
  the name of the property that will be changed
- propertyValue: unknown
  
  the new value that should be assigned to the given property name
Returns void
Implementation of IDropdownServerSide.changeProperty

Overrides AbstractParent.changeProperty
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:1088

clear

clear(): void
Method that will check for all Selected OptionItems and Unselect them

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide

Returns void
Implementation of IDropdownServerSide.clear
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:1112

close

close(): void
Method used to close the Dropdown

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide

Returns void
Implementation of IDropdownServerSide.close
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:1127

disable

disable(): void
Set pattern with a disable status

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide

Returns void
Implementation of IDropdownServerSide.disable
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:1137

dispose

dispose(): void
Destroy the Dropdown.

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide

Returns void
Implementation of IDropdownServerSide.dispose

Overrides AbstractParent.dispose
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:1152

enable

enable(): void
Remove disable status from

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide

Returns void
Implementation of IDropdownServerSide.enable
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:1166

getSelectedValues

getSelectedValues(): string
This method has no implementation on this context.

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide

Returns string
Implementation of IDropdownServerSide.getSelectedValues
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:1181

open

open(): void
Method used to open the Dropdown

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide

Returns void
Implementation of IDropdownServerSide.open
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:1190

registerCallback

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

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide
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 IDropdownServerSide.registerCallback

Overrides AbstractParent.registerCallback
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:1202

setBalloonOptionsAriaLabel

setBalloonOptionsAriaLabel(value?: string): void
Method used to set the balloon AriaLabelText that will be applied to the balloon options container element
Parameters
- Optional value: string
  
  Text to be added
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:1220

setProviderConfigs

setProviderConfigs(): string
This method has no implementation on this context.

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide

Returns string
Implementation of IDropdownServerSide.setProviderConfigs
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:1230

setProviderEvent

setProviderEvent(): string
This method has no implementation on this context.

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide

Returns string
Implementation of IDropdownServerSide.setProviderEvent
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:1239

setSelectAriaLabel

setSelectAriaLabel(value?: string): void
Method used to set the AriaLabel text that will be applied to the SelectValuesWrapper "input" element
Parameters
- Optional value: string
  
  Text to be added
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:1248

unsetProviderEvent

unsetProviderEvent(): string
This method has no implementation on this context.

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide

Returns string
Implementation of IDropdownServerSide.unsetProviderEvent
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:1259

validation

validation(isValid: boolean, validationMessage: string): void
Set the validation status, and also pass the message to show

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide
Parameters
- isValid: boolean
- validationMessage: string
Returns void
Implementation of IDropdownServerSide.validation
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:1270

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

`Private` _activeScreenElement

_activeScreenElement: HTMLElement

`Private` _balloonContainerElement

_balloonContainerElement: HTMLElement

`Private` _balloonContentElement

_balloonContentElement: HTMLElement

`Private` _balloonFocusableElemsInFooter

_balloonFocusableElemsInFooter: HTMLElement[]

`Private` _balloonFooterElement

_balloonFooterElement: HTMLElement

`Private` _balloonOptionsAriaLabel

_balloonOptionsAriaLabel: string

`Private` _balloonOptionsWrapperElement

_balloonOptionsWrapperElement: HTMLElement

`Private` _balloonPositionClass

_balloonPositionClass: string = ''

`Private` _balloonSearchInputElement

_balloonSearchInputElement: HTMLElement

`Private` _balloonSearchInputWrapperElement

_balloonSearchInputWrapperElement: HTMLElement

`Private` _balloonWrapperElement

_balloonWrapperElement: HTMLElement

`Private` _closeDynamically

_closeDynamically: boolean = false

`Private` _eventOnBodyClick

_eventOnBodyClick: Generic

`Private` _eventOnClick

_eventOnClick: Generic

`Private` _eventOnClickInputSearch

_eventOnClickInputSearch: Generic

`Private` _eventOnCloseTransitionEnd

_eventOnCloseTransitionEnd: Generic

`Private` _eventOnOrientationChange

_eventOnOrientationChange: Generic

`Private` _eventOnScreenScroll

_eventOnScreenScroll: Generic

`Private` _eventOnSearchInputBlur

_eventOnSearchInputBlur: Generic

`Private` _eventOnSearchInputFocus

_eventOnSearchInputFocus: Generic

`Private` _eventOnSpanFocus

_eventOnSpanFocus: Generic

`Private` _eventOnTouchMove

_eventOnTouchMove: Generic

`Private` _eventOnWindowResize

_eventOnWindowResize: Generic

`Private` _eventOnkeyboardPress

_eventOnkeyboardPress: Generic

`Private` _focusTrapInstance

_focusTrapInstance: FocusTrap

`Private` _hasA11yEnabled

_hasA11yEnabled: boolean = false

`Private` _intersectionObserver

_intersectionObserver: IntersectionObserver

`Private` _isBlocked

_isBlocked: boolean = false

`Private` _isInsidePopup

_isInsidePopup: boolean

`Private` _isOpen

_isOpen: boolean = false

`Private` _platformEventOnToggleCallback

_platformEventOnToggleCallback: OSGeneric

`Private` _selectValuesWrapper

_selectValuesWrapper: HTMLElement

`Private` _selectValuesWrapperAriaLabel

_selectValuesWrapperAriaLabel: string

`Private` _selfElementBoundingClientRect

_selfElementBoundingClientRect: DOMRect = ...

`Private` _windowWidth

_windowWidth: number

Accessors

`Protected` _enableAccessibility

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Inherited from Patterns.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 IDropdownServerSide.selfElement

Inherited from Patterns.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 IDropdownServerSide.isBuilt

Inherited from Patterns.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 Patterns.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 IDropdownServerSide.uniqueId

Inherited from Patterns.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 IDropdownServerSide.widgetId

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

Constructors

constructor

new OSUIDropdownServerSide(uniqueId: string, configs: JSON): OSUIDropdownServerSide
Parameters
- uniqueId: string
- configs: JSON
Returns OSUIDropdownServerSide
Overrides AbstractParent.constructor
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:81

Class OSUIDropdownServerSide

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Methods

Properties

Accessors

Constructors

Methods

Protected getChild

Returns

Memberof

Parameters

childId: string

Returns IDropdownServerSideItem

Protected getChildByIndex

Returns

Memberof

Parameters

index: number

Optional childType: string

Returns IDropdownServerSideItem

Protected getChildIndex

Returns

Memberof

Parameters

childId: string

Returns number

Protected setChild

Memberof

Parameters

childItem: IDropdownServerSideItem

Returns void

Protected unsetChild

Memberof

Parameters

childId: string

Returns void

getChildItems

Returns

Memberof

Parameters

Optional type: string

Returns IDropdownServerSideItem[]

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 _addErrorMessage

Parameters

text: string

Returns void

Private _close

Returns void

Private _endOfCloseAnimation

Returns void

Private _getRecommendedPosition

Parameters

isIntersecting: boolean

boundingClientRect: DOMRect

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` _addErrorMessage

`Private` _close

`Private` _endOfCloseAnimation

`Private` _getRecommendedPosition

`Private` _handleFocusTrap

`Private` _hasNoImplementation

`Private` _moveBallonElement

`Private` _onBodyClick

`Private` _onKeyboardPressed

`Private` _onOrientationChange

`Private` _onScreenScroll

`Private` _onSearchInputBlur

`Private` _onSearchInputClicked

`Private` _onSearchInputFocus

`Private` _onSelectValuesWrapperClicked

`Private` _onSpanElementFocus

`Private` _onTouchMove

`Private` _onWindowResize

`Private` _open

`Private` _optionItemHasBeenClicked

`Private` _optionItemKeyPressed

`Private` _setBalloonCoordinates

`Private` _setBalloonWrapperExtendedClass

`Private` _setCssClasses

`Private` _setInitialOptions

`Private` _setNewOptionItem

`Private` _setObserver

`Private` _setUpEvents

`Private` _touchMove