Class OSUIDropdownServerSide

Defines the interface for OSFramework.Patterns.Dropdown > DropdownServerSide Pattern

Hierarchy (View Summary)

OSFramework.OSUI.Patterns.AbstractParent<
OSUIDropdownServerSideConfig,
IDropdownServerSideItem,
>
- OSUIDropdownServerSide

Implements

IDropdownServerSide

Constructors

constructor

new OSUIDropdownServerSide(
uniqueId: string,
configs: JSON,
): OSUIDropdownServerSide
Parameters
- uniqueId: string
- configs: JSON
Returns OSUIDropdownServerSide
Overrides AbstractParent.constructor
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:56

Properties

`Protected`isProviderBased

isProviderBased: boolean = false

balloonOptions

balloonOptions: BalloonOptions

Accessors

`Protected`_enableAccessibility

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

Returns boolean

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from Patterns.AbstractParent._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
Implementation of IDropdownServerSide.selfElement

Inherited from Patterns.AbstractParent.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
Implementation of IDropdownServerSide.isBuilt

Inherited from Patterns.AbstractParent.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 Patterns.AbstractParent.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
Implementation of IDropdownServerSide.uniqueId

Inherited from Patterns.AbstractParent.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
Implementation of IDropdownServerSide.widgetId

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

Methods

`Protected`getChild

getChild(childId: string): IDropdownServerSideItem
Protected
Get the child reference based on given Id
Parameters
- childId: string
  Child Id of the element to be found
Returns IDropdownServerSideItem
Child Reference

Memberof
OSFramework.Patterns.AbstractParent
Inherited from AbstractParent.getChild
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:32

`Protected`getChildByIndex

getChildByIndex(index: number, childType?: string): IDropdownServerSideItem
Protected
Get a child reference by a given Index position
Parameters
- index: number
  Index of the item to be returned
- OptionalchildType: string
  To be based on childType childs collection, otherwise will assume parent only contains one child type!
Returns IDropdownServerSideItem
Child Reference

Memberof
OSFramework.Patterns.AbstractParent
Inherited from AbstractParent.getChildByIndex
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:53

`Protected`getChildIndex

getChildIndex(childId: string): number
Protected
Get a child index from a given child Id
Parameters
- childId: string
  Child id where index will be found
Returns number
Index value

Memberof
OSFramework.Patterns.AbstractParent
Inherited from AbstractParent.getChildIndex
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:72

`Protected`notifyChildren

notifyChildren(notificationType: string): void
Method used to notify all children about a given notification type
Parameters
- notificationType: string
  Notification type
Returns void

Memberof
OSFramework.Patterns.AbstractParent
Inherited from AbstractParent.notifyChildren
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:87

`Protected`setChild

setChild(childItem: IDropdownServerSideItem): void
Protected
Method that is used to set a given child as a Parent child.
Parameters
- childItem: IDropdownServerSideItem
  Reference to be added
Returns void

Memberof
OSFramework.Patterns.AbstractParent
Inherited from AbstractParent.setChild
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:102

`Protected`unsetChild

unsetChild(childId: string): void
Protected
Method that will remove Child by given Id
Parameters
- childId: string
  Id of the item that will be removed
Returns void

Memberof
OSFramework.Patterns.AbstractParent
Inherited from AbstractParent.unsetChild
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:134

getChildItems

getChildItems(type?: string): IDropdownServerSideItem[]
Getter that allows to obtain all the childs when parent only contains childs of one type, otherwise a type must be passed in order to return all child of the given type!
Parameters
- Optionaltype: string
  To be based on childType childs collection, otherwise will assume parent only contains one child type!
Returns IDropdownServerSideItem[]

Memberof
OSFramework.Patterns.AbstractParent
Inherited from AbstractParent.getChildItems
- Defined in OSFramework/OSUI/Pattern/AbstractParent.ts:199

`Protected`finishBuild

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

Returns void

Memberof
OSFramework.Patterns.AbstractPattern
Inherited from AbstractParent.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 AbstractParent.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 AbstractParent.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 AbstractParent.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
Implementation of IDropdownServerSide.equalsToID

Inherited from AbstractParent.equalsToID
- Defined in OSFramework/OSUI/Pattern/AbstractPattern.ts:172

`Protected`setA11YProperties

setA11YProperties(): void
Protected
Add the Accessibility Attributes values

Returns void

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide
Overrides AbstractParent.setA11YProperties
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:657

`Protected`setCallbacks

setCallbacks(): void
Protected
Method to set the calbacks

Returns void

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide
Overrides AbstractParent.setCallbacks
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:690

`Protected`setHtmlElements

setHtmlElements(): void
Protected
Method to set the html elements used

Returns void

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide
Overrides AbstractParent.setHtmlElements
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:707

`Protected`unsetCallbacks

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

Returns void

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide
Overrides AbstractParent.unsetCallbacks
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:736

`Protected`unsetHtmlElements

unsetHtmlElements(): void
Protected
Method to unset the html elements used

Returns void

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide
Overrides AbstractParent.unsetHtmlElements
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:754

beNotifiedByChild

beNotifiedByChild(
childItem: OSFramework.OSUI.Patterns.DropdownServerSideItem.DropdownServerSideItem,
notifiedTo: OSFramework.OSUI.Patterns.Dropdown.ServerSide.Enum.ChildNotifyActionType,
): void
Method used to be notified by a given dropdownOptionId about a given action and act accordingly
Parameters
- childItem: OSFramework.OSUI.Patterns.DropdownServerSideItem.DropdownServerSideItem
- notifiedTo: OSFramework.OSUI.Patterns.Dropdown.ServerSide.Enum.ChildNotifyActionType
  {Enum.ChildNotifyActionType} triggered notification type
Returns void

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide
Implementation of IDropdownServerSide.beNotifiedByChild

Overrides AbstractParent.beNotifiedByChild
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:773

build

build(): void
Method to build the DropdownServerSide

Returns void

Memberof
OSUIDropdownServerSide
Implementation of IDropdownServerSide.build

Overrides AbstractParent.build
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:802

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
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide
Implementation of IDropdownServerSide.changeProperty

Overrides AbstractParent.changeProperty
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:821

clear

clear(): void
Method that will check for all Selected OptionItems and Unselect them

Returns void

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide
Implementation of IDropdownServerSide.clear
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:838

close

close(): void
Method used to close the Dropdown

Returns void

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide
Implementation of IDropdownServerSide.close
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:853

disable

disable(): void
Set pattern with a disable status

Returns void

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide
Implementation of IDropdownServerSide.disable
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:863

dispose

dispose(): void
Destroy the Dropdown.

Returns void

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide
Implementation of IDropdownServerSide.dispose

Overrides AbstractParent.dispose
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:877

enable

enable(): void
Remove disable status from

Returns void

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide
Implementation of IDropdownServerSide.enable
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:890

getSelectedValues

getSelectedValues(): string
This method has no implementation on this context.

Returns string

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide
Implementation of IDropdownServerSide.getSelectedValues
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:904

open

open(): void
Method used to open the Dropdown

Returns void

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide
Implementation of IDropdownServerSide.open
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:913

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
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide
Implementation of IDropdownServerSide.registerCallback

Overrides AbstractParent.registerCallback
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:925

setBalloonOptions

setBalloonOptions(balloonOptions?: BalloonOptions): void
Method to set the Balloon options
Parameters
- OptionalballoonOptions: BalloonOptions
Returns void

Memberof
OSUIDropdownServerSide
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:944

setBalloonOptionsAriaLabel

setBalloonOptionsAriaLabel(value?: string): void
Method used to set the balloon AriaLabelText that will be applied to the balloon options container element
Parameters
- Optionalvalue: string
  Text to be added
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:976

setProviderConfigs

setProviderConfigs(): string
This method has no implementation on this context.

Returns string

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide
Implementation of IDropdownServerSide.setProviderConfigs
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:986

setProviderEvent

setProviderEvent(): string
This method has no implementation on this context.

Returns string

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide
Implementation of IDropdownServerSide.setProviderEvent
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:995

setSelectAriaLabel

setSelectAriaLabel(value?: string): void
Method used to set the AriaLabel text that will be applied to the SelectValuesWrapper "input" element
Parameters
- Optionalvalue: string
  Text to be added
Returns void
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:1004

unsetProviderEvent

unsetProviderEvent(): string
This method has no implementation on this context.

Returns string

Memberof
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide
Implementation of IDropdownServerSide.unsetProviderEvent
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:1015

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
OSFramework.Patterns.Dropdown.ServerSide.OSUIDropdownServerSide
Implementation of IDropdownServerSide.validation
- Defined in OSFramework/OSUI/Pattern/Dropdown/ServerSide/DropdownServerSide.ts:1026

Class OSUIDropdownServerSide

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OSUIDropdownServerSide

Properties

ProtectedisProviderBased

balloonOptions

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

Methods

ProtectedgetChild

Parameters

Returns IDropdownServerSideItem

Memberof

ProtectedgetChildByIndex

Parameters

Returns IDropdownServerSideItem

Memberof

ProtectedgetChildIndex

Parameters

Returns number

Memberof

ProtectednotifyChildren

Parameters

Returns void

Memberof

ProtectedsetChild

Parameters

Returns void

Memberof

ProtectedunsetChild

Parameters

Returns void

Memberof

getChildItems

Parameters

Returns IDropdownServerSideItem[]

Memberof

ProtectedfinishBuild

Returns void

Memberof

ProtectedtriggerPlatformEventCallback

Parameters

Returns void

Memberof

ProtectedtriggerPlatformInitializedEventCallback

Returns void

Memberof

ProtectedunsetGlobalCallbacks

Returns void

Memberof

equalsToID

Parameters

Returns boolean

Memberof

`Protected`isProviderBased

`Protected`_enableAccessibility

`Protected`getChild

`Protected`getChildByIndex

`Protected`getChildIndex

`Protected`notifyChildren

`Protected`setChild

`Protected`unsetChild

`Protected`finishBuild

`Protected`triggerPlatformEventCallback

`Protected`triggerPlatformInitializedEventCallback

`Protected`unsetGlobalCallbacks

`Protected`setA11YProperties

`Protected`setCallbacks

`Protected`setHtmlElements

`Protected`unsetCallbacks

`Protected`unsetHtmlElements