An abstract container for sections and subsections in the sap.uxap.ObjectPageLayout.
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#constructor for a general description of the syntax of the settings object.
new sap.uxap.ObjectPageSectionBase(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | ID for the new control, generated automatically if no ID is given |
|
mSettings? | object | Initial settings for the new control |
Name | Type | Default Value | Description |
---|---|---|---|
importance | sap.uxap.Importance | High | Determines whether the section will be hidden on low resolutions. |
title | string | Defines the title of the respective section/subsection. Note: If a subsection is the only one (or the only one visible) within a section, its title is displayed instead of the section title. This behavior is true even if the |
|
titleLevel | sap.ui.core.TitleLevel | Auto | Determines the ARIA level of the Note: Defining a |
visible | boolean | true | Invisible ObjectPageSectionBase are not rendered Visibility: public |
Default Aggregation:
Name | Cardinality | Type | Description |
---|---|---|---|
ariaLabelledBy | 0..1 | sap.ui.core.InvisibleText |
Screen Reader ariaLabelledBy |
customAnchorBarButton | 0..1 | sap.m.Button |
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. |
Method | Description |
---|---|
connectToModels |
Explicitly ask to connect to the UI5 model tree |
destroyCustomAnchorBarButton |
Destroys the customAnchorBarButton in the aggregation customAnchorBarButton. |
sap.uxap.ObjectPageSectionBase.extend |
Creates a new subclass of class sap.uxap.ObjectPageSectionBase with name
|
getCustomAnchorBarButton |
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. |
getImportance |
Gets current value of property importance. Determines whether the section will be hidden on low resolutions. Default value is |
sap.uxap.ObjectPageSectionBase.getMetadata |
Returns a metadata object for class sap.uxap.ObjectPageSectionBase. |
getSectionText |
Returns the control name text. To be overwritten by the specific control method. |
getTitle |
Gets current value of property title. Defines the title of the respective section/subsection. Note: If a subsection is the only one (or the only one visible) within a section, its title is displayed instead of the section title. This behavior is true even if the |
getTitleLevel |
Gets current value of property titleLevel. Determines the ARIA level of the Note: Defining a Default value is |
getVisible |
Gets current value of property visible. Invisible ObjectPageSectionBase are not rendered Default value is |
setCustomAnchorBarButton |
Sets the aggregated customAnchorBarButton. |
setImportance |
Sets a new value for property importance. Determines whether the section will be hidden on low resolutions. When called with a value of Default value is |
setInvisibleTextLabelValue |
Returns the DOM Element that should get the focus. To be overwritten by the specific control method. |
setTitle |
Sets a new value for property title. Defines the title of the respective section/subsection. Note: If a subsection is the only one (or the only one visible) within a section, its title is displayed instead of the section title. This behavior is true even if the When called with a value of |
setTitleLevel |
Sets a new value for property titleLevel. Determines the ARIA level of the Note: Defining a When called with a value of Default value is |
setVisible |
Sets a new value for property visible. Invisible ObjectPageSectionBase are not rendered When called with a value of Default value is |
Destroys the customAnchorBarButton in the aggregation customAnchorBarButton.
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sClassName | string |
Name of the class being created |
|
oClassInfo | object |
Object literal with information about the class |
|
FNMetaImpl | function |
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class |
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.
Gets current value of property importance.
Determines whether the section will be hidden on low resolutions.
Default value is High
.
Returns a metadata object for class sap.uxap.ObjectPageSectionBase.
Gets current value of property title.
Defines the title of the respective section/subsection.
Note: If a subsection is the only one (or the only one visible) within a section, its title is displayed instead of the section title. This behavior is true even if the showTitle
propeprty of sap.uxap.ObjectPageSubSection is set to false
.
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
.
Gets current value of property visible.
Invisible ObjectPageSectionBase are not rendered
Default value is true
.
Sets the aggregated customAnchorBarButton.
Param | Type | DefaultValue | Description |
---|---|---|---|
oCustomAnchorBarButton | sap.m.Button |
The customAnchorBarButton to set |
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 High
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sImportance | sap.uxap.Importance | High |
New value for property |
Returns the DOM Element that should get the focus.
To be overwritten by the specific control method.
Sets a new value for property title.
Defines the title of the respective section/subsection.
Note: If a subsection is the only one (or the only one visible) within a section, its title is displayed instead of the section title. This behavior is true even if the showTitle
propeprty of sap.uxap.ObjectPageSubSection is set to false
.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sTitle | string |
New value for property |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sTitleLevel | sap.ui.core.TitleLevel | Auto |
New value for property |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
bVisible | boolean | true |
New value for property |