Docs For Class JFormFieldList

Description

Form Field class for the Joomla Platform.

Supports a generic list of options.

since: 11.1

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

JFormField
   |
   --JFormFieldList

Direct descendents

Class	Description
JFormFieldBannerClient	Bannerclient Field class for the Joomla Framework.
JFormFieldCategoryEdit	Form Field class for the Joomla Framework.
JFormFieldCategoryParent	Form Field class for the Joomla Framework.
JFormFieldDirectories	Renders a list of directories.
JFormFieldSearchFilter	Search Filter field for the Finder package.
JFormFieldMenuOrdering	Form Field class for the Joomla Framework.
JFormFieldMenuParent	Form Field class for the Joomla Framework.
JFormFieldMenutype	Form Field class for the Joomla Framework.
JFormFieldNewsfeeds	Form Field class for the Joomla Framework.
JFormFieldGroupParent	Form Field class for the Joomla Framework.
JFormFieldLanguage	Form Field class for the Joomla Platform.
JFormFieldAuthor	Form Field to load a list of content authors
JFormFieldContentlanguage	Form Field class for the Joomla Platform.
JFormFieldContenttype	Form Field class for the Joomla Framework.
JFormFieldHeadertag	Form Field class for the Joomla! CMS.
JFormFieldHelpsite	Form Field class for the Joomla Platform.
JFormFieldLimitbox	Field to load a list of posible item count limits
JFormFieldMenu	Supports an HTML select list of menus
JFormFieldModuletag	Form Field class for the Joomla! CMS.
JFormFieldTag	Form Field class for the Joomla Framework.
JFormFieldUserGroupList	Field to load a list of available users statuses
FOFFormFieldActions	Form Field class for FOF Supports a generic list of options.
FOFFormFieldComponents	Form Field class for FOF Components installed on the site
FOFFormFieldList	Form Field class for FOF Supports a generic list of options.
FOFFormFieldPublished	Form Field class for FOF Supports a generic list of options.
JFormFieldAccessLevel	Form Field class for the Joomla Platform.
JFormFieldCacheHandler	Form Field class for the Joomla Platform.
JFormFieldCombo	Form Field class for the Joomla Platform.
JFormFieldDatabaseConnection	Form Field class for the Joomla Platform.
JFormFieldFileList	Supports an HTML select list of files
JFormFieldFolderList	Supports an HTML select list of folder
JFormFieldInteger	Form Field class for the Joomla Platform.
JFormFieldPlugins	Form Field class for the Joomla Framework.
JFormFieldPredefinedList	Form Field to load a list of predefined values
JFormFieldSessionHandler	Form Field class for the Joomla Platform.
JFormFieldSQL	Supports an custom SQL select list
JFormFieldCategory	Form Field class for the Joomla Platform.

Variable Summary

string $type

Method Summary

string getInput ()

array getOptions ()

Variables

string $type = 'List' (line 28)

The form field type.

since: 11.1
access: protected

Redefinition of:

JFormField::$type: The form field type.

Redefined in descendants as:

JFormFieldBannerClient::$type : The form field type.
JFormFieldCategoryEdit::$type : A flexible category list that respects access controls
JFormFieldCategoryParent::$type : The form field type.
JFormFieldDirectories::$type : The form field type.
JFormFieldSearchFilter::$type : The form field type.
JFormFieldMenuOrdering::$type : The form field type.
JFormFieldMenuParent::$type : The form field type.
JFormFieldMenutype::$type : The form field type.
JFormFieldNewsfeeds::$type : The form field type.
JFormFieldGroupParent::$type : The form field type.
JFormFieldLanguage::$type : The form field type.
JFormFieldAuthor::$type : The form field type.
JFormFieldContentlanguage::$type : The form field type.
JFormFieldContenttype::$type : A flexible tag list that respects access controls
JFormFieldHeadertag::$type : The form field type.
JFormFieldHelpsite::$type : The form field type.
JFormFieldLimitbox::$type : The form field type.
JFormFieldMenu::$type : The form field type.
JFormFieldModuletag::$type : The form field type.
JFormFieldTag::$type : A flexible tag list that respects access controls
JFormFieldUserGroupList::$type : The form field type.
JFormFieldAccessLevel::$type : The form field type.
JFormFieldCacheHandler::$type : The form field type.
JFormFieldCombo::$type : The form field type.
JFormFieldDatabaseConnection::$type : The form field type.
JFormFieldFileList::$type : The form field type.
JFormFieldImageList::$type : The form field type.
JFormFieldFolderList::$type : The form field type.
JFormFieldInteger::$type : The form field type.
JFormFieldPlugins::$type : The field type.
JFormFieldPredefinedList::$type : The form field type.
JFormFieldRegistrationDateRange::$type : The form field type.
JFormFieldStatus::$type : The form field type.
JFormFieldUserActive::$type : The form field type.
JFormFieldUserState::$type : The form field type.
JFormFieldSessionHandler::$type : The form field type.
JFormFieldSQL::$type : The form field type.
JFormFieldCategory::$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

Methods

getInput (line 38)

Method to get the field input markup for a generic list.

Use the multiple attribute to enable multiselect.

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

string getInput ()

Redefinition of:

JFormField::getInput(): Method to get the field input markup.

Redefined in descendants as:

JFormFieldMenuOrdering::getInput() : Method to get the field input markup
JFormFieldMenutype::getInput() : Method to get the field input markup.
JFormFieldContenttype::getInput() : Method to get the field input for a list of content types.
JFormFieldHelpsite::getInput() : Override to add refresh button
JFormFieldTag::getInput() : Method to get the field input for a tag field.
JFormFieldAccessLevel::getInput() : Method to get the field input markup.
JFormFieldCombo::getInput() : Method to get the field input markup for a combo box field.

getOptions (line 84)

Method to get the field options.

return: The field option objects.
since: 11.1
access: protected

array getOptions ()

Redefined in descendants as:

JFormFieldBannerClient::getOptions() : Method to get the field options.
JFormFieldCategoryEdit::getOptions() : Method to get a list of categories that respects access controls and can be used for either category assignment or parent category assignment in edit screens.
JFormFieldCategoryParent::getOptions() : Method to get the field options.
JFormFieldDirectories::getOptions() : Method to get the field options.
JFormFieldSearchFilter::getOptions() : Method to get the field options.
JFormFieldMenuOrdering::getOptions() : Method to get the list of siblings in a menu.
JFormFieldMenuParent::getOptions() : Method to get the field options.
JFormFieldNewsfeeds::getOptions() : Method to get the field options.
JFormFieldGroupParent::getOptions() : Method to get the field options.
JFormFieldLanguage::getOptions() : Method to get the field options.
JFormFieldAuthor::getOptions() : Method to get the options to populate list
JFormFieldContentlanguage::getOptions() : Method to get the field options for content languages.
JFormFieldContenttype::getOptions() : Method to get a list of content types
JFormFieldHeadertag::getOptions() : Method to get the field options.
JFormFieldHelpsite::getOptions() : Method to get the help site field options.
JFormFieldLimitbox::getOptions() : Method to get the options to populate to populate list
JFormFieldMenu::getOptions() : Method to get the list of menus for the field options.
JFormFieldModuletag::getOptions() : Method to get the field options.
JFormFieldTag::getOptions() : Method to get a list of tags
FOFFormFieldTag::getOptions() : Method to get a list of tags
JFormFieldUserGroupList::getOptions() : Method to get the options to populate list
FOFFormFieldActions::getOptions() : Method to get the field options.
FOFFormFieldComponents::getOptions() : Get a list of all installed components and also translates them.
FOFFormFieldList::getOptions() : Method to get the field options.
FOFFormFieldModel::getOptions() : Method to get the field options.
FOFFormFieldPublished::getOptions() : Method to get the field options.
JFormFieldCacheHandler::getOptions() : Method to get the field options.
JFormFieldDatabaseConnection::getOptions() : Method to get the list of database options.
JFormFieldFileList::getOptions() : Method to get the list of files for the field options.
JFormFieldImageList::getOptions() : Method to get the list of images field options.
JFormFieldFolderList::getOptions() : Method to get the field options.
JFormFieldInteger::getOptions() : Method to get the field options.
JFormFieldPlugins::getOptions() : Method to get a list of options for a list input.
JFormFieldPredefinedList::getOptions() : Method to get the options to populate list
JFormFieldSessionHandler::getOptions() : Method to get the session handler field options.
JFormFieldSQL::getOptions() : Method to get the custom field options.
JFormFieldCategory::getOptions() : Method to get the field options for category Use the extension attribute in a form to specify the.specific extension for which categories should be displayed.

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()