JEditor: Difference between revisions
From Joomla! Documentation
Bulk upload by Doxiki2 |
m preparing for archive only |
||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
=={{JVer|11.1}} JEditor== | |||
===Description=== | |||
{{ | |||
=== | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
!Visibility | |||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
|[[JEditor::__construct | |public | ||
| | |[[API17:JEditor::__construct|__construct]] | ||
|Constructor. | |||
|- | |- | ||
|[[JEditor::display | |public | ||
|[[API17:JEditor::display|display]] | |||
|Display the editor area. | |Display the editor area. | ||
|- | |- | ||
|[[JEditor::getButtons | |public | ||
|[[API17:JEditor::getButtons|getButtons]] | |||
|Get the editor buttons. | |Get the editor buttons. | ||
|- | |- | ||
|[[JEditor::getContent | |public | ||
|[[API17:JEditor::getContent|getContent]] | |||
|Get the editor contents. | |Get the editor contents. | ||
|- | |- | ||
|[[JEditor::initialise | |public | ||
|[[API17:JEditor::initialise|initialise]] | |||
|Initialise the editor. | |Initialise the editor. | ||
|- | |- | ||
|[[JEditor::save | |public | ||
|[[API17:JEditor::save|save]] | |||
|Save the editor content. | |Save the editor content. | ||
|- | |- | ||
|[[JEditor::setContent | |public | ||
|[[API17:JEditor::setContent|setContent]] | |||
|Set the editor contents. | |Set the editor contents. | ||
|- | |- | ||
|[[JEditor::getInstance | |public static | ||
|[[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. | ||
|- | |- | ||
|[[JEditor::_loadEditor | |protected | ||
|[[API17:JEditor::_loadEditor|_loadEditor]] | |||
|Load the editor. | |Load the editor. | ||
|- | |- | ||
|} | |} | ||
* '''Defined in''' libraries/joomla/html/editor.php | |||
* '''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}} Subpackage [[API17:Subpackage Html|Html]] | ||
* [[API17:JEditor|Other versions of JEditor]] | |||
===Examples=== | ===User contributed notes=== | ||
=== Code Examples === | |||
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=JEditor | category=JEditor | ||
namespace=CodeExample | |||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
namespace=CodeExample | |||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude> | <noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude> | ||
Latest revision as of 02:55, 25 March 2017
JEditor
Description
Methods
| 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
jimport( 'joomla.html.editor' );
See also
- JEditor source code on BitBucket
- Subpackage Html
- Other versions of JEditor
User contributed notes
Code Examples