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.
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
. 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. addStyleClass,
allowTextSelection,
attachBrowserEvent,
attachValidateFieldGroup,
checkFieldGroupIds,
clone,
detachBrowserEvent,
detachValidateFieldGroup,
fireValidateFieldGroup,
getAccessibilityInfo,
getBusy,
getBusyIndicatorDelay,
getControlsByFieldGroupId,
getFieldGroupIds,
getIdForLabel,
getRenderer,
getVisible,
hasStyleClass,
invalidate,
isBusy,
onAfterRendering,
onBeforeRendering,
placeAt,
removeStyleClass,
rerender,
setFieldGroupIds,
toggleStyleClass,
triggerValidateFieldGroup $,
addCustomData,
addDependent,
addEventDelegate,
applyFocusInfo,
bindElement,
data,
destroy,
destroyCustomData,
destroyDependents,
destroyLayoutData,
destroyTooltip,
enhanceAccessibilityState,
exit,
findElements,
fireEvent,
focus,
getCustomData,
getDependents,
getDomRef,
getElementBinding,
getFocusDomRef,
getFocusInfo,
getInterface,
getLayoutData,
getMetadata,
getTooltip,
getTooltip_AsString,
getTooltip_Text,
indexOfCustomData,
indexOfDependent,
init,
insertCustomData,
insertDependent,
prop,
removeAllCustomData,
removeAllDependents,
removeCustomData,
removeDependent,
removeEventDelegate,
setLayoutData,
toString,
unbindElement 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,
isBound,
isInvalidateSuppressed,
isTreeBinding,
propagateMessages,
removeAggregation,
removeAllAggregation,
removeAllAssociation,
removeAssociation,
setAggregation,
setAssociation,
setBindingContext,
setModel,
setProperty,
unbindAggregation,
unbindContext,
unbindObject,
unbindProperty,
validateAggregation,
validateProperty 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:
{string} | sId? | id for the new control, generated automatically if no id is given |
{object} | mSettings? | 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:
{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 |
Returns a metadata object for class sap.ui.core.InvisibleText.
Returns:
getText(): string
Gets current value of property
text
.
The text of the InvisibleText.
Default value is
.
Returns:
{string} | Value of property text |
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:
{string} | sText | New value for property text |
Returns:
toStatic(): sap.ui.core.InvisibleControl
Adds this
control into the static, hidden area UI area container.
Returns:
{sap.ui.core.InvisibleControl} | Returns this to allow method chaining |
See:
setBusy(): sap.ui.core.InvisibleControl
- Deprecated:
- Local BusyIndicator is not supported by control.
Returns:
{sap.ui.core.InvisibleControl} | Returns this to allow method chaining |
setBusyIndicatorDelay(): sap.ui.core.InvisibleControl
- Deprecated:
- Local BusyIndicator is not supported by control.
Returns:
{sap.ui.core.InvisibleControl} | Returns this to allow method chaining |
setTooltip(): sap.ui.core.InvisibleControl
- Deprecated:
- Tooltip is not supported by control.
Returns:
{sap.ui.core.InvisibleControl} | Returns this to allow method chaining |
setVisible(): sap.ui.core.InvisibleControl
- Deprecated:
- Property visible is not supported by control.
Returns:
{sap.ui.core.InvisibleControl} | Returns this to allow method chaining |