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` `FormField::$name` The internal field name, passed to forms. `$title` `FormField::$title` The field label. `$children` `FormField::$value` The value of the field. Overrides `CompositeField::__construct`
`public`	# `FieldHolder( )` Returns the fields nested inside another DIV Returns the fields nested inside another DIV Overrides `CompositeField::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`
`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(), SmallFieldHolder(), 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(), Title(), Value(), addExtraClass(), attrName(), attrTitle(), attrValue(), createTag(), dataValue(), describe(), extraClass(), forTemplate(), getCustomValidationMessage(), getForm(), getTabIndex(), getTabIndexHTML(), hasClass(), id(), isDisabled(), isReadonly(), jsValidation(), name_to_label(), removeExtraClass(), saveInto(), securityTokenEnabled(), setContainerFieldSet(), setCustomValidationMessage(), setDisabled(), setError(), setLeftTitle(), setName(), setReadonly(), setRightTitle(), setTabIndex(), setTitle(), setValue(), transform()

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

`public integer`	`$headingLevel`	# int int

Properties inherited from CompositeField

$children, $columnCount, $readonly

Properties inherited from FormField

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