Docs For Class PlgEditorTinymce

Description

TinyMCE Editor Plugin

since: 1.5

Located in /plugins/editors/tinymce/tinymce.php (line 19)

JObject
   |
   --JEvent
      |
      --JPlugin
         |
         --PlgEditorTinymce

Variable Summary

JApplicationCms $app

boolean $autoloadLanguage

mixed $_basePath

Method Summary

string onDisplay (string $name, string $content, string $width, string $height, int $col, int $row, [boolean $buttons = true], [string $id = null], [string $asset = null], [object $author = null])

string onGetContent (string $editor)

boolean onGetInsertMethod (string $name)

string onInit ()

string onSave (string $editor)

string onSetContent (string $editor, string $html)

Variables

JApplicationCms $app = null (line 40)

Loads the application object

since: 3.2
access: protected

boolean $autoloadLanguage = true (line 32)

Load the language file on instantiation.

since: 3.1
access: protected

Redefinition of:

JPlugin::$autoloadLanguage: Affects constructor behavior. If true, language files will be loaded automatically.

mixed $_basePath = 'media/editors/tinymce' (line 24)

Base path for editor files

access: protected

Inherited Variables

Inherited from JPlugin

JPlugin::$params
JPlugin::$_name
JPlugin::$_type

Inherited from JEvent

JEvent::$_subject

Inherited from JObject

JObject::$_errors

Methods

onDisplay (line 786)

Display the editor area.

access: public

string onDisplay (string $name, string $content, string $width, string $height, int $col, int $row, [boolean $buttons = true], [string $id = null], [string $asset = null], [object $author = null])

string $name: The name of the editor area.
string $content: The content of the field.
string $width: The width of the editor area.
string $height: The height of the editor area.
int $col: The number of columns for the editor area.
int $row: The number of rows for the editor area.
boolean $buttons: True and the editor buttons will be displayed.
string $id: An optional ID for the textarea. If not supplied the name is used.
string $asset: The object asset
object $author: The author.

onGetContent (line 694)

TinyMCE WYSIWYG Editor - get the editor content

access: public

string onGetContent (string $editor)

string $editor: The name of the editor

onGetInsertMethod (line 731)

Inserts html code into the editor

access: public

boolean onGetInsertMethod (string $name)

string $name: The name of the editor

onInit (line 49)

Initialises the Editor.

return: JavaScript Initialization string
since: 1.5
access: public

string onInit ()

onSave (line 719)

TinyMCE WYSIWYG Editor - copy editor content to form field

access: public

string onSave (string $editor)

string $editor: The name of the editor

onSetContent (line 707)

TinyMCE WYSIWYG Editor - set the editor content

access: public

string onSetContent (string $editor, string $html)

string $editor: The name of the editor
string $html: The html to place in the editor

Inherited Methods

Inherited From JPlugin

JPlugin::__construct()
JPlugin::loadLanguage()

Inherited From JEvent

JEvent::__construct()
JEvent::update()

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::__toString()