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.
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#constructor for a general description of the syntax of the settings object.
new sap.ui.core.InvisibleText(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | id for the new control, generated automatically if no id is given |
|
mSettings? | object | initial settings for the new control |
Name | Type | Default Value | Description |
---|---|---|---|
blocked | boolean | false | Whether the control is currently in blocked state. Visibility: public |
busy | boolean | false | Whether the control is currently in busy state. Visibility: public |
busyIndicatorDelay | int | 1000 | The delay in milliseconds, after which the busy indicator will show up for this control. Visibility: public |
busyIndicatorSize | sap.ui.core.BusyIndicatorSize | Medium | The size of the BusyIndicator. For controls with a width smaller 3rem a |
fieldGroupIds | string[] | The IDs of a logical field group that this control belongs to. All fields in a logical field group should share the same For backward compatibility with older releases, field group IDs are syntactically not limited, but it is suggested to use only valid sap.ui.core.IDs. See #attachValidateFieldGroup or consult the Field Group documentation. |
|
visible | boolean | true | Whether the control should be visible on the screen. If set to false, a placeholder will be rendered to mark the location of the invisible control in the DOM of the current page. The placeholder will be hidden and have zero dimensions ( Also see InvisibleRenderer. Visibility: public |
Name | Cardinality | Type | Description |
---|---|---|---|
customData | 0..n | sap.ui.core.CustomData |
Custom Data, a data structure like a map containing arbitrary key value pairs. |
dependents | 0..n | sap.ui.core.Element |
Dependents are not rendered, but their databinding context and lifecycle are bound to the aggregating Element. |
dragDropConfig | 0..n | sap.ui.core.dnd.DragDropBase |
Defines the drag-and-drop configuration. Note: This configuration might be ignored due to control metadata restrictions. |
layoutData | 0..1 | sap.ui.core.LayoutData |
Defines the layout constraints for this control when it is used inside a Layout. LayoutData classes are typed classes and must match the embedding Layout. See VariantLayoutData for aggregating multiple alternative LayoutData instances to a single Element. |
tooltip | 0..1 | sap.ui.core.TooltipBase |
The tooltip that should be shown for this Element. In the most simple case, a tooltip is a string that will be rendered by the control and displayed by the browser when the mouse pointer hovers over the control's DOM. In this variant, Controls need to explicitly support this kind of tooltip as they have to render it, but most controls do. Exceptions will be documented for the corresponding controls (e.g. Alternatively, UI5 currently does not provide a recommended implementation of See the section Using Tooltips
|
Method | Description |
---|---|
sap.ui.core.InvisibleText.extend |
Creates a new subclass of class sap.ui.core.InvisibleText with name
|
sap.ui.core.InvisibleText.getMetadata |
Returns a metadata object for class sap.ui.core.InvisibleText. |
sap.ui.core.InvisibleText.getStaticId |
Returns the ID of a shared Calls with the same library and text key will return the same instance. The instance will be rendered statically. When accessibility has been switched off by configuration or when the text key is empty or falsy, no ID will be returned. |
getText |
Gets current value of property text. The text of the InvisibleText. Default value is |
setBusy |
Since 1.27 local BusyIndicator is not supported by control.
|
setBusyIndicatorDelay |
Since 1.27 local BusyIndicator is not supported by control.
|
setBusyIndicatorSize |
Since 1.54 local BusyIndicator is not supported by control.
|
setText |
Sets a new value for property text. The text of the InvisibleText. When called with a value of Default value is |
setTooltip |
Since 1.27 tooltip is not supported by control.
|
setVisible |
Since 1.27 property <code>visible</code> is not supported by control.
|
toStatic |
Adds
|
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.
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 |
Returns a metadata object for class sap.ui.core.InvisibleText.
Returns the ID of a shared InvisibleText
instance whose text
property is retrieved from the given library resource bundle and text key.
Calls with the same library and text key will return the same instance. The instance will be rendered statically.
When accessibility has been switched off by configuration or when the text key is empty or falsy, no ID will be returned.
Param | Type | DefaultValue | Description |
---|---|---|---|
sLibrary | string |
Name of the library to load the resource bundle for |
|
sTextKey | string |
Key of the text to retrieve from the resource bundle |
Gets current value of property text.
The text of the InvisibleText.
Default value is empty string
.
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 empty string
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sText | string | "" |
New value for property |