Joomla! Documentation - User contributions [en]

Modulelayout form field type

2012-01-15T19:49:53Z

Samcoult: Created page with "The '''modulelayout''' form field type provides a drop down list of all available layouts for a module, grouped by core and template. If the parameter has a saved value this is ..."

The '''modulelayout''' form field type provides a drop down list of all available layouts for a module, grouped by core and template. If the parameter has a saved value this is selected when the page is first loaded. If not, the default value (if any) is selected.

* '''type''' (mandatory) must be modulelayout.
* '''name''' (mandatory) is the unique name of the parameter.
* '''label''' (mandatory) (translatable) is the descriptive title of the field.
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.

Example XML parameter definition:
<source lang="xml"><field name="mymodulelayout" type="modulelayout" label="JFIELD_ALT_LAYOUT_LABEL" description="JFIELD_ALT_MODULE_LAYOUT_DESC" /></source>
<noinclude>
=== See also ===
* [[Standard form field types|List of standard form field types]]
[[Category:Standard form field types]]</noinclude>

Componentlayout form field type

2012-01-15T19:48:24Z

Samcoult:

The '''componentlayout''' form field type provides a drop down list of all available layouts for a view of an extension. If the parameter has a saved value this is selected when the page is first loaded. If not, the default value (if any) is selected.

* '''type''' (mandatory) must be componentlayout.
* '''name''' (mandatory) is the unique name of the parameter.
* '''label''' (mandatory) (translatable) is the descriptive title of the field.
* '''extension''' (mandatory) is the name of the extension for which the layouts will be retrieved (e.g. 'com_content').
* '''view''' (mandatory) is the name of the view for which the layouts will be retrieved (e.g. 'article').
* '''useglobal''' (optional).
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.

Example XML parameter definition:
<source lang="xml"><field name="mylayout" type="componentlayout" extension="com_content" view="article" label="JFIELD_ALT_LAYOUT" useglobal="true" description="JFIELD_ALT_COMPONENT_LAYOUT" /></source>
<noinclude>
=== See also ===
* [[Standard form field types|List of standard form field types]]
[[Category:Standard form field types]]</noinclude>

Componentlayout form field type

2012-01-15T19:43:29Z

Samcoult:

The '''componentlayout''' form field type provides a drop down list of all available layouts for a view of an extension. If the parameter has a saved value this is selected when the page is first loaded. If not, the default value (if any) is selected.

* '''type''' (mandatory) must be category.
* '''name''' (mandatory) is the unique name of the parameter.
* '''label''' (mandatory) (translatable) is the descriptive title of the field.
* '''extension''' (mandatory) is the name of the extension for which the layouts will be retrieved (e.g. 'com_content').
* '''view''' (mandatory) is the name of the view for which the layouts will be retrieved (e.g. 'article').
* '''useglobal''' (optional).
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.

Example XML parameter definition:
<source lang="xml"><field name="mylayout" type="componentlayout" extension="com_content" view="article" label="JFIELD_ALT_LAYOUT" useglobal="true" description="JFIELD_ALT_COMPONENT_LAYOUT" /></source>
<noinclude>
=== See also ===
* [[Standard form field types|List of standard form field types]]
[[Category:Standard form field types]]</noinclude>

Componentlayout form field type

2012-01-15T19:42:49Z

Samcoult: Created page with "The '''componentlayout''' form field type provides a drop down list of all available layouts for a view of an extension. If the parameter has a saved value this is selected when..."

The '''componentlayout''' form field type provides a drop down list of all available layouts for a view of an extension. If the parameter has a saved value this is selected when the page is first loaded. If not, the default value (if any) is selected.

* '''type''' (mandatory) must be category.
* '''name''' (mandatory) is the unique name of the parameter.
* '''label''' (mandatory) (translatable) is the descriptive title of the field.
* '''extension''' (mandatory) is the name of the extension for which the layouts will be retrieved (e.g. 'com_content').
* '''view''' (mandatory) is the name of the view for which the layouts will be retrieved (e.g. 'article').
* '''useglobal''' (optional).
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.

Example XML parameter definition:
<source lang="xml"><field name="mylayout" type="componentlayout" extension="com_content" view="article" label="JFIELD_ALT_LAYOUR" description="JFIELD_ALT_COMPONENT_LAYOUT" /></source>
<noinclude>
=== See also ===
* [[Standard form field types|List of standard form field types]]
[[Category:Standard form field types]]</noinclude>

Checkbox form field type

2012-01-15T19:23:27Z

Samcoult: Created page with "The '''checkbox''' form field type provides a single checkbox. If the parameter has a saved value this is selected when the page is first loaded. If not, the default value (if ..."

The '''checkbox''' form field type provides a single checkbox. If the parameter has a saved value this is selected when the page is first loaded. If not, the default value (if any) is selected.

* '''type''' (mandatory) must be checkbox
* '''name''' (mandatory) is the unique name of the parameter.
* '''label''' (mandatory) (translatable) is the descriptive title of the field.
* '''default''' (optional) is the default value of the checkbox
* '''description''' (optional) (translatable) is text that will be shown as a tooltip when the user moves the mouse over the drop-down box.
* '''class''' (optional) is a CSS class name for the HTML form field. If omitted this will default to 'inputbox'.

Example XML parameter definition:
<source lang="xml"><field name="mycheckbox" type="checkbox" label="Show title" description="" default="0" /></source>
<noinclude>
=== See also ===
* [[Standard form field types|List of standard form field types]]
[[Category:Standard form field types]]</noinclude>