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
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.
getTitleLevel()Gets current value of property titleLevel.
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.
setTitleLevel(sTitleLevel)Sets a new value for property titleLevel.
setVisible(bVisible)Sets a new value for property visible.
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:
stringsId?id for the new control, generated automatically if no id is given
objectmSettings?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:
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.uxap.ObjectPageSectionBase.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.uxap.ObjectPageSectionBase.
Returns:
sap.ui.base.MetadataMetadata 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.ObjectPageSectionBaseReference 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.

Returns:
sap.uxap.ImportanceValue of property importance
Since:
1.32.0
getTitle(): string

Gets current value of property title.

Section Title

Returns:
stringValue of property title
getTitleLevel(): sap.ui.core.TitleLevel

Gets current value of property titleLevel.

Determines the ARIA level of the ObjectPageSectionBase title. The ARIA level is used by assisting technologies, such as screen readers, to create a hierarchical site map for faster navigation.


Note: Defining a titleLevel will add aria-level attribute from 1 to 6, instead of changing the ObjectPageSectionBase title HTML tag from H1 to H6.
For example: if titleLevel is TitleLevel.H1, it will result as aria-level of 1 added to the ObjectPageSectionBase title.

Default value is Auto.

Returns:
sap.ui.core.TitleLevelValue of property titleLevel
Since:
1.44.0
getVisible(): boolean

Gets current value of property visible.

Invisible ObjectPageSectionBase are not rendered

Default value is true.

Returns:
booleanValue of property visible
setCustomAnchorBarButton(oCustomAnchorBarButton): sap.uxap.ObjectPageSectionBase
Sets the aggregated customAnchorBarButton.
Parameters:
sap.m.ButtonoCustomAnchorBarButtonThe customAnchorBarButton to set
Returns:
sap.uxap.ObjectPageSectionBaseReference 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.ImportancesImportanceNew value for property importance
Returns:
sap.uxap.ObjectPageSectionBaseReference to this in order to allow method chaining
Since:
1.32.0

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:
stringsTitleNew value for property title
Returns:
sap.uxap.ObjectPageSectionBaseReference to this in order to allow method chaining
setTitleLevel(sTitleLevel): sap.uxap.ObjectPageSectionBase

Sets a new value for property titleLevel.

Determines the ARIA level of the ObjectPageSectionBase title. The ARIA level is used by assisting technologies, such as screen readers, to create a hierarchical site map for faster navigation.


Note: Defining a titleLevel will add aria-level attribute from 1 to 6, instead of changing the ObjectPageSectionBase title HTML tag from H1 to H6.
For example: if titleLevel is TitleLevel.H1, it will result as aria-level of 1 added to the ObjectPageSectionBase title.

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

Default value is Auto.

Parameters:
sap.ui.core.TitleLevelsTitleLevelNew value for property titleLevel
Returns:
sap.uxap.ObjectPageSectionBaseReference to this in order to allow method chaining
Since:
1.44.0
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:
booleanbVisibleNew value for property visible
Returns:
sap.uxap.ObjectPageSectionBaseReference to this in order to allow method chaining