Référence de la classe PlgEditorCodemirror

Graphe d'héritage de PlgEditorCodemirror:

Fonctions membres publiques
	onInit ()
	onSave ($id)
	onGetContent ($id)
	onSetContent ($id, $content)
	onGetInsertMethod ()
	onDisplay ( $name, $content, $width, $height, $col, $row, $buttons=true, $id=null, $asset=null, $author=null, $params=array())

Fonctions membres protégées
	displayButtons ($name, $buttons, $asset, $author)
	getFontInfo ($font)
	loadKeyMap ($keyMap)

Attributs protégés
	$autoloadLanguage = true
	$modeAlias = array()

Description détaillée

CodeMirror Editor Plugin.

Depuis

1.6

Documentation des fonctions membres

displayButtons()

displayButtons (   $name,   $buttons,   $asset,   $author  )

protected

Displays the editor buttons.

Paramètres

string	$name	Button name.
mixed	$buttons	[array with button objects | boolean true to display buttons]
mixed	$asset	Unused.
mixed	$author	Unused.

Renvoie

string HTML

Références $asset, $author, $buttons, $name, $results, et $return.

getFontInfo()

getFontInfo (   $font )

protected

Gets font info from the json data file

Paramètres

string

$font

A key from the $fonts array.

Renvoie

object

Références null.

loadKeyMap()

loadKeyMap (   $keyMap )

protected

Loads a keyMap file

Paramètres

string

$keyMap

The name of a keyMap file to load.

Renvoie

void

Références $basePath, et JDEBUG.

onDisplay()

onDisplay	(		$name,
			$content,
			$width,
			$height,
			$col,
			$row,
			$buttons = true,
			$id = null,
			$asset = null,
			$author = null,
			$params = array()
	)

Display the editor area.

Paramètres

string	$name	The control name.
string	$content	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	Not used.
object	$author	Not used.
array	$params	Associative array of editor parameters.

Renvoie

string HTML

Références $asset, $author, $buttons, $content, $dispatcher, $displayData, $height, $id, $name, $options, $params, $results, $row, $width, JEventDispatcher\getInstance(), et JDEBUG.

onGetContent()

onGetContent

(

$id

)

Get the editor content.

Paramètres

string

$id

The id of the editor field.

Renvoie

string Javascript

Obsolète:

4.0 Use directly the returned code

Références $id, et json_encode.

onGetInsertMethod()

onGetInsertMethod

(

)

Adds the editor specific insert method.

Renvoie

void

Obsolète:

4.0 Code is loaded in the init script

Références getDocument.

onInit()

onInit

(

)

Initialises the Editor.

Renvoie

void

Références $dispatcher, $displayData, $doc, getDocument, et JEventDispatcher\getInstance().

onSave()

onSave

(

$id

)

Copy editor content to form field.

Paramètres

string

$id

The id of the editor field.

Renvoie

string Javascript

Obsolète:

4.0 Code executes directly on submit

Références $id, et json_encode.

onSetContent()

onSetContent	(		$id,
			$content
	)

Set the editor content.

Paramètres

string	$id	The id of the editor field.
string	$content	The content to set.

Renvoie

string Javascript

Obsolète:

4.0 Use directly the returned code

Références $content, $id, et json_encode.

Documentation des champs

$autoloadLanguage

$autoloadLanguage = true

protected

$modeAlias

$modeAlias = array()

protected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• codemirror.php