Interface IDropdownServerSideItem

Defines the interface for OutSystemsUI DropdownServerSideItem Pattern

Export

Interface

IDropdownServerSideItem

Hierarchy-Diagram

Legend

class

interface

public property

protected property

private property

public method

protected method

private method

Hierarchy

IChild
- IDropdownServerSideItem

Implemented by

OSFramework.OSUI.Patterns.DropdownServerSideItem.DropdownServerSideItem

Index

Methods

build

build(): void
Build object, instantiating dependencies, and manipulating DOM when necessary

Memberof
OSFramework.Interface.IBuilder

Returns void
Inherited from IChild.build
- Defined in OSFramework/OSUI/Interface/IBuilder.ts:15

`Optional` setBlur

setBlur(): void
Method used to set item as focus state

Memberof
OSFramework.Interface.IChild

Returns void
Inherited from IChild.setBlur
- Defined in OSFramework/OSUI/Interface/IChild.ts:20

`Optional` setFocus

setFocus(): void
Method used to set item as blur state

Memberof
OSFramework.Interface.IChild

Returns void
Inherited from IChild.setFocus
- Defined in OSFramework/OSUI/Interface/IChild.ts:27

`Optional` setTabindex

setTabindex(): void
Method used to set the tabindex attribute

Memberof
OSFramework.Interface.IChild

Returns void
Inherited from IChild.setTabindex
- Defined in OSFramework/OSUI/Interface/IChild.ts:34

`Optional` unsetTabindex

unsetTabindex(): void
Method used to unset the tabindex attribute

Memberof
OSFramework.Interface.IChild

Returns void
Inherited from IChild.unsetTabindex
- Defined in OSFramework/OSUI/Interface/IChild.ts:41

dispose

dispose(): void
Dispose object and free up its used resources

Memberof
OSFramework.Interface.IDisposable

Returns void
Inherited from IChild.dispose
- Defined in OSFramework/OSUI/Interface/IDisposable.ts:15

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Method signature to change the properties/configs of the pattern.

Memberof
OSFramework.Interface.IPattern
Parameters
- propertyName: string
- propertyValue: unknown
Returns void
Inherited from IChild.changeProperty
- Defined in OSFramework/OSUI/Interface/IPattern.ts:52

registerCallback

registerCallback(eventName: string, callback: OSGeneric): void
Enables to register simple callbacks for the platform. Internal use.

Memberof
OSFramework.Interface.IPattern
Parameters
- eventName: string
- callback: OSGeneric
Returns void
Inherited from IChild.registerCallback
- Defined in OSFramework/OSUI/Interface/IPattern.ts:61

equalsToID

equalsToID(id: string): boolean
Validates if object matched with the given id

Returns
{boolean}

Memberof
OSFramework.Interface.ISearchById
Parameters
- id: string
Returns boolean
Inherited from IChild.equalsToID
- Defined in OSFramework/OSUI/Interface/ISearchById.ts:17

toggleSelected

toggleSelected(triggerCallback?: boolean): void
Method used to update the DropdownOptionItem selected state

Memberof
OSFramework.Patterns.DropdownServerSideItem.IDropdownServerSideItem
Parameters
- Optional triggerCallback: boolean
  
  True by default, used to block the callback when needed
Returns void
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/IDropdownServerSideItem.ts:42

Accessors

isFirstChild

get isFirstChild(): boolean
Returns boolean
Inherited from Interface.IChild.isFirstChild
- Defined in OSFramework/OSUI/Interface/IChild.ts:10
set isFirstChild(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Interface.IChild.isFirstChild
- Defined in OSFramework/OSUI/Interface/IChild.ts:11

isLastChild

get isLastChild(): boolean
Returns boolean
Inherited from Interface.IChild.isLastChild
- Defined in OSFramework/OSUI/Interface/IChild.ts:12
set isLastChild(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Interface.IChild.isLastChild
- Defined in OSFramework/OSUI/Interface/IChild.ts:13

IsSelected

get IsSelected(): boolean
Getter that allows to obtain the IsSelectd status value.

Memberof
OSFramework.Patterns.DropdownServerSideItem.IDropdownServerSideItem

Returns boolean
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/IDropdownServerSideItem.ts:26

ItemId

get ItemId(): string
Getter that allows to obtain the ItemId value.

Memberof
OSFramework.Patterns.DropdownServerSideItem.IDropdownServerSideItem

Returns string
- Defined in OSFramework/OSUI/Pattern/DropdownServerSideItem/IDropdownServerSideItem.ts:35

Properties

isBuilt

isBuilt: boolean

Indicates if the instance of the pattern is built.

Memberof

OSFramework.Interface.IPattern

selfElement

selfElement: HTMLElement

Pattern HTML element

Memberof

OSFramework.Interface.IPattern

uniqueId

uniqueId: string

Internal Id of the instance of the pattern.

Memberof

OSFramework.Interface.IPattern

widgetId

widgetId: string

External Id of the instance of the pattern

Memberof

OSFramework.Interface.IPattern

keyboardTriggeredKey

keyboardTriggeredKey: string

Key used to trigger the notification into Dropdown parent

Memberof

OSFramework.Patterns.DropdownServerSideItem.IDropdownServerSideItem

Interface IDropdownServerSideItem

Export

Interface

Hierarchy-Diagram

Legend

Hierarchy

Implemented by

Index

Methods

Accessors

Properties

Methods

build

Memberof

Returns void

Optional setBlur

Memberof

Returns void

Optional setFocus

Memberof

Returns void

Optional setTabindex

Memberof

Returns void

Optional unsetTabindex

Memberof

Returns void

dispose

Memberof

Returns void

changeProperty

Memberof

Parameters

propertyName: string

propertyValue: unknown

Returns void

registerCallback

Memberof

Parameters

eventName: string

callback: OSGeneric

Returns void

equalsToID

Returns

Memberof

Parameters

id: string

Returns boolean

toggleSelected

Memberof

Parameters

Optional triggerCallback: boolean

Returns void

Accessors

isFirstChild

Returns boolean

Parameters

value: boolean

Returns void

isLastChild

Returns boolean

Parameters

value: boolean

Returns void

IsSelected

Memberof

Returns boolean

ItemId

Memberof

Returns string

Properties

isBuilt

Memberof

selfElement

Memberof

uniqueId

Memberof

widgetId

Memberof

keyboardTriggeredKey

`Optional` setBlur

`Optional` setFocus

`Optional` setTabindex

`Optional` unsetTabindex

`Optional` triggerCallback: boolean