Difference between revisions of "Standard form field and parameter types"
From Joomla! Documentation
(First pass at updating this page for Joomla 1.6.) |
Radiant tech (talk | contribs) m (added Form fields category) |
||
(6 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
− | There are many different standard form field types supported in the Joomla Framework for all extension types (templates, components, modules and plugins). | + | There are many different standard [[parameter]] and [[form field]] types supported in the Joomla Framework for all extension types (templates, components, modules and plugins). This section gives a brief description of each form field type, in alphabetical order. Full details of each form field type are given on the following pages. |
− | Form fields and the [[JForm]] class were introduced in Joomla 1.6. | + | Form fields and the [[JForm]] class were introduced in Joomla 1.6. Prior to that these standard types were referred to as parameter types and were handled by the, now deprecated, [[JParameter]] class. |
{| class="wikitable" style="vertical-align:top; border:1px solid Sienna; background-color:Cornsilk;" | {| class="wikitable" style="vertical-align:top; border:1px solid Sienna; background-color:Cornsilk;" | ||
|- style="background-color:Wheat; font-weight:bold; text-align: left;" | |- style="background-color:Wheat; font-weight:bold; text-align: left;" | ||
− | !width=15%| | + | !width=15%|[[Parameter]] |
+ | !width=15%|[[Form field]] | ||
!width=70%|Description | !width=70%|Description | ||
− | |||
|- | |- | ||
− | |||
| | | | ||
− | |{{JVer|1.6}} | + | |{{JVer|1.6}} [[Accesslevel form field type|accesslevel]] |
+ | |provides a drop down list of viewing access levels. | ||
|- | |- | ||
− | |||
| | | | ||
− | |{{JVer|1.6}} | + | |{{JVer|1.6}} [[Cachehandler form field type|cachehandler]] |
+ | |provides a list of available cache handling options. | ||
|- | |- | ||
− | |[[Calendar parameter type|calendar]] | + | |{{JVer|1.5}} [[Calendar parameter type|calendar]] |
− | |provides a text box for entry of a date. | + | |{{JVer|1.6}} [[Calendar form field type|calendar]] |
− | + | |provides a text box for entry of a date. An icon next to the text box provides a link to a pop-up calendar, which can also be used to enter the date value. | |
|- | |- | ||
− | |[[Category parameter type|category]] | + | |{{JVer|1.5}} [[Category parameter type|category]] |
+ | | | ||
|provides a drop down list of categories from a given section. | |provides a drop down list of categories from a given section. | ||
− | |||
|- | |- | ||
− | |||
| | | | ||
− | |{{JVer|1.6}} | + | |{{JVer|1.6}} [[Category form field type|category]] |
+ | |provides a drop down list of categories from a given extension. | ||
+ | |- | ||
+ | | | ||
+ | |{{JVer|1.6}} [[Checkbox form field type|checkbox]] | ||
+ | |provides a single checkbox to be checked or unchecked. | ||
|- | |- | ||
− | |||
| | | | ||
− | |{{JVer|1.6}} | + | |{{JVer|1.6}} [[Checkboxes form field type|checkboxes]] |
+ | |provides unlimited checkboxes that can be used for multi-select. | ||
|- | |- | ||
− | |||
| | | | ||
− | |{{JVer|1.6}} | + | |{{JVer|1.6}} [[Combo form field type|combo]] |
+ | |provides a combo box field. | ||
|- | |- | ||
− | |||
| | | | ||
− | |{{JVer|1.6}} | + | |{{JVer|1.6}} [[Componentlayout form field type|componentlayout]] |
+ | |provides a grouped list of core and template alternate layouts for a component item. | ||
|- | |- | ||
− | |||
| | | | ||
− | |{{JVer|1.6}} | + | |{{JVer|1.6}} [[Contentlanguage form field type|contentlanguage]] |
+ | |provides a list of installed content languages for use in conjunction with the language switcher plugin. | ||
|- | |- | ||
− | |||
| | | | ||
− | |{{JVer|1.6}} | + | |{{JVer|1.6}} [[Editor form field type|editor]] |
+ | |provides an editor area field | ||
|- | |- | ||
− | |[[Editors parameter type|editors]] | + | |{{JVer|1.5}} [[Editors parameter type|editors]] |
+ | |{{JVer|1.6}} [[Editors form field type|editors]] | ||
|provides a drop down list of the available WYSIWYG editors. | |provides a drop down list of the available WYSIWYG editors. | ||
− | |||
|- | |- | ||
− | |||
| | | | ||
− | |{{JVer|1.6}} | + | |{{JVer|1.6}} [[File form field type|file]] |
+ | | | ||
|- | |- | ||
− | |[[Filelist parameter type|filelist]] | + | |{{JVer|1.5}} [[Filelist parameter type|filelist]] |
+ | |{{JVer|1.6}} [[Filelist form field type|filelist]] | ||
|provides a drop down list of files from a specified directory. | |provides a drop down list of files from a specified directory. | ||
− | |||
|- | |- | ||
− | |[[Folderlist parameter type|folderlist]] | + | |{{JVer|1.5}} [[Folderlist parameter type|folderlist]] |
+ | |{{JVer|1.6}} [[Folderlist form field type|folderlist]] | ||
|provides a drop down list of folders from a specified directory. | |provides a drop down list of folders from a specified directory. | ||
− | |||
|- | |- | ||
− | |||
| | | | ||
− | |{{JVer|1.6}} | + | |{{JVer|1.6}} [[Groupedlist form field type|groupedlist]] |
+ | |provides a drop down list of items organized into groups. | ||
|- | |- | ||
− | |[[Helpsite | + | |{{JVer|1.5}} [[Helpsites parameter type|helpsites]] |
+ | |{{JVer|1.6}} [[Helpsite form field type|helpsite]] | ||
|provides a drop down list of the help sites for your Joomla installation. | |provides a drop down list of the help sites for your Joomla installation. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
− | |[[Hidden parameter type|hidden]] | + | |{{JVer|1.5}} [[Hidden parameter type|hidden]] |
+ | |{{JVer|1.6}} [[Hidden form field type|hidden]] | ||
|provides a hidden field for saving a parameter whose value cannot be altered directly by a user in the Administrator (it can be altered in code or by editing the ''params.ini'' file). | |provides a hidden field for saving a parameter whose value cannot be altered directly by a user in the Administrator (it can be altered in code or by editing the ''params.ini'' file). | ||
− | |||
|- | |- | ||
− | |[[Imagelist parameter type|imagelist]] | + | |{{JVer|1.5}} [[Imagelist parameter type|imagelist]] |
+ | |{{JVer|1.6}} [[Imagelist form field type|imagelist]] | ||
|provides a drop down list of image files in a specified directory. | |provides a drop down list of image files in a specified directory. | ||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
− | |||
| | | | ||
− | |{{JVer|1.6}} | + | |{{JVer|1.6}} [[Integer form field type|integer]] |
+ | |provides a drop down list of integers between a minimum and maximum. | ||
|- | |- | ||
− | |[[Language | + | |{{JVer|1.5}} [[Languages parameter type|languages]] |
+ | |{{JVer|1.6}} [[Language form field type|language]] | ||
|provides a drop down list of the installed languages for the Front-end or Back-end. | |provides a drop down list of the installed languages for the Front-end or Back-end. | ||
− | |||
|- | |- | ||
− | | | + | |{{JVer|1.5}} [[List parameter type|list]] |
− | + | |{{JVer|1.6}} [[List form field type|list]] | |
− | |{{JVer|1. | ||
− | |||
− | |||
|provides a drop down list of custom-defined entries. | |provides a drop down list of custom-defined entries. | ||
− | |||
|- | |- | ||
− | |||
| | | | ||
− | |{{JVer|1.6}} | + | |{{JVer|1.6}} [[Media form field type|media]] |
+ | |provides modal access to the media manager for insertion of images with upload for users with appropriate permissions. | ||
|- | |- | ||
− | |[[ | + | |{{JVer|1.5}} [[Menu parameter type|menu]] |
− | + | |{{JVer|1.6}} [[Menu form field type|menu]] | |
− | |{{JVer|1.6}} | ||
− | |||
− | |||
|provides a drop down list of the available menus from your Joomla site. | |provides a drop down list of the available menus from your Joomla site. | ||
− | |||
|- | |- | ||
− | |[[Menuitem parameter type|menuitem]] | + | |{{JVer|1.5}} [[Menuitem parameter type|menuitem]] |
+ | |{{JVer|1.6}} [[Menuitem form field type|menuitem]] | ||
|provides a drop down list of the available menu items from your Joomla site. | |provides a drop down list of the available menu items from your Joomla site. | ||
− | |||
|- | |- | ||
− | |||
| | | | ||
− | |{{JVer|1.6}} | + | |{{JVer|1.6}} [[Modulelayout form field type|modulelayout]] |
+ | |provides a list of alternative layout for a module grouped by core and template. | ||
|- | |- | ||
− | |[[Password parameter type|password]] | + | |{{JVer|1.5}} [[Password parameter type|password]] |
− | |provides a text box for entry of a password. | + | |{{JVer|1.6}} [[Password form field type|password]] |
− | + | |provides a text box for entry of a password. The password characters will be obscured as they are entered. | |
|- | |- | ||
− | |[[Radio parameter type|radio]] | + | |{{JVer|1.5}} [[Radio parameter type|radio]] |
+ | |{{JVer|1.6}} [[Radio form field type|radio]] | ||
|provides radio buttons to select different options. | |provides radio buttons to select different options. | ||
− | |||
|- | |- | ||
− | |||
| | | | ||
− | |{{JVer|1.6}} | + | |{{JVer|1.6}} [[Rules form field type|rules]] |
+ | |provides a matrix of group by action options for managing access control. Display depends on context. | ||
|- | |- | ||
− | |||
| | | | ||
− | |{{JVer|1.6}} | + | |{{JVer|1.6}} [[Sessionhandler form field type|sessionhandler]] |
+ | |provides a drop down list of session handler options. | ||
|- | |- | ||
− | |[[Section parameter type|section]] | + | |{{JVer|1.5}} [[Section parameter type|section]] |
− | |provides a drop down list of the sections from your Joomla site. | + | | |
− | + | |provides a drop down list of the sections from your Joomla site. Sections have been removed in favour of subcategories in Joomla 1.6 onwards. | |
|- | |- | ||
− | |[[Spacer parameter type|spacer]] | + | |{{JVer|1.5}} [[Spacer parameter type|spacer]] |
− | |provides a visual separator between parameter field elements. | + | |{{JVer|1.6}} [[Spacer form field type|spacer]] |
− | + | |provides a visual separator between parameter field elements. It is purely a visual aid and no parameter value is stored. | |
|- | |- | ||
− | |[[Sql parameter type|sql]] | + | |{{JVer|1.5}} [[Sql parameter type|sql]] |
− | |provides a drop down list of entries obtained by running a query on the Joomla Database. | + | |{{JVer|1.6}} [[SQL form field type|sql]] |
− | + | |provides a drop down list of entries obtained by running a query on the Joomla Database. The first results column returned by the query provides the values for the drop down box. | |
|- | |- | ||
− | |||
| | | | ||
− | |{{JVer|1.6}} | + | |{{JVer|1.6}} [[Templatestyle form field type|templatestyle]] |
+ | |provides a drop down list of template styles. | ||
|- | |- | ||
− | |[[Text parameter type|text]] | + | |{{JVer|1.5}} [[Text parameter type|text]] |
+ | |{{JVer|1.6}} [[Text form field type|text]] | ||
|provides a text box for data entry. | |provides a text box for data entry. | ||
− | |||
|- | |- | ||
− | |[[Textarea parameter type|textarea]] | + | |{{JVer|1.5}} [[Textarea parameter type|textarea]] |
+ | |{{JVer|1.6}} [[Textarea form field type|textarea]] | ||
|provides a text area for entry of multi-line text. | |provides a text area for entry of multi-line text. | ||
− | |||
|- | |- | ||
− | |[[Timezone | + | |{{JVer|1.5}} [[Timezones parameter type|timezone]] |
+ | |{{JVer|1.6}} [[Timezone form field type|timezone]] | ||
|provides a drop down list of time zones. | |provides a drop down list of time zones. | ||
− | |||
|- | |- | ||
− | |[[ | + | | |
− | |provides a | + | |{{JVer|1.6}} [[User form field type|user]] |
− | + | |provides a modal list of users. | |
|- | |- | ||
− | |[[ | + | |{{JVer|1.5}} [[Usergroup parameter type|usergroup]] |
| | | | ||
− | | | + | |provides a drop down list of user groups. |
|- | |- | ||
− | |[[Usergroup | + | | |
− | |provides | + | |{{JVer|1.6}} [[Usergroup form field type|usergroup]] |
− | + | |provides an array of check boxes allowing multi-select. | |
|} | |} | ||
− | <noinclude>[[Category:Components]][[Category:Modules]][[Category:Plugins]][[Category:Templates]][[Category:Development]][[Category:Parameters]]</noinclude> | + | <noinclude>[[Category:Components]][[Category:Modules]][[Category:Plugins]][[Category:Templates]][[Category:Development]][[Category:Parameters]][[Category:Form fields]]</noinclude> |
Revision as of 07:09, 21 October 2011
There are many different standard parameter and form field types supported in the Joomla Framework for all extension types (templates, components, modules and plugins). This section gives a brief description of each form field type, in alphabetical order. Full details of each form field type are given on the following pages.
Form fields and the JForm class were introduced in Joomla 1.6. Prior to that these standard types were referred to as parameter types and were handled by the, now deprecated, JParameter class.
Parameter | Form field | Description |
---|---|---|
accesslevel | provides a drop down list of viewing access levels. | |
cachehandler | provides a list of available cache handling options. | |
calendar | calendar | provides a text box for entry of a date. An icon next to the text box provides a link to a pop-up calendar, which can also be used to enter the date value. |
category | provides a drop down list of categories from a given section. | |
category | provides a drop down list of categories from a given extension. | |
checkbox | provides a single checkbox to be checked or unchecked. | |
checkboxes | provides unlimited checkboxes that can be used for multi-select. | |
combo | provides a combo box field. | |
componentlayout | provides a grouped list of core and template alternate layouts for a component item. | |
contentlanguage | provides a list of installed content languages for use in conjunction with the language switcher plugin. | |
editor | provides an editor area field | |
editors | editors | provides a drop down list of the available WYSIWYG editors. |
file | ||
filelist | filelist | provides a drop down list of files from a specified directory. |
folderlist | folderlist | provides a drop down list of folders from a specified directory. |
groupedlist | provides a drop down list of items organized into groups. | |
helpsites | helpsite | provides a drop down list of the help sites for your Joomla installation. |
hidden | hidden | provides a hidden field for saving a parameter whose value cannot be altered directly by a user in the Administrator (it can be altered in code or by editing the params.ini file). |
imagelist | imagelist | provides a drop down list of image files in a specified directory. |
integer | provides a drop down list of integers between a minimum and maximum. | |
languages | language | provides a drop down list of the installed languages for the Front-end or Back-end. |
list | list | provides a drop down list of custom-defined entries. |
media | provides modal access to the media manager for insertion of images with upload for users with appropriate permissions. | |
menu | menu | provides a drop down list of the available menus from your Joomla site. |
menuitem | menuitem | provides a drop down list of the available menu items from your Joomla site. |
modulelayout | provides a list of alternative layout for a module grouped by core and template. | |
password | password | provides a text box for entry of a password. The password characters will be obscured as they are entered. |
radio | radio | provides radio buttons to select different options. |
rules | provides a matrix of group by action options for managing access control. Display depends on context. | |
sessionhandler | provides a drop down list of session handler options. | |
section | provides a drop down list of the sections from your Joomla site. Sections have been removed in favour of subcategories in Joomla 1.6 onwards. | |
spacer | spacer | provides a visual separator between parameter field elements. It is purely a visual aid and no parameter value is stored. |
sql | sql | provides a drop down list of entries obtained by running a query on the Joomla Database. The first results column returned by the query provides the values for the drop down box. |
templatestyle | provides a drop down list of template styles. | |
text | text | provides a text box for data entry. |
textarea | textarea | provides a text area for entry of multi-line text. |
timezone | timezone | provides a drop down list of time zones. |
user | provides a modal list of users. | |
usergroup | provides a drop down list of user groups. | |
usergroup | provides an array of check boxes allowing multi-select. |