Class OSUIVirtualSelectSearch

Defines the interface for VirtualSelect provider based Patterns

Hierarchy (View Summary)

AbstractVirtualSelect<VirtualSelectSearchConfig>
- OSUIVirtualSelectSearch

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

Properties

`Protected`isProviderBased

isProviderBased: boolean = false

`Protected`providerEventsManagerInstance

providerEventsManagerInstance: IProviderEventManager

`Protected`virtualselectConfigs

virtualselectConfigs: VirtualSelectMethods

`Protected`virtualselectOpts

virtualselectOpts: VirtualSelectOpts

Accessors

`Protected`_enableAccessibility

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

Returns boolean

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

Returns boolean

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

Returns string

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

providerInfo

get providerInfo(): ProviderInfo
ProviderInfo getter

Returns ProviderInfo

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from AbstractVirtualSelect.providerInfo
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:345

provider

get provider(): P
Provider getter

Returns P

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from AbstractVirtualSelect.provider
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:374

Methods

`Protected`finishBuild

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

Returns void

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

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

Returns void

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

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

Returns void

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from AbstractVirtualSelect.redraw
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:132

checkAddedProviderEvents

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

Returns void

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from AbstractVirtualSelect.checkAddedProviderEvents
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:181

checkPendingProviderEvents

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

Returns void

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from AbstractVirtualSelect.checkPendingProviderEvents
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:195

setProviderEvent

setProviderEvent(
    eventName: string,
    callback: Generic,
    uniqueId: string,
    saveEvent?: boolean,
): void
Method to add a provider event using extensibility
Parameters
- eventName: string
- callback: Generic
- uniqueId: string
- OptionalsaveEvent: boolean = true
Returns void
{void}

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from AbstractVirtualSelect.setProviderEvent
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:262

unsetProviderEvent

unsetProviderEvent(eventId: string): void
Method to remove a provider event using extensibility
Parameters
- eventId: string
Returns void
{void}

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from AbstractVirtualSelect.unsetProviderEvent
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:295

updateProviderEvents

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

Memberof
OSFramework.Patterns.AbstractProviderPattern
Inherited from AbstractVirtualSelect.updateProviderEvents
- Defined in OSFramework/OSUI/Pattern/AbstractProviderPattern.ts:322

`Protected`createProviderInstance

createProviderInstance(): void
Protected
Create the provider instance

Returns void

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect
Inherited from AbstractVirtualSelect.createProviderInstance
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:137

`Protected`prepareConfigs

prepareConfigs(): void
Protected
Syncs selection from the live provider into AbstractVirtualSelectConfig.StartingSelection, then builds provider options and creates the instance.

Returns void

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect
Inherited from AbstractVirtualSelect.prepareConfigs
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:196

`Protected`setA11YProperties

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

Returns void

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect
Inherited from AbstractVirtualSelect.setA11YProperties
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:215

`Protected`setCallbacks

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

Returns void

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect
Inherited from AbstractVirtualSelect.setCallbacks
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:225

`Protected`setHtmlElements

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

Returns void

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect
Inherited from AbstractVirtualSelect.setHtmlElements
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:239

`Protected`unsetCallbacks

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

Returns void

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect
Inherited from AbstractVirtualSelect.unsetCallbacks
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:249

`Protected`unsetHtmlElements

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

Returns void

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect
Inherited from AbstractVirtualSelect.unsetHtmlElements
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:265

build

build(): void
Builds the Pattern

Returns void

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect
Inherited from AbstractVirtualSelect.build
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:274

clear

clear(silentOnChangedEvent?: boolean): void
Clear any selected values from the Dropdown
Parameters
- silentOnChangedEvent: boolean = true
  If True, OnChange event will not be triggered
Returns void

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect
Inherited from AbstractVirtualSelect.clear
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:334

close

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

Returns void

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect
Inherited from AbstractVirtualSelect.close
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:343

disable

disable(): void
Set Dropdown as disabled

Returns void

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect
Inherited from AbstractVirtualSelect.disable
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:357

dispose

dispose(): void
Destroy the Dropdown.

Returns void

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect
Inherited from AbstractVirtualSelect.dispose
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:369

enable

enable(): void
Set Dropdown as enabled

Returns void

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect
Inherited from AbstractVirtualSelect.enable
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:396

getSelectedValues

getSelectedValues(): string
Get the selected values

Returns string

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect
Inherited from AbstractVirtualSelect.getSelectedValues
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:408

open

open(): void
Method used to open the Dropdown

Returns void

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect
Inherited from AbstractVirtualSelect.open
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:431

registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Method used to register the provider 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
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect
Inherited from AbstractVirtualSelect.registerCallback
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:443

setHiddenInputWrapperAriaLabelVal

setHiddenInputWrapperAriaLabelVal(value?: string): void
Parameters
- Optionalvalue: string
Returns void

Deprecated
use 'SetVirtualSelectConfigs' client action through LowCode or 'OutSystems.OSUI.Patterns.DropdownAPI.SetProviderConfigs()' API instead.
Inherited from AbstractVirtualSelect.setHiddenInputWrapperAriaLabelVal
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:460

setProviderConfigs

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

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect
Inherited from AbstractVirtualSelect.setProviderConfigs
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:476

setValue

setValue(
optionsToSelect: DropDownOption[],
silentOnChangedEvent?: boolean,
): void
Method used to set the Dropdown options values dynamically
Parameters
- optionsToSelect: DropDownOption[]
  List of options to bet set
- silentOnChangedEvent: boolean = true
  If True, OnChange event will not be triggered
Returns void

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect
Inherited from AbstractVirtualSelect.setValue
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:489

togglePopup

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

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect
Inherited from AbstractVirtualSelect.togglePopup
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:510

validation

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

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelect
Inherited from AbstractVirtualSelect.validation
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelect.ts:524

`Protected`getSelectedOptionsStructure

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

Returns DropDownOption[]
{DropDownOption[]}

Memberof
Providers.OSUI.Dropdown.VirtualSelect.Search.OSUIVirtualSelectSearch
Overrides AbstractVirtualSelect.getSelectedOptionsStructure
- Defined in Providers/OSUI/Dropdown/VirtualSelect/Search/VirtualSelectSearch.ts:16

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Update property value from a given property name at OnParametersChange
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

Memberof
Providers.OSUI.Dropdown.VirtualSelect.Search.OSUIVirtualSelectSearch
Overrides AbstractVirtualSelect.changeProperty
- Defined in Providers/OSUI/Dropdown/VirtualSelect/Search/VirtualSelectSearch.ts:41

Class OSUIVirtualSelectSearch

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OSUIVirtualSelectSearch

Properties

ProtectedisProviderBased

ProtectedproviderEventsManagerInstance

ProtectedvirtualselectConfigs

ProtectedvirtualselectOpts

Accessors

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

providerInfo

Returns ProviderInfo

Memberof

provider

Returns P

Memberof

Methods

ProtectedfinishBuild

Returns void

Memberof

ProtectedtriggerPlatformEventCallback

Parameters

Returns void

Memberof

ProtectedtriggerPlatformInitializedEventCallback

Returns void

Memberof

ProtectedunsetGlobalCallbacks

Returns void

Memberof

equalsToID

Parameters

Returns boolean

Memberof

Protectedredraw

Returns void

Memberof

checkAddedProviderEvents

Returns void

Memberof

checkPendingProviderEvents

Returns void

Memberof

setProviderEvent

Parameters

Returns void

Memberof

unsetProviderEvent

Parameters

Returns void

Memberof

updateProviderEvents

Parameters

Returns void

Memberof

`Protected`isProviderBased

`Protected`providerEventsManagerInstance

`Protected`virtualselectConfigs

`Protected`virtualselectOpts

`Protected`_enableAccessibility

`Protected`finishBuild

`Protected`triggerPlatformEventCallback

`Protected`triggerPlatformInitializedEventCallback

`Protected`unsetGlobalCallbacks

`Protected`redraw

`Protected`createProviderInstance

`Protected`prepareConfigs

`Protected`setA11YProperties

`Protected`setCallbacks

`Protected`setHtmlElements

`Protected`unsetCallbacks

`Protected`unsetHtmlElements