OTRS API Reference JavaScript

Namespace: Core.UI.RichTextEditor

Core.UI. RichTextEditor

Richtext Editor.
Author:
  • OTRS AG
Source:

Methods

(static) Focus($EditorArea)

This function focusses the given RTE.
Parameters:
Name Type Description
$EditorArea jQueryObject The jQuery object of the element that is a rich text editor.
Source:

(static) GetRTE($EditorArea) → {jQueryObject}

Get RTE jQuery element.
Parameters:
Name Type Description
$EditorArea jQueryObject The jQuery object of the element that is a rich text editor.
Source:
Returns:
jQuery object of the corresponsing RTE element.
Type
jQueryObject

(static) Init()

This function initializes JS functionality.
Source:

(static) InitAllEditors()

This function initializes as a rich text editor every textarea element that containing the RichText class.
Source:

(static) InitEditor($EditorArea) → {Boolean}

This function initializes the application and executes the needed functions.
Parameters:
Name Type Description
$EditorArea jQueryObject The jQuery object of the element that will be a rich text editor.
Source:
Returns:
Returns false on error.
Type
Boolean

(static) IsEnabled($EditorArea) → {Boolean}

This function check if a rich text editor is enable in this moment.
Parameters:
Name Type Description
$EditorArea jQueryObject The jQuery object of the element that is a rich text editor.
Source:
Returns:
True if RTE is enabled, false otherwise
Type
Boolean

(static) UpdateLinkedField($EditorArea)

This function updates the linked field for a rich text editor.
Parameters:
Name Type Description
$EditorArea jQueryObject The jQuery object of the element that is a rich text editor.
Source: