Class plgEditorTinymce

Description

TinyMCE Editor Plugin

  • since: 1.5

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

JObject
   |
   --JEvent
      |
      --JPlugin
         |
         --plgEditorTinymce
Variable Summary
mixed $_basePath
Method Summary
plgEditorTinymce __construct ( &$subject, array $config, object $subject)
string onDisplay (string $name, string $content, string $width, string $height, int $col, int $row, [boolean $buttons = true], [string $id = null], [ $asset = null], [ $author = null])
string onGetContent (string $editor)
boolean onGetInsertMethod ( $name)
string onInit ()
string onSave (string $editor)
string onSetContent (string $editor,  $html)
string _displayButtons ( $name,  $buttons,  $asset,  $author)
string _toogleButton ( $name)
Variables
mixed $_basePath = 'media/editors/tinymce/jscripts/tiny_mce' (line 21)

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
Constructor __construct (line 31)

Constructor

  • since: 1.5
  • access: public
plgEditorTinymce __construct ( &$subject, array $config, object $subject)
  • object $subject: The object to observe
  • array $config: An array that holds the plugin configuration
  • &$subject

Redefinition of:
JPlugin::__construct()
Constructor
onDisplay (line 714)

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], [ $asset = null], [ $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.
  • $asset
  • $author
onGetContent (line 634)

TinyMCE WYSIWYG Editor - get the editor content

  • access: public
string onGetContent (string $editor)
  • string $editor: The name of the editor
onGetInsertMethod (line 667)
  • access: public
boolean onGetInsertMethod ( $name)
  • $name
onInit (line 44)

Initialises the Editor.

  • return: JavaScript Initialization string
  • since: 1.5
  • access: public
string onInit ()
onSave (line 658)

TinyMCE WYSIWYG Editor - copy editor content to form field

  • access: public
string onSave (string $editor)
  • string $editor: The name of the editor
onSetContent (line 646)

TinyMCE WYSIWYG Editor - set the editor content

  • access: public
string onSetContent (string $editor,  $html)
  • string $editor: The name of the editor
  • $html
_displayButtons (line 743)
  • access: private
string _displayButtons ( $name,  $buttons,  $asset,  $author)
  • $name
  • $buttons
  • $asset
  • $author
_toogleButton (line 797)
  • access: private
string _toogleButton ( $name)
  • $name

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()
JObject::__toString()

Documentation generated on Mon, 25 Jun 2012 14:00:13 -0500 by phpDocumentor 1.4.4