Settings for accessible landmarks which can be applied to the container elements of a sap.m.Page
control. These landmarks are e.g. used by assistive technologies (like screenreaders) to provide a meaningful page overview.
Constructor for a new sap.m.PageAccessibleLandmarkInfo
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.m.PageAccessibleLandmarkInfo(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 |
Name | Type | Default Value | Description |
---|---|---|---|
contentLabel | string | Texts that describe the landmark of the content container of the corresponding If not set (and a landmark different than |
|
contentRole | sap.ui.core.AccessibleLandmarkRole | Main | Landmark role of the content container of the corresponding If set to |
footerLabel | string | Texts that describe the landmark of the footer container of the corresponding If not set (and a landmark different than |
|
footerRole | sap.ui.core.AccessibleLandmarkRole | Region | Landmark role of the footer container of the corresponding If set to |
headerLabel | string | Texts that describe the landmark of the header container of the corresponding If not set (and a landmark different than |
|
headerRole | sap.ui.core.AccessibleLandmarkRole | Region | Landmark role of the header container of the corresponding If set to |
rootLabel | string | Texts that describe the landmark of the root container of the corresponding If not set (and a landmark different than |
|
rootRole | sap.ui.core.AccessibleLandmarkRole | Region | Landmark role of the root container of the corresponding If set to |
subHeaderLabel | string | Texts that describe the landmark of the subheader container of the corresponding If not set (and a landmark different than |
|
subHeaderRole | sap.ui.core.AccessibleLandmarkRole | None | Landmark role of the subheader container of the corresponding If set to |
Method | Description |
---|---|
sap.m.PageAccessibleLandmarkInfo.extend |
Creates a new subclass of class sap.m.PageAccessibleLandmarkInfo with name
|
getContentLabel |
Gets current value of property contentLabel. Texts that describe the landmark of the content container of the corresponding If not set (and a landmark different than |
getContentRole |
Gets current value of property contentRole. Landmark role of the content container of the corresponding If set to Default value is |
getFooterLabel |
Gets current value of property footerLabel. Texts that describe the landmark of the footer container of the corresponding If not set (and a landmark different than |
getFooterRole |
Gets current value of property footerRole. Landmark role of the footer container of the corresponding If set to Default value is |
getHeaderLabel |
Gets current value of property headerLabel. Texts that describe the landmark of the header container of the corresponding If not set (and a landmark different than |
getHeaderRole |
Gets current value of property headerRole. Landmark role of the header container of the corresponding If set to Default value is |
sap.m.PageAccessibleLandmarkInfo.getMetadata |
Returns a metadata object for class sap.m.PageAccessibleLandmarkInfo. |
getRootLabel |
Gets current value of property rootLabel. Texts that describe the landmark of the root container of the corresponding If not set (and a landmark different than |
getRootRole |
Gets current value of property rootRole. Landmark role of the root container of the corresponding If set to Default value is |
getSubHeaderLabel |
Gets current value of property subHeaderLabel. Texts that describe the landmark of the subheader container of the corresponding If not set (and a landmark different than |
getSubHeaderRole |
Gets current value of property subHeaderRole. Landmark role of the subheader container of the corresponding If set to Default value is |
setContentLabel |
Sets a new value for property contentLabel. Texts that describe the landmark of the content container of the corresponding If not set (and a landmark different than When called with a value of |
setContentRole |
Sets a new value for property contentRole. Landmark role of the content container of the corresponding If set to When called with a value of Default value is |
setFooterLabel |
Sets a new value for property footerLabel. Texts that describe the landmark of the footer container of the corresponding If not set (and a landmark different than When called with a value of |
setFooterRole |
Sets a new value for property footerRole. Landmark role of the footer container of the corresponding If set to When called with a value of Default value is |
setHeaderLabel |
Sets a new value for property headerLabel. Texts that describe the landmark of the header container of the corresponding If not set (and a landmark different than When called with a value of |
setHeaderRole |
Sets a new value for property headerRole. Landmark role of the header container of the corresponding If set to When called with a value of Default value is |
setRootLabel |
Sets a new value for property rootLabel. Texts that describe the landmark of the root container of the corresponding If not set (and a landmark different than When called with a value of |
setRootRole |
Sets a new value for property rootRole. Landmark role of the root container of the corresponding If set to When called with a value of Default value is |
setSubHeaderLabel |
Sets a new value for property subHeaderLabel. Texts that describe the landmark of the subheader container of the corresponding If not set (and a landmark different than When called with a value of |
setSubHeaderRole |
Sets a new value for property subHeaderRole. Landmark role of the subheader container of the corresponding If set to When called with a value of Default value is |
Creates a new subclass of class sap.m.PageAccessibleLandmarkInfo 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 |
Gets current value of property contentLabel.
Texts that describe the landmark of the content container of the corresponding sap.m.Page
control.
If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None
is defined), a predefined text is used.
Gets current value of property contentRole.
Landmark role of the content container of the corresponding sap.m.Page
control.
If set to sap.ui.core.AccessibleLandmarkRole.None
, no landmark will be added to the container.
Default value is "Main"
.
Gets current value of property headerLabel.
Texts that describe the landmark of the header container of the corresponding sap.m.Page
control.
If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None
is defined), a predefined text is used.
Gets current value of property headerRole.
Landmark role of the header container of the corresponding sap.m.Page
control.
If set to sap.ui.core.AccessibleLandmarkRole.None
, no landmark will be added to the container.
Default value is "Region"
.
Returns a metadata object for class sap.m.PageAccessibleLandmarkInfo.
Gets current value of property rootLabel.
Texts that describe the landmark of the root container of the corresponding sap.m.Page
control.
If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None
is defined), a predefined text is used.
Gets current value of property rootRole.
Landmark role of the root container of the corresponding sap.m.Page
control.
If set to sap.ui.core.AccessibleLandmarkRole.None
, no landmark will be added to the container.
Default value is "Region"
.
Gets current value of property subHeaderLabel.
Texts that describe the landmark of the subheader container of the corresponding sap.m.Page
control.
If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None
is defined), a predefined text is used.
Gets current value of property subHeaderRole.
Landmark role of the subheader container of the corresponding sap.m.Page
control.
If set to sap.ui.core.AccessibleLandmarkRole.None
, no landmark will be added to the container.
Default value is "None"
.
Sets a new value for property contentLabel.
Texts that describe the landmark of the content container of the corresponding sap.m.Page
control.
If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None
is defined), a predefined text is used.
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 |
Sets a new value for property contentRole.
Landmark role of the content container of the corresponding sap.m.Page
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 |
---|---|---|---|
sContentRole | sap.ui.core.AccessibleLandmarkRole | "Main" |
New value for property |
Sets a new value for property headerLabel.
Texts that describe the landmark of the header container of the corresponding sap.m.Page
control.
If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None
is defined), a predefined text is used.
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 |
Sets a new value for property headerRole.
Landmark role of the header container of the corresponding sap.m.Page
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 |
---|---|---|---|
sHeaderRole | sap.ui.core.AccessibleLandmarkRole | "Region" |
New value for property |
Sets a new value for property rootLabel.
Texts that describe the landmark of the root container of the corresponding sap.m.Page
control.
If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None
is defined), a predefined text is used.
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 |
Sets a new value for property rootRole.
Landmark role of the root container of the corresponding sap.m.Page
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 |
---|---|---|---|
sRootRole | sap.ui.core.AccessibleLandmarkRole | "Region" |
New value for property |
Sets a new value for property subHeaderLabel.
Texts that describe the landmark of the subheader container of the corresponding sap.m.Page
control.
If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None
is defined), a predefined text is used.
When called with a value of null
or undefined
, the default value of the property will be restored.
Param | Type | DefaultValue | Description |
---|---|---|---|
sSubHeaderLabel | string |
New value for property |
Sets a new value for property subHeaderRole.
Landmark role of the subheader container of the corresponding sap.m.Page
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 |
---|---|---|---|
sSubHeaderRole | sap.ui.core.AccessibleLandmarkRole | "None" |
New value for property |