Class VirtualSelectSearchConfig

Class that represents the custom configurations received by the Dropdown Search mode.

Export

Hierarchy-Diagram

UML class diagram of VirtualSelectSearchConfig

Legend

class

abstract class

public property

protected property

private property

public method

protected method

private method

italic abstract property/method

Hierarchy

AbstractVirtualSelectConfig
- VirtualSelectSearchConfig

Properties

ExtendedClass

ExtendedClass: string

IsDisabled

IsDisabled: boolean

`Protected` providerExtendedOptions

providerExtendedOptions: VirtualSelectOpts

ElementId

ElementId: string

NoOptionsText

NoOptionsText: string

NoResultsText

NoResultsText: string

OptionsList

OptionsList: DropDownOption[]

PopupDropboxBreakpoint

PopupDropboxBreakpoint: string

Prompt

Prompt: string

SearchPrompt

SearchPrompt: string

ShowDropboxAsPopup

ShowDropboxAsPopup: boolean = true

StartingSelection

StartingSelection: DropDownOption[]

AllowMultipleSelection

AllowMultipleSelection: boolean

Methods

`Protected` validateBoolean

validateBoolean(value: boolean, defaultValue: boolean): boolean
Protected
Method that helps to validate if a boolean is not undefined

Returns
{boolean}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- value: boolean
- defaultValue: boolean
Returns boolean
Inherited from AbstractVirtualSelectConfig.validateBoolean
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:31

`Protected` validateDate

validateDate(value: string | Date, defaultValue: string): string | Date
Protected
Method that helps to validate if a given value is a valid date

Returns
{(string | Date)}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- value: string | Date
- defaultValue: string
Returns string | Date
Inherited from AbstractVirtualSelectConfig.validateDate
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:44

`Protected` validateInRange

validateInRange(value: unknown, defaultValue: unknown, ...args: unknown[]): unknown
Protected
Method that helps to validate if a given value is within a range of values.

Returns
{unknown}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- value: unknown
- defaultValue: unknown
- Rest ...args: unknown[]
Returns unknown
Inherited from AbstractVirtualSelectConfig.validateInRange
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:58

`Protected` validateNumber

validateNumber(value: number, defaultValue: number): number
Protected
Method that helps to validate if a number is not empty or undefined.

Returns
{number}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- value: number
- defaultValue: number
Returns number
Inherited from AbstractVirtualSelectConfig.validateNumber
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:80

`Protected` validateString

validateString(value: string, defaultValue: string): string
Protected
Method that helps to validate if a string is not empty or undefined.

Returns
{string}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- value: string
- defaultValue: string
Returns string
Inherited from AbstractVirtualSelectConfig.validateString
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:93

`Protected` validateTime

validateTime(value: string, defaultValue: string): string
Protected
Method that helps to validate if a given value is a valid time

Returns
{(string)}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- value: string
- defaultValue: string
Returns string
Inherited from AbstractVirtualSelectConfig.validateTime
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:106

validateCanChange

validateCanChange(_isBuilt: boolean, _key: string): boolean
Method that validates if a given property can be changed.

Returns
{boolean}

Memberof
OSFramework.Patterns.AbstractConfiguration
Parameters
- _isBuilt: boolean
- _key: string
Returns boolean
Inherited from AbstractVirtualSelectConfig.validateCanChange
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:119

`Protected` mergeConfigs

mergeConfigs(commonConfigs: any, specificConfigs: any, extendedConfigs?: any): any
Protected
Method to merge Common, Specific and External configs

Returns
{ProviderConfigs}

Memberof
OSFramework.Patterns.AbstractProviderConfiguration
Parameters
- commonConfigs: any
- specificConfigs: any
- Optional extendedConfigs: any
Returns any
Inherited from AbstractVirtualSelectConfig.mergeConfigs
- Defined in OSFramework/OSUI/Pattern/AbstractProviderConfiguration.ts:23

setExtensibilityConfigs

setExtensibilityConfigs(newConfigs: VirtualSelectOpts): void
Method to validate and save the external provider configs

Memberof
Providers.OSUI.Dropdown.VirtualSelect.AbstractVirtualSelectConfig
Parameters
- newConfigs: VirtualSelectOpts
Returns void
Inherited from AbstractVirtualSelectConfig.setExtensibilityConfigs
- Defined in Providers/OSUI/Dropdown/VirtualSelect/AbstractVirtualSelectConfig.ts:218

`Protected` getSelectedValues

getSelectedValues(): string[]
Protected
Method used to get the key values of the given selected values

Returns
{string[]}

Memberof
Providers.OSUI.Dropdown.VirtualSelect.Search.VirtualSelectSearchConfig

Returns string[]
Overrides AbstractVirtualSelectConfig.getSelectedValues
- Defined in Providers/OSUI/Dropdown/VirtualSelect/Search/VirtualSelectSearchConfig.ts:20

getProviderConfig

getProviderConfig(): VirtualSelectOpts
Set the configs for the Dropdown Search mode

Returns
{VirtualSelectOpts}

Memberof
Providers.OSUI.Dropdown.VirtualSelect.Search.VirtualSelectSearchConfig

Returns VirtualSelectOpts
Overrides AbstractVirtualSelectConfig.getProviderConfig
- Defined in Providers/OSUI/Dropdown/VirtualSelect/Search/VirtualSelectSearchConfig.ts:49

validateDefault

validateDefault(key: string, value: unknown): unknown
Override, validate configs key values

Returns
{unknown}

Memberof
Providers.OSUI.Dropdown.VirtualSelect.Search.VirtualSelectSearchConfig
Parameters
- key: string
- value: unknown
Returns unknown
Overrides AbstractVirtualSelectConfig.validateDefault
- Defined in Providers/OSUI/Dropdown/VirtualSelect/Search/VirtualSelectSearchConfig.ts:65

Constructors

constructor

new VirtualSelectSearchConfig(config: JSON): VirtualSelectSearchConfig
Parameters
- config: JSON
Returns VirtualSelectSearchConfig
Inherited from AbstractVirtualSelectConfig.constructor
- Defined in OSFramework/OSUI/Pattern/Dropdown/AbstractDropdownConfig.ts:7

Class VirtualSelectSearchConfig

Export

Hierarchy-Diagram

Legend

Hierarchy

Index

Properties

Methods

Constructors

Properties

ExtendedClass

IsDisabled

Protected providerExtendedOptions

ElementId

NoOptionsText

NoResultsText

OptionsList

PopupDropboxBreakpoint

Prompt

SearchPrompt

ShowDropboxAsPopup

StartingSelection

AllowMultipleSelection

Methods

Protected validateBoolean

Returns

Memberof

Parameters

value: boolean

defaultValue: boolean

Returns boolean

Protected validateDate

Returns

Memberof

Parameters

value: string | Date

defaultValue: string

Returns string | Date

Protected validateInRange

Returns

Memberof

Parameters

value: unknown

defaultValue: unknown

Rest ...args: unknown[]

Returns unknown

Protected validateNumber

Returns

Memberof

Parameters

value: number

defaultValue: number

Returns number

Protected validateString

Returns

Memberof

Parameters

value: string

defaultValue: string

Returns string

Protected validateTime

Returns

Memberof

Parameters

value: string

defaultValue: string

Returns string

validateCanChange

Returns

Memberof

Parameters

_isBuilt: boolean

_key: string

Returns boolean

Protected mergeConfigs

Returns

Memberof

Parameters

commonConfigs: any

specificConfigs: any

`Protected` providerExtendedOptions

`Protected` validateBoolean

`Protected` validateDate

`Protected` validateInRange

`Rest` ...args: unknown[]

`Protected` validateNumber

`Protected` validateString

`Protected` validateTime

`Protected` mergeConfigs

`Optional` extendedConfigs: any

`Protected` getSelectedValues