Class OSUIDropdownServerSideConfig

Class that represents the custom configurations received by the Dropdown.

Export

Hierarchy-Diagram

UML class diagram of OSUIDropdownServerSideConfig

Legend

class

abstract class

public property

private property

public method

protected method

Hierarchy

AbstractConfiguration
- OSUIDropdownServerSideConfig

Index

Properties

ExtendedClass

ExtendedClass: string

`Private` _balloonMaxHeight

_balloonMaxHeight: OSFramework.OSUI.Patterns.Dropdown.ServerSide.Enum.PropertiesValues = Enum.PropertiesValues.MaxHeight

`Private` _balloonOptionsArialabel

_balloonOptionsArialabel: string = ''

`Private` _selectValuesWrapperAriaLabel

_selectValuesWrapperAriaLabel: OSFramework.OSUI.Patterns.Dropdown.ServerSide.Enum.PropertiesValues = Enum.PropertiesValues.SelectValuesWrapperAriaLabelValue

AllowMultipleSelection

AllowMultipleSelection: boolean

IsDisabled

IsDisabled: 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 AbstractConfiguration.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 AbstractConfiguration.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 AbstractConfiguration.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 AbstractConfiguration.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 AbstractConfiguration.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 AbstractConfiguration.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 AbstractConfiguration.validateCanChange
- Defined in OSFramework/OSUI/Pattern/AbstractConfiguration.ts:119

validateDefault

validateDefault(key: string, value: unknown): unknown
Method that will check if a given property (key) value is the type expected!

Returns
value

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSideConfig
Parameters
- key: string
  
  property name
- value: unknown
  
  value to be check
Returns unknown
Overrides AbstractConfiguration.validateDefault
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSideConfig.ts:38

Constructors

constructor

new OSUIDropdownServerSideConfig(config: JSON): OSUIDropdownServerSideConfig
Parameters
- config: JSON
Returns OSUIDropdownServerSideConfig
Overrides AbstractConfiguration.constructor
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSideConfig.ts:22

Accessors

balloonMaxHeight

get balloonMaxHeight(): number
Getter that allows to obtain the MaxHeight that ballon should have.

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSideConfig

Returns number
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSideConfig.ts:61

balloonOptionsArialabel

get balloonOptionsArialabel(): string
Getter that allows to obtain the string that should be added to the balloon options container by default

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSideConfig

Returns string
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSideConfig.ts:71

selectValuesWrapperAriaLabel

get selectValuesWrapperAriaLabel(): string
Getter that allows to obtain the string that should be added to the select "input" container.

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSideConfig

Returns string
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSideConfig.ts:81

Class OSUIDropdownServerSideConfig

Export

Hierarchy-Diagram

Legend

Hierarchy

Index

Properties

Methods

Constructors

Accessors

Properties

ExtendedClass

Private _balloonMaxHeight

Private _balloonOptionsArialabel

Private _selectValuesWrapperAriaLabel

AllowMultipleSelection

IsDisabled

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

validateDefault

Returns

Memberof

Parameters

key: string

value: unknown

Returns unknown

Constructors

constructor

Parameters

config: JSON

Returns OSUIDropdownServerSideConfig

`Private` _balloonMaxHeight

`Private` _balloonOptionsArialabel

`Private` _selectValuesWrapperAriaLabel

`Protected` validateBoolean

`Protected` validateDate

`Protected` validateInRange

`Rest` ...args: unknown[]

`Protected` validateNumber

`Protected` validateString

`Protected` validateTime