Actions

Difference between revisions of "Standard form field and parameter types"

From Joomla! Documentation

m (added Form fields category)
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{cookiejar}}
+
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.
===Parameter types supported===
+
 
----
+
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.
This chunk should begin by explaining what extension parameters are and
+
 
provide a simple illustration of parameters in use. It should then
+
{| class="wikitable" style="vertical-align:top; border:1px solid Sienna; background-color:Cornsilk;"
describe how and where to place parameter definitions in extension XML
+
|- style="background-color:Wheat; font-weight:bold; text-align: left;"
files and how to access parameter values in PHP during extension execution.
+
!width=15%|[[Parameter]]
Having listed the available parameter types in brief, it should
+
!width=15%|[[Form field]]
then provide a complete reference to each type including the XML syntax
+
!width=70%|Description
required and annotated screenshots to show their effect.
+
|-
----
+
|
[[Category:Templates]]
+
|{{JVer|1.6}} [[Accesslevel form field type|accesslevel]]
 +
|provides a drop down list of viewing access levels.
 +
|-
 +
|
 +
|{{JVer|1.6}} [[Cachehandler form field type|cachehandler]]
 +
|provides a list of available cache handling options.
 +
|-
 +
|{{JVer|1.5}} [[Calendar parameter type|calendar]]
 +
|{{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.
 +
|-
 +
|{{JVer|1.5}} [[Category parameter type|category]]
 +
|
 +
|provides a drop down list of categories from a given section.
 +
|-
 +
|
 +
|{{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}} [[Checkboxes form field type|checkboxes]]
 +
|provides unlimited checkboxes that can be used for multi-select.
 +
|-
 +
|
 +
|{{JVer|1.6}} [[Combo form field type|combo]]
 +
|provides a combo box field.
 +
|-
 +
|
 +
|{{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}} [[Contentlanguage form field type|contentlanguage]]
 +
|provides a list of installed content languages for use in conjunction with the language switcher plugin.
 +
|-
 +
|
 +
|{{JVer|1.6}} [[Editor form field type|editor]]
 +
|provides an editor area field
 +
|-
 +
|{{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.
 +
|-
 +
|
 +
|{{JVer|1.6}} [[File form field type|file]]
 +
|
 +
|-
 +
|{{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.
 +
|-
 +
|{{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.
 +
|-
 +
|
 +
|{{JVer|1.6}} [[Groupedlist form field type|groupedlist]]
 +
|provides a drop down list of items organized into groups.
 +
|-
 +
|{{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.
 +
|-
 +
|{{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).
 +
|-
 +
|{{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.
 +
|-
 +
|
 +
|{{JVer|1.6}} [[Integer form field type|integer]]
 +
|provides a drop down list of integers between a minimum and maximum.
 +
|-
 +
|{{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.
 +
|-
 +
|{{JVer|1.5}} [[List parameter type|list]]
 +
|{{JVer|1.6}} [[List form field type|list]]
 +
|provides a drop down list of custom-defined entries.
 +
|-
 +
|
 +
|{{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]]
 +
|provides a drop down list of the available menus from your Joomla site.
 +
|-
 +
|{{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.
 +
|-
 +
|
 +
|{{JVer|1.6}} [[Modulelayout form field type|modulelayout]]
 +
|provides a list of alternative layout for a module grouped by core and template.
 +
|-
 +
|{{JVer|1.5}} [[Password parameter type|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.
 +
|-
 +
|{{JVer|1.5}} [[Radio parameter type|radio]]
 +
|{{JVer|1.6}} [[Radio form field type|radio]]
 +
|provides radio buttons to select different options.
 +
|-
 +
|
 +
|{{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}} [[Sessionhandler form field type|sessionhandler]]
 +
|provides a drop down list of session handler options.
 +
|-
 +
|{{JVer|1.5}} [[Section parameter type|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.
 +
|-
 +
|{{JVer|1.5}} [[Spacer parameter type|spacer]]
 +
|{{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.
 +
|-
 +
|{{JVer|1.5}} [[Sql parameter type|sql]]
 +
|{{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}} [[Templatestyle form field type|templatestyle]]
 +
|provides a drop down list of template styles.
 +
|-
 +
|{{JVer|1.5}} [[Text parameter type|text]]
 +
|{{JVer|1.6}} [[Text form field type|text]]
 +
|provides a text box for data entry.
 +
|-
 +
|{{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.
 +
|-
 +
|{{JVer|1.5}} [[Timezones parameter type|timezone]]
 +
|{{JVer|1.6}} [[Timezone form field type|timezone]]
 +
|provides a drop down list of time zones.
 +
|-
 +
|
 +
|{{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.
 +
|-
 +
|
 +
|{{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]][[Category:Form fields]]</noinclude>

Revision as of 06: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
Joomla 1.6 accesslevel provides a drop down list of viewing access levels.
Joomla 1.6 cachehandler provides a list of available cache handling options.
Joomla 1.5 calendar Joomla 1.6 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.
Joomla 1.5 category provides a drop down list of categories from a given section.
Joomla 1.6 category provides a drop down list of categories from a given extension.
Joomla 1.6 checkbox provides a single checkbox to be checked or unchecked.
Joomla 1.6 checkboxes provides unlimited checkboxes that can be used for multi-select.
Joomla 1.6 combo provides a combo box field.
Joomla 1.6 componentlayout provides a grouped list of core and template alternate layouts for a component item.
Joomla 1.6 contentlanguage provides a list of installed content languages for use in conjunction with the language switcher plugin.
Joomla 1.6 editor provides an editor area field
Joomla 1.5 editors Joomla 1.6 editors provides a drop down list of the available WYSIWYG editors.
Joomla 1.6 file
Joomla 1.5 filelist Joomla 1.6 filelist provides a drop down list of files from a specified directory.
Joomla 1.5 folderlist Joomla 1.6 folderlist provides a drop down list of folders from a specified directory.
Joomla 1.6 groupedlist provides a drop down list of items organized into groups.
Joomla 1.5 helpsites Joomla 1.6 helpsite provides a drop down list of the help sites for your Joomla installation.
Joomla 1.5 hidden Joomla 1.6 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).
Joomla 1.5 imagelist Joomla 1.6 imagelist provides a drop down list of image files in a specified directory.
Joomla 1.6 integer provides a drop down list of integers between a minimum and maximum.
Joomla 1.5 languages Joomla 1.6 language provides a drop down list of the installed languages for the Front-end or Back-end.
Joomla 1.5 list Joomla 1.6 list provides a drop down list of custom-defined entries.
Joomla 1.6 media provides modal access to the media manager for insertion of images with upload for users with appropriate permissions.
Joomla 1.5 menu Joomla 1.6 menu provides a drop down list of the available menus from your Joomla site.
Joomla 1.5 menuitem Joomla 1.6 menuitem provides a drop down list of the available menu items from your Joomla site.
Joomla 1.6 modulelayout provides a list of alternative layout for a module grouped by core and template.
Joomla 1.5 password Joomla 1.6 password provides a text box for entry of a password. The password characters will be obscured as they are entered.
Joomla 1.5 radio Joomla 1.6 radio provides radio buttons to select different options.
Joomla 1.6 rules provides a matrix of group by action options for managing access control. Display depends on context.
Joomla 1.6 sessionhandler provides a drop down list of session handler options.
Joomla 1.5 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.
Joomla 1.5 spacer Joomla 1.6 spacer provides a visual separator between parameter field elements. It is purely a visual aid and no parameter value is stored.
Joomla 1.5 sql Joomla 1.6 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.
Joomla 1.6 templatestyle provides a drop down list of template styles.
Joomla 1.5 text Joomla 1.6 text provides a text box for data entry.
Joomla 1.5 textarea Joomla 1.6 textarea provides a text area for entry of multi-line text.
Joomla 1.5 timezone Joomla 1.6 timezone provides a drop down list of time zones.
Joomla 1.6 user provides a modal list of users.
Joomla 1.5 usergroup provides a drop down list of user groups.
Joomla 1.6 usergroup provides an array of check boxes allowing multi-select.