Form Field class for the Joomla Platform.

Provides a grouped list select field.

• since: 11.1

Located in /libraries/joomla/form/fields/groupedlist.php (line 20)

JFormField
   |
   --JFormFieldGroupedList

string $type = 'GroupedList' (line 28)

The form field type.

• since: 11.1
• access: protected

---

Redefinition of:

JFormField::$type

The form field type.

---

Redefined in descendants as:

• JFormFieldChromeStyle::$type : The form field type.
• JFormFieldMenuitem::$type : The form field type.
• JFormFieldTemplatestyle::$type : The form field type.
• JFormFieldTimezone::$type : The form field type.

Inherited Variables

Inherited from JFormField

JFormField::$autocomplete
JFormField::$autofocus
JFormField::$class
JFormField::$count
JFormField::$default
JFormField::$description
JFormField::$disabled
JFormField::$element
JFormField::$fieldname
JFormField::$form
JFormField::$formControl
JFormField::$generated_fieldname
JFormField::$group
JFormField::$hidden
JFormField::$hint
JFormField::$id
JFormField::$input
JFormField::$label
JFormField::$labelClass
JFormField::$multiple
JFormField::$name
JFormField::$onchange
JFormField::$onclick
JFormField::$pattern
JFormField::$readonly
JFormField::$repeat
JFormField::$required
JFormField::$size
JFormField::$spellcheck
JFormField::$translateDescription
JFormField::$translateHint
JFormField::$translateLabel
JFormField::$validate
JFormField::$value

getGroups (line 38)

Method to get the field option groups.

• return: The field option objects as a nested array in groups.
• since: 11.1
• throws: UnexpectedValueException
• access: protected

array getGroups ()

---

Redefined in descendants as:

• JFormFieldChromeStyle::getGroups() : Method to get the list of template chrome style options grouped by template.
• JFormFieldMenuitem::getGroups() : Method to get the field option groups.
• JFormFieldTemplatestyle::getGroups() : Method to get the list of template style options grouped by template.
• JFormFieldTimezone::getGroups() : Method to get the time zone field option groups.

getInput (line 142)

Method to get the field input markup fora grouped list.

Multiselect is enabled by using the multiple attribute.

• return: The field input markup.
• since: 11.1
• access: protected

string getInput ()

---

Redefinition of:

JFormField::getInput()

Method to get the field input markup.

Inherited Methods

Inherited From JFormField

JFormField::__construct()
JFormField::getAttribute()
JFormField::getControlGroup()
JFormField::getFieldName()
JFormField::getId()
JFormField::getInput()
JFormField::getLabel()
JFormField::getName()
JFormField::getTitle()
JFormField::setForm()
JFormField::setup()
JFormField::setValue()
JFormField::__get()
JFormField::__set()