\BootstrapFormField
The base class for creating a {@link FormField} object that is compatible with the Twitter Bootstrap CSS framework.
- Author: Uncle Cheese <unclecheese@leftandmain.com>
Synopsis
class BootstrapFormField
extends DataExtension
{
- // members
- protected array $holderAttributes = ;
- protected array $holderClasses = ;
- protected array $labelClasses = ;
- protected array $inputClasses = ;
- protected String $gridLabelClass = '';
- protected String $gridInputClass = '';
- // methods
- 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()
- private void loadErrorMessage()
- public void onBeforeRender()
Hierarchy
Extends
- DataExtension
Tasks
Line | Task |
---|---|
245+ | allow setting error message as inline |
Members
protected
Methods
private
- loadErrorMessage() — checks for error messages in owner form field adds error class to holder and loads error message as helptext
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