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

From Joomla! Documentation

(Deleting a field type that doesn't exist)
Line 10: Line 10:
 
|-
 
|-
 
|[[Accesslevel parameter type|accesslevel]]
 
|[[Accesslevel parameter type|accesslevel]]
−
|
+
|provides a drop down list of viewing access levels.
 
|{{JVer|1.6}}
 
|{{JVer|1.6}}
 
|-
 
|-
 
|[[Cachehandler parameter type|cachehandler]]
 
|[[Cachehandler parameter type|cachehandler]]
−
|
+
|provides a list of available cache handling options.
 
|{{JVer|1.6}}
 
|{{JVer|1.6}}
 
|-
 
|-
Line 22: Line 22:
 
|-
 
|-
 
|[[Category parameter type|category]]
 
|[[Category parameter type|category]]
−
|provides a drop down list of categories from a given section.
+
|provides a drop down list of categories for an extension (from a given section in 1.5).
 
|{{JVer|1.5}}{{JVer|1.6}}
 
|{{JVer|1.5}}{{JVer|1.6}}
 
|-
 
|-
 
|[[Checkbox parameter type|checkbox]]
 
|[[Checkbox parameter type|checkbox]]
−
|
+
|provides a single checkbox to be checked or unchecked
 
|{{JVer|1.6}}
 
|{{JVer|1.6}}
 
|-
 
|-
 
|[[Checkboxes parameter type|checkboxes]]
 
|[[Checkboxes parameter type|checkboxes]]
−
|
+
|provides unlimited checkboxes that can be used for multi-select.
 
|{{JVer|1.6}}
 
|{{JVer|1.6}}
 
|-
 
|-
 
|[[Combo parameter type|combo]]
 
|[[Combo parameter type|combo]]
−
|
+
|provides a combo box field.
 
|{{JVer|1.6}}
 
|{{JVer|1.6}}
 
|-
 
|-
 
|[[Componentlayout parameter type|componentlayout]]
 
|[[Componentlayout parameter type|componentlayout]]
−
|
+
|provides a grouped list of core and template alternate layouts for a component item.
 
|{{JVer|1.6}}
 
|{{JVer|1.6}}
 
|-
 
|-
 
|[[Contentlanguage parameter type|contentlanguage]]
 
|[[Contentlanguage parameter 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 parameter type|editor]]
 
|[[Editor parameter type|editor]]
−
|
+
|provides an editor area field
 
|{{JVer|1.6}}
 
|{{JVer|1.6}}
 
|-
 
|-
Line 66: Line 66:
 
|-
 
|-
 
|[[Groupedlist parameter type|groupedlist]]
 
|[[Groupedlist parameter type|groupedlist]]
−
|
+
|provides a drop down list of items organized into groups.
 
|{{JVer|1.6}}
 
|{{JVer|1.6}}
 
|-
 
|-
Line 85: Line 85:
 
|{{JVer|1.5}}{{JVer|1.6}}
 
|{{JVer|1.5}}{{JVer|1.6}}
 
|-
 
|-
−
|[[Imagelist parameter type|imagelist]]
 
−
|
 
−
|{{JVer|1.6}}
 
 
|-
 
|-
 
|[[Integer parameter type|integer]]
 
|[[Integer parameter type|integer]]
−
|
+
|provides a drop down list of integers between a minimum and maximum.
 
|{{JVer|1.6}}
 
|{{JVer|1.6}}
 
|-
 
|-
Line 106: Line 103:
 
|-
 
|-
 
|[[Media parameter type|media]]
 
|[[Media parameter type|media]]
−
|
+
|provides modal access to the media manager for insertion of images with upload for users with appropriate permissions.
 
|{{JVer|1.6}}
 
|{{JVer|1.6}}
 
|-
 
|-
Line 118: Line 115:
 
|-
 
|-
 
|[[Modulelayout parameter type|modulelayout]]
 
|[[Modulelayout parameter type|modulelayout]]
−
|
+
|provides a list of alternative layout for a module grouped by core and template.
 
|{{JVer|1.6}}
 
|{{JVer|1.6}}
 
|-
 
|-
Line 130: Line 127:
 
|-
 
|-
 
|[[Rules parameter type|rules]]
 
|[[Rules parameter 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 parameter type|sessionhandler]]
 
|[[Sessionhandler parameter type|sessionhandler]]
−
|
+
|provides a drop down list of session handler options.
 
|{{JVer|1.6}}
 
|{{JVer|1.6}}
 
|-
 
|-
Line 150: Line 147:
 
|-
 
|-
 
|[[Templatestyle parameter type|templatestyle]]
 
|[[Templatestyle parameter type|templatestyle]]
−
|
+
|provides a drop down list of template styles.
 
|{{JVer|1.6}}
 
|{{JVer|1.6}}
 
|-
 
|-
Line 170: Line 167:
 
|-
 
|-
 
|[[User parameter type|user]]
 
|[[User parameter type|user]]
−
|
+
|provides a modal list of users.
 
|{{JVer|1.6}}
 
|{{JVer|1.6}}
 
|-
 
|-
 
|[[Usergroup parameter type|usergroup]]
 
|[[Usergroup parameter type|usergroup]]
−
|provides a drop down list of user groups.
+
|in 1.5 provides a drop down list of user groups.
 +
in 1.6 provides an array of check boxes allowing multi-select.  
 
|{{JVer|1.5}}{{JVer|1.6}}
 
|{{JVer|1.5}}{{JVer|1.6}}
 
|}
 
|}
  
 
<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]]</noinclude>

Revision as of 22:08, 22 April 2011

There are many different standard 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.

Type Description Availability
accesslevel provides a drop down list of viewing access levels. Joomla 1.6
cachehandler provides a list of available cache handling options. 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.5Joomla 1.6
category provides a drop down list of categories for an extension (from a given section in 1.5). Joomla 1.5Joomla 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.6
editors provides a drop down list of the available WYSIWYG editors. Joomla 1.5Joomla 1.6
file Joomla 1.6
filelist provides a drop down list of files from a specified directory. Joomla 1.5Joomla 1.6
folderlist provides a drop down list of folders from a specified directory. Joomla 1.5Joomla 1.6
groupedlist provides a drop down list of items organized into groups. Joomla 1.6
helpsite provides a drop down list of the help sites for your Joomla installation. Joomla 1.6
helpsites provides a drop down list of the help sites for your Joomla installation. Deprecated; use helpsite in Joomla 1.6 onwards. Joomla 1.5
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.5Joomla 1.6
imagelist provides a drop down list of image files in a specified directory. Joomla 1.5Joomla 1.6
integer provides a drop down list of integers between a minimum and maximum. Joomla 1.6
language provides a drop down list of the installed languages for the Front-end or Back-end. Joomla 1.6
languages provides a drop down list of the installed languages for the Front-end or Back-end. Deprecated; use language in Joomla 1.6 onwards. Joomla 1.5
list provides a drop down list of custom-defined entries. Joomla 1.5Joomla 1.6
media provides modal access to the media manager for insertion of images with upload for users with appropriate permissions. Joomla 1.6
menu provides a drop down list of the available menus from your Joomla site. Joomla 1.5Joomla 1.6
menuitem provides a drop down list of the available menu items from your Joomla site. Joomla 1.5Joomla 1.6
modulelayout provides a list of alternative layout for a module grouped by core and template. 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.5Joomla 1.6
radio provides radio buttons to select different options. Joomla 1.5Joomla 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.6
section provides a drop down list of the sections from your Joomla site. Deprecated; use category in Joomla 1.6 onwards. Joomla 1.5
spacer provides a visual separator between parameter field elements. It is purely a visual aid and no parameter value is stored. Joomla 1.5Joomla 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.5Joomla 1.6
templatestyle provides a drop down list of template styles. Joomla 1.6
text provides a text box for data entry. Joomla 1.5Joomla 1.6
textarea provides a text area for entry of multi-line text. Joomla 1.5Joomla 1.6
timezone provides a drop down list of time zones. Joomla 1.6
timezones provides a drop down list of time zones. Deprecated; use timezone in Joomla 1.6 onwards. Joomla 1.5
user provides a modal list of users. Joomla 1.6
usergroup in 1.5 provides a drop down list of user groups.

in 1.6 provides an array of check boxes allowing multi-select.

Joomla 1.5Joomla 1.6
Retrieved from "https://docs.joomla.org/index.php?title=Standard_form_field_and_parameter_types&oldid=48675"