Interface IAccordionItem

Defines the interface for OutSystemsUI AccordionItem Pattern

Hierarchy-Diagram

Legend

class

interface

public property

protected property

private property

public method

protected method

private method

Hierarchy

IChild
IOpenable
- IAccordionItem

Implemented by

OSFramework.OSUI.Patterns.AccordionItem.AccordionItem

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

close

close(): void
Method signature to close the pattern.

Memberof
OSFramework.Interface.IOpenable

Returns void
Inherited from IOpenable.close
- Defined in OSFramework/OSUI/Interface/IOpenable.ts:16

open

open(isOpenedByApi?: boolean): void
Method signature to open the pattern.

Memberof
IOpenable
Parameters
- Optional isOpenedByApi: boolean
Returns void
Inherited from IOpenable.open
- Defined in OSFramework/OSUI/Interface/IOpenable.ts:24

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

allowTitleEvents

allowTitleEvents(): void
Method to prevent clicks inside thte title to open the accordion

Memberof
IAccordionItem

Returns void
- Defined in OSFramework/OSUI/Pattern/AccordionItem/IAccordionItem.ts:28

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

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

isDisabled

isDisabled: boolean

Returns the value of disable state

Memberof

IAccordionItem

isOpen

isOpen: boolean

Returns the value of open state

Memberof

IAccordionItem

Interface IAccordionItem

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

close

Memberof

Returns void

open

Memberof

Parameters

Optional isOpenedByApi: boolean

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

allowTitleEvents

Memberof

Returns void

Accessors

isFirstChild

Returns boolean

Parameters

value: boolean

Returns void

isLastChild

Returns boolean

Parameters

value: boolean

Returns void

Properties

isBuilt

Memberof

selfElement

Memberof

uniqueId

Memberof

widgetId

Memberof

isDisabled

Memberof

isOpen

`Optional` setBlur

`Optional` setFocus

`Optional` setTabindex

`Optional` unsetTabindex

`Optional` isOpenedByApi: boolean