class sap.uxap.ObjectPageAccessibleLandmarkInfo

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/uxap/ObjectPageAccessibleLandmarkInfo
Application Component: CA-UI5-CTR

Settings for accessible landmarks which can be applied to the container elements of a sap.uxap.ObjectPageLayout control. These landmarks are used by assistive technologies (such as screenreaders) to provide a meaningful page overview.


Constructor

Constructor for a new sap.uxap.ObjectPageAccessibleLandmarkInfo element.

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.ObjectPageAccessibleLandmarkInfo(sId?, mSettings?)
Param Type Default Value Description
sId? string

ID for the new element, generated automatically if no ID is given

mSettings? object

Initial settings for the new element


Properties

Name Type Default Value Description
contentLabel string

Texts which describe the landmark of the content container of the corresponding sap.uxap.ObjectPageLayout control.

If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None is defined), no label is set.

Visibility: public
contentRole sap.ui.core.AccessibleLandmarkRole None

Landmark role of the content container of the corresponding sap.uxap.ObjectPageLayout control.

If set to sap.ui.core.AccessibleLandmarkRole.None, no landmark will be added to the container.

Visibility: public
footerLabel string

Texts which describe the landmark of the header container of the corresponding sap.uxap.ObjectPageLayout control.

If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None is defined), no label is set.

Visibility: public
footerRole sap.ui.core.AccessibleLandmarkRole Region

Landmark role of the footer container of the corresponding sap.uxap.ObjectPageLayout control.

If set to sap.ui.core.AccessibleLandmarkRole.None, no landmark will be added to the container.

Visibility: public
headerLabel string

Texts which describe the landmark of the header container of the corresponding sap.uxap.ObjectPageLayout control.

If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None is defined), no label is set.

Visibility: public
headerRole sap.ui.core.AccessibleLandmarkRole Banner

Landmark role of the header container of the corresponding sap.uxap.ObjectPageLayout control.

If set to sap.ui.core.AccessibleLandmarkRole.None, no landmark will be added to the container.

Visibility: public
navigationLabel string

Texts which describe the landmark of the navigation container of the corresponding sap.uxap.ObjectPageLayout control.

If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None is defined), no label is set.

Visibility: public
navigationRole sap.ui.core.AccessibleLandmarkRole Navigation

Landmark role of the navigation container of the corresponding sap.uxap.ObjectPageLayout control.

If set to sap.ui.core.AccessibleLandmarkRole.None, no landmark will be added to the container.

Visibility: public
rootLabel string

Texts which describe the landmark of the root container of the corresponding sap.uxap.ObjectPageLayout control.

If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None is defined), no label is set.

Visibility: public
rootRole sap.ui.core.AccessibleLandmarkRole Main

Landmark role of the root container of the corresponding sap.uxap.ObjectPageLayout control.

If set to sap.ui.core.AccessibleLandmarkRole.None, no landmark will be added to the container.

Visibility: public

Methods Overview

Method Description
sap.uxap.ObjectPageAccessibleLandmarkInfo.extend

Creates a new subclass of class sap.uxap.ObjectPageAccessibleLandmarkInfo 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.Element.extend.

getContentLabel

Gets current value of property contentLabel.

Texts which describe the landmark of the content container of the corresponding sap.uxap.ObjectPageLayout control.

If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None is defined), no label is set.

getContentRole

Gets current value of property contentRole.

Landmark role of the content container of the corresponding sap.uxap.ObjectPageLayout control.

If set to sap.ui.core.AccessibleLandmarkRole.None, no landmark will be added to the container.

Default value is "None".

getFooterLabel

Gets current value of property footerLabel.

Texts which describe the landmark of the header container of the corresponding sap.uxap.ObjectPageLayout control.

If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None is defined), no label is set.

getFooterRole

Gets current value of property footerRole.

Landmark role of the footer container of the corresponding sap.uxap.ObjectPageLayout control.

If set to sap.ui.core.AccessibleLandmarkRole.None, no landmark will be added to the container.

Default value is "Region".

getHeaderLabel

Gets current value of property headerLabel.

Texts which describe the landmark of the header container of the corresponding sap.uxap.ObjectPageLayout control.

If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None is defined), no label is set.

getHeaderRole

Gets current value of property headerRole.

Landmark role of the header container of the corresponding sap.uxap.ObjectPageLayout control.

If set to sap.ui.core.AccessibleLandmarkRole.None, no landmark will be added to the container.

Default value is "Banner".

sap.uxap.ObjectPageAccessibleLandmarkInfo.getMetadata

Returns a metadata object for class sap.uxap.ObjectPageAccessibleLandmarkInfo.

getNavigationLabel

Gets current value of property navigationLabel.

Texts which describe the landmark of the navigation container of the corresponding sap.uxap.ObjectPageLayout control.

If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None is defined), no label is set.

getNavigationRole

Gets current value of property navigationRole.

Landmark role of the navigation container of the corresponding sap.uxap.ObjectPageLayout control.

If set to sap.ui.core.AccessibleLandmarkRole.None, no landmark will be added to the container.

Default value is "Navigation".

getRootLabel

Gets current value of property rootLabel.

Texts which describe the landmark of the root container of the corresponding sap.uxap.ObjectPageLayout control.

If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None is defined), no label is set.

getRootRole

Gets current value of property rootRole.

Landmark role of the root container of the corresponding sap.uxap.ObjectPageLayout control.

If set to sap.ui.core.AccessibleLandmarkRole.None, no landmark will be added to the container.

Default value is "Main".

setContentLabel

Sets a new value for property contentLabel.

Texts which describe the landmark of the content container of the corresponding sap.uxap.ObjectPageLayout control.

If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None is defined), no label is set.

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

setContentRole

Sets a new value for property contentRole.

Landmark role of the content container of the corresponding sap.uxap.ObjectPageLayout control.

If set to sap.ui.core.AccessibleLandmarkRole.None, no landmark will be added to the container.

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

Default value is "None".

setFooterLabel

Sets a new value for property footerLabel.

Texts which describe the landmark of the header container of the corresponding sap.uxap.ObjectPageLayout control.

If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None is defined), no label is set.

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

setFooterRole

Sets a new value for property footerRole.

Landmark role of the footer container of the corresponding sap.uxap.ObjectPageLayout control.

If set to sap.ui.core.AccessibleLandmarkRole.None, no landmark will be added to the container.

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

Default value is "Region".

setHeaderLabel

Sets a new value for property headerLabel.

Texts which describe the landmark of the header container of the corresponding sap.uxap.ObjectPageLayout control.

If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None is defined), no label is set.

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

setHeaderRole

Sets a new value for property headerRole.

Landmark role of the header container of the corresponding sap.uxap.ObjectPageLayout control.

If set to sap.ui.core.AccessibleLandmarkRole.None, no landmark will be added to the container.

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

Default value is "Banner".

setNavigationLabel

Sets a new value for property navigationLabel.

Texts which describe the landmark of the navigation container of the corresponding sap.uxap.ObjectPageLayout control.

If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None is defined), no label is set.

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

setNavigationRole

Sets a new value for property navigationRole.

Landmark role of the navigation container of the corresponding sap.uxap.ObjectPageLayout control.

If set to sap.ui.core.AccessibleLandmarkRole.None, no landmark will be added to the container.

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

Default value is "Navigation".

setRootLabel

Sets a new value for property rootLabel.

Texts which describe the landmark of the root container of the corresponding sap.uxap.ObjectPageLayout control.

If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None is defined), no label is set.

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

setRootRole

Sets a new value for property rootRole.

Landmark role of the root container of the corresponding sap.uxap.ObjectPageLayout control.

If set to sap.ui.core.AccessibleLandmarkRole.None, no landmark will be added to the container.

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

Default value is "Main".

sap.uxap.ObjectPageAccessibleLandmarkInfo.extend

Creates a new subclass of class sap.uxap.ObjectPageAccessibleLandmarkInfo 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.Element.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

getContentLabel

Gets current value of property contentLabel.

Texts which describe the landmark of the content container of the corresponding sap.uxap.ObjectPageLayout control.

If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None is defined), no label is set.

getContentRole

Gets current value of property contentRole.

Landmark role of the content container of the corresponding sap.uxap.ObjectPageLayout control.

If set to sap.ui.core.AccessibleLandmarkRole.None, no landmark will be added to the container.

Default value is "None".

getFooterLabel

Gets current value of property footerLabel.

Texts which describe the landmark of the header container of the corresponding sap.uxap.ObjectPageLayout control.

If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None is defined), no label is set.

getFooterRole

Gets current value of property footerRole.

Landmark role of the footer container of the corresponding sap.uxap.ObjectPageLayout control.

If set to sap.ui.core.AccessibleLandmarkRole.None, no landmark will be added to the container.

Default value is "Region".

getHeaderLabel

Gets current value of property headerLabel.

Texts which describe the landmark of the header container of the corresponding sap.uxap.ObjectPageLayout control.

If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None is defined), no label is set.

getHeaderRole

Gets current value of property headerRole.

Landmark role of the header container of the corresponding sap.uxap.ObjectPageLayout control.

If set to sap.ui.core.AccessibleLandmarkRole.None, no landmark will be added to the container.

Default value is "Banner".

sap.uxap.ObjectPageAccessibleLandmarkInfo.getMetadata

Returns a metadata object for class sap.uxap.ObjectPageAccessibleLandmarkInfo.

getNavigationLabel

Gets current value of property navigationLabel.

Texts which describe the landmark of the navigation container of the corresponding sap.uxap.ObjectPageLayout control.

If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None is defined), no label is set.

getNavigationRole

Gets current value of property navigationRole.

Landmark role of the navigation container of the corresponding sap.uxap.ObjectPageLayout control.

If set to sap.ui.core.AccessibleLandmarkRole.None, no landmark will be added to the container.

Default value is "Navigation".

getRootLabel

Gets current value of property rootLabel.

Texts which describe the landmark of the root container of the corresponding sap.uxap.ObjectPageLayout control.

If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None is defined), no label is set.

getRootRole

Gets current value of property rootRole.

Landmark role of the root container of the corresponding sap.uxap.ObjectPageLayout control.

If set to sap.ui.core.AccessibleLandmarkRole.None, no landmark will be added to the container.

Default value is "Main".

setContentLabel

Sets a new value for property contentLabel.

Texts which describe the landmark of the content container of the corresponding sap.uxap.ObjectPageLayout control.

If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None is defined), no label is set.

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

Param Type DefaultValue Description
sContentLabel string

New value for property contentLabel

setContentRole

Sets a new value for property contentRole.

Landmark role of the content container of the corresponding sap.uxap.ObjectPageLayout control.

If set to sap.ui.core.AccessibleLandmarkRole.None, no landmark will be added to the container.

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

Default value is "None".

Param Type DefaultValue Description
sContentRole sap.ui.core.AccessibleLandmarkRole "None"

New value for property contentRole

setFooterLabel

Sets a new value for property footerLabel.

Texts which describe the landmark of the header container of the corresponding sap.uxap.ObjectPageLayout control.

If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None is defined), no label is set.

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

Param Type DefaultValue Description
sFooterLabel string

New value for property footerLabel

setFooterRole

Sets a new value for property footerRole.

Landmark role of the footer container of the corresponding sap.uxap.ObjectPageLayout control.

If set to sap.ui.core.AccessibleLandmarkRole.None, no landmark will be added to the container.

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

Default value is "Region".

Param Type DefaultValue Description
sFooterRole sap.ui.core.AccessibleLandmarkRole "Region"

New value for property footerRole

setHeaderLabel

Sets a new value for property headerLabel.

Texts which describe the landmark of the header container of the corresponding sap.uxap.ObjectPageLayout control.

If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None is defined), no label is set.

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

Param Type DefaultValue Description
sHeaderLabel string

New value for property headerLabel

setHeaderRole

Sets a new value for property headerRole.

Landmark role of the header container of the corresponding sap.uxap.ObjectPageLayout control.

If set to sap.ui.core.AccessibleLandmarkRole.None, no landmark will be added to the container.

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

Default value is "Banner".

Param Type DefaultValue Description
sHeaderRole sap.ui.core.AccessibleLandmarkRole "Banner"

New value for property headerRole

setNavigationLabel

Sets a new value for property navigationLabel.

Texts which describe the landmark of the navigation container of the corresponding sap.uxap.ObjectPageLayout control.

If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None is defined), no label is set.

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

Param Type DefaultValue Description
sNavigationLabel string

New value for property navigationLabel

setNavigationRole

Sets a new value for property navigationRole.

Landmark role of the navigation container of the corresponding sap.uxap.ObjectPageLayout control.

If set to sap.ui.core.AccessibleLandmarkRole.None, no landmark will be added to the container.

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

Default value is "Navigation".

Param Type DefaultValue Description
sNavigationRole sap.ui.core.AccessibleLandmarkRole "Navigation"

New value for property navigationRole

setRootLabel

Sets a new value for property rootLabel.

Texts which describe the landmark of the root container of the corresponding sap.uxap.ObjectPageLayout control.

If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None is defined), no label is set.

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

Param Type DefaultValue Description
sRootLabel string

New value for property rootLabel

setRootRole

Sets a new value for property rootRole.

Landmark role of the root container of the corresponding sap.uxap.ObjectPageLayout control.

If set to sap.ui.core.AccessibleLandmarkRole.None, no landmark will be added to the container.

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

Default value is "Main".

Param Type DefaultValue Description
sRootRole sap.ui.core.AccessibleLandmarkRole "Main"

New value for property rootRole