Class Accordion

Defines the interface for OutSystemsUI Patterns

Hierarchy-Diagram

Legend

class

abstract class

interface

public property

private property

public method

protected method

italic abstract property/method

Hierarchy

OSFramework.Patterns.AbstractParent<AccordionConfig, IAccordionItem>
- Accordion

Implements

IAccordion

Methods

`Protected` getChild

getChild(childId: string): IAccordionItem
Protected
Get the child reference based on given Id

Returns
Child Reference

Memberof
OSFramework.Patterns.AbstractParent
Parameters
- childId: string
  
  Child Id of the element to be found
Returns IAccordionItem
Inherited from AbstractParent.getChild
- Defined in OSFramework/Pattern/AbstractParent.ts:32

`Protected` getChildByIndex

getChildByIndex(index: number, childType?: string): IAccordionItem
Protected
Get a child reference by a given Index position

Returns
Child Reference

Memberof
OSFramework.Patterns.AbstractParent
Parameters
- index: number
  
  Index of the item to be returned
- Optional childType: string
  
  To be based on childType childs collection, otherwise will assume parent only contains one child type!
Returns IAccordionItem
Inherited from AbstractParent.getChildByIndex
- Defined in OSFramework/Pattern/AbstractParent.ts:53

`Protected` getChildIndex

getChildIndex(childId: string): number
Protected
Get a child index from a given child Id

Returns
Index value

Memberof
OSFramework.Patterns.AbstractParent
Parameters
- childId: string
  
  Child id where index will be found
Returns number
Inherited from AbstractParent.getChildIndex
- Defined in OSFramework/Pattern/AbstractParent.ts:72

`Protected` setChild

setChild(childItem: IAccordionItem): void
Protected
Method that is used to set a given child as a Parent child.

Memberof
OSFramework.Patterns.AbstractParent
Parameters
- childItem: IAccordionItem
  
  Reference to be added
Returns void
Inherited from AbstractParent.setChild
- Defined in OSFramework/Pattern/AbstractParent.ts:89

`Protected` unsetChild

unsetChild(childId: string): void
Protected
Method that will remove Child by given Id

Memberof
OSFramework.Patterns.AbstractParent
Parameters
- childId: string
  
  Id of the item that will be removed
Returns void
Inherited from AbstractParent.unsetChild
- Defined in OSFramework/Pattern/AbstractParent.ts:121

getChildItems

getChildItems(type?: string): IAccordionItem[]
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!

Returns

Memberof
OSFramework.Patterns.AbstractParent
Parameters
- Optional type: string
  
  To be based on childType childs collection, otherwise will assume parent only contains one child type!
Returns IAccordionItem[]
Inherited from AbstractParent.getChildItems
- Defined in OSFramework/Pattern/AbstractParent.ts:186

`Protected` finishBuild

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns void
Inherited from AbstractParent.finishBuild
- Defined in OSFramework/Pattern/AbstractPattern.ts:50

equalsToID

equalsToID(patternId: string): boolean
Enables to uniquely identify the pattern in all ways.

Returns
{boolean}

Memberof
OSFramework.Patterns.AbstractPattern
Parameters
- patternId: string
Returns boolean
Implementation of IAccordion.equalsToID

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

`Protected` setA11YProperties

setA11YProperties(): void
Protected
Sets the A11Y properties when the pattern is built.

Memberof
OSFramework.Patterns.Accordion.Accordion

Returns void
Overrides AbstractParent.setA11YProperties
- Defined in OSFramework/Pattern/Accordion/Accordion.ts:17

`Protected` setCallbacks

setCallbacks(): void
Protected
This method has no implementation on this pattern context!

Memberof
OSFramework.Patterns.Accordion.Accordion

Returns void
Overrides AbstractParent.setCallbacks
- Defined in OSFramework/Pattern/Accordion/Accordion.ts:27

`Protected` setHtmlElements

setHtmlElements(): void
Protected
This method has no implementation on this pattern context!

Memberof
OSFramework.Patterns.Accordion.Accordion

Returns void
Overrides AbstractParent.setHtmlElements
- Defined in OSFramework/Pattern/Accordion/Accordion.ts:37

`Protected` unsetCallbacks

unsetCallbacks(): void
Protected
This method has no implementation on this pattern context!

Memberof
OSFramework.Patterns.Accordion.Accordion

Returns void
Overrides AbstractParent.unsetCallbacks
- Defined in OSFramework/Pattern/Accordion/Accordion.ts:47

`Protected` unsetHtmlElements

unsetHtmlElements(): void
Protected
This method has no implementation on this pattern context!

Memberof
OSFramework.Patterns.Accordion.Accordion

Returns void
Overrides AbstractParent.unsetHtmlElements
- Defined in OSFramework/Pattern/Accordion/Accordion.ts:57

addAccordionItem

addAccordionItem(childItem: OSFramework.Patterns.AccordionItem.AccordionItem): void
Method to add a new accordionItem

Memberof
OSFramework.Patterns.Accordion.Accordion
Parameters
- childItem: OSFramework.Patterns.AccordionItem.AccordionItem
Returns void
Implementation of IAccordion.addAccordionItem
- Defined in OSFramework/Pattern/Accordion/Accordion.ts:67

beNotifiedByChild

beNotifiedByChild(childItem: OSFramework.Patterns.AccordionItem.AccordionItem, notifiedTo: OSFramework.Patterns.Accordion.Enum.ChildNotifyActionType): void
Method used to be notified by a given ChildId about a given action and act accordingly

Memberof
OSFramework.Patterns.Accordion.Accordion
Parameters
- childItem: OSFramework.Patterns.AccordionItem.AccordionItem
- notifiedTo: OSFramework.Patterns.Accordion.Enum.ChildNotifyActionType
  
  {Enum.ChildNotifyActionType} triggered notification type
Returns void
Implementation of IAccordion.beNotifiedByChild

Overrides AbstractParent.beNotifiedByChild
- Defined in OSFramework/Pattern/Accordion/Accordion.ts:91

build

build(): void
Method to build the pattern.

Memberof
OSFramework.Patterns.Accordion.Accordion

Returns void
Implementation of IAccordion.build

Overrides AbstractParent.build
- Defined in OSFramework/Pattern/Accordion/Accordion.ts:117

changeProperty

changeProperty(propertyName: string, propertyValue: unknown): void
Method to change the value of configs/current state.

Memberof
OSFramework.Patterns.Accordion.Accordion
Parameters
- propertyName: string
- propertyValue: unknown
Returns void
Implementation of IAccordion.changeProperty

Overrides AbstractParent.changeProperty
- Defined in OSFramework/Pattern/Accordion/Accordion.ts:132

collapseAllItems

collapseAllItems(): void
Method to close all accordionItems

Memberof
OSFramework.Patterns.Accordion.Accordion

Returns void
Implementation of IAccordion.collapseAllItems
- Defined in OSFramework/Pattern/Accordion/Accordion.ts:150

dispose

dispose(): void
Method to destroy accordion instance

Memberof
OSFramework.Patterns.Accordion.Accordion

Returns void
Implementation of IAccordion.dispose

Overrides AbstractParent.dispose
- Defined in OSFramework/Pattern/Accordion/Accordion.ts:165

expandAllItems

expandAllItems(): void
Method to open all accordionItems

Memberof
OSFramework.Patterns.Accordion.Accordion

Returns void
Implementation of IAccordion.expandAllItems
- Defined in OSFramework/Pattern/Accordion/Accordion.ts:174

removeAccordionItem

removeAccordionItem(childId: string): void
Method to remove an accordionItem

Memberof
OSFramework.Patterns.Accordion.Accordion
Parameters
- childId: string
Returns void
Implementation of IAccordion.removeAccordionItem
- Defined in OSFramework/Pattern/Accordion/Accordion.ts:197

triggerAccordionItemClose

triggerAccordionItemClose(childId: string): void
Method to close all accordionItems but one

Returns
{void}

Memberof
OSFramework.Patterns.Accordion.Accordion
Parameters
- childId: string
Returns void
Implementation of IAccordion.triggerAccordionItemClose
- Defined in OSFramework/Pattern/Accordion/Accordion.ts:216

Accessors

`Protected` _enableAccessibility

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

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Inherited from AbstractParent._enableAccessibility
- Defined in OSFramework/Pattern/AbstractPattern.ts:128

selfElement

get selfElement(): HTMLElement
Getter that allows to obtain the self element.

Memberof
OSFramework.Patterns.AbstractPattern

Returns HTMLElement
Implementation of IAccordion.selfElement

Inherited from AbstractParent.selfElement
- Defined in OSFramework/Pattern/AbstractPattern.ts:139

isBuilt

get isBuilt(): boolean
Getter that tells if the pattern is already built.

Memberof
OSFramework.Patterns.AbstractPattern

Returns boolean
Implementation of IAccordion.isBuilt

Inherited from AbstractParent.isBuilt
- Defined in OSFramework/Pattern/AbstractPattern.ts:150

configs

get configs(): C
Current configurations/state of the pattern.

Memberof
OSFramework.Patterns.AbstractPattern

Returns C
Inherited from AbstractParent.configs
- Defined in OSFramework/Pattern/AbstractPattern.ts:161

uniqueId

get uniqueId(): string
Unique id of the pattern. Internal use only.

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of IAccordion.uniqueId

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

widgetId

get widgetId(): string
Id of the pattern known by the developer. External use only.

Memberof
OSFramework.Patterns.AbstractPattern

Returns string
Implementation of IAccordion.widgetId

Inherited from AbstractParent.widgetId
- Defined in OSFramework/Pattern/AbstractPattern.ts:183

Constructors

constructor

new Accordion(uniqueId: string, configs: JSON): OSFramework.Patterns.Accordion.Accordion
Parameters
- uniqueId: string
- configs: JSON
Returns OSFramework.Patterns.Accordion.Accordion
Overrides AbstractParent.constructor
- Defined in OSFramework/Pattern/Accordion/Accordion.ts:7

Class Accordion

Hierarchy-Diagram

Legend

Hierarchy

Implements

Index

Methods

Accessors

Constructors

Methods

Protected getChild

Returns

Memberof

Parameters

childId: string

Returns IAccordionItem

Protected getChildByIndex

Returns

Memberof

Parameters

index: number

Optional childType: string

Returns IAccordionItem

Protected getChildIndex

Returns

Memberof

Parameters

childId: string

Returns number

Protected setChild

Memberof

Parameters

childItem: IAccordionItem

Returns void

Protected unsetChild

Memberof

Parameters

childId: string

Returns void

getChildItems

Returns

Memberof

Parameters

Optional type: string

Returns IAccordionItem[]

Protected finishBuild

Memberof

Returns void

equalsToID

Returns

Memberof

Parameters

patternId: string

Returns boolean

Protected setA11YProperties

Memberof

Returns void

Protected setCallbacks

Memberof

Returns void

Protected setHtmlElements

Memberof

Returns void

Protected unsetCallbacks

Memberof

Returns void

Protected unsetHtmlElements

Memberof

Returns void

addAccordionItem

Memberof

Parameters

childItem: OSFramework.Patterns.AccordionItem.AccordionItem

Returns void

beNotifiedByChild

Memberof

Parameters

childItem: OSFramework.Patterns.AccordionItem.AccordionItem

notifiedTo: OSFramework.Patterns.Accordion.Enum.ChildNotifyActionType

Returns void

`Protected` getChild

`Protected` getChildByIndex

`Optional` childType: string

`Protected` getChildIndex

`Protected` setChild

`Protected` unsetChild

`Optional` type: string

`Protected` finishBuild

`Protected` setA11YProperties

`Protected` setCallbacks

`Protected` setHtmlElements

`Protected` unsetCallbacks

`Protected` unsetHtmlElements

`Protected` _enableAccessibility