PageAccessibleLandmarkInfo

extends Element

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 Summary

new sap.m.PageAccessibleLandmarkInfo(sId?, mSettings?)Constructor for a new sap.m.PageAccessibleLandmarkInfo element.

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

Method Summary

sap.m.PageAccessibleLandmarkInfo.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.PageAccessibleLandmarkInfo with name sClassName and enriches it with the information contained in oClassInfo.

sap.m.PageAccessibleLandmarkInfo.getMetadata()Returns a metadata object for class sap.m.PageAccessibleLandmarkInfo.

getContentLabel()Gets current value of property contentLabel.

getContentRole()Gets current value of property contentRole.

getFooterLabel()Gets current value of property footerLabel.

getFooterRole()Gets current value of property footerRole.

getHeaderLabel()Gets current value of property headerLabel.

getHeaderRole()Gets current value of property headerRole.

getRootLabel()Gets current value of property rootLabel.

getRootRole()Gets current value of property rootRole.

getSubHeaderLabel()Gets current value of property subHeaderLabel.

getSubHeaderRole()Gets current value of property subHeaderRole.

setContentLabel(sContentLabel)Sets a new value for property contentLabel.

setContentRole(sContentRole)Sets a new value for property contentRole.

setFooterLabel(sFooterLabel)Sets a new value for property footerLabel.

setFooterRole(sFooterRole)Sets a new value for property footerRole.

setHeaderLabel(sHeaderLabel)Sets a new value for property headerLabel.

setHeaderRole(sHeaderRole)Sets a new value for property headerRole.

setRootLabel(sRootLabel)Sets a new value for property rootLabel.

setRootRole(sRootRole)Sets a new value for property rootRole.

setSubHeaderLabel(sSubHeaderLabel)Sets a new value for property subHeaderLabel.

setSubHeaderRole(sSubHeaderRole)Sets a new value for property subHeaderRole.

Methods borrowed from class sap.ui.core.Element

Methods borrowed from class sap.ui.base.ManagedObject

addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, invalidate, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty

Methods borrowed from class sap.ui.base.EventProvider

attachEvent, attachEventOnce, detachEvent, hasListeners

Constructor Detail

new sap.m.PageAccessibleLandmarkInfo(sId?, mSettings?)

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 for a general description of the syntax of the settings object.

The supported settings are:

Properties
- rootRole : sap.ui.core.AccessibleLandmarkRole (default: Region)
- rootLabel : string
- contentRole : sap.ui.core.AccessibleLandmarkRole (default: Main)
- contentLabel : string
- headerRole : sap.ui.core.AccessibleLandmarkRole (default: Region)
- headerLabel : string
- subHeaderRole : sap.ui.core.AccessibleLandmarkRole
- subHeaderLabel : string
- footerRole : sap.ui.core.AccessibleLandmarkRole (default: Region)
- footerLabel : string

In addition, all settings applicable to the base type sap.ui.core.Element can be used as well.

Parameters:

{string}	sId?	Id for the new element, generated automatically if no id is given
{object}	mSettings?	Initial settings for the new element

Method Detail

sap.m.PageAccessibleLandmarkInfo.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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.

Parameters:

{string}	sClassName	Name of the class being created
{object}	oClassInfo?	Object literal with information about the class
{function}	FNMetaImpl?	Constructor function for the metadata object; if not given, it defaults to `sap.ui.core.ElementMetadata`

Returns:

{function}

Created class / constructor function

sap.m.PageAccessibleLandmarkInfo.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.m.PageAccessibleLandmarkInfo.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getContentLabel(): string

Gets current value of property contentLabel.

Texts which describes 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.

Returns:

{string} Value of property contentLabel

getContentRole(): sap.ui.core.AccessibleLandmarkRole

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.

Returns:

{sap.ui.core.AccessibleLandmarkRole} Value of property contentRole

getFooterLabel(): string

Gets current value of property footerLabel.

Texts which describes 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.

Returns:

{string} Value of property footerLabel

getFooterRole(): sap.ui.core.AccessibleLandmarkRole

Gets current value of property footerRole.

Landmark role of the footer 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:

{sap.ui.core.AccessibleLandmarkRole} Value of property footerRole

getHeaderLabel(): string

Gets current value of property headerLabel.

Texts which describes 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.

Returns:

{string} Value of property headerLabel

getHeaderRole(): sap.ui.core.AccessibleLandmarkRole

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:

{sap.ui.core.AccessibleLandmarkRole} Value of property headerRole

getRootLabel(): string

Gets current value of property rootLabel.

Texts which describes 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.

Returns:

{string} Value of property rootLabel

getRootRole(): sap.ui.core.AccessibleLandmarkRole

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.

Returns:

{sap.ui.core.AccessibleLandmarkRole} Value of property rootRole

getSubHeaderLabel(): string

Gets current value of property subHeaderLabel.

Texts which describes 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.

Returns:

{string} Value of property subHeaderLabel

getSubHeaderRole(): sap.ui.core.AccessibleLandmarkRole

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.

Returns:

{sap.ui.core.AccessibleLandmarkRole} Value of property subHeaderRole

setContentLabel(sContentLabel): sap.m.PageAccessibleLandmarkInfo

Sets a new value for property contentLabel.

Texts which describes 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.

Parameters:

{string} sContentLabel New value for property contentLabel

Returns:

{sap.m.PageAccessibleLandmarkInfo} Reference to this in order to allow method chaining

setContentRole(sContentRole): sap.m.PageAccessibleLandmarkInfo

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.

Parameters:

{sap.ui.core.AccessibleLandmarkRole} sContentRole New value for property contentRole

Returns:

{sap.m.PageAccessibleLandmarkInfo} Reference to this in order to allow method chaining

setFooterLabel(sFooterLabel): sap.m.PageAccessibleLandmarkInfo

Sets a new value for property footerLabel.

Texts which describes 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.

Parameters:

{string} sFooterLabel New value for property footerLabel

Returns:

{sap.m.PageAccessibleLandmarkInfo} Reference to this in order to allow method chaining

setFooterRole(sFooterRole): sap.m.PageAccessibleLandmarkInfo

Sets a new value for property footerRole.

Landmark role of the footer 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.

Parameters:

{sap.ui.core.AccessibleLandmarkRole} sFooterRole New value for property footerRole

Returns:

{sap.m.PageAccessibleLandmarkInfo} Reference to this in order to allow method chaining

setHeaderLabel(sHeaderLabel): sap.m.PageAccessibleLandmarkInfo

Sets a new value for property headerLabel.

Texts which describes 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.

Parameters:

{string} sHeaderLabel New value for property headerLabel

Returns:

{sap.m.PageAccessibleLandmarkInfo} Reference to this in order to allow method chaining

setHeaderRole(sHeaderRole): sap.m.PageAccessibleLandmarkInfo

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.

Parameters:

{sap.ui.core.AccessibleLandmarkRole} sHeaderRole New value for property headerRole

Returns:

{sap.m.PageAccessibleLandmarkInfo} Reference to this in order to allow method chaining

setRootLabel(sRootLabel): sap.m.PageAccessibleLandmarkInfo

Sets a new value for property rootLabel.

Texts which describes 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.

Parameters:

{string} sRootLabel New value for property rootLabel

Returns:

{sap.m.PageAccessibleLandmarkInfo} Reference to this in order to allow method chaining

setRootRole(sRootRole): sap.m.PageAccessibleLandmarkInfo

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.

Parameters:

{sap.ui.core.AccessibleLandmarkRole} sRootRole New value for property rootRole

Returns:

{sap.m.PageAccessibleLandmarkInfo} Reference to this in order to allow method chaining

setSubHeaderLabel(sSubHeaderLabel): sap.m.PageAccessibleLandmarkInfo

Sets a new value for property subHeaderLabel.

Texts which describes 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.

Parameters:

{string} sSubHeaderLabel New value for property subHeaderLabel

Returns:

{sap.m.PageAccessibleLandmarkInfo} Reference to this in order to allow method chaining

setSubHeaderRole(sSubHeaderRole): sap.m.PageAccessibleLandmarkInfo

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.

Parameters:

{sap.ui.core.AccessibleLandmarkRole} sSubHeaderRole New value for property subHeaderRole

Returns:

{sap.m.PageAccessibleLandmarkInfo} Reference to this in order to allow method chaining