SilverStripe 2.4 API Docs
  • Package
  • Class
  • Tree
  • Deprecated
Version: master
  • master
  • 3.1
  • 3.0
  • 2.4
  • tagfield

Packages

  • cms
    • assets
    • batchaction
    • batchactions
    • bulkloading
    • comments
    • content
    • core
    • export
    • publishers
    • reports
    • security
    • tasks
  • forms
    • actions
    • core
    • fields-basic
    • fields-dataless
    • fields-datetime
    • fields-files
    • fields-formatted
    • fields-formattedinput
    • fields-relational
    • fields-structural
    • transformations
    • validators
  • installer
  • None
  • PHP
  • sapphire
    • api
    • bulkloading
    • control
    • core
    • cron
    • dev
    • email
    • fields-formattedinput
    • filesystem
    • formatters
    • forms
    • i18n
    • integration
    • misc
    • model
    • parsers
    • search
    • security
    • tasks
    • testing
    • tools
    • validation
    • view
    • widgets

Classes

  • CheckboxField
  • CheckboxField_Disabled
  • CheckboxField_Readonly
  • CheckboxSetField
  • DropdownField
  • GroupedDropdownField
  • ListboxField
  • LookupField
  • NullableField
  • OptionsetField
  • ReadonlyField
  • TextareaField
  • TextField

Class ListboxField

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

Usage

new ListboxField(
   $name = "pickanumber",
   $title = "Pick a number",
   $source = array(
      "1" => "one",
      "2" => "two",
      "3" => "three"
   ),
   $value = 1
)
Object
Extended by ViewableData implements IteratorAggregate
Extended by RequestHandler
Extended by FormField
Extended by DropdownField
Extended by ListboxField
Package: forms\fields-basic
See: DropdownField for a simple <select> field with a single element.
See: CheckboxSetField for multiple selections through checkboxes.
See: OptionsetField for single selections via radiobuttons.
See: TreeDropdownField for a rich and customizeable UI that can visualize a tree of selectable elements
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
integer
$size Optional size of the select element
$multiple
FormField::$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
integer
$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(), setDisabled(), setEmptyString(), setHasEmptyDefault(), setSource()

Methods inherited from FormField

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

Methods inherited from RequestHandler

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

Methods inherited from ViewableData

ATT_val(), BaseHref(), CSSClasses(), CurrentMember(), CurrentPage(), Debug(), Even(), EvenOdd(), First(), FirstLast(), HasPerm(), IsAjax(), JS_val(), Last(), Me(), Middle(), MiddleString(), Modulus(), MultipleOf(), Odd(), Pos(), RAW_val(), SQL_val(), ThemeDir(), 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(), 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

$containerFieldSet, $customValidationMessage, $description, $dontEscape, $extraClass, $extraClasses, $form, $leftTitle, $message, $messageType, $name, $readonly, $rightTitle, $tabIndex, $title, $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

Comments

Comment policy: Please use comments for tips and corrections about the described functionality. Comments are moderated, we reserve the right to remove comments that are inappropriate or are no longer relevant.
Use the Silverstripe Forum to ask questions.
blog comments powered by Disqus
SilverStripe 2.4 API Docs API documentation generated by ApiGen 2.8.0