Class sap.ui.commons.FormattedTextViewModule: sap/ui/commons/FormattedTextView

extends Control

The FormattedTextView control allows the usage of a limited set of HTML tags for display.
Deprecated API:
Since version 1.38. Instead, use the sap.ui.core.HTML control.

Since: 1.9.0.
Constructor Summary
new sap.ui.commons.FormattedTextView(sId?, mSettings?)Constructor for a new FormattedTextView.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.commons.FormattedTextView.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.commons.FormattedTextView with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.commons.FormattedTextView.getMetadata()Returns a metadata object for class sap.ui.commons.FormattedTextView.
addControl(oControl)Adds some control to the aggregation controls.
destroyControls()Destroys all the controls in the aggregation controls.
getAccessibleRole()Gets current value of property accessibleRole.
getControls()Gets content of aggregation controls.
getHtmlText()Gets current value of property htmlText.
hasControls()Indicates whether the FormattedTextView contains other controls.
indexOfControl(oControl)Checks for the provided sap.ui.core.Control in the aggregation controls.
insertControl(oControl, iIndex)Inserts a control into the aggregation controls.
removeAllControls()Removes all the controls from the aggregation controls.
removeControl(vControl)Removes a control from the aggregation controls.
setAccessibleRole(sAccessibleRole)Sets a new value for property accessibleRole.
setContent(sHtmlText, aControls)Sets text with placeholders and given array of controls.
setHtmlText(sText)Sets the HTML text to be displayed.
Constructor Detail
new sap.ui.commons.FormattedTextView(sId?, mSettings?)

Constructor for a new FormattedTextView.

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:

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.commons.FormattedTextView.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.commons.FormattedTextView 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.commons.FormattedTextView.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.commons.FormattedTextView.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addControl(oControl): sap.ui.commons.FormattedTextView
Adds some control to the aggregation controls.
Parameters:
sap.ui.core.ControloControlthe control to add; if empty, nothing is inserted
Returns:
sap.ui.commons.FormattedTextViewReference to this in order to allow method chaining
Destroys all the controls in the aggregation controls.
Returns:
sap.ui.commons.FormattedTextViewReference to this in order to allow method chaining
getAccessibleRole(): sap.ui.core.AccessibleRole

Gets current value of property accessibleRole.

The ARIA role for the control.

Default value is Document.

Returns:
sap.ui.core.AccessibleRoleValue of property accessibleRole
getControls(): sap.ui.core.Control[]

Gets content of aggregation controls.

Array of controls that should be replaced within htmlText.

Returns:
sap.ui.core.Control[]
getHtmlText(): string

Gets current value of property htmlText.

Determines text with placeholders.

Default value is .

Returns:
stringValue of property htmlText
hasControls(): boolean
Indicates whether the FormattedTextView contains other controls.
Returns:
boolean
indexOfControl(oControl): int
Checks for the provided sap.ui.core.Control in the aggregation controls. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.core.ControloControlThe control whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertControl(oControl, iIndex): sap.ui.commons.FormattedTextView
Inserts a control into the aggregation controls.
Parameters:
sap.ui.core.ControloControlthe control to insert; if empty, nothing is inserted
intiIndexthe 0-based index the control should be inserted at; for a negative value of iIndex, the control is inserted at position 0; for a value greater than the current size of the aggregation, the control is inserted at the last position
Returns:
sap.ui.commons.FormattedTextViewReference to this in order to allow method chaining
removeAllControls(): sap.ui.core.Control[]

Removes all the controls from the aggregation controls.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.core.Control[]An array of the removed elements (might be empty)
removeControl(vControl): sap.ui.core.Control
Removes a control from the aggregation controls.
Parameters:
int|string|sap.ui.core.ControlvControlThe control to remove or its index or id
Returns:
sap.ui.core.ControlThe removed control or null
setAccessibleRole(sAccessibleRole): sap.ui.commons.FormattedTextView

Sets a new value for property accessibleRole.

The ARIA role for the control.

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

Default value is Document.

Parameters:
sap.ui.core.AccessibleRolesAccessibleRoleNew value for property accessibleRole
Returns:
sap.ui.commons.FormattedTextViewReference to this in order to allow method chaining
setContent(sHtmlText, aControls)
Sets text with placeholders and given array of controls.
Parameters:
stringsHtmlTextContains the corresponding HTML text
sap.ui.commons.FormattedTextViewControlaControlsArray of controls that should be used within given HTML text
setHtmlText(sText)
Sets the HTML text to be displayed.
Parameters:
stringsTextHTML text as a string