Class AbstractVirtualSelect<C>`Abstract`

Defines the interface for VirtualSelect provider based Patterns

Type Parameters

C extends AbstractVirtualSelectConfig

Hierarchy-Diagram

UML class diagram of AbstractVirtualSelect

Legend

class

abstract class

interface

public property

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractDropdown<VirtualSelect, C>
- AbstractVirtualSelect
  - OSUIVirtualSelectSearch
  - OSUIVirtualSelectTags

Implements

IVirtualSelect

Index

Methods

`Protected` finishBuild

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractDropdown.finishBuild
- Defined in OSFramework/Pattern/AbstractPattern.ts:50

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

Inherited from AbstractDropdown.equalsToID
- Defined in OSFramework/Pattern/AbstractPattern.ts:115

`Protected` redraw

redraw(): void
Protected
Method that will be responsible to redraw pattern when needed

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
Inherited from AbstractDropdown.redraw
- Defined in OSFramework/Pattern/AbstractProviderPattern.ts:92

`Protected` triggerPlatformEventInitialized

triggerPlatformEventInitialized(platFormCallback: OSGeneric): void
Trigger platform's InstanceIntializedHandler client Action

Memberof
OSFramework.Patterns.AbstractProviderPattern
Parameters
- platFormCallback: OSGeneric
Returns void
Inherited from AbstractDropdown.triggerPlatformEventInitialized
- Defined in OSFramework/Pattern/AbstractProviderPattern.ts:111

checkAddedProviderEvents

checkAddedProviderEvents(): void
Method to check for pending events to be added

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
Inherited from AbstractDropdown.checkAddedProviderEvents
- Defined in OSFramework/Pattern/AbstractProviderPattern.ts:137

checkPendingProviderEvents

checkPendingProviderEvents(): void
Method to check for saved events to be added after a destroy/init cycle

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
Inherited from AbstractDropdown.checkPendingProviderEvents
- Defined in OSFramework/Pattern/AbstractProviderPattern.ts:151

setProviderEvent

setProviderEvent(eventName: string, callback: Generic, uniqueId: string, saveEvent??: boolean): void
Method to add a provider event using extensibility

Returns
{void}

Memberof
OSFramework.Patterns.AbstractProviderPattern
Parameters
- eventName: string
- callback: Generic
- uniqueId: string
- Optional saveEvent: boolean = true
Returns void
Implementation of IVirtualSelect.setProviderEvent

Inherited from AbstractDropdown.setProviderEvent
- Defined in OSFramework/Pattern/AbstractProviderPattern.ts:181

unsetProviderEvent

unsetProviderEvent(eventId: string): void
Method to remove a provider event using extensibility

Returns
{void}

Memberof
OSFramework.Patterns.AbstractProviderPattern
Parameters
- eventId: string
Returns void
Implementation of IVirtualSelect.unsetProviderEvent

Inherited from AbstractDropdown.unsetProviderEvent
- Defined in OSFramework/Pattern/AbstractProviderPattern.ts:214

updateProviderEvents

updateProviderEvents(providerInfo: ProviderInfo): void
Method to update the provider events API instance and save/pending events

Memberof
OSFramework.Patterns.AbstractProviderPattern
Parameters
- providerInfo: ProviderInfo
Returns void
Inherited from AbstractDropdown.updateProviderEvents
- Defined in OSFramework/Pattern/AbstractProviderPattern.ts:241

`Private` _addErrorMessage

_addErrorMessage(text: string): void
Parameters
- text: string
Returns void
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:27

`Private` _manageAttributes

_manageAttributes(): void
Returns void
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:45

`Private` _manageDisableStatus

_manageDisableStatus(): void
Returns void
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:54

`Private` _onMouseUp

_onMouseUp(event: any): void
Parameters
- event: any
Returns void
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:73

`Private` _onSelectedOption

_onSelectedOption(): void
Returns void
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:78

`Private` _onWindowResize

_onWindowResize(): void
Returns void
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:88

`Private` _setElementId

_setElementId(): void
Returns void
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:95

`Private` _setUpEvents

_setUpEvents(): void
Returns void
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:101

`Private` _unsetEvents

_unsetEvents(): void
Returns void
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:120

`Protected` createProviderInstance

createProviderInstance(): void
Protected
Create the provider instance

Memberof
Providers.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:136

`Protected` setA11YProperties

setA11YProperties(): void
Protected
Method that adds the necessary attributes for A11Y purposes

Memberof
Providers.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
Overrides AbstractDropdown.setA11YProperties
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:168

`Protected` setCallbacks

setCallbacks(): void
Protected
Set the callbacks that will be assigned to the window click event

Memberof
Providers.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
Overrides AbstractDropdown.setCallbacks
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:179

`Protected` setHtmlElements

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

Memberof
Providers.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
Overrides AbstractDropdown.setHtmlElements
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:192

`Protected` unsetCallbacks

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

Memberof
Providers.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
Overrides AbstractDropdown.unsetCallbacks
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:202

`Protected` unsetHtmlElements

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

Memberof
Providers.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
Overrides AbstractDropdown.unsetHtmlElements
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:216

build

build(): void
Builds the Pattern

Memberof
Providers.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
Implementation of IVirtualSelect.build

Overrides AbstractDropdown.build
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:225

changeProperty

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

Memberof
Providers.Dropdown.VirtualSelect.AbstractVirtualSelect
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 IVirtualSelect.changeProperty

Overrides AbstractDropdown.changeProperty
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:246

clear

clear(): void
Clear any selected values from the Dropdown

Memberof
Providers.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
Implementation of IVirtualSelect.clear

Overrides AbstractDropdown.clear
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:292

close

close(): void
Method used to close the Dropdown

Memberof
Providers.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
Implementation of IVirtualSelect.close

Overrides AbstractDropdown.close
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:301

disable

disable(): void
Set Dropdown as disabled

Memberof
Providers.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
Implementation of IVirtualSelect.disable

Overrides AbstractDropdown.disable
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:310

dispose

dispose(): void
Destroy the Dropdown.

Memberof
Providers.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
Implementation of IVirtualSelect.dispose

Overrides AbstractDropdown.dispose
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:323

enable

enable(): void
Set Dropdown as enabled

Memberof
Providers.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
Implementation of IVirtualSelect.enable

Overrides AbstractDropdown.enable
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:350

getSelectedValues

getSelectedValues(): string
Get the selected values

Memberof
Providers.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns string
Implementation of IVirtualSelect.getSelectedValues

Overrides AbstractDropdown.getSelectedValues
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:363

open

open(): void
Method used to open the Dropdown

Memberof
Providers.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
Implementation of IVirtualSelect.open

Overrides AbstractDropdown.open
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:386

registerCallback

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

Memberof
Providers.Dropdown.VirtualSelect.AbstractVirtualSelect
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
Overrides AbstractDropdown.registerCallback
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:397

setHiddenInputWrapperAriaLabelVal

setHiddenInputWrapperAriaLabelVal(value?: string): void
Method used to set the Hidden Input AriaLabel text value

Memberof
Providers.Dropdown.VirtualSelect.AbstractVirtualSelect
Parameters
- Optional value: string
Returns void
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:422

setProviderConfigs

setProviderConfigs(newConfigs: VirtualSelectOpts): void
Method used to set all the extended VirtualSelect properties across the different types of instances

Memberof
Providers.Dropdown.VirtualSelect.AbstractVirtualSelect
Parameters
- newConfigs: VirtualSelectOpts
Returns void
Implementation of IVirtualSelect.setProviderConfigs

Overrides AbstractDropdown.setProviderConfigs
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:434

setValue

setValue(optionsToSelect: DropDownOption[], silentOnChangedEvent?: boolean): void
Method used to set the Dropdown options values dynamically

Memberof
Providers.Dropdown.VirtualSelect.AbstractVirtualSelect
Parameters
- optionsToSelect: DropDownOption[]
  
  List of options to bet set
- silentOnChangedEvent: boolean = true
  
  If True, OnChange event will not be triggered
Returns void
Implementation of IVirtualSelect.setValue
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:446

togglePopup

togglePopup(isEnabled: boolean): void
Toggle the dropbox as popup on small screen like mobile

Memberof
Providers.Dropdown.VirtualSelect.AbstractVirtualSelect
Parameters
- isEnabled: boolean
Returns void
Implementation of IVirtualSelect.togglePopup
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:464

validation

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

Memberof
Providers.Dropdown.VirtualSelect.AbstractVirtualSelect
Parameters
- isValid: boolean
- validationMessage: string
Returns void
Implementation of IVirtualSelect.validation

Overrides AbstractDropdown.validation
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:478

`Protected` `Abstract` getSelectedOptionsStructure

getSelectedOptionsStructure(): DropDownOption[]
Returns DropDownOption[]
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:498

`Protected` `Abstract` prepareConfigs

prepareConfigs(): void
Returns void
Overrides AbstractDropdown.prepareConfigs
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:499

Accessors

`Protected` _enableAccessibility

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Inherited from OSFramework.Patterns.Dropdown.AbstractDropdown._enableAccessibility
- Defined in OSFramework/Pattern/AbstractPattern.ts:128

selfElement

get selfElement(): HTMLElement
Getter that allows to obtain the self element.

Memberof
OSFramework.Patterns.AbstractPattern

Returns HTMLElement
Implementation of IVirtualSelect.selfElement

Inherited from OSFramework.Patterns.Dropdown.AbstractDropdown.selfElement
- Defined in OSFramework/Pattern/AbstractPattern.ts:139

isBuilt

get isBuilt(): boolean
Getter that tells if the pattern is already built.

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Implementation of IVirtualSelect.isBuilt

Inherited from OSFramework.Patterns.Dropdown.AbstractDropdown.isBuilt
- Defined in OSFramework/Pattern/AbstractPattern.ts:150

configs

get configs(): C
Current configurations/state of the pattern.

Memberof
OSFramework.Patterns.AbstractPattern

Returns C
Inherited from OSFramework.Patterns.Dropdown.AbstractDropdown.configs
- Defined in OSFramework/Pattern/AbstractPattern.ts:161

uniqueId

get uniqueId(): string
Unique id of the pattern. Internal use only.

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of IVirtualSelect.uniqueId

Inherited from OSFramework.Patterns.Dropdown.AbstractDropdown.uniqueId
- Defined in OSFramework/Pattern/AbstractPattern.ts:172

widgetId

get widgetId(): string
Id of the pattern known by the developer. External use only.

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of IVirtualSelect.widgetId

Inherited from OSFramework.Patterns.Dropdown.AbstractDropdown.widgetId
- Defined in OSFramework/Pattern/AbstractPattern.ts:183

providerInfo

get providerInfo(): ProviderInfo
ProviderInfo getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns ProviderInfo
Inherited from OSFramework.Patterns.Dropdown.AbstractDropdown.providerInfo
- Defined in OSFramework/Pattern/AbstractProviderPattern.ts:264

provider

get provider(): P
Provider getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns P
Inherited from OSFramework.Patterns.Dropdown.AbstractDropdown.provider
- Defined in OSFramework/Pattern/AbstractProviderPattern.ts:293

Properties

`Protected` _provider

_provider: any

`Protected` _providerInfo

_providerInfo: ProviderInfo

`Protected` providerEventsManagerInstance

providerEventsManagerInstance: IProviderEventManager

`Private` _eventOnWindowResize

_eventOnWindowResize: Generic

`Private` _onMouseUpEvent

_onMouseUpEvent: Generic

`Private` _onSelectedOptionEvent

_onSelectedOptionEvent: Generic

`Private` _platformEventInitializedCallback

_platformEventInitializedCallback: OSGeneric

`Private` _platformEventSelectedOptCallback

_platformEventSelectedOptCallback: OSFramework.Patterns.Dropdown.Callbacks.OSOnSelectEvent

`Protected` _hiddenInputWrapperAriaLabelVal

_hiddenInputWrapperAriaLabelVal: string

`Protected` _virtualselectConfigs

_virtualselectConfigs: VirtualSelectMethods

`Protected` _virtualselectOpts

_virtualselectOpts: VirtualSelectOpts

Constructors

constructor

new AbstractVirtualSelect<C>(uniqueId: string, configs: C): AbstractVirtualSelect<C>
Type Parameters
- C extends AbstractVirtualSelectConfig<C>
Parameters
- uniqueId: string
- configs: C
Returns AbstractVirtualSelect<C>
Overrides AbstractDropdown.constructor
- Defined in Providers/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:22

Class AbstractVirtualSelect<C>Abstract

Type Parameters

C extends AbstractVirtualSelectConfig

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Methods

Accessors

Properties

Constructors

Methods

Protected finishBuild

Memberof

Returns void

equalsToID

Returns

Memberof

Parameters

patternId: string

Returns boolean

Protected redraw

Memberof

Returns void

Protected triggerPlatformEventInitialized

Memberof

Parameters

platFormCallback: OSGeneric

Returns void

checkAddedProviderEvents

Memberof

Returns void

checkPendingProviderEvents

Memberof

Returns void

setProviderEvent

Returns

Memberof

Parameters

eventName: string

callback: Generic

uniqueId: string

Optional saveEvent: boolean = true

Returns void

unsetProviderEvent

Returns

Memberof

Parameters

eventId: string

Returns void

updateProviderEvents

Memberof

Parameters

providerInfo: ProviderInfo

Returns void

Private _addErrorMessage

Parameters

text: string

Returns void

Private _manageAttributes

Returns void

Private _manageDisableStatus

Returns void

Private _onMouseUp

Parameters

event: any

Returns void

Private _onSelectedOption

Returns void

Private _onWindowResize

Returns void

Private _setElementId

Returns void

Private _setUpEvents

Returns void

Private _unsetEvents

Returns void

Protected createProviderInstance

Memberof

Class AbstractVirtualSelect<C>`Abstract`

`Protected` finishBuild

`Protected` redraw

`Protected` triggerPlatformEventInitialized

`Optional` saveEvent: boolean = true

`Private` _addErrorMessage

`Private` _manageAttributes

`Private` _manageDisableStatus

`Private` _onMouseUp

`Private` _onSelectedOption

`Private` _onWindowResize

`Private` _setElementId

`Private` _setUpEvents

`Private` _unsetEvents

`Protected` createProviderInstance

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` unsetCallbacks

`Protected` unsetHtmlElements

`Optional` value: string