JEditor
Description
JEditor class to handle WYSIWYG editors
Located in /joomla/html/editor.php (line 27)
JObject (Subpackage Base)
JObservable (Subpackage Base)
Variable Summary
Method Summary
void
display
(string $name, string $html, string $width, string $height, int $col, int $row, [boolean $buttons = true], [array $params = array()])
Variables
object
$_editor
= null (line 34)
Editor Plugin object
string
$_name
= null (line 41)
Editor Plugin name
array
$_tagForSEF
= array('start' => '<!-- Start Editor -->', 'end' => '<!-- End Editor -->') (line 48)
Editor start and end tag
Used to tell SEF plugin not to process editor contents
Inherited Variables
Inherited from JObject
Methods
constructor
JEditor
__construct
([string $editor = 'none'])
- string $editor: The editor name
Redefinition of:
- JObservable::__construct()
- Constructor
Present a text area
void
display
(string $name, string $html, string $width, string $height, int $col, int $row, [boolean $buttons = true], [array $params = array()])
- 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
- array $params: Associative array of editor parameters
Get the editor buttons
void
getButtons
( $editor, [mixed $buttons = true])
- mixed $buttons: Can be boolean or array, if boolean defines if the buttons are displayed, if array defines a list of buttons not to show.
- $editor
Get the editor contents
void
getContent
(string $editor)
- string $editor: The name of the editor control
Returns a reference to a global Editor object, only creating it if it doesn't already exist.
This method must be invoked as:
$editor = &JEditor::getInstance([$editor);
- string $editor: The editor to use.
Save the editor content
void
save
(string $editor)
- string $editor: The name of the editor control
Set the editor contents
void
setContent
(string $editor, string $html)
- string $editor: The name of the editor control
- string $html: The contents of the text area
Inherited Methods
Inherited From JObservable
JObservable::__construct()
Inherited From JObject