Class sap.m.FormattedTextModule: sap/m/FormattedText

extends Control

The FormattedText control allows the usage of a limited set of tags for inline display of formatted text in HTML format.


Since: 1.38.0.
Constructor Summary
new sap.m.FormattedText(sId?, mSettings?)Constructor for a new FormattedText.
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.m.FormattedText.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.FormattedText with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.FormattedText.getMetadata()Returns a metadata object for class sap.m.FormattedText.
getDisableStyleAttribute()Gets current value of property disableStyleAttribute.
getHeight()Gets current value of property height.
getHtmlText()Gets current value of property htmlText.
getWidth()Gets current value of property width.
setDisableStyleAttribute(bDisableStyleAttribute)Sets a new value for property disableStyleAttribute.
setHeight(sHeight)Sets a new value for property height.
setHtmlText(sText)Defines the HTML text to be displayed.
setWidth(sWidth)Sets a new value for property width.
Methods borrowed from class sap.ui.core.Control
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, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, 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, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
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, 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.FormattedText(sId?, mSettings?)
Constructor for a new FormattedText.

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:
{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.m.FormattedText.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.m.FormattedText 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
sap.m.FormattedText.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.FormattedText.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getDisableStyleAttribute(): boolean
Gets current value of property disableStyleAttribute.

Disables rendering of the style attribute in the FormattedText.

Default value is false.

Returns:
{boolean} Value of property disableStyleAttribute
getHeight(): sap.ui.core.CSSSize
Gets current value of property height.

Optional height of the control in CSS units.

Returns:
{sap.ui.core.CSSSize} Value of property height
getHtmlText(): string
Gets current value of property htmlText.

Text in HTML format. The following tags are supported:

  • a
  • abbr
  • blockquote
  • br
  • cite
  • code
  • em
  • h1
  • h2
  • h3
  • h4
  • h5
  • h6
  • p
  • pre
  • strong
  • span
  • u
  • dl
  • dt
  • dl
  • ul
  • ol
  • li

class, style, and target attributes are allowed. If target is not set, links open in a new window by default.

Only safe href attributes can be used. See jQuery.sap.validateUrl.

Default value is .

Returns:
{string} Value of property htmlText
getWidth(): sap.ui.core.CSSSize
Gets current value of property width.

Optional width of the control in CSS units.

Returns:
{sap.ui.core.CSSSize} Value of property width
setDisableStyleAttribute(bDisableStyleAttribute): sap.m.FormattedText
Sets a new value for property disableStyleAttribute.

Disables rendering of the style attribute in the FormattedText.

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

Default value is false.

Parameters:
{boolean}bDisableStyleAttribute New value for property disableStyleAttribute
Returns:
{sap.m.FormattedText} Reference to this in order to allow method chaining
setHeight(sHeight): sap.m.FormattedText
Sets a new value for property height.

Optional height of the control in CSS units.

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

Parameters:
{sap.ui.core.CSSSize}sHeight New value for property height
Returns:
{sap.m.FormattedText} Reference to this in order to allow method chaining
setHtmlText(sText)
Defines the HTML text to be displayed.
Parameters:
{string}sText HTML text as a string
setWidth(sWidth): sap.m.FormattedText
Sets a new value for property width.

Optional width of the control in CSS units.

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

Parameters:
{sap.ui.core.CSSSize}sWidth New value for property width
Returns:
{sap.m.FormattedText} Reference to this in order to allow method chaining