Class sap.uxap.ObjectPageSectionBaseModule: sap/uxap/ObjectPageSectionBase

extends Control
known direct subclasses: ObjectPageSection, ObjectPageSubSection

An abstract container for object page sections and subSections


Since: 1.26.
Constructor Summary
new sap.uxap.ObjectPageSectionBase(sId?, mSettings?)Constructor for a new ObjectPageSectionBase.
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.ObjectPageSectionBase.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.uxap.ObjectPageSectionBase with name sClassName and enriches it with the information contained in oClassInfo.
sap.uxap.ObjectPageSectionBase.getMetadata()Returns a metadata object for class sap.uxap.ObjectPageSectionBase.
connectToModels()Explicitly ask to connect to the UI5 model tree
destroyCustomAnchorBarButton()Destroys the customAnchorBarButton in the aggregation customAnchorBarButton.
getCustomAnchorBarButton()Gets content of aggregation customAnchorBarButton.
getImportance()Gets current value of property importance.
getTitle()Gets current value of property title.
getVisible()Gets current value of property visible.
setCustomAnchorBarButton(oCustomAnchorBarButton)Sets the aggregated customAnchorBarButton.
setImportance(sImportance)Sets a new value for property importance.
setTitle(sTitle)Sets a new value for property title.
setVisible(bVisible)Sets a new value for property visible.
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.ObjectPageSectionBase(sId?, mSettings?)
Constructor for a new ObjectPageSectionBase.

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.ui.core.Control 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.ObjectPageSectionBase.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.uxap.ObjectPageSectionBase 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:
{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.ObjectPageSectionBase.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.uxap.ObjectPageSectionBase.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
connectToModels(): void
Explicitly ask to connect to the UI5 model tree
destroyCustomAnchorBarButton(): sap.uxap.ObjectPageSectionBase
Destroys the customAnchorBarButton in the aggregation customAnchorBarButton.
Returns:
{sap.uxap.ObjectPageSectionBase} Reference to this in order to allow method chaining
getCustomAnchorBarButton(): sap.m.Button
Gets content of aggregation customAnchorBarButton.

The custom button that will provide a link to the section in the ObjectPageLayout anchor bar. This button will be used as a custom template to be into the ObjectPageLayout anchorBar area, therefore property changes happening on this button template after the first rendering won't affect the actual button copy used in the anchorBar.

If you want to change some of the button properties, you would need to bind them to a model.

Returns:
{sap.m.Button}
getImportance(): sap.uxap.Importance
Gets current value of property importance.

Determines whether the section will be hidden on low resolutions.

Default value is library.Importance.High.

Since:
1.32.0
Returns:
{sap.uxap.Importance} Value of property importance
getTitle(): string
Gets current value of property title.

Section Title

Returns:
{string} Value of property title
getVisible(): boolean
Gets current value of property visible.

Invisible ObjectPageSectionBase are not rendered

Default value is true.

Returns:
{boolean} Value of property visible
setCustomAnchorBarButton(oCustomAnchorBarButton): sap.uxap.ObjectPageSectionBase
Sets the aggregated customAnchorBarButton.
Parameters:
{sap.m.Button}oCustomAnchorBarButton The customAnchorBarButton to set
Returns:
{sap.uxap.ObjectPageSectionBase} Reference to this in order to allow method chaining
setImportance(sImportance): sap.uxap.ObjectPageSectionBase
Sets a new value for property importance.

Determines whether the section will be hidden on low resolutions.

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

Default value is library.Importance.High.

Parameters:
{sap.uxap.Importance}sImportance New value for property importance
Since:
1.32.0
Returns:
{sap.uxap.ObjectPageSectionBase} Reference to this in order to allow method chaining
setTitle(sTitle): sap.uxap.ObjectPageSectionBase
Sets a new value for property title.

Section Title

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.uxap.ObjectPageSectionBase} Reference to this in order to allow method chaining
setVisible(bVisible): sap.uxap.ObjectPageSectionBase
Sets a new value for property visible.

Invisible ObjectPageSectionBase are not rendered

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

Default value is true.

Parameters:
{boolean}bVisible New value for property visible
Returns:
{sap.uxap.ObjectPageSectionBase} Reference to this in order to allow method chaining