Class ToggleCompositeField

Allows visibility of a group of fields to be toggled using '+' and '-' icons

Object

Extended by

ViewableData implements IteratorAggregate

Extended by

RequestHandler

Extended by

FormField

Extended by

CompositeField

Extended by

ToggleCompositeField

Package: forms\fields-structural
Located at sapphire/forms/ToggleCompositeField.php

Methods summary

`public`	# `__construct( FormField::$name $name, FormField::$title $title, FormField::$value $children )` Create a new field. Create a new field. Parameters `$name` name The internal field name, passed to forms. `$title` title The field label. `$children` value The value of the field. Overrides `CompositeField::__construct`
`public`	# `FieldHolder( )` Returns a "Field Holder" for this field - used by templates. Forms are constructed from by concatenating a number of these field holders. The default field holder is a label and form field inside a paragraph tag. Returns a "Field Holder" for this field - used by templates. Forms are constructed from by concatenating a number of these field holders. The default field holder is a label and form field inside a paragraph tag. Composite fields can override FieldHolder to create whatever visual effects you like. It's a good idea to put the actual HTML for field holders into templates. The default field holder is the DefaultFieldHolder template. This lets you override the HTML for specific sites, if it's necessary. Overrides `FormField::FieldHolder`
`public`	# `startClosed( boolean $bool )` Determines if the field should render open or closed by default. Determines if the field should render open or closed by default. Parameters `$bool` boolean
`public String`	# `HeadingLevel( )` Returns `String` String
`public`	# `Type( )` Returns the field type - used by templates. The field type is the class name with the word Field dropped off the end, all lowercase. It's handy for assigning HTML classes. Returns the field type - used by templates. The field type is the class name with the word Field dropped off the end, all lowercase. It's handy for assigning HTML classes. Overrides `FormField::Type`

Methods inherited from CompositeField

Field(), FieldSet(), IsReadonly(), collateDataFields(), debug(), fieldByName(), fieldPosition(), getChildren(), hasData(), insertAfter(), insertBefore(), isComposite(), makeFieldReadonly(), performDisabledTransformation(), performReadonlyTransformation(), push(), removeByName(), replaceField(), rootFieldSet(), setChildren(), setColumnCount(), setForm(), setID(), validate()

Methods inherited from FormField

LeftTitle(), Link(), Message(), MessageType(), Name(), Required(), RightTitle(), SmallFieldHolder(), Title(), Value(), addExtraAttribute(), addExtraClass(), allowHTML5(), allow_html5(), attrName(), attrTitle(), attrValue(), createTag(), dataValue(), describe(), extraClass(), fieldHolderTemplates(), fieldTemplates(), forTemplate(), getCustomValidationMessage(), getExtraClasses(), getForm(), getHTML5Attribute(), getTabIndex(), getTabIndexHTML(), hasClass(), id(), isDisabled(), isReadonly(), jsValidation(), name_to_label(), removeExtraAttribute(), removeExtraClass(), saveInto(), securityTokenEnabled(), setAutocomplete(), setContainerFieldSet(), setCustomValidationMessage(), setDisabled(), setError(), setFieldHolderTemplate(), setHTML5Attribute(), setLeftTitle(), setName(), setReadonly(), setRightTitle(), setSmallFieldHolderTemplate(), setTabIndex(), setTemplate(), setTitle(), setValue(), smallFieldHolderTemplates(), transform(), useHTML5(), use_html5()

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

`public integer`	`$headingLevel`	# int int

Properties inherited from CompositeField

$children, $columnCount, $readonly

Properties inherited from FormField

$autocomplete, $containerFieldSet, $customValidationMessage, $description, $disabled, $dontEscape, $extraAttributes, $extraClass, $extraClasses, $fieldHTML5, $fieldHolderTemplate, $form, $html5Attributes, $leftTitle, $message, $messageType, $name, $possible_autocomplete_values, $rightTitle, $smallFieldHolderTemplate, $tabIndex, $template, $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. -