Standard form field and parameter types
From Joomla! Documentation
Revision as of 11:13, 20 May 2011 by Mvangeest (talk | contribs) (moved Standard form field types to Standard form field and parameter types: This table mixes form fields (JFormField) with parameters (JElement))
Revision as of 11:13, 20 May 2011 by Mvangeest (talk | contribs) (moved Standard form field types to Standard form field and parameter types: This table mixes form fields (JFormField) with parameters (JElement))
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. | |
cachehandler | provides a list of available cache handling options. | |
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 for an extension (from a given section in 1.5). | |
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 | provides a drop down list of the available WYSIWYG editors. | |
file | ||
filelist | provides a drop down list of files from a specified directory. | |
folderlist | provides a drop down list of folders from a specified directory. | |
groupedlist | provides a drop down list of items organized into groups. | |
helpsite | provides a drop down list of the help sites for your Joomla installation. | |
helpsites | provides a drop down list of the help sites for your Joomla installation. Deprecated; use helpsite in Joomla 1.6 onwards. | |
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 | 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. | |
language | provides a drop down list of the installed languages for the Front-end or Back-end. | |
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. | |
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 | provides a drop down list of the available menus from your Joomla site. | |
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 | provides a text box for entry of a password. The password characters will be obscured as they are entered. | |
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. Deprecated; use category in Joomla 1.6 onwards. | |
spacer | provides a visual separator between parameter field elements. It is purely a visual aid and no parameter value is stored. | |
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 | provides a text box for data entry. | |
textarea | provides a text area for entry of multi-line text. | |
timezone | provides a drop down list of time zones. | |
timezones | provides a drop down list of time zones. Deprecated; use timezone in Joomla 1.6 onwards. | |
user | provides a modal list of users. | |
usergroup | in 1.5 provides a drop down list of user groups.
in 1.6 provides an array of check boxes allowing multi-select. |