RichTextEditor

The RichTextEditor-Control is used to enter formatted text.

Disclaimer:Since version 1.6.0. The RichTextEditor of SAPUI5 contains a third party component TinyMCE provided by Moxiecode Systems AB. The SAP license agreement covers the development of applications with RichTextEditor of SAPUI5 (as of May 2014).

Constructor Summary

new sap.ui.richtexteditor.RichTextEditor(sId?, mSettings?)Constructor for a new RichTextEditor.

Event Summary

beforeEditorInit(oControlEvent)This event is fired right before the TinyMCE instance is created and can be used to change the settings object that will be given to TinyMCE.

change(oControlEvent)Event is fired when the text in the field has changed AND the focus leaves the editor or when the Enter key is pressed.

ready(oControlEvent)Fired when the used editor is loaded and ready (its HTML is also created).

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.ui.richtexteditor.RichTextEditor.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.richtexteditor.RichTextEditor with name sClassName and enriches it with the information contained in oClassInfo.

sap.ui.richtexteditor.RichTextEditor.getMetadata()Returns a metadata object for class sap.ui.richtexteditor.RichTextEditor.

addButtonGroup(mGroup?)Adds a button group to the editor.

addPlugin(mPlugin?)Allows to add plugins (that must already be installed on the server) to the RichtextEditor.

attachBeforeEditorInit(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the beforeEditorInit event of this sap.ui.richtexteditor.RichTextEditor.

attachChange(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the change event of this sap.ui.richtexteditor.RichTextEditor.

attachReady(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the ready event of this sap.ui.richtexteditor.RichTextEditor.

detachBeforeEditorInit(fnFunction, oListener)Detaches event handler fnFunction from the beforeEditorInit event of this sap.ui.richtexteditor.RichTextEditor.

detachChange(fnFunction, oListener)Detaches event handler fnFunction from the change event of this sap.ui.richtexteditor.RichTextEditor.

detachReady(fnFunction, oListener)Detaches event handler fnFunction from the ready event of this sap.ui.richtexteditor.RichTextEditor.

fireBeforeEditorInit(mArguments?)Fires event beforeEditorInit to attached listeners.

fireChange(mArguments?)Fires event change to attached listeners.

fireReady(mArguments?)Fires event ready to attached listeners.

getButtonGroups()Gets current value of property buttonGroups.

getEditable()Gets current value of property editable.

getEditorType()Gets current value of property editorType.

getHeight()Gets current value of property height.

getNativeApi()Returns the current editor's instance.

getPlugins()Gets current value of property plugins.

getRequired()Gets current value of property required.

getSanitizeValue()Gets current value of property sanitizeValue.

getShowGroupClipboard()Gets current value of property showGroupClipboard.

getShowGroupFont()Gets current value of property showGroupFont.

getShowGroupFontStyle()Gets current value of property showGroupFontStyle.

getShowGroupInsert()Gets current value of property showGroupInsert.

getShowGroupLink()Gets current value of property showGroupLink.

getShowGroupStructure()Gets current value of property showGroupStructure.

getShowGroupTextAlign()Gets current value of property showGroupTextAlign.

getShowGroupUndo()Gets current value of property showGroupUndo.

getTextDirection()Gets current value of property textDirection.

getUseLegacyTheme()Gets current value of property useLegacyTheme.

getValue()Gets current value of property value.

getWidth()Gets current value of property width.

getWrapping()Gets current value of property wrapping.

setButtonGroups(sButtonGroups)Sets a new value for property buttonGroups.

setEditable(bEditable)Sets a new value for property editable.

setEditorType(sEditorType?)Switches the editor type and sets the default settings for the editor.

setHeight(sHeight)Sets a new value for property height.

setPlugins(sPlugins)Sets a new value for property plugins.

setRequired(bRequired)Sets a new value for property required.

setSanitizeValue(bSanitizeValue)Sets a new value for property sanitizeValue.

setShowGroupClipboard(bShowGroupClipboard)Sets a new value for property showGroupClipboard.

setShowGroupFont(bShowGroupFont)Sets a new value for property showGroupFont.

setShowGroupFontStyle(bShowGroupFontStyle)Sets a new value for property showGroupFontStyle.

setShowGroupInsert(bShowGroupInsert)Sets a new value for property showGroupInsert.

setShowGroupLink(bShowGroupLink)Sets a new value for property showGroupLink.

setShowGroupStructure(bShowGroupStructure)Sets a new value for property showGroupStructure.

setShowGroupTextAlign(bShowGroupTextAlign)Sets a new value for property showGroupTextAlign.

setShowGroupUndo(bShowGroupUndo)Sets a new value for property showGroupUndo.

setTextDirection(sTextDirection)Sets a new value for property textDirection.

setUseLegacyTheme(bUseLegacyTheme?)Allows to opt out of the legacy theme that is applied to keep the old button look.

setValue(sValue)Sets a new value for property value.

setWidth(sWidth)Sets a new value for property width.

setWrapping(bWrapping)Sets a new value for property wrapping.

getEditorLocation()Gets current value of property editorLocation.

setEditorLocation(sEditorLocation)Sets a new value for property editorLocation.

Methods borrowed from class sap.ui.core.Control

Methods borrowed from class sap.ui.core.Element

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.ui.richtexteditor.RichTextEditor(sId?, mSettings?)

Constructor for a new RichTextEditor.

The RichTextEditor uses a third party component, which might in some cases not be completely compatible with the way UI5's (re-)rendering mechanism works. If you keep hidden instances of the control (instances which are not visible in the DOM), you might run into problems with some browser versions. In this case please make sure you destroy the RichTextEditor instance instead of hiding it and create a new one when you show it again.

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
- value : string (default: )
- textDirection : sap.ui.core.TextDirection (default: Inherit)
- width : sap.ui.core.CSSSize
- height : sap.ui.core.CSSSize
- editorType : string (default: TinyMCE)
- editorLocation : string (default: js/tiny_mce/tiny_mce_src.js)
- editable : boolean (default: true)
- showGroupFontStyle : boolean (default: true)
- showGroupTextAlign : boolean (default: true)
- showGroupStructure : boolean (default: true)
- showGroupFont : boolean (default: false)
- showGroupClipboard : boolean (default: true)
- showGroupInsert : boolean (default: false)
- showGroupLink : boolean (default: false)
- showGroupUndo : boolean (default: false)
- wrapping : boolean (default: true)
- required : boolean (default: false)
- sanitizeValue : boolean (default: true)
- plugins : object[] (default: [])
- useLegacyTheme : boolean (default: true)
- buttonGroups : object[] (default: [])
Events
- change : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- ready : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
- beforeEditorInit : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

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

Event Detail

beforeEditorInit(oControlEvent)

This event is fired right before the TinyMCE instance is created and can be used to change the settings object that will be given to TinyMCE. The parameter "configuration" is the javascript oject that will be given to TinyMCE upon first instantiation. The configuration parameter contains a map that can be changed in the case of TinyMCE.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

change(oControlEvent)

Event is fired when the text in the field has changed AND the focus leaves the editor or when the Enter key is pressed.

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters
{string}	oControlEvent.getParameters.newValue	The new control value.

ready(oControlEvent)

Fired when the used editor is loaded and ready (its HTML is also created).

Parameters:

{sap.ui.base.Event}	oControlEvent
{sap.ui.base.EventProvider}	oControlEvent.getSource
{object}	oControlEvent.getParameters

Method Detail

sap.ui.richtexteditor.RichTextEditor.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.richtexteditor.RichTextEditor 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.ui.richtexteditor.RichTextEditor.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.ui.richtexteditor.RichTextEditor.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

addButtonGroup(mGroup?): object

Adds a button group to the editor.

Parameters:

{map\|string}	mGroup?	Name/ID of a single button or map containing the group information
{string[]}	mGroup.buttons?	Array of name/IDs of the buttons in the group
{string}	mGroup.name?	Name/ID of the group.
{boolean}	mGroup.visible?, Default: true	(optional) The priority of the button group. Lower priorities are added first.
{int}	mGroup.row?	(optional) Row number in which the button should be
{int}	mGroup.priority?, Default: 10	(optional) The priority of the button group. Lower priorities are added first.

Returns:

{object}

Control instance (for method chaining)

addPlugin(mPlugin?): object

Allows to add plugins (that must already be installed on the server) to the RichtextEditor.

Parameters:

{map|string}

mPlugin?

A map with the property name containing the plugin IDs/name or an object with the property "name".

Returns:

{object}

Control instance (for method chaining)

attachBeforeEditorInit(oData?, fnFunction, oListener?): sap.ui.richtexteditor.RichTextEditor

Attaches event handler fnFunction to the beforeEditorInit event of this sap.ui.richtexteditor.RichTextEditor.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.richtexteditor.RichTextEditor itself.

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.ui.richtexteditor.RichTextEditor` itself

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

attachChange(oData?, fnFunction, oListener?): sap.ui.richtexteditor.RichTextEditor

Attaches event handler fnFunction to the change event of this sap.ui.richtexteditor.RichTextEditor.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.richtexteditor.RichTextEditor itself.

Event is fired when the text in the field has changed AND the focus leaves the editor or when the Enter key is pressed.

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.ui.richtexteditor.RichTextEditor` itself

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

attachReady(oData?, fnFunction, oListener?): sap.ui.richtexteditor.RichTextEditor

Attaches event handler fnFunction to the ready event of this sap.ui.richtexteditor.RichTextEditor.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.richtexteditor.RichTextEditor itself.

Fired when the used editor is loaded and ready (its HTML is also created).

Parameters:

{object}	oData?	An application-specific payload object that will be passed to the event handler along with the event object when firing the event
{function}	fnFunction	The function to be called when the event occurs
{object}	oListener?	Context object to call the event handler with. Defaults to this `sap.ui.richtexteditor.RichTextEditor` itself

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

detachBeforeEditorInit(fnFunction, oListener): sap.ui.richtexteditor.RichTextEditor

Detaches event handler fnFunction from the beforeEditorInit event of this sap.ui.richtexteditor.RichTextEditor.

The passed function and listener object must match the ones used for event registration.

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

detachChange(fnFunction, oListener): sap.ui.richtexteditor.RichTextEditor

Detaches event handler fnFunction from the change event of this sap.ui.richtexteditor.RichTextEditor.

The passed function and listener object must match the ones used for event registration.

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

detachReady(fnFunction, oListener): sap.ui.richtexteditor.RichTextEditor

Detaches event handler fnFunction from the ready event of this sap.ui.richtexteditor.RichTextEditor.

The passed function and listener object must match the ones used for event registration.

Parameters:

{function}	fnFunction	The function to be called, when the event occurs
{object}	oListener	Context object on which the given function had to be called

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

fireBeforeEditorInit(mArguments?): sap.ui.richtexteditor.RichTextEditor

Fires event beforeEditorInit to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

fireChange(mArguments?): sap.ui.richtexteditor.RichTextEditor

Fires event change to attached listeners.

Expects the following event parameters:

newValue of type stringThe new control value.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

fireReady(mArguments?): sap.ui.richtexteditor.RichTextEditor

Fires event ready to attached listeners.

Parameters:

{Map}

mArguments?

The arguments to pass along with the event

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

getButtonGroups(): object[]

Gets current value of property buttonGroups.

An array of button configurations. These configurations contain the names of buttons as array in the property "buttons" and the name of the group in "name", they can also contain the "row" where the buttons should be placed, a "priority" and whether the buttons are "visible". See method addButtonGroup() for more details on the structure of the objects in this array.

Default value is [].

Returns:

{object[]} Value of property buttonGroups

getEditable(): boolean

Gets current value of property editable.

Whether the editor content can be modified by the user. When set to "false" there might not be any editor toolbar.

Default value is true.

Returns:

{boolean} Value of property editable

getEditorType(): string

Gets current value of property editorType.

The editor implementation to use. Valid values are the ones found under sap.ui.richtexteditor.EditorType and any other editor identifier that may be introduced by other groups (hence this is not an enumeration). Any attempts to set this property after the first rendering will not have any effect.

Default value is TinyMCE.

Returns:

{string} Value of property editorType

getHeight(): sap.ui.core.CSSSize

Gets current value of property height.

Height of RichTextEditor control in CSS units.

Returns:

{sap.ui.core.CSSSize} Value of property height

getNativeApi(): object

Returns the current editor's instance. CAUTION: using the native editor introduces a dependency to that editor and breaks the wrapping character of the RichTextEditor control, so it should only be done in justified cases.

Returns:

{object}

The native editor object (here: The TinyMCE editor instance)

getPlugins(): object[]

Gets current value of property plugins.

An array of plugin configuration objects with the obligatory property "name". Each object has to contain a property "name" which then contains the plugin name/ID.

Default value is [].

Returns:

{object[]} Value of property plugins

getRequired(): boolean

Gets current value of property required.

Whether a value is required.

Default value is false.

Returns:

{boolean} Value of property required

getSanitizeValue(): boolean

Gets current value of property sanitizeValue.

Whether to run the HTML sanitizer once the value (HTML markup) is applied or not. To configure allowed URLs please use the whitelist API via jQuery.sap.addUrlWhitelist

Default value is true.

Returns:

{boolean} Value of property sanitizeValue

getShowGroupClipboard(): boolean

Gets current value of property showGroupClipboard.

Whether the toolbar button group containing commands like Cut, Copy and Paste is available. Changing this after the initial rendering will result in some visible redrawing.

Default value is true.

Returns:

{boolean} Value of property showGroupClipboard

getShowGroupFont(): boolean

Gets current value of property showGroupFont.

Whether the toolbar button group containing commands like Font, Font Size and Colors is available. Changing this after the initial rendering will result in some visible redrawing.

Default value is false.

Returns:

{boolean} Value of property showGroupFont

getShowGroupFontStyle(): boolean

Gets current value of property showGroupFontStyle.

Whether the toolbar button group containing commands like Bold, Italic, Underline and Strikethrough is available. Changing this after the initial rendering will result in some visible redrawing.

Default value is true.

Returns:

{boolean} Value of property showGroupFontStyle

getShowGroupInsert(): boolean

Gets current value of property showGroupInsert.

Whether the toolbar button group containing commands like Insert Image and Insert Smiley is available. Changing this after the initial rendering will result in some visible redrawing.

Default value is false.

Returns:

{boolean} Value of property showGroupInsert

getShowGroupLink(): boolean

Gets current value of property showGroupLink.

Whether the toolbar button group containing commands like Create Link and Remove Link is available. Changing this after the initial rendering will result in some visible redrawing.

Default value is false.

Returns:

{boolean} Value of property showGroupLink

getShowGroupStructure(): boolean

Gets current value of property showGroupStructure.

Whether the toolbar button group containing commands like Bullets and Indentation is available. Changing this after the initial rendering will result in some visible redrawing.

Default value is true.

Returns:

{boolean} Value of property showGroupStructure

getShowGroupTextAlign(): boolean

Gets current value of property showGroupTextAlign.

Whether the toolbar button group containing text alignment commands is available. Changing this after the initial rendering will result in some visible redrawing.

Default value is true.

Returns:

{boolean} Value of property showGroupTextAlign

getShowGroupUndo(): boolean

Gets current value of property showGroupUndo.

Whether the toolbar button group containing commands like Undo and Redo is available. Changing this after the initial rendering will result in some visible redrawing.

Default value is false.

Returns:

{boolean} Value of property showGroupUndo

getTextDirection(): sap.ui.core.TextDirection

Gets current value of property textDirection.

The text direction

Default value is Inherit.

Returns:

{sap.ui.core.TextDirection} Value of property textDirection

getUseLegacyTheme(): boolean

Gets current value of property useLegacyTheme.

Whether or not to use the legacy theme for the toolbar buttons. If this is set to false, the default theme for the editor will be used (which might change slightly with every update). The legacy theme has the disadvantage that not all functionality has its own icon, so using non default buttons might lead to invisible buttons with the legacy theme - use the default editor theme in this case.

Default value is true.

Returns:

{boolean} Value of property useLegacyTheme

getValue(): string

Gets current value of property value.

An HTML string representing the editor content. Because this is HTML, the value cannot be generically escaped to prevent cross-site scripting, so the application is responsible for doing so. Overwriting this property would also reset editor's Undo manager and buttons "Undo"/"Redo" would be set to their initial state.

Default value is .

Returns:

{string} Value of property value

getWidth(): sap.ui.core.CSSSize

Gets current value of property width.

Width of RichTextEditor control in CSS units.

Returns:

{sap.ui.core.CSSSize} Value of property width

getWrapping(): boolean

Gets current value of property wrapping.

Whether the text in the editor is wrapped. This does not affect the editor's value, only the representation in the control.

Default value is true.

Returns:

{boolean} Value of property wrapping

setButtonGroups(sButtonGroups): sap.ui.richtexteditor.RichTextEditor

Sets a new value for property buttonGroups.

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

Default value is [].

Parameters:

{object[]} sButtonGroups New value for property buttonGroups

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

setEditable(bEditable): sap.ui.richtexteditor.RichTextEditor

Sets a new value for property editable.

Whether the editor content can be modified by the user. When set to "false" there might not be any editor toolbar.

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

Default value is true.

Parameters:

{boolean} bEditable New value for property editable

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

setEditorType(sEditorType?): object

Switches the editor type and sets the default settings for the editor. All plugins and button groups should be set after this has been invoked

Parameters:

{string}

sEditorType?

Which editor type to be used (currently only TinyMCE 3 and 4)

Returns:

{object}

Control instance (for method chaining)

setHeight(sHeight): sap.ui.richtexteditor.RichTextEditor

Sets a new value for property height.

Height of RichTextEditor 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.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

setPlugins(sPlugins): sap.ui.richtexteditor.RichTextEditor

Sets a new value for property plugins.

An array of plugin configuration objects with the obligatory property "name". Each object has to contain a property "name" which then contains the plugin name/ID.

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

Default value is [].

Parameters:

{object[]} sPlugins New value for property plugins

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

setRequired(bRequired): sap.ui.richtexteditor.RichTextEditor

Sets a new value for property required.

Whether a value is required.

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

Default value is false.

Parameters:

{boolean} bRequired New value for property required

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

setSanitizeValue(bSanitizeValue): sap.ui.richtexteditor.RichTextEditor

Sets a new value for property sanitizeValue.

Whether to run the HTML sanitizer once the value (HTML markup) is applied or not. To configure allowed URLs please use the whitelist API via jQuery.sap.addUrlWhitelist

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

Default value is true.

Parameters:

{boolean} bSanitizeValue New value for property sanitizeValue

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

setShowGroupClipboard(bShowGroupClipboard): sap.ui.richtexteditor.RichTextEditor

Sets a new value for property showGroupClipboard.

Whether the toolbar button group containing commands like Cut, Copy and Paste is available. Changing this after the initial rendering will result in some visible redrawing.

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

Default value is true.

Parameters:

{boolean} bShowGroupClipboard New value for property showGroupClipboard

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

setShowGroupFont(bShowGroupFont): sap.ui.richtexteditor.RichTextEditor

Sets a new value for property showGroupFont.

Whether the toolbar button group containing commands like Font, Font Size and Colors is available. Changing this after the initial rendering will result in some visible redrawing.

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

Default value is false.

Parameters:

{boolean} bShowGroupFont New value for property showGroupFont

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

setShowGroupFontStyle(bShowGroupFontStyle): sap.ui.richtexteditor.RichTextEditor

Sets a new value for property showGroupFontStyle.

Whether the toolbar button group containing commands like Bold, Italic, Underline and Strikethrough is available. Changing this after the initial rendering will result in some visible redrawing.

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

Default value is true.

Parameters:

{boolean} bShowGroupFontStyle New value for property showGroupFontStyle

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

setShowGroupInsert(bShowGroupInsert): sap.ui.richtexteditor.RichTextEditor

Sets a new value for property showGroupInsert.

Whether the toolbar button group containing commands like Insert Image and Insert Smiley is available. Changing this after the initial rendering will result in some visible redrawing.

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

Default value is false.

Parameters:

{boolean} bShowGroupInsert New value for property showGroupInsert

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

setShowGroupLink(bShowGroupLink): sap.ui.richtexteditor.RichTextEditor

Sets a new value for property showGroupLink.

Whether the toolbar button group containing commands like Create Link and Remove Link is available. Changing this after the initial rendering will result in some visible redrawing.

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

Default value is false.

Parameters:

{boolean} bShowGroupLink New value for property showGroupLink

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

setShowGroupStructure(bShowGroupStructure): sap.ui.richtexteditor.RichTextEditor

Sets a new value for property showGroupStructure.

Whether the toolbar button group containing commands like Bullets and Indentation is available. Changing this after the initial rendering will result in some visible redrawing.

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

Default value is true.

Parameters:

{boolean} bShowGroupStructure New value for property showGroupStructure

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

setShowGroupTextAlign(bShowGroupTextAlign): sap.ui.richtexteditor.RichTextEditor

Sets a new value for property showGroupTextAlign.

Whether the toolbar button group containing text alignment commands is available. Changing this after the initial rendering will result in some visible redrawing.

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

Default value is true.

Parameters:

{boolean} bShowGroupTextAlign New value for property showGroupTextAlign

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

setShowGroupUndo(bShowGroupUndo): sap.ui.richtexteditor.RichTextEditor

Sets a new value for property showGroupUndo.

Whether the toolbar button group containing commands like Undo and Redo is available. Changing this after the initial rendering will result in some visible redrawing.

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

Default value is false.

Parameters:

{boolean} bShowGroupUndo New value for property showGroupUndo

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

setTextDirection(sTextDirection): sap.ui.richtexteditor.RichTextEditor

Sets a new value for property textDirection.

The text direction

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

Default value is Inherit.

Parameters:

{sap.ui.core.TextDirection} sTextDirection New value for property textDirection

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

setUseLegacyTheme(bUseLegacyTheme?): object

Allows to opt out of the legacy theme that is applied to keep the old button look. In case butons are used that are not in the legacy theme, this can be disabled in order to show the button correctly.

Parameters:

{boolean}

bUseLegacyTheme?

Whether to use the legacy button theme

Returns:

{object}

Control instance (for method chaining)

setValue(sValue): sap.ui.richtexteditor.RichTextEditor

Sets a new value for property value.

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

Default value is .

Parameters:

{string} sValue New value for property value

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

setWidth(sWidth): sap.ui.richtexteditor.RichTextEditor

Sets a new value for property width.

Width of RichTextEditor 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.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

setWrapping(bWrapping): sap.ui.richtexteditor.RichTextEditor

Sets a new value for property wrapping.

Whether the text in the editor is wrapped. This does not affect the editor's value, only the representation in the control.

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

Default value is true.

Parameters:

{boolean} bWrapping New value for property wrapping

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining

getEditorLocation(): string

Gets current value of property editorLocation.

Relative or absolute URL where the editor is available. Must be on the same server. Any attempts to set this property after the first rendering will not have any effect.

Default value is js/tiny_mce/tiny_mce_src.js.

Deprecated:
Since version 1.25.0. The editorLocation is set implicitly when choosing the editorType.

Returns:

{string} Value of property editorLocation

setEditorLocation(sEditorLocation): sap.ui.richtexteditor.RichTextEditor

Sets a new value for property editorLocation.

Relative or absolute URL where the editor is available. Must be on the same server. Any attempts to set this property after the first rendering will not have any effect.

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

Default value is js/tiny_mce/tiny_mce_src.js.

Parameters:

{string} sEditorLocation New value for property editorLocation

Deprecated:
Since version 1.25.0. The editorLocation is set implicitly when choosing the editorType.

Returns:

{sap.ui.richtexteditor.RichTextEditor} Reference to this in order to allow method chaining