Class sap.ui.commons.AccordionSectionModule: sap/ui/commons/AccordionSection
extends Element
Represents a panel which is a container for other controls. The container does not have any layout function.
Deprecated API:Since version 1.38.
Constructor Summary
Event Summary
Events borrowed from class sap.ui.base.ManagedObject
Method Summary
sap.ui.commons.AccordionSection.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.commons.AccordionSection with name
sClassName and enriches it with the information contained in oClassInfo.sap.ui.commons.AccordionSection.getMetadata()Returns a metadata object for class sap.ui.commons.AccordionSection.
attachScroll(oData?, fnFunction, oListener?)Attaches event handler
fnFunction to the scroll event of this sap.ui.commons.AccordionSection.detachScroll(fnFunction, oListener)Detaches event handler
fnFunction from the scroll event of this sap.ui.commons.AccordionSection.Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, rerender, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, invalidate, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
Constructor Detail
new sap.ui.commons.AccordionSection(sId?, mSettings?)
Constructor for a new AccordionSection.
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
- content : sap.ui.core.Control[] (default)
- Events
- scroll : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
In addition, all settings applicable to the base type sap.ui.core.Element can be used as well.
Parameters:
| {string} | sId? | id for the new control, generated automatically if no id is given |
| {object} | mSettings? | initial settings for the new control |
- Deprecated:
- Since version 1.38.
Event Detail
scroll(oControlEvent)
Event is fired when the user scrolls the panel
Parameters:
| {sap.ui.base.Event} | oControlEvent | |
| {sap.ui.base.EventProvider} | oControlEvent.getSource | |
| {object} | oControlEvent.getParameters | |
| {int} | oControlEvent.getParameters.left | Horizontal scroll position |
| {int} | oControlEvent.getParameters.top | Vertical scroll position |
Method Detail
sap.ui.commons.AccordionSection.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.commons.AccordionSection 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.Element.extend.
Parameters:
| {string} | sClassName | Name of the class being created |
| {object} | oClassInfo? | Object literal with information about the class |
| {function} | FNMetaImpl? | Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata |
Returns:
| {function} | Created class / constructor function |
sap.ui.commons.AccordionSection.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.commons.AccordionSection.
Returns:
| {sap.ui.base.Metadata} | Metadata object describing this class |
addContent(oContent): sap.ui.commons.AccordionSection
Adds some content to the aggregation
content. Parameters:
| {sap.ui.core.Control} | oContent | the content to add; if empty, nothing is inserted |
Returns:
| {sap.ui.commons.AccordionSection} | Reference to this in order to allow method chaining |
attachScroll(oData?, fnFunction, oListener?): sap.ui.commons.AccordionSection
Attaches event handler
fnFunction to the scroll event of this sap.ui.commons.AccordionSection. 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.AccordionSection itself.
Event is fired when the user scrolls the panel
Parameters:
| {object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
| {function} | fnFunction | The function to be called when the event occurs |
| {object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.commons.AccordionSection itself |
Returns:
| {sap.ui.commons.AccordionSection} | Reference to this in order to allow method chaining |
destroyContent(): sap.ui.commons.AccordionSection
Destroys all the content in the aggregation
content. Returns:
| {sap.ui.commons.AccordionSection} | Reference to this in order to allow method chaining |
detachScroll(fnFunction, oListener): sap.ui.commons.AccordionSection
Detaches event handler
fnFunction from the scroll event of this sap.ui.commons.AccordionSection. The passed function and listener object must match the ones used for event registration.
Parameters:
| {function} | fnFunction | The function to be called, when the event occurs |
| {object} | oListener | Context object on which the given function had to be called |
Returns:
| {sap.ui.commons.AccordionSection} | Reference to this in order to allow method chaining |
fireScroll(mArguments?): sap.ui.commons.AccordionSection
Fires event
scroll to attached listeners. Expects the following event parameters:
leftof typeintHorizontal scroll positiontopof typeintVertical scroll position
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
Returns:
| {sap.ui.commons.AccordionSection} | Reference to this in order to allow method chaining |
getContent(): sap.ui.core.Control[]
Gets content of aggregation
content. Aggregates the controls that are contained in the panel. The control layout is browser-dependent. For a stable content layout, use a layout control as direct single child. When the panel dimensions are set, the child control may have width and height of 100%; when the panel dimensions are not set, the child defines the panel size.
Returns:
| {sap.ui.core.Control[]} |
getEnabled(): boolean
Gets current value of property
enabled. It is required that the used theme supports the control.
Default value is true.
Returns:
| {boolean} | Value of property enabled |
getMaxHeight(): sap.ui.core.CSSSize
Gets current value of property
maxHeight. When the section content exceeds maxHeight, a vertical scroll bar appears.
Returns:
| {sap.ui.core.CSSSize} | Value of property maxHeight |
getTitle(): string
Gets current value of property
title. Text for the section header
Returns:
| {string} | Value of property title |
indexOfContent(oContent): int
Checks for the provided
sap.ui.core.Control in the aggregation content. and returns its index if found or -1 otherwise. Parameters:
| {sap.ui.core.Control} | oContent | The content whose index is looked for |
Returns:
| {int} | The index of the provided control in the aggregation if found, or -1 otherwise |
insertContent(oContent, iIndex): sap.ui.commons.AccordionSection
Inserts a content into the aggregation
content. Parameters:
| {sap.ui.core.Control} | oContent | the content to insert; if empty, nothing is inserted |
| {int} | iIndex | the 0-based index the content should be inserted at; for a negative value of iIndex, the content is inserted at position 0; for a value greater than the current size of the aggregation, the content is inserted at the last position |
Returns:
| {sap.ui.commons.AccordionSection} | Reference to this in order to allow method chaining |
removeAllContent(): sap.ui.core.Control[]
Removes all the controls from the aggregation
content. Additionally, it unregisters them from the hosting UIArea.
Returns:
| {sap.ui.core.Control[]} | An array of the removed elements (might be empty) |
removeContent(vContent): sap.ui.core.Control
Removes a content from the aggregation
content. Parameters:
| {int|string|sap.ui.core.Control} | vContent | The contentto remove or its index or id |
Returns:
| {sap.ui.core.Control} | The removed content or null |
setCollapsed(bCollapsed): sap.ui.commons.AccordionSection
Property setter for the "collapsed" state
Parameters:
| {boolean} | bCollapsed | Whether the AccordionSection is collapsed or not |
Returns:
| {sap.ui.commons.AccordionSection} | 'this' to allow method chaining |
setEnabled(bEnabled): sap.ui.commons.AccordionSection
Property setter for the "enabled" state
Parameters:
| {boolean} | bEnabled | Whether the AccordionSection is enabled or not |
Returns:
| {sap.ui.commons.AccordionSection} | 'this' to allow method chaining |
setMaxHeight(sMaxHeight): sap.ui.commons.AccordionSection
Sets a new value for property
maxHeight. When the section content exceeds maxHeight, a vertical scroll bar appears.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {sap.ui.core.CSSSize} | sMaxHeight | New value for property maxHeight |
Returns:
| {sap.ui.commons.AccordionSection} | Reference to this in order to allow method chaining |
setTitle(sTitle): sap.ui.commons.AccordionSection
Sets a new value for property
title. Text for the section header
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {string} | sTitle | New value for property title |
Returns:
| {sap.ui.commons.AccordionSection} | Reference to this in order to allow method chaining |