Class sap.uxap.ObjectPageSectionModule: sap/uxap/ObjectPageSection

extends ObjectPageSectionBase

An ObjectPageSection is the top-level information container of an Object page. Its purpose is to aggregate Subsections. Disclaimer: This control is intended to be used only as part of the Object page layout


Since: 1.26.
Constructor Summary
new sap.uxap.ObjectPageSection(sId?, mSettings?)Constructor for a new ObjectPageSection.
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.uxap.ObjectPageSection.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.uxap.ObjectPageSection with name sClassName and enriches it with the information contained in oClassInfo.
sap.uxap.ObjectPageSection.getMetadata()Returns a metadata object for class sap.uxap.ObjectPageSection.
addSubSection(oSubSection)Adds some subSection to the aggregation subSections.
destroySubSections()Destroys all the subSections in the aggregation subSections.
getSelectedSubSection()ID of the element which is the current target of the association selectedSubSection, or null.
getShowTitle()Gets current value of property showTitle.
getSubSections()Gets content of aggregation subSections.
getTitleUppercase()Gets current value of property titleUppercase.
indexOfSubSection(oSubSection)Checks for the provided sap.uxap.ObjectPageSubSection in the aggregation subSections.
insertSubSection(oSubSection, iIndex)Inserts a subSection into the aggregation subSections.
removeAllSubSections()Removes all the controls from the aggregation subSections.
removeSubSection(vSubSection)Removes a subSection from the aggregation subSections.
setSelectedSubSection(oSelectedSubSection)Sets the associated selectedSubSection.
setShowTitle(bShowTitle)Sets a new value for property showTitle.
setTitleUppercase(bTitleUppercase)Sets a new value for property titleUppercase.
Methods borrowed from class sap.uxap.ObjectPageSectionBase
connectToModels, destroyCustomAnchorBarButton, getCustomAnchorBarButton, getImportance, getTitle, getVisible, setCustomAnchorBarButton, setImportance, setTitle, setVisible
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, 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, 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
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.uxap.ObjectPageSection(sId?, mSettings?)
Constructor for a new ObjectPageSection.

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:

In addition, all settings applicable to the base type sap.uxap.ObjectPageSectionBase 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
Method Detail
sap.uxap.ObjectPageSection.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.uxap.ObjectPageSection with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.uxap.ObjectPageSectionBase.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.uxap.ObjectPageSection.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.uxap.ObjectPageSection.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addSubSection(oSubSection): sap.uxap.ObjectPageSection
Adds some subSection to the aggregation subSections.
Parameters:
{sap.uxap.ObjectPageSubSection}oSubSection the subSection to add; if empty, nothing is inserted
Returns:
{sap.uxap.ObjectPageSection} Reference to this in order to allow method chaining
destroySubSections(): sap.uxap.ObjectPageSection
Destroys all the subSections in the aggregation subSections.
Returns:
{sap.uxap.ObjectPageSection} Reference to this in order to allow method chaining
getSelectedSubSection(): sap.uxap.ObjectPageSubSection
ID of the element which is the current target of the association selectedSubSection, or null.
Returns:
{sap.uxap.ObjectPageSubSection}
getShowTitle(): boolean
Gets current value of property showTitle.

Determines whether to display the Section title or not.

Default value is true.

Returns:
{boolean} Value of property showTitle
getSubSections(): sap.uxap.ObjectPageSubSection[]
Gets content of aggregation subSections.

The list of Subsections.

Returns:
{sap.uxap.ObjectPageSubSection[]}
getTitleUppercase(): boolean
Gets current value of property titleUppercase.

Determines whether the Section title is displayed in upper case.

Default value is true.

Returns:
{boolean} Value of property titleUppercase
indexOfSubSection(oSubSection): int
Checks for the provided sap.uxap.ObjectPageSubSection in the aggregation subSections. and returns its index if found or -1 otherwise.
Parameters:
{sap.uxap.ObjectPageSubSection}oSubSection The subSection whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertSubSection(oSubSection, iIndex): sap.uxap.ObjectPageSection
Inserts a subSection into the aggregation subSections.
Parameters:
{sap.uxap.ObjectPageSubSection}oSubSection the subSection to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the subSection should be inserted at; for a negative value of iIndex, the subSection is inserted at position 0; for a value greater than the current size of the aggregation, the subSection is inserted at the last position
Returns:
{sap.uxap.ObjectPageSection} Reference to this in order to allow method chaining
removeAllSubSections(): sap.uxap.ObjectPageSubSection[]
Removes all the controls from the aggregation subSections.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.uxap.ObjectPageSubSection[]} An array of the removed elements (might be empty)
removeSubSection(vSubSection): sap.uxap.ObjectPageSubSection
Removes a subSection from the aggregation subSections.
Parameters:
{int|string|sap.uxap.ObjectPageSubSection}vSubSection The subSectionto remove or its index or id
Returns:
{sap.uxap.ObjectPageSubSection} The removed subSection or null
setSelectedSubSection(oSelectedSubSection): sap.uxap.ObjectPageSection
Sets the associated selectedSubSection.
Parameters:
{sap.uxap.ObjectPageSubSection}oSelectedSubSection Id of an element which becomes the new target of this selectedSubSection association; alternatively, an element instance may be given
Returns:
{sap.uxap.ObjectPageSection} Reference to this in order to allow method chaining
setShowTitle(bShowTitle): sap.uxap.ObjectPageSection
Sets a new value for property showTitle.

Determines whether to display the Section title or not.

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

Default value is true.

Parameters:
{boolean}bShowTitle New value for property showTitle
Returns:
{sap.uxap.ObjectPageSection} Reference to this in order to allow method chaining
setTitleUppercase(bTitleUppercase): sap.uxap.ObjectPageSection
Sets a new value for property titleUppercase.

Determines whether the Section title is displayed in upper case.

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

Default value is true.

Parameters:
{boolean}bTitleUppercase New value for property titleUppercase
Returns:
{sap.uxap.ObjectPageSection} Reference to this in order to allow method chaining