Actions

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

From Joomla! Documentation

m (Added categorisation.)
(First pass at updating this page for Joomla 1.6.)
Line 1: Line 1:
There are 21 different standard parameter types supported in the Joomla Framework for all extension types (templates, components, modules and plugins).  This section gives a brief description of each parameter type, in alphabetical order.  Full details of each parameter type are given on the following pages.
+
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.
 +
 
 +
{| class="wikitable" style="vertical-align:top; border:1px solid Sienna; background-color:Cornsilk;"
 +
|- style="background-color:Wheat; font-weight:bold; text-align: left;"
 +
!width=15%|Type
 +
!width=70%|Description
 +
!width=15%|Availability
 +
|-
 +
|[[Accesslevel parameter type|accesslevel]]
 +
|
 +
|{{JVer|1.6}}
 +
|-
 +
|[[Cachehandler parameter type|cachehandler]]
 +
|
 +
|{{JVer|1.6}}
 +
|-
 +
|[[Calendar parameter 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}}{{JVer|1.6}}
 +
|-
 +
|[[Category parameter type|category]]
 +
|provides a drop down list of categories from a given section.
 +
|{{JVer|1.5}}{{JVer|1.6}}
 +
|-
 +
|[[Checkbox parameter type|checkbox]]
 +
|
 +
|{{JVer|1.6}}
 +
|-
 +
|[[Checkboxes parameter type|checkboxes]]
 +
|
 +
|{{JVer|1.6}}
 +
|-
 +
|[[Combo parameter type|combo]]
 +
|
 +
|{{JVer|1.6}}
 +
|-
 +
|[[Componentlayout parameter type|componentlayout]]
 +
|
 +
|{{JVer|1.6}}
 +
|-
 +
|[[Contentlanguage parameter type|contentlanguage]]
 +
|
 +
|{{JVer|1.6}}
 +
|-
 +
|[[Editor parameter type|editor]]
 +
|
 +
|{{JVer|1.6}}
 +
|-
 +
|[[Editors parameter type|editors]]
 +
|provides a drop down list of the available WYSIWYG editors.
 +
|{{JVer|1.5}}{{JVer|1.6}}
 +
|-
 +
|[[File parameter type|file]]
 +
|
 +
|{{JVer|1.6}}
 +
|-
 +
|[[Filelist parameter type|filelist]]
 +
|provides a drop down list of files from a specified directory.
 +
|{{JVer|1.5}}{{JVer|1.6}}
 +
|-
 +
|[[Folderlist parameter type|folderlist]]
 +
|provides a drop down list of folders from a specified directory.
 +
|{{JVer|1.5}}{{JVer|1.6}}
 +
|-
 +
|[[Groupedlist parameter type|groupedlist]]
 +
|
 +
|{{JVer|1.6}}
 +
|-
 +
|[[Helpsite parameter type|helpsite]]
 +
|provides a drop down list of the help sites for your Joomla installation.
 +
|{{JVer|1.6}}
 +
|-
 +
|[[Helpsites parameter type|helpsites]]
 +
|provides a drop down list of the help sites for your Joomla installation.  Deprecated; use [[Helpsite parameter type|helpsite]] in Joomla 1.6 onwards.
 +
|{{JVer|1.5}}
 +
|-
 +
|[[Hidden parameter 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}}{{JVer|1.6}}
 +
|-
 +
|[[Imagelist parameter type|imagelist]]
 +
|provides a drop down list of image files in a specified directory.
 +
|{{JVer|1.5}}{{JVer|1.6}}
 +
|-
 +
|[[Imagelist parameter type|imagelist]]
 +
|
 +
|{{JVer|1.6}}
 +
|-
 +
|[[Integer parameter type|integer]]
 +
|
 +
|{{JVer|1.6}}
 +
|-
 +
|[[Language parameter type|language]]
 +
|provides a drop down list of the installed languages for the Front-end or Back-end.
 +
|{{JVer|1.6}}
 +
|-
 +
|[[Languages parameter type|languages]]
 +
|provides a drop down list of the installed languages for the Front-end or Back-end.  Deprecated; use [[Language parameter type|language]] in Joomla 1.6 onwards.
 +
|{{JVer|1.5}}
 +
|-
 +
|[[List parameter type|list]]
 +
|provides a drop down list of custom-defined entries.
 +
|{{JVer|1.5}}{{JVer|1.6}}
 +
|-
 +
|[[Media parameter type|media]]
 +
|
 +
|{{JVer|1.6}}
 +
|-
 +
|[[Mediamanager parameter type|mediamanager]]
 +
|
 +
|{{JVer|1.6}}
 +
|-
 +
|[[Menu parameter type|menu]]
 +
|provides a drop down list of the available menus from your Joomla site.
 +
|{{JVer|1.5}}{{JVer|1.6}}
 +
|-
 +
|[[Menuitem parameter type|menuitem]]
 +
|provides a drop down list of the available menu items from your Joomla site.
 +
|{{JVer|1.5}}{{JVer|1.6}}
 +
|-
 +
|[[Modulelayout parameter type|modulelayout]]
 +
|
 +
|{{JVer|1.6}}
 +
|-
 +
|[[Password parameter type|password]]
 +
|provides a text box for entry of a password.  The password characters will be obscured as they are entered.
 +
|{{JVer|1.5}}{{JVer|1.6}}
 +
|-
 +
|[[Radio parameter type|radio]]
 +
|provides radio buttons to select different options.
 +
|{{JVer|1.5}}{{JVer|1.6}}
 +
|-
 +
|[[Rules parameter type|rules]]
 +
|
 +
|{{JVer|1.6}}
 +
|-
 +
|[[Sessionhandler parameter type|sessionhandler]]
 +
|
 +
|{{JVer|1.6}}
 +
|-
 +
|[[Section parameter type|section]]
 +
|provides a drop down list of the sections from your Joomla site.  Deprecated; use [[Category parameter type|category]] in Joomla 1.6 onwards.
 +
|{{JVer|1.5}}
 +
|-
 +
|[[Spacer parameter 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}}{{JVer|1.6}}
 +
|-
 +
|[[Sql parameter 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.5}}{{JVer|1.6}}
 +
|-
 +
|[[Templatestyle parameter type|templatestyle]]
 +
|
 +
|{{JVer|1.6}}
 +
|-
 +
|[[Text parameter type|text]]
 +
|provides a text box for data entry.
 +
|{{JVer|1.5}}{{JVer|1.6}}
 +
|-
 +
|[[Textarea parameter type|textarea]]
 +
|provides a text area for entry of multi-line text.
 +
|{{JVer|1.5}}{{JVer|1.6}}
 +
|-
 +
|[[Timezone parameter type|timezone]]
 +
|provides a drop down list of time zones.
 +
|{{JVer|1.6}}
 +
|-
 +
|[[Timezones parameter type|timezones]]
 +
|provides a drop down list of time zones.  Deprecated; use [[Timezone parameter type|timezone]] in Joomla 1.6 onwards.
 +
|{{JVer|1.5}}
 +
|-
 +
|[[User parameter type|user]]
 +
|
 +
|{{JVer|1.6}}
 +
|-
 +
|[[Usergroup parameter type|usergroup]]
 +
|provides a drop down list of user groups.
 +
|{{JVer|1.5}}{{JVer|1.6}}
 +
|}
  
* '''[[Calendar parameter 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]]''' provides a drop down list of categories from a given section.
 
* '''[[Editors parameter type|editors]]''' provides a drop down list of the available WYSIWYG editors.
 
* '''[[Filelist parameter type|filelist]]''' provides a drop down list of files from a specified directory.
 
* '''[[Folderlist parameter type|folderlist]]''' provides a drop down list of folders from a specified directory.
 
* '''[[Helpsites parameter type|helpsites]]''' provides a drop down list of the help sites for your Joomla installation.
 
* '''[[Hidden parameter 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).
 
* '''[[Imagelist parameter type|imagelist]]''' provides a drop down list of image files in a specified directory.
 
* '''[[Languages parameter type|languages]]''' provides a drop down list of the installed languages for the Front-end or Back-end.
 
* '''[[List parameter type|list]]''' provides a drop down list of custom-defined entries.
 
* '''[[Menu parameter type|menu]]''' provides a drop down list of the available menus from your Joomla site.
 
* '''[[Menuitem parameter type|menuitem]]''' provides a drop down list of the available menu items from your Joomla site.
 
* '''[[Password parameter 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]]''' provides radio buttons to select different options.
 
* '''[[Section parameter type|section]]''' provides a drop down list of the sections from your Joomla site.
 
* '''[[Spacer parameter 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]]''' 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.
 
* '''[[Text parameter type|text]]''' provides a text box for data entry.
 
* '''[[Textarea parameter type|textarea]]''' provides a text area for entry of multi-line text.
 
* '''[[Timezones parameter type|timezones]]''' provides a drop down list of time zones.
 
* '''[[Usergroup parameter type|usergroup]]''' provides a drop down list of user groups.
 
 
<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 13:51, 20 July 2010

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 Joomla 1.6
cachehandler 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 from a given section. Joomla 1.5Joomla 1.6
checkbox Joomla 1.6
checkboxes Joomla 1.6
combo Joomla 1.6
componentlayout Joomla 1.6
contentlanguage Joomla 1.6
editor 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 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
imagelist Joomla 1.6
integer 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 Joomla 1.6
mediamanager 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 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 Joomla 1.6
sessionhandler 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 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 Joomla 1.6
usergroup provides a drop down list of user groups. Joomla 1.5Joomla 1.6