\BootstrapOptionsetField
Creates a {@link OptionsetField} or a subclass thereof that is compatible with the Twitter Bootstrap CSS framework.
- Author: Uncle Cheese <unclecheese@leftandmain.com>
Synopsis
class BootstrapOptionsetField
extends BootstrapFormField
{
- // members
- protected array $columnCounts = ;
- protected $numberOfColumns;
- // Inherited members from BootstrapFormField
- protected array $holderAttributes;
- protected array $holderClasses;
- protected array $labelClasses;
- protected array $inputClasses;
- protected String $gridLabelClass;
- protected String $gridInputClass;
- // methods
- public BootstrapOptionsetField setInline()
- public OptionsetField setColumns()
- public boolean HasColumns()
- public int ColumnCount()
- public string ColumnClasses()
- public int PerColumn()
- // Inherited methods from BootstrapFormField
- public BootstrapFormField addPlaceholder()
- public BootstrapFormField addHelpText()
- public BootstrapFormField addInlineHelpText()
- public BootstrapFormField setHolderAttribute()
- public string HolderAttributes()
- public BootstrapFormField addInputClass()
- public string InputClasses()
- public BootstrapFormField addLabelClass()
- public string LabelClasses()
- public BootstrapFormField addHolderClass()
- public string HolderClasses()
- public string BootstrapLayout()
- public BootstrapFormField setGridLabelClass()
- public BootstrapFormField setGridInputClass()
- public integer GridLabelClass()
- public integer GridInputClass()
- public void onBeforeRender()
Hierarchy
Extends
Members
protected
- $columnCounts
—
array
An array of column_name => span_length pairs. - $gridInputClass
—
String
The input grid class for the bootstrap 3 horizontal form overrides form setting - $gridLabelClass
—
String
The label grid class for the bootstrap 3 horizontal form overrides form setting - $holderAttributes — array
- $holderClasses
- $inputClasses
- $labelClasses
- $numberOfColumns
—
int
Number of columns in the options layout
Methods
public
- ColumnClasses() — A list of classes for the column divs
- ColumnCount() — Number of columns in the layout
- HasColumns() — Tells whether this option set is using a columnar layout
- PerColumn() — Number of options per column
- setColumns() — Sets the column layout for the options
- setInline() — Enable or disable "inline" presentation, in which buttons are laid out left to right, rather than top to bottom.
Inherited from BootstrapFormField
public
- BootstrapLayout() — returns the bootstrap Layout to be used in templates
- GridInputClass() — returns Grid input class to be used in templates
- GridLabelClass() — returns Grid label class to be used in templates
- HolderAttributes() — Returns the list of attributes suitable for an HTML tag
- HolderClasses() — returns the holder classes to be used in templates also triggers checking for error messages
- InputClasses() — returns the input classes to be used in templates also triggers checking for error messages
- LabelClasses() — returns the label classes to be used in templates also triggers checking for error messages
- addHelpText() — Adds a block of help text to the form field. (HTML safe).
- addHolderClass() — Allows adding custom classes to the holder
- addInlineHelpText() — Adds a line of inline help text to a form field (HTML safe).
- addInputClass() — Allows adding custom classes to the input
- addLabelClass() — Allows adding custom classes to the label
- addPlaceholder() — Adds a HTML5 placeholder attribute to the form field
- onBeforeRender() — Adds the form-control class to *just* the formfield, not the holder.
- setGridInputClass() — Allows setting custom Grid input class to override from grid label class
- setGridLabelClass() — Allows setting custom Grid label class to override from grid label class
- setHolderAttribute() — Sets an attribute on the wrapper <div> for the formfield