Class OSUIVirtualSelectSearch

Defines the interface for VirtualSelect provider based Patterns

Hierarchy-Diagram

UML class diagram of OSUIVirtualSelectSearch

Legend

class

abstract class

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractVirtualSelect<VirtualSelectSearchConfig>
- OSUIVirtualSelectSearch

Properties

`Protected` isProviderBased

isProviderBased: boolean = false

`Protected` providerEventsManagerInstance

providerEventsManagerInstance: IProviderEventManager

`Protected` hiddenInputWrapperAriaLabelVal

hiddenInputWrapperAriaLabelVal: string

`Protected` virtualselectConfigs

virtualselectConfigs: VirtualSelectMethods

`Protected` virtualselectOpts

virtualselectOpts: VirtualSelectOpts

Methods

`Protected` finishBuild

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractVirtualSelect.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 AbstractVirtualSelect.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 AbstractVirtualSelect.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 AbstractVirtualSelect.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
Inherited from AbstractVirtualSelect.equalsToID
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:172

`Protected` redraw

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

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
Inherited from AbstractVirtualSelect.redraw
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:107

checkAddedProviderEvents

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

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns void
Inherited from AbstractVirtualSelect.checkAddedProviderEvents
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:156

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 AbstractVirtualSelect.checkPendingProviderEvents
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:170

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
Inherited from AbstractVirtualSelect.setProviderEvent
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:235

unsetProviderEvent

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

Returns
{void}

Memberof
OSFramework.Patterns.AbstractProviderPattern
Parameters
- eventId: string
Returns void
Inherited from AbstractVirtualSelect.unsetProviderEvent
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:268

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 AbstractVirtualSelect.updateProviderEvents
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:295

`Protected` createProviderInstance

createProviderInstance(): void
Protected
Create the provider instance

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
Inherited from AbstractVirtualSelect.createProviderInstance
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:133

`Protected` setA11YProperties

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

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
Inherited from AbstractVirtualSelect.setA11YProperties
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:187

`Protected` setCallbacks

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

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
Inherited from AbstractVirtualSelect.setCallbacks
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:198

`Protected` setHtmlElements

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

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
Inherited from AbstractVirtualSelect.setHtmlElements
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:212

`Protected` unsetCallbacks

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

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
Inherited from AbstractVirtualSelect.unsetCallbacks
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:222

`Protected` unsetHtmlElements

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

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
Inherited from AbstractVirtualSelect.unsetHtmlElements
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:238

build

build(): void
Builds the Pattern

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
Inherited from AbstractVirtualSelect.build
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:247

clear

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

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
Inherited from AbstractVirtualSelect.clear
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:305

close

close(): void
Method used to close the Dropdown if is opened

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
Inherited from AbstractVirtualSelect.close
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:314

disable

disable(): void
Set Dropdown as disabled

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
Inherited from AbstractVirtualSelect.disable
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:328

dispose

dispose(): void
Destroy the Dropdown.

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
Inherited from AbstractVirtualSelect.dispose
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:340

enable

enable(): void
Set Dropdown as enabled

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
Inherited from AbstractVirtualSelect.enable
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:367

getSelectedValues

getSelectedValues(): string
Get the selected values

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns string
Inherited from AbstractVirtualSelect.getSelectedValues
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:379

open

open(): void
Method used to open the Dropdown

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect

Returns void
Inherited from AbstractVirtualSelect.open
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:402

registerCallback

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

Memberof
Providers.OSUI.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
Inherited from AbstractVirtualSelect.registerCallback
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:414

setHiddenInputWrapperAriaLabelVal

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

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect
Parameters
- Optional value: string
Returns void
Inherited from AbstractVirtualSelect.setHiddenInputWrapperAriaLabelVal
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:434

setProviderConfigs

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

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect
Parameters
- newConfigs: VirtualSelectOpts
Returns void
Inherited from AbstractVirtualSelect.setProviderConfigs
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:446

setValue

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

Memberof
Providers.OSUI.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
Inherited from AbstractVirtualSelect.setValue
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:459

togglePopup

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

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect
Parameters
- isEnabled: boolean
Returns void
Inherited from AbstractVirtualSelect.togglePopup
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:480

validation

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

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect
Parameters
- isValid: boolean
- validationMessage: string
Returns void
Inherited from AbstractVirtualSelect.validation
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:494

`Protected` getSelectedOptionsStructure

getSelectedOptionsStructure(): DropDownOption[]
Protected
Get the selected values options that will be used to pass into platform as a JSON string

Returns
{DropDownOption[]}

Memberof
Providers.OSUI.Dropdown.VirtualSelect.Search.OSUIVirtualSelectSearch

Returns DropDownOption[]
Overrides AbstractVirtualSelect.getSelectedOptionsStructure
- Defined in Providers/OSUI/Dropdown/VirtualSelect/Search/VirtualSelectSearch.ts:21

`Protected` prepareConfigs

prepareConfigs(): void
Protected
Method that will set the provider configurations in order to properly create its instance

Memberof
Providers.OSUI.Dropdown.VirtualSelect.Search.OSUIVirtualSelectSearch

Returns void
Overrides AbstractVirtualSelect.prepareConfigs
- Defined in Providers/OSUI/Dropdown/VirtualSelect/Search/VirtualSelectSearch.ts:45

changeProperty

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

Memberof
Providers.OSUI.Dropdown.VirtualSelect.Search.OSUIVirtualSelectSearch
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
Overrides AbstractVirtualSelect.changeProperty
- Defined in Providers/OSUI/Dropdown/VirtualSelect/Search/VirtualSelectSearch.ts:60

Accessors

`Protected` _enableAccessibility

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Inherited from AbstractVirtualSelect._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
Inherited from AbstractVirtualSelect.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
Inherited from AbstractVirtualSelect.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 AbstractVirtualSelect.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
Inherited from AbstractVirtualSelect.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
Inherited from AbstractVirtualSelect.widgetId
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:262

providerInfo

get providerInfo(): ProviderInfo
ProviderInfo getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns ProviderInfo
Inherited from AbstractVirtualSelect.providerInfo
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:318

provider

get provider(): P
Provider getter

Memberof
OSFramework.Patterns.AbstractProviderPattern

Returns P
Inherited from AbstractVirtualSelect.provider
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:347

Constructors

constructor

new OSUIVirtualSelectSearch(uniqueId: string, configs: JSON): OSUIVirtualSelectSearch
Parameters
- uniqueId: string
- configs: JSON
Returns OSUIVirtualSelectSearch
Overrides AbstractVirtualSelect.constructor
- Defined in Providers/OSUI/Dropdown/VirtualSelect/Search/VirtualSelectSearch.ts:5

Class OSUIVirtualSelectSearch

Hierarchy-Diagram

Legend

Hierarchy

Index

Properties

Methods

Accessors

Constructors

Properties

Protected isProviderBased

Protected providerEventsManagerInstance

Protected hiddenInputWrapperAriaLabelVal

Protected virtualselectConfigs

Protected virtualselectOpts

Methods

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

Protected redraw

Memberof

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

Protected createProviderInstance

Memberof

Returns void

Protected setA11YProperties

Memberof

Returns void

Protected setCallbacks

Memberof

Returns void

Protected setHtmlElements

Memberof

Returns void

Protected unsetCallbacks

Memberof

`Protected` isProviderBased

`Protected` providerEventsManagerInstance

`Protected` hiddenInputWrapperAriaLabelVal

`Protected` virtualselectConfigs

`Protected` virtualselectOpts

`Protected` finishBuild

`Protected` triggerPlatformEventCallback

`Rest` ...args: unknown[]

`Protected` triggerPlatformInitializedEventCallback

`Protected` unsetGlobalCallbacks

`Protected` redraw

`Optional` saveEvent: boolean = true

`Protected` createProviderInstance

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` unsetCallbacks

`Protected` unsetHtmlElements

`Optional` value: string

`Protected` getSelectedOptionsStructure

`Protected` prepareConfigs