Editors parameter type
From Joomla! Documentation
Revision as of 08:37, 30 April 2013 by JoomlaWikiBot
|Parameters have been superseded by form fields in Joomla! 1.6. You may want to use the corresponding Editors form field type.|
The editors parameter type provides a drop down list of the available and enabled WYSIWYG editors. If the parameter has a saved value this is selected when the page is first loaded. If not, the default value (if any) is selected.
The first option on the list is always '- Select Editor -' (which is a translatable string) and is given the value 0.
- type (mandatory) must be editors.
- name (mandatory) is the unique name of the parameter.
- label (mandatory) (translatable) is the descriptive title of the field.
- default (optional) is the default editor name. This is the name listed in the File column in the Plugin Manager screen.
- description (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
Example XML parameter definition:
<param name="myeditor" type="editors" default="none" label="Select an editor" />