API17:JEditor
From Joomla! Documentation
(Difference between revisions)
(Layout updates) |
m (→User contributed notes: bad link repair) |
||
| (One intermediate revision by one user not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| + | =={{JVer|11.1}} JEditor== | ||
| + | ===Description=== | ||
| + | {{Description:JEditor}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[Description:JEditor|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JEditor|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| + | !Visibility | ||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
| + | |public | ||
|[[JEditor::__construct/11.1|__construct]] | |[[JEditor::__construct/11.1|__construct]] | ||
| − | | | + | |Constructor. |
|- | |- | ||
| + | |public | ||
|[[JEditor::display/11.1|display]] | |[[JEditor::display/11.1|display]] | ||
|Display the editor area. | |Display the editor area. | ||
|- | |- | ||
| + | |public | ||
|[[JEditor::getButtons/11.1|getButtons]] | |[[JEditor::getButtons/11.1|getButtons]] | ||
|Get the editor buttons. | |Get the editor buttons. | ||
|- | |- | ||
| + | |public | ||
|[[JEditor::getContent/11.1|getContent]] | |[[JEditor::getContent/11.1|getContent]] | ||
|Get the editor contents. | |Get the editor contents. | ||
|- | |- | ||
| + | |public | ||
|[[JEditor::initialise/11.1|initialise]] | |[[JEditor::initialise/11.1|initialise]] | ||
|Initialise the editor. | |Initialise the editor. | ||
|- | |- | ||
| + | |public | ||
|[[JEditor::save/11.1|save]] | |[[JEditor::save/11.1|save]] | ||
|Save the editor content. | |Save the editor content. | ||
|- | |- | ||
| + | |public | ||
|[[JEditor::setContent/11.1|setContent]] | |[[JEditor::setContent/11.1|setContent]] | ||
|Set the editor contents. | |Set the editor contents. | ||
|- | |- | ||
| + | |public static | ||
|[[JEditor::getInstance/11.1|getInstance]] | |[[JEditor::getInstance/11.1|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 | ||
|[[JEditor::_loadEditor/11.1|_loadEditor]] | |[[JEditor::_loadEditor/11.1|_loadEditor]] | ||
|Load the editor. | |Load the editor. | ||
|- | |- | ||
|} | |} | ||
| + | * '''Defined in''' libraries/joomla/html/editor.php | ||
| + | * '''Extends''' [[JObservable/11.1|JObservable]] | ||
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.html.editor' );</source> | <source lang="php">jimport( 'joomla.html.editor' );</source> | ||
===See also=== | ===See also=== | ||
| − | * JEditor source code | + | * {{JVer|11.1}} '''JEditor source code''' on [[jplatform:html/editor.php|BitBucket]] |
| − | * [[JEditor|Other versions of | + | * {{JVer|11.1}} Subpackage [[Subpackage Html/11.1|Html]] |
| + | * [[JEditor|Other versions of JEditor]] | ||
{{SeeAlso:JEditor}} | {{SeeAlso:JEditor}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JEditor|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JEditor|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | === | + | ===User contributed notes=== |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 63: | Line 70: | ||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
| − | <noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JEditor]]</noinclude> | + | <noinclude>[[Category:Platform JClasses]][[Category:Platform 11.1]][[Category:JEditor]]</noinclude> |
Revision as of 13:38, 29 August 2012
JEditor
Description
Description:JEditor [Edit Descripton]
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
SeeAlso:JEditor [Edit See Also]
User contributed notes
<CodeExamplesForm />
