Class sap.ui.commons.AccordionModule: sap/ui/commons/Accordion

extends Control

Contains N sections, acting as containers for any library control
Deprecated API:
Since version 1.38.
Constructor Summary
new sap.ui.commons.Accordion(sId?, mSettings?)Constructor for a new Accordion.
Event Summary
sectionClose(oControlEvent)Event is triggered when the user closes a section.
sectionOpen(oControlEvent)Event is triggered when the user opens a section.
sectionsReorder(oControlEvent)Event is triggered when the user changes the position of a section.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.commons.Accordion.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.commons.Accordion with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.commons.Accordion.getMetadata()Returns a metadata object for class sap.ui.commons.Accordion.
addSection(oSection)Adds some section to the aggregation sections.
attachSectionClose(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the sectionClose event of this sap.ui.commons.Accordion.
attachSectionOpen(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the sectionOpen event of this sap.ui.commons.Accordion.
attachSectionsReorder(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the sectionsReorder event of this sap.ui.commons.Accordion.
closeSection(sSectionId)Closes a section and opens the default one
destroySections()Destroys all the sections in the aggregation sections.
detachSectionClose(fnFunction, oListener)Detaches event handler fnFunction from the sectionClose event of this sap.ui.commons.Accordion.
detachSectionOpen(fnFunction, oListener)Detaches event handler fnFunction from the sectionOpen event of this sap.ui.commons.Accordion.
detachSectionsReorder(fnFunction, oListener)Detaches event handler fnFunction from the sectionsReorder event of this sap.ui.commons.Accordion.
fireSectionClose(mParameters?)Fires event sectionClose to attached listeners.
fireSectionOpen(mParameters?)Fires event sectionOpen to attached listeners.
fireSectionsReorder(mParameters?)Fires event sectionsReorder to attached listeners.
getOpenedSectionsId()Gets current value of property openedSectionsId.
getSections()Gets content of aggregation sections.
getWidth()Gets current value of property width.
indexOfSection(oSection)Checks for the provided sap.ui.commons.AccordionSection in the aggregation sections.
insertSection(oSection, iIndex)Inserts a section into the aggregation sections.
openSection(sSectionId)Opens a section
removeAllSections()Removes all the controls from the aggregation sections.
removeSection(vSection)Removes a section from the aggregation sections.
setOpenedSectionsId(sOpenedSectionsId)Redefinition of the method to add additional handling
setWidth(sWidth)Sets a new value for property width.
Constructor Detail
new sap.ui.commons.Accordion(sId?, mSettings?)

Constructor for a new Accordion.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

  • Properties

  • Aggregations

    • sections : sap.ui.commons.AccordionSection[] (default)

  • Events

    • sectionOpen : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • sectionClose : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
    • sectionsReorder : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:
stringsId?id for the new control, generated automatically if no id is given
objectmSettings?initial settings for the new control
Event Detail
sectionClose(oControlEvent)
Event is triggered when the user closes a section.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
stringoControlEvent.getParameters.closeSectionIdID of the closed section
sectionOpen(oControlEvent)
Event is triggered when the user opens a section.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
stringoControlEvent.getParameters.openSectionIdID of the opened section
string[]oControlEvent.getParameters.closeSectionIdsIDs of the sections to be closed. Can be initial in the case of no previously opened section.
sectionsReorder(oControlEvent)
Event is triggered when the user changes the position of a section.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
stringoControlEvent.getParameters.movedSectionIdID of the moved section
intoControlEvent.getParameters.newIndexNew index of the moved section
Method Detail
sap.ui.commons.Accordion.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.commons.Accordion with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend.

Parameters:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.ui.commons.Accordion.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.commons.Accordion.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addSection(oSection): sap.ui.commons.Accordion
Adds some section to the aggregation sections.
Parameters:
sap.ui.commons.AccordionSectionoSectionthe section to add; if empty, nothing is inserted
Returns:
sap.ui.commons.AccordionReference to this in order to allow method chaining
attachSectionClose(oData?, fnFunction, oListener?): sap.ui.commons.Accordion

Attaches event handler fnFunction to the sectionClose event of this sap.ui.commons.Accordion.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.commons.Accordion itself.

Event is triggered when the user closes a section.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.commons.Accordion itself
Returns:
sap.ui.commons.AccordionReference to this in order to allow method chaining
attachSectionOpen(oData?, fnFunction, oListener?): sap.ui.commons.Accordion

Attaches event handler fnFunction to the sectionOpen event of this sap.ui.commons.Accordion.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.commons.Accordion itself.

Event is triggered when the user opens a section.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.commons.Accordion itself
Returns:
sap.ui.commons.AccordionReference to this in order to allow method chaining
attachSectionsReorder(oData?, fnFunction, oListener?): sap.ui.commons.Accordion

Attaches event handler fnFunction to the sectionsReorder event of this sap.ui.commons.Accordion.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.commons.Accordion itself.

Event is triggered when the user changes the position of a section.

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.commons.Accordion itself
Returns:
sap.ui.commons.AccordionReference to this in order to allow method chaining
closeSection(sSectionId): void
Closes a section and opens the default one
Parameters:
stringsSectionIdId of the section that is being closed
destroySections(): sap.ui.commons.Accordion
Destroys all the sections in the aggregation sections.
Returns:
sap.ui.commons.AccordionReference to this in order to allow method chaining
detachSectionClose(fnFunction, oListener): sap.ui.commons.Accordion

Detaches event handler fnFunction from the sectionClose event of this sap.ui.commons.Accordion.

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.commons.AccordionReference to this in order to allow method chaining
detachSectionOpen(fnFunction, oListener): sap.ui.commons.Accordion

Detaches event handler fnFunction from the sectionOpen event of this sap.ui.commons.Accordion.

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.commons.AccordionReference to this in order to allow method chaining
detachSectionsReorder(fnFunction, oListener): sap.ui.commons.Accordion

Detaches event handler fnFunction from the sectionsReorder event of this sap.ui.commons.Accordion.

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.commons.AccordionReference to this in order to allow method chaining
fireSectionClose(mParameters?): sap.ui.commons.Accordion
Fires event sectionClose to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
stringmParameters.closeSectionId?ID of the closed section
Returns:
sap.ui.commons.AccordionReference to this in order to allow method chaining
fireSectionOpen(mParameters?): sap.ui.commons.Accordion
Fires event sectionOpen to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
stringmParameters.openSectionId?ID of the opened section
string[]mParameters.closeSectionIds?IDs of the sections to be closed. Can be initial in the case of no previously opened section.
Returns:
sap.ui.commons.AccordionReference to this in order to allow method chaining
fireSectionsReorder(mParameters?): sap.ui.commons.Accordion
Fires event sectionsReorder to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
stringmParameters.movedSectionId?ID of the moved section
intmParameters.newIndex?New index of the moved section
Returns:
sap.ui.commons.AccordionReference to this in order to allow method chaining
getOpenedSectionsId(): string

Gets current value of property openedSectionsId.

Section IDs that are opened by default at application start

Returns:
stringValue of property openedSectionsId

Gets content of aggregation sections.

Empty container used to display any library control

Returns:
sap.ui.commons.AccordionSection[]
getWidth(): sap.ui.core.CSSSize

Gets current value of property width.

When the specified width is less than the width of a section content, a horizontal scroll bar is provided.

Default value is 200px.

Returns:
sap.ui.core.CSSSizeValue of property width
indexOfSection(oSection): int
Checks for the provided sap.ui.commons.AccordionSection in the aggregation sections. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.commons.AccordionSectionoSectionThe section whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertSection(oSection, iIndex): sap.ui.commons.Accordion
Inserts a section into the aggregation sections.
Parameters:
sap.ui.commons.AccordionSectionoSectionthe section to insert; if empty, nothing is inserted
intiIndexthe 0-based index the section should be inserted at; for a negative value of iIndex, the section is inserted at position 0; for a value greater than the current size of the aggregation, the section is inserted at the last position
Returns:
sap.ui.commons.AccordionReference to this in order to allow method chaining
openSection(sSectionId): void
Opens a section
Parameters:
stringsSectionIdId of the section that is being opened
removeAllSections(): sap.ui.commons.AccordionSection[]

Removes all the controls from the aggregation sections.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.commons.AccordionSection[]An array of the removed elements (might be empty)
removeSection(vSection): sap.ui.commons.AccordionSection
Removes a section from the aggregation sections.
Parameters:
int|string|sap.ui.commons.AccordionSectionvSectionThe section to remove or its index or id
Returns:
sap.ui.commons.AccordionSectionThe removed section or null
setOpenedSectionsId(sOpenedSectionsId): sap.ui.commons.Accordion
Redefinition of the method to add additional handling
Parameters:
stringsOpenedSectionsIdNew value for property openedSectionsId
Returns:
sap.ui.commons.Accordion'this' to allow method chaining
setWidth(sWidth): sap.ui.commons.Accordion

Sets a new value for property width.

When the specified width is less than the width of a section content, a horizontal scroll bar is provided.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 200px.

Parameters:
sap.ui.core.CSSSizesWidthNew value for property width
Returns:
sap.ui.commons.AccordionReference to this in order to allow method chaining