Difference between revisions of "JEditor"
From Joomla! Documentation
(Updated to r1448:247ba8d88526) |
m (preparing for archive only) |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
=={{JVer|11.1}} JEditor== | =={{JVer|11.1}} JEditor== | ||
===Description=== | ===Description=== | ||
| − | + | ||
| − | + | ||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
| Line 14: | Line 12: | ||
|- | |- | ||
|public | |public | ||
| − | |[[JEditor::__construct | + | |[[API17:JEditor::__construct|__construct]] |
|Constructor. | |Constructor. | ||
|- | |- | ||
|public | |public | ||
| − | |[[JEditor::display | + | |[[API17:JEditor::display|display]] |
|Display the editor area. | |Display the editor area. | ||
|- | |- | ||
|public | |public | ||
| − | |[[JEditor::getButtons | + | |[[API17:JEditor::getButtons|getButtons]] |
|Get the editor buttons. | |Get the editor buttons. | ||
|- | |- | ||
|public | |public | ||
| − | |[[JEditor::getContent | + | |[[API17:JEditor::getContent|getContent]] |
|Get the editor contents. | |Get the editor contents. | ||
|- | |- | ||
|public | |public | ||
| − | |[[JEditor::initialise | + | |[[API17:JEditor::initialise|initialise]] |
|Initialise the editor. | |Initialise the editor. | ||
|- | |- | ||
|public | |public | ||
| − | |[[JEditor::save | + | |[[API17:JEditor::save|save]] |
|Save the editor content. | |Save the editor content. | ||
|- | |- | ||
|public | |public | ||
| − | |[[JEditor::setContent | + | |[[API17:JEditor::setContent|setContent]] |
|Set the editor contents. | |Set the editor contents. | ||
|- | |- | ||
|public static | |public static | ||
| − | |[[JEditor::getInstance | + | |[[API17:JEditor::getInstance|getInstance]] |
|Returns the global Editor object, only creating it if it doesn't already exist. | |Returns the global Editor object, only creating it if it doesn't already exist. | ||
|- | |- | ||
|protected | |protected | ||
| − | |[[JEditor::_loadEditor | + | |[[API17:JEditor::_loadEditor|_loadEditor]] |
|Load the editor. | |Load the editor. | ||
|- | |- | ||
|} | |} | ||
* '''Defined in''' libraries/joomla/html/editor.php | * '''Defined in''' libraries/joomla/html/editor.php | ||
| − | * '''Extends''' [[JObservable | + | * '''Extends''' [[API17:JObservable|JObservable]] |
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.html.editor' );</source> | <source lang="php">jimport( 'joomla.html.editor' );</source> | ||
===See also=== | ===See also=== | ||
* {{JVer|11.1}} '''JEditor source code''' on [[jplatform:html/editor.php|BitBucket]] | * {{JVer|11.1}} '''JEditor source code''' on [[jplatform:html/editor.php|BitBucket]] | ||
| − | * {{JVer|11.1}} Subpackage [[Subpackage Html | + | * {{JVer|11.1}} Subpackage [[API17:Subpackage Html|Html]] |
| − | * [[JEditor|Other versions of JEditor]] | + | * [[API17:JEditor|Other versions of JEditor]] |
| − | + | ||
| − | + | ||
| − | |||
| − | |||
===User contributed notes=== | ===User contributed notes=== | ||
| − | + | === Code Examples === | |
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=JEditor | category=JEditor | ||
| − | + | namespace=CodeExample | |
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| Line 73: | Line 69: | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
| − | <noinclude> | + | <noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude> |
Latest revision as of 21:55, 24 March 2017
The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
JEditor[edit]
Description[edit]
Methods[edit]
| Visibility | Method name | Description |
|---|---|---|
| public | __construct | Constructor. |
| public | display | Display the editor area. |
| public | getButtons | Get the editor buttons. |
| public | getContent | Get the editor contents. |
| public | initialise | Initialise the editor. |
| public | save | Save the editor content. |
| public | setContent | Set the editor contents. |
| public static | getInstance | Returns the global Editor object, only creating it if it doesn't already exist. |
| protected | _loadEditor | Load the editor. |
- Defined in libraries/joomla/html/editor.php
- Extends JObservable
Importing[edit]
jimport( 'joomla.html.editor' );See also[edit]
- JEditor source code on BitBucket
- Subpackage Html
- Other versions of JEditor
User contributed notes[edit]
Code Examples[edit]