Class sap.ui.core.InvisibleTextModule: sap/ui/core/InvisibleText

extends Control

An InvisibleText is used to bring hidden texts to the UI for screen reader support. The hidden text can e.g. be referenced in the ariaLabelledBy or ariaDescribedBy associations of other controls.

The inherited properties busy, busyIndicatorDelay and visible and the aggregation tooltip is not supported by this control.


Since: 1.27.0.
Constructor Summary
new sap.ui.core.InvisibleText(sId?, mSettings?)Constructor for a new InvisibleText.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.core.InvisibleText.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.core.InvisibleText with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.core.InvisibleText.getMetadata()Returns a metadata object for class sap.ui.core.InvisibleText.
getText()Gets current value of property text.
setText(sText)Sets a new value for property text.
toStatic()Adds this control into the static, hidden area UI area container.
Constructor Detail
new sap.ui.core.InvisibleText(sId?, mSettings?)

Constructor for a new InvisibleText.

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

    • text : string (default: )

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

Parameters:
stringsId?id for the new control, generated automatically if no id is given
objectmSettings?initial settings for the new control
Method Detail
sap.ui.core.InvisibleText.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.core.InvisibleText 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.

Parameters:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.ui.core.InvisibleText.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.core.InvisibleText.
Returns:
sap.ui.base.MetadataMetadata object describing this class
getText(): string

Gets current value of property text.

The text of the InvisibleText.

Default value is .

Returns:
stringValue of property text
setText(sText): sap.ui.core.InvisibleText

Sets a new value for property text.

The text of the InvisibleText.

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

Default value is .

Parameters:
stringsTextNew value for property text
Returns:
sap.ui.core.InvisibleTextReference to this in order to allow method chaining
Adds this control into the static, hidden area UI area container.
Returns:
sap.ui.core.InvisibleTextReturns this to allow method chaining
See:
sap.ui.core.Control#placeAt
Returns:
sap.ui.core.InvisibleTextReturns this to allow method chaining
Deprecated API:
Local BusyIndicator is not supported by control.
setBusyIndicatorDelay(): sap.ui.core.InvisibleText
Returns:
sap.ui.core.InvisibleTextReturns this to allow method chaining
Deprecated API:
Local BusyIndicator is not supported by control.
Returns:
sap.ui.core.InvisibleTextReturns this to allow method chaining
Deprecated API:
Tooltip is not supported by control.
Returns:
sap.ui.core.InvisibleTextReturns this to allow method chaining
Deprecated API:
Property visible is not supported by control.