[ Index ]

PHP Cross Reference of Joomla 1.5.26 DE

title

Body

[close]

/libraries/joomla/html/ -> editor.php (summary)

(no description)

Copyright: Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
License: GNU/GPL, see LICENSE.php
Version: $Id: editor.php 14401 2010-01-26 14:10:00Z louis $
File Size: 320 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

JEditor:: (9 methods):
  __construct()
  getInstance()
  initialise()
  display()
  save()
  getContent()
  setContent()
  getButtons()
  _loadEditor()


Class: JEditor  - X-Ref

JEditor class to handle WYSIWYG editors

__construct($editor = 'none')   X-Ref
constructor

param: string    The editor name

getInstance($editor = 'none')   X-Ref
Returns a reference to a global Editor object, only creating it
if it doesn't already exist.

This method must be invoked as:
<pre>  $editor = &JEditor::getInstance([$editor);</pre>

param: string    $editor  The editor to use.
return: JEditor    The Editor object.

initialise()   X-Ref
Initialize the editor


display($name, $html, $width, $height, $col, $row, $buttons = true, $params = array()   X-Ref
Present a text area

param: string    The control name
param: string    The contents of the text area
param: string    The width of the text area (px or %)
param: string    The height of the text area (px or %)
param: int        The number of columns for the textarea
param: int        The number of rows for the textarea
param: boolean    True and the editor buttons will be displayed
param: array    Associative array of editor parameters

save( $editor )   X-Ref
Save the editor content

param: string    The name of the editor control

getContent( $editor )   X-Ref
Get the editor contents

param: string    The name of the editor control

setContent( $editor, $html )   X-Ref
Set the editor contents

param: string    The name of the editor control
param: string    The contents of the text area

getButtons($editor, $buttons = true)   X-Ref
Get the editor buttons

param: 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.

_loadEditor($config = array()   X-Ref
Load the editor

param: array    Associative array of editor config paramaters



Generated: Wed Mar 28 15:54:07 2012 Cross-referenced by PHPXref 0.7.1