Settings for accessible landmarks which can be applied to the container elements of a sap.f.DynamicPage
control.
These landmarks are used by assistive technologies (such as screen readers) to provide a meaningful page overview.
Constructor for a new sap.f.DynamicPageAccessibleLandmarkInfo
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.f.DynamicPageAccessibleLandmarkInfo(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 which describe the landmark of the content container of the corresponding If not set (and a landmark different than |
|
contentRole | sap.ui.core.AccessibleLandmarkRole | None | Landmark role of the content container of the corresponding If set to |
footerLabel | string | Texts which describe the landmark of the header container of the corresponding If not set (and a landmark different than |
|
footerRole | sap.ui.core.AccessibleLandmarkRole | None | Landmark role of the footer container of the corresponding If set to |
headerLabel | string | Texts which describe the landmark of the header container of the corresponding If not set (and a landmark different than |
|
headerRole | sap.ui.core.AccessibleLandmarkRole | None | Landmark role of the header container of the corresponding If set to |
rootLabel | string | Texts which describe the landmark of the root container of the corresponding If not set (and a landmark different than |
|
rootRole | sap.ui.core.AccessibleLandmarkRole | None | Landmark role of the root container of the corresponding If set to |
Method | Description |
---|---|
sap.f.DynamicPageAccessibleLandmarkInfo.extend |
Creates a new subclass of class sap.f.DynamicPageAccessibleLandmarkInfo with name
|
getContentLabel |
Gets current value of property contentLabel. Texts which 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 which describe the landmark of the header 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 which 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.f.DynamicPageAccessibleLandmarkInfo.getMetadata |
Returns a metadata object for class sap.f.DynamicPageAccessibleLandmarkInfo. |
getRootLabel |
Gets current value of property rootLabel. Texts which 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 |
setContentLabel |
Sets a new value for property contentLabel. Texts which 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 which describe the landmark of the header 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 which 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 which 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 |
Creates a new subclass of class sap.f.DynamicPageAccessibleLandmarkInfo 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 which describe the landmark of the content container of the corresponding sap.f.DynamicPage
control.
If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None
is defined), no label is set.
Gets current value of property contentRole.
Landmark role of the content container of the corresponding sap.f.DynamicPage
control.
If set to sap.ui.core.AccessibleLandmarkRole.None
, no landmark will be added to the container.
Default value is "None"
.
Gets current value of property headerLabel.
Texts which describe the landmark of the header container of the corresponding sap.f.DynamicPage
control.
If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None
is defined), no label is set.
Gets current value of property headerRole.
Landmark role of the header container of the corresponding sap.f.DynamicPage
control.
If set to sap.ui.core.AccessibleLandmarkRole.None
, no landmark will be added to the container.
Default value is "None"
.
Returns a metadata object for class sap.f.DynamicPageAccessibleLandmarkInfo.
Gets current value of property rootLabel.
Texts which describe the landmark of the root container of the corresponding sap.f.DynamicPage
control.
If not set (and a landmark different than sap.ui.core.AccessibleLandmarkRole.None
is defined), no label is set.
Gets current value of property rootRole.
Landmark role of the root container of the corresponding sap.f.DynamicPage
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 which describe the landmark of the content container of the corresponding sap.f.DynamicPage
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 |
Sets a new value for property contentRole.
Landmark role of the content container of the corresponding sap.f.DynamicPage
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 |
Sets a new value for property headerLabel.
Texts which describe the landmark of the header container of the corresponding sap.f.DynamicPage
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 |
Sets a new value for property headerRole.
Landmark role of the header container of the corresponding sap.f.DynamicPage
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 |
---|---|---|---|
sHeaderRole | sap.ui.core.AccessibleLandmarkRole | "None" |
New value for property |
Sets a new value for property rootLabel.
Texts which describe the landmark of the root container of the corresponding sap.f.DynamicPage
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 |
Sets a new value for property rootRole.
Landmark role of the root container of the corresponding sap.f.DynamicPage
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 |
---|---|---|---|
sRootRole | sap.ui.core.AccessibleLandmarkRole | "None" |
New value for property |