Class plgEditorNone

Description

Plain Textarea Editor Plugin

  • since: 1.5

Located in /plugins/editors/none/none.php (line 17)

JObject
   |
   --JEvent
      |
      --JPlugin
         |
         --plgEditorNone
Method Summary
string onDisplay (string $name,  $content, string $width, string $height, int $col, int $row, [boolean $buttons = true], [string $id = null], [string $asset = null], [object $author = null], [array $params = array()], string $html)
string onGetContent (string $id)
string onGetInsertMethod (string $id)
string onInit ()
void onSave ()
string onSetContent (string $id, string $html)
void _displayButtons ( $name,  $buttons,  $asset,  $author)
Variables

Inherited Variables

Inherited from JPlugin

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

Inherited from JEvent

JEvent::$_subject

Inherited from JObject

JObject::$_errors
Methods
onDisplay (line 126)

Display the editor area.

string onDisplay (string $name,  $content, string $width, string $height, int $col, int $row, [boolean $buttons = true], [string $id = null], [string $asset = null], [object $author = null], [array $params = array()], string $html)
  • string $name: The control name.
  • string $html: The contents of the text area.
  • string $width: The width of the text area (px or %).
  • string $height: The height of the text area (px or %).
  • int $col: The number of columns for the textarea.
  • int $row: The number of rows for the textarea.
  • boolean $buttons: True and the editor buttons will be displayed.
  • string $id: An optional ID for the textarea (note: since 1.6). If not supplied the name is used.
  • string $asset
  • object $author
  • array $params: Associative array of editor parameters.
  • $content
onGetContent (line 70)

Get the editor content.

string onGetContent (string $id)
  • string $id: The id of the editor field.
onGetInsertMethod (line 93)
string onGetInsertMethod (string $id)
  • string $id
onInit (line 26)

Method to handle the onInitEditor event.

  • Initialises the Editor

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

Copy editor content to form field.

Not applicable in this editor.

void onSave ()
onSetContent (line 83)

Set the editor content.

string onSetContent (string $id, string $html)
  • string $id: The id of the editor field.
  • string $html: The content to set.
_displayButtons (line 147)
void _displayButtons ( $name,  $buttons,  $asset,  $author)
  • $name
  • $buttons
  • $asset
  • $author

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 13:58:11 -0500 by phpDocumentor 1.4.4