Webylon 3.2 API Docs
  • Package
  • Class
  • Tree
  • Deprecated
  • Download
Version: current
  • 3.2
  • 3.1

Packages

  • 1c
    • exchange
      • catalog
  • auth
  • Booking
  • building
    • company
  • cart
    • shipping
    • steppedcheckout
  • Catalog
    • monument
  • cms
    • assets
    • batchaction
    • batchactions
    • bulkloading
    • comments
    • content
    • core
    • export
    • newsletter
    • publishers
    • reports
    • security
    • tasks
  • Dashboard
  • DataObjectManager
  • event
  • faq
  • forms
    • actions
    • core
    • fields-basic
    • fields-dataless
    • fields-datetime
    • fields-files
    • fields-formatted
    • fields-formattedinput
    • fields-relational
    • fields-structural
    • transformations
    • validators
  • googlesitemaps
  • guestbook
  • installer
  • newsletter
  • None
  • photo
    • gallery
  • PHP
  • polls
  • recaptcha
  • 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
  • seo
    • open
      • graph
  • sfDateTimePlugin
  • spamprotection
  • stealth
    • captha
  • subsites
  • userform
    • pagetypes
  • userforms
  • webylon
  • widgets

Classes

  • CompositeField
  • FieldGroup
  • FieldSet
  • HiddenFieldSet
  • SelectionGroup
  • Tab
  • TabSet
  • ToggleCompositeField

Class TabSet

Defines a set of tabs in a form. The tabs are build with our standard tabstrip javascript library. By default, the HTML is generated using FieldHolder.

Object
Extended by ViewableData implements IteratorAggregate
Extended by RequestHandler
Extended by FormField
Extended by CompositeField
Extended by TabSet

Direct known subclasses

PrintableTransformation_TabSet

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

Methods summary

public
# __construct( string $name )

Parameters

$name
string $name Identifier

Overrides

CompositeField::__construct
public
# id( )

Returns the HTML ID of the field - used in the template by label tags. The ID is generated as FormName_FieldName. All Field functions should ensure that this ID is included in the field.

Returns the HTML ID of the field - used in the template by label tags. The ID is generated as FormName_FieldName. All Field functions should ensure that this ID is included in the field.

Overrides

FormField::id
public
# FieldHolder( )

Returns a tab-strip and the associated tabs. The HTML is a standardised format, containing a <ul;

Returns a tab-strip and the associated tabs. The HTML is a standardised format, containing a <ul;

Overrides

FormField::FieldHolder
public
# Tabs( )

Return a dataobject set of all this classes tabs

Return a dataobject set of all this classes tabs

public
# setTabs( mixed $children )
public
# setTabSet( mixed $val )
public
# getTabSet( )
public
# fieldByName( mixed $name )

Returns the named tab

Returns the named tab

Overrides

CompositeField::fieldByName
public
# push( mixed $field )

Add a new child field to the end of the set.

Add a new child field to the end of the set.

Overrides

CompositeField::push
public
# insertBefore( FormField $field, string $insertBefore )

Inserts a field before a particular field in a FieldSet.

Inserts a field before a particular field in a FieldSet.

Parameters

$field
FormField $item The form field to insert
$insertBefore
string $name Name of the field to insert before

Overrides

CompositeField::insertBefore
public
# insertAfter( mixed $field, mixed $insertAfter )

Overrides

CompositeField::insertAfter
public
# removeByName( string $tabName, boolean $dataFieldOnly = false )

Remove a field from this CompositeField by Name. The field could also be inside a CompositeField.

Remove a field from this CompositeField by Name. The field could also be inside a CompositeField.

Parameters

$tabName
string $fieldName The name of the field
$dataFieldOnly
boolean $dataFieldOnly If this is true, then a field will only be removed if it's a data field. Dataless fields, such as tabs, will be left as-is.

Overrides

CompositeField::removeByName

Methods inherited from CompositeField

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

Methods inherited from FormField

LeftTitle(), Link(), Message(), MessageType(), Name(), Required(), RightTitle(), SmallFieldHolder(), Title(), Type(), Value(), addExtraAttribute(), addExtraClass(), allowHTML5(), allow_html5(), attrName(), attrTitle(), attrValue(), createTag(), dataValue(), describe(), extraClass(), fieldHolderTemplates(), fieldTemplates(), forTemplate(), getCustomValidationMessage(), getExtraClasses(), getForm(), getHTML5Attribute(), getTabIndex(), getTabIndexHTML(), hasClass(), 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

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. -
Webylon 3.2 API Docs API documentation generated by ApiGen 2.8.0