Class sap.uxap.ObjectPageSubSectionModule: sap/uxap/ObjectPageSubSection

extends ObjectPageSectionBase

An ObjectPageSubSection is the second-level information container of an Object page and may only be used within an Object page section. Subsections may display primary information in the so called blocks aggregation (always visible) and not-so-important information in the moreBlocks aggregation, whose content is initially hidden, but may be accessed via a See more (...) button. Disclaimer: This control is intended to be used only as part of the Object page layout


Since: 1.26.
Constructor Summary
new sap.uxap.ObjectPageSubSection(sId?, mSettings?)Constructor for a new ObjectPageSubSection.
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.ObjectPageSubSection.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.uxap.ObjectPageSubSection with name sClassName and enriches it with the information contained in oClassInfo.
sap.uxap.ObjectPageSubSection.getMetadata()Returns a metadata object for class sap.uxap.ObjectPageSubSection.
addAction(oAction)Adds some action to the aggregation actions.
addBlock(oBlock)Adds some block to the aggregation blocks.
addMoreBlock(oMoreBlock)Adds some moreBlock to the aggregation moreBlocks.
destroyActions()Destroys all the actions in the aggregation actions.
destroyBlocks()Destroys all the blocks in the aggregation blocks.
destroyMoreBlocks()Destroys all the moreBlocks in the aggregation moreBlocks.
getActions()Gets content of aggregation actions.
getBlocks()Gets content of aggregation blocks.
getMode()Gets current value of property mode.
getMoreBlocks()Gets content of aggregation moreBlocks.
getTitleUppercase()Gets current value of property titleUppercase.
indexOfAction(oAction)Checks for the provided sap.ui.core.Control in the aggregation actions.
indexOfBlock(oBlock)Checks for the provided sap.ui.core.Control in the aggregation blocks.
indexOfMoreBlock(oMoreBlock)Checks for the provided sap.ui.core.Control in the aggregation moreBlocks.
insertAction(oAction, iIndex)Inserts a action into the aggregation actions.
insertBlock(oBlock, iIndex)Inserts a block into the aggregation blocks.
insertMoreBlock(oMoreBlock, iIndex)Inserts a moreBlock into the aggregation moreBlocks.
removeAction(vAction)Removes a action from the aggregation actions.
removeAllActions()Removes all the controls from the aggregation actions.
removeAllBlocks()Removes all the controls from the aggregation blocks.
removeAllMoreBlocks()Removes all the controls from the aggregation moreBlocks.
removeBlock(vBlock)Removes a block from the aggregation blocks.
removeMoreBlock(vMoreBlock)Removes a moreBlock from the aggregation moreBlocks.
setMode(sMode)Sets a new value for property mode.
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, 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, 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.ObjectPageSubSection(sId?, mSettings?)
Constructor for a new ObjectPageSubSection.

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
    • mode : sap.uxap.ObjectPageSubSectionMode (default: Collapsed)
    • titleUppercase : boolean (default: false)
  • Aggregations

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.ObjectPageSubSection.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.uxap.ObjectPageSubSection 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.ObjectPageSubSection.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.uxap.ObjectPageSubSection.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addAction(oAction): sap.uxap.ObjectPageSubSection
Adds some action to the aggregation actions.
Parameters:
{sap.ui.core.Control}oAction the action to add; if empty, nothing is inserted
Returns:
{sap.uxap.ObjectPageSubSection} Reference to this in order to allow method chaining
addBlock(oBlock): sap.uxap.ObjectPageSubSection
Adds some block to the aggregation blocks.
Parameters:
{sap.ui.core.Control}oBlock the block to add; if empty, nothing is inserted
Returns:
{sap.uxap.ObjectPageSubSection} Reference to this in order to allow method chaining
addMoreBlock(oMoreBlock): sap.uxap.ObjectPageSubSection
Adds some moreBlock to the aggregation moreBlocks.
Parameters:
{sap.ui.core.Control}oMoreBlock the moreBlock to add; if empty, nothing is inserted
Returns:
{sap.uxap.ObjectPageSubSection} Reference to this in order to allow method chaining
destroyActions(): sap.uxap.ObjectPageSubSection
Destroys all the actions in the aggregation actions.
Returns:
{sap.uxap.ObjectPageSubSection} Reference to this in order to allow method chaining
destroyBlocks(): sap.uxap.ObjectPageSubSection
Destroys all the blocks in the aggregation blocks.
Returns:
{sap.uxap.ObjectPageSubSection} Reference to this in order to allow method chaining
destroyMoreBlocks(): sap.uxap.ObjectPageSubSection
Destroys all the moreBlocks in the aggregation moreBlocks.
Returns:
{sap.uxap.ObjectPageSubSection} Reference to this in order to allow method chaining
getActions(): sap.ui.core.Control[]
Gets content of aggregation actions.

Actions available for this Subsection

Returns:
{sap.ui.core.Control[]}
getBlocks(): sap.ui.core.Control[]
Gets content of aggregation blocks.

Controls to be displayed in the subsection

Returns:
{sap.ui.core.Control[]}
getMode(): sap.uxap.ObjectPageSubSectionMode
Gets current value of property mode.

A mode property that will be passed to the controls in the blocks and moreBlocks aggregations. Only relevant if these aggregations use Object page blocks.

Default value is Collapsed.

Returns:
{sap.uxap.ObjectPageSubSectionMode} Value of property mode
getMoreBlocks(): sap.ui.core.Control[]
Gets content of aggregation moreBlocks.

Additional controls to display when the Show more / See all / (...) button is pressed

Returns:
{sap.ui.core.Control[]}
getTitleUppercase(): boolean
Gets current value of property titleUppercase.

Determines whether the Subsection title is displayed in upper case.

Default value is false.

Returns:
{boolean} Value of property titleUppercase
indexOfAction(oAction): int
Checks for the provided sap.ui.core.Control in the aggregation actions. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Control}oAction The action whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
indexOfBlock(oBlock): int
Checks for the provided sap.ui.core.Control in the aggregation blocks. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Control}oBlock The block whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
indexOfMoreBlock(oMoreBlock): int
Checks for the provided sap.ui.core.Control in the aggregation moreBlocks. and returns its index if found or -1 otherwise.
Parameters:
{sap.ui.core.Control}oMoreBlock The moreBlock whose index is looked for
Returns:
{int} The index of the provided control in the aggregation if found, or -1 otherwise
insertAction(oAction, iIndex): sap.uxap.ObjectPageSubSection
Inserts a action into the aggregation actions.
Parameters:
{sap.ui.core.Control}oAction the action to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the action should be inserted at; for a negative value of iIndex, the action is inserted at position 0; for a value greater than the current size of the aggregation, the action is inserted at the last position
Returns:
{sap.uxap.ObjectPageSubSection} Reference to this in order to allow method chaining
insertBlock(oBlock, iIndex): sap.uxap.ObjectPageSubSection
Inserts a block into the aggregation blocks.
Parameters:
{sap.ui.core.Control}oBlock the block to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the block should be inserted at; for a negative value of iIndex, the block is inserted at position 0; for a value greater than the current size of the aggregation, the block is inserted at the last position
Returns:
{sap.uxap.ObjectPageSubSection} Reference to this in order to allow method chaining
insertMoreBlock(oMoreBlock, iIndex): sap.uxap.ObjectPageSubSection
Inserts a moreBlock into the aggregation moreBlocks.
Parameters:
{sap.ui.core.Control}oMoreBlock the moreBlock to insert; if empty, nothing is inserted
{int}iIndex the 0-based index the moreBlock should be inserted at; for a negative value of iIndex, the moreBlock is inserted at position 0; for a value greater than the current size of the aggregation, the moreBlock is inserted at the last position
Returns:
{sap.uxap.ObjectPageSubSection} Reference to this in order to allow method chaining
removeAction(vAction): sap.ui.core.Control
Removes a action from the aggregation actions.
Parameters:
{int|string|sap.ui.core.Control}vAction The actionto remove or its index or id
Returns:
{sap.ui.core.Control} The removed action or null
removeAllActions(): sap.ui.core.Control[]
Removes all the controls from the aggregation actions.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeAllBlocks(): sap.ui.core.Control[]
Removes all the controls from the aggregation blocks.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeAllMoreBlocks(): sap.ui.core.Control[]
Removes all the controls from the aggregation moreBlocks.

Additionally, it unregisters them from the hosting UIArea.

Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeBlock(vBlock): sap.ui.core.Control
Removes a block from the aggregation blocks.
Parameters:
{int|string|sap.ui.core.Control}vBlock The blockto remove or its index or id
Returns:
{sap.ui.core.Control} The removed block or null
removeMoreBlock(vMoreBlock): sap.ui.core.Control
Removes a moreBlock from the aggregation moreBlocks.
Parameters:
{int|string|sap.ui.core.Control}vMoreBlock The moreBlockto remove or its index or id
Returns:
{sap.ui.core.Control} The removed moreBlock or null
setMode(sMode): sap.uxap.ObjectPageSubSection
Sets a new value for property mode.

A mode property that will be passed to the controls in the blocks and moreBlocks aggregations. Only relevant if these aggregations use Object page blocks.

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

Default value is Collapsed.

Parameters:
{sap.uxap.ObjectPageSubSectionMode}sMode New value for property mode
Returns:
{sap.uxap.ObjectPageSubSection} Reference to this in order to allow method chaining
setTitleUppercase(bTitleUppercase): sap.uxap.ObjectPageSubSection
Sets a new value for property titleUppercase.

Determines whether the Subsection 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 false.

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