Class ListboxField

Multi-line listbox field, created from a <select> tag.

Object

Extended by

ViewableData implements IteratorAggregate

Extended by

RequestHandler

Extended by

FormField

Extended by

DropdownField

Extended by

ListboxField

Package: forms\fields-basic
Located at sapphire/forms/ListboxField.php

Methods summary

`public`	# `__construct( string $name, string $title = '', array $source = array(), string\|array $value = '', integer $size = null, FormField::$form $multiple = false, mixed $form = null )` Creates a new dropdown field. Creates a new dropdown field. Parameters `$name` string $name The field name `$title` string $title The field title `$source` array $source An map of the dropdown items `$value` string\|array $value You can pass an array of values or a single value like a drop down to be selected `$size` int $size Optional size of the select element `$multiple` form The parent form `$form` Overrides `DropdownField::__construct`
`public string`	# `Field( )` Returns a <select> tag containing all the appropriate <option> tags Returns a <select> tag containing all the appropriate <option> tags Returns `string` HTML tag for this dropdown field Overrides `DropdownField::Field`
`public`	# `setSize( integer $size )` Sets the size of this dropdown in rows. Sets the size of this dropdown in rows. Parameters `$size` int $size The height in rows (e.g. 3)
`public`	# `setMultiple( boolean $bool )` Sets this field to have a muliple select attribute Sets this field to have a muliple select attribute Parameters `$bool` boolean $bool

Methods inherited from DropdownField

extraClass(), getEmptyString(), getHasEmptyDefault(), getSource(), isSelected(), performReadonlyTransformation(), setEmptyString(), setHasEmptyDefault(), setSource()

Methods inherited from FormField

FieldHolder(), LeftTitle(), Link(), Message(), MessageType(), Name(), Required(), RightTitle(), SmallFieldHolder(), Title(), Type(), Value(), addExtraAttribute(), addExtraClass(), allowHTML5(), allow_html5(), attrName(), attrTitle(), attrValue(), createTag(), dataValue(), debug(), describe(), forTemplate(), getCustomValidationMessage(), getForm(), getTabIndex(), getTabIndexHTML(), hasClass(), hasData(), id(), isComposite(), isDisabled(), isReadonly(), jsValidation(), name_to_label(), performDisabledTransformation(), removeExtraAttribute(), removeExtraClass(), rootFieldSet(), saveInto(), securityTokenEnabled(), setAutocomplete(), setContainerFieldSet(), setCustomValidationMessage(), setDisabled(), setError(), setForm(), setHTML5Attribute(), setLeftTitle(), setName(), setReadonly(), setRightTitle(), setTabIndex(), setTitle(), setValue(), transform(), useHTML5(), use_html5(), validate()

Methods inherited from RequestHandler

allowedActions(), checkAccessAction(), getRequest(), handleRequest(), hasAction(), httpError()

Methods inherited from ViewableData

ATT_val(), BaseHref(), CSSClasses(), ColumnBreak(), ColumnCalc(), ColumnNumber(), ColumnPad(), ColumnPos(), CurrentMember(), CurrentPage(), Debug(), Even(), EvenOdd(), First(), FirstLast(), HasPerm(), IsAjax(), JS_val(), Last(), Me(), Middle(), MiddleString(), Modulus(), MultipleOf(), Odd(), Pos(), RAW_val(), SQL_val(), ThemeDir(), ThemeName(), Top(), TotalItems(), XML_val(), __get(), __isset(), __set(), buildCastingCache(), cachedCall(), castingClass(), castingHelper(), castingHelperPair(), castingObjectCreator(), castingObjectCreatorPair(), customise(), defineMethods(), escapeTypeForField(), getField(), getIterator(), getSecurityID(), getXMLValues(), hasField(), hasValue(), i18nLocale(), iteratorProperties(), obj(), renderWith(), setCustomisedObj(), setField()

Methods inherited from Object

__call(), __toString(), __wakeup(), addMethodsFrom(), addStaticVars(), addWrapperMethod(), add_extension(), add_static_var(), allMethodNames(), cacheToFile(), cacheToFileWithArgs(), clearCache(), combined_static(), create(), createMethod(), create_from_string(), exists(), extInstance(), extend(), getCustomClass(), getExtensionInstance(), getExtensionInstances(), get_extensions(), get_static(), hasExtension(), hasMethod(), has_extension(), invokeWithExtensions(), is_a(), loadCache(), parentClass(), parse_class_spec(), remove_extension(), sanitiseCachename(), saveCache(), set_stat(), set_static(), set_uninherited(), stat(), strong_create(), uninherited(), uninherited_static(), useCustomClass()

Magic methods summary

Properties summary

`protected integer`	`$size`	# The size of the field in rows. The size of the field in rows.
`protected boolean`	`$multiple`	# Should the user be able to select multiple items on this dropdown field? Should the user be able to select multiple items on this dropdown field?

Properties inherited from DropdownField

$disabled, $emptyString, $hasEmptyDefault, $isSelected, $source

Properties inherited from FormField

$autocomplete, $containerFieldSet, $customValidationMessage, $description, $dontEscape, $extraAttributes, $extraClass, $extraClasses, $fieldHTML5, $form, $html5Attributes, $leftTitle, $message, $messageType, $name, $possible_autocomplete_values, $readonly, $rightTitle, $tabIndex, $title, $use_html5, $value

Properties inherited from RequestHandler

$allowed_actions, $brokenOnConstruct, $request, $url_handlers

Properties inherited from ViewableData

$casting, $customisedObject, $default_cast, $failover, $iteratorPos, $iteratorTotalItems

Properties inherited from Object

$class, $extension_instances, $extensions

[Raise a SilverStripe Framework issue/bug](https://github.com/silverstripe/silverstripe-framework/issues/new)
- [Raise a SilverStripe CMS issue/bug](https://github.com/silverstripe/silverstripe-cms/issues/new)
- Please use the Silverstripe Forums to ask development related questions. -