Form field

Revision as of 12:54, 20 May 2011

Form fields are fields in a HTML <form>. Joomla! 1.6 and newer supply the JForm class to conveniently and flexibly create forms with a large amount of form fields. Each form field type is a subclass of JFormField.

In addition to being a flexible page creation tool, JFormFields are used by Joomla! to allow administrators to configure Joomla! or its extensions without changing the underlying code. In Joomla! 1.5, this was handled by the now deprecated JParameter and JElement classes.

To define form fields in the configuration of an extension, you must include them into the <fields name="params"> section of the <config> element in your XML manifest file.

Standard form field types

Numerous types of form field are built into Joomla!. The following table lists these standard types and their availability. Use the single-page reference if you want to print all existing form field documentation.

Please note that many of these fields are available as parameter types in Joomla! 1.5. For a list of parameter types, see J1.5:Standard parameter types. For a comparison between form field and parameter types, see Standard form field and parameter types.

Type	Description	Availability
accesslevel	provides a drop down list of viewing access levels.	and newer
cachehandler	provides a list of available cache handling options.	and newer
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.	and newer
captcha	provides a drop down list of the captcha plugins.	and newer
category	provides a drop down list of categories for an extension.	and newer
checkbox	provides a single checkbox to be checked or unchecked	and newer
checkboxes	provides unlimited checkboxes that can be used for multi-select.	and newer
Chrome Style	provides a list of template chrome style options grouped by template.	and newer
color	provides a color picker when clicking the input box.	and newer
Content Language	Provides a list of content languages.	and newer
Content Type	Provides a list of content types.	and newer
combo	provides a combo box field.	and newer
componentlayout	provides a grouped list of core and template alternate layouts for a component item.	and newer
contentlanguage	provides a list of installed content languages for use in conjunction with the language switcher plugin.	and newer
Database Connection	Provides a list of available database connections, optionally limiting to a given list.	and newer
editor	provides an editor area field.	and newer
editors	Provides a drop down list of the available WYSIWYG editors. Since use plugins form field instead.
email	provides an email field.	and newer
file		and newer
filelist	provides a drop down list of files from a specified directory.	and newer
folderlist	provides a drop down list of folders from a specified directory.	and newer
groupedlist	provides a drop down list of items organized into groups.	and newer
header tag	provides a drop down list of the header tags (h1-h6).	and newer
helpsite	provides a drop down list of the help sites for your Joomla installation.	and newer
hidden	provides a hidden field for saving a form field 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).	and newer
imagelist	provides a drop down list of image files in a specified directory.	and newer
integer	provides a drop down list of integers between a minimum and maximum.	and newer
language	provides a drop down list of the installed languages for the Front-end or Back-end.	and newer
list	provides a drop down list of custom-defined entries.	and newer
media	provides modal access to the media manager for insertion of images with upload for users with appropriate permissions.	and newer
menu	provides a drop down list of the available menus from your Joomla site.	and newer
Menu Item	provides a drop down list of the available menu items from your Joomla site.	and newer
Module Layout	provides a list of alternative layout for a module grouped by core and template.	and newer
Module Order	Provides a drop down to set the ordering of module in a given position	and newer
Module Position	provides a text input to set the position of a module.	and newer
Module Tag	provides a list of html5 elements (used to wrap a module in).	and newer
note	supports a one line text field.	and newer
password	provides a text box for entry of a password. The password characters will be obscured as they are entered.	and newer
plugins	provides a list of plugins from a given folder.	and newer
radio	provides radio buttons to select different options.	and newer
rules	provides a matrix of group by action options for managing access control. Display depends on context.	and newer
sessionhandler	provides a drop down list of session handler options.	and newer
spacer	provides a visual separator between form fields. It is purely a visual aid and no value is stored.	and newer
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.	and newer
tag	provides an entry point for tags (either AJAX or Nested).	and newer
tel	provides an input field for a telephone number.	and newer
templatestyle	provides a drop down list of template styles.	and newer
text	provides a text box for data entry.	and newer
textarea	provides a text area for entry of multi-line text.	and newer
timezone	provides a drop down list of time zones.	and newer
URL	provides a URL text input field.	and newer
user	provides a modal list of users.	and newer
usergroup	provides a drop down list of user groups.	and newer