Support Joomla!

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

The Joomla! Developer Network content is © copyright 2006 by the individual contributors and can be used in accordance with the Creative Commons License, Attribution- NonCommercial- ShareAlike 2.5

Class JEditor

Description
Description | Variables (details) | Methods (details)

JEditor class to handle WYSIWYG editors

Located in /joomla/html/editor.php (line 28) 

Class JObject   (Subpackage Base)

Abstract class JObservable   (Subpackage Base)
   
   Class JEditor   (Subpackage HTML)
Variable Summary
Description | Variables (details) | Methods (details)
Variable mixed $_editor
Variable mixed $_name
Method Summary
Description | Variables (details) | Methods (details)
Constructor JEditor __construct ([string $editor = 'none'])
Method void display ( $name,  $html,  $width,  $height,  $col,  $row, [ $buttons = true])
Method void getContent ( $editor)
Method JEditor &getInstance ([string $editor = 'none'])
Method void initialise ()
Method void save ( $editor)
Method void setContent ( $editor,  $html)
Variables
Description | Variables (details) | Methods (details)
mixed $_editor = null (line 35)

Editor Plugin object

mixed $_name = null (line 43)

Editor Plugin name

Methods
Description | Variables (details) Methods (details)
Constructor __construct (line 52)

constructor

  • access: protected
JEditor __construct ([string $editor = 'none'])
  • string $editor: The editor name
Redefinition of:
JObservable::__construct()
Constructor
display (line 115)

Present a text area

void display ( $name,  $html,  $width,  $height,  $col,  $row, [ $buttons = true])
  • $name
  • $html
  • $width
  • $height
  • $col
  • $row
  • $buttons
getContent (line 187)

Get the editor contents

void getContent ( $editor)
  • $editor
getInstance (line 67)

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);

  • return: The Editor object.
  • access: public
JEditor &getInstance ([string $editor = 'none'])
  • string $editor: The editor to use.
initialise (line 88)

Initialize the editor

void initialise ()
save (line 160)

Save the editor content

void save ( $editor)
  • $editor
setContent (line 209)

Set the editor contents

void setContent ( $editor,  $html)
  • $editor
  • $html

Inherited Methods

Inherited From JObservable

JObservable::__construct()
JObservable::attach()
JObservable::detach()
JObservable::getState()
JObservable::notify()

Inherited From JObject

JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getPublicProperties()
JObject::set()
JObject::toString()
Documentation generated on Mon, 05 Mar 2007 20:57:17 +0000 by phpDocumentor 1.3.1