com.helger.bootstrap3.form

Class BootstrapForm

java.lang.Object

com.helger.html.hc.impl.AbstractHCNode

com.helger.html.hc.impl.AbstractHCElement<THISTYPE>

com.helger.html.hc.impl.AbstractHCElementWithInternalChildren<THISTYPE,com.helger.html.hc.IHCNode>

com.helger.html.hc.impl.AbstractHCElementWithChildren<IMPLTYPE>

com.helger.html.hc.html.AbstractHCForm<BootstrapForm>

com.helger.bootstrap3.form.BootstrapForm

All Implemented Interfaces:

com.helger.commons.IHasPlainText, com.helger.commons.parent.IHasChildren<com.helger.html.hc.IHCNode>, com.helger.commons.parent.IHasChildrenSorted<com.helger.html.hc.IHCNode>, com.helger.html.hc.IHCElement<BootstrapForm>, com.helger.html.hc.IHCElementWithChildren<BootstrapForm>, com.helger.html.hc.IHCHasChildren, com.helger.html.hc.IHCHasChildrenMutable<BootstrapForm,com.helger.html.hc.IHCNode>, com.helger.html.hc.IHCHasCSSClasses<BootstrapForm>, com.helger.html.hc.IHCHasCSSStyles<BootstrapForm>, com.helger.html.hc.IHCNode, com.helger.html.hc.IHCNodeWithChildren<BootstrapForm>, Serializable

@NotThreadSafe
public class BootstrapForm
extends com.helger.html.hc.html.AbstractHCForm<BootstrapForm>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_LEFT_PART
static int	DEFAULT_RIGHT_PART

Fields inherited from class com.helger.html.hc.html.AbstractHCForm

DEFAULT_AUTO_COMPLETE, DEFAULT_METHOD, DEFAULT_NOVALIDATE, DEFAULT_SUBMIT_PRESSING_ENTER

Fields inherited from class com.helger.html.hc.impl.AbstractHCElement

DEFAULT_HIDDEN, DEFAULT_SPELLCHECK, DEFAULT_TRANSLATE, DEFAULT_UNFOCUSABLE

Fields inherited from interface com.helger.html.hc.IHCElement

DEFAULT_TABINDEX

Constructor Summary

Constructors

Constructor and Description
BootstrapForm()
BootstrapForm(EBootstrapFormType eFormType)
BootstrapForm(com.helger.commons.url.ISimpleURL aAction)
BootstrapForm(com.helger.commons.url.ISimpleURL aAction, EBootstrapFormType eFormType)
BootstrapForm(String sAction)
BootstrapForm(String sAction, EBootstrapFormType eFormType)

Method Summary

Methods

Modifier and Type	Method and Description
BootstrapForm	addFormGroup(BootstrapFormGroup aFormGroup)
IBootstrapFormGroupRenderer	getFormGroupRenderer()
EBootstrapFormType	getFormType()
BootstrapGridSpec	getLeft()
BootstrapGridSpec	getRight()
BootstrapForm	setFormGroupRenderer(IBootstrapFormGroupRenderer aFormGroupRenderer)
BootstrapForm	setFormType(EBootstrapFormType eFormType)
BootstrapForm	setLeft(int nLeftParts) Set the left part of a horizontal form.
BootstrapForm	setLeft(int nLeftPartsXS, int nLeftPartsSM, int nLeftPartsMD, int nLeftPartsLG) Set the left part of a horizontal form.
BootstrapForm	setSplitting(BootstrapGridSpec aLeft, BootstrapGridSpec aRight) Set the left part of a horizontal form.

Methods inherited from class com.helger.html.hc.html.AbstractHCForm

applyProperties, getAcceptCharset, getActionJS, getActionURL, getEncType, getMethod, getName, getSubmitButtonTabIndex, getTarget, isAutoCompleteOff, isAutoCompleteOn, isAutoCompleteUndefined, isNoValidate, isSubmitPressingEnter, setAcceptCharset, setAction, setAction, setAction, setAutoComplete, setAutoComplete, setEncType, setEncTypeFileUpload, setEncTypeTextPlain, setFileUploadEncType, setMethod, setName, setNoValidate, setSubmitPressingEnter, setSubmitPressingEnter, setTarget, toString

Methods inherited from class com.helger.html.hc.impl.AbstractHCElementWithChildren

addChild, addChild, addChild, addChild, addChildren, addChildren, addChildren, addChildren

Methods inherited from class com.helger.html.hc.impl.AbstractHCElementWithInternalChildren

addAndReturnChild, addAndReturnChild, addChild, addChild, addChildren, addChildren, addChildren, afterAddChild, afterRemoveChild, beforeAddChild, canConvertToNode, directGetChildren, getAllChildren, getAllChildrenAsNodeList, getChild, getChildAtIndex, getChildCount, getChildren, getChildrenFormEmitting, getFirstChild, getLastChild, getPlainText, hasChildren, internalBeforeConvertToNode, recursiveContainsChildWithTagName, removeAllChildren, removeChild, removeChild, sortAllChildren

Methods inherited from class com.helger.html.hc.impl.AbstractHCElement

addClass, addClasses, addClasses, addClasses, addEventHandler, addStyle, addStyle, addStyles, addStyles, addStyles, containsClass, containsCustomAttr, containsDataAttr, containsEventHandler, containsStyle, createElement, ensureID, finishAfterApplyProperties, getAccessKey, getAllClasses, getAllClassesAsString, getAllClassNames, getAllCustomAttrs, getAllDataAttrs, getAllStyles, getAllStylesAsString, getAllStyleValues, getContentEditable, getContextMenu, getCustomAttrCount, getCustomAttrValue, getDataAttrValue, getDirection, getDraggable, getDropZone, getElement, getEventHandler, getID, getLanguage, getRole, getStyleValue, getTabIndex, getTagName, getTitle, hasAnyClass, hasAnyStyle, hasCustomAttrs, hasDataAttrs, hasID, hasStyle, internalConvertToNode, isDataAttrName, isHidden, isSpellCheck, isTranslateOff, isTranslateOn, isTranslateUndefined, isUnfocusable, makeDataAttrName, prependEventHandler, removeAllClasses, removeAllEventHandler, removeAllStyles, removeClass, removeCustomAttr, removeDataAttr, removeStyle, setAccessKey, setContentEditable, setContextMenu, setCustomAttr, setCustomAttr, setCustomAttr, setDataAttr, setDataAttr, setDataAttr, setDirection, setDraggable, setDropZone, setEventHandler, setHidden, setID, setLanguage, setRole, setSpellCheck, setTabIndex, setTitle, setTranslate, setTranslate, setUnfocusable, setUniqueID, thisAsT

Methods inherited from class com.helger.html.hc.impl.AbstractHCNode

applyCustomization, beforeConvertToNode, convertToNode, getAsConditionalCommentNode, getAsHTMLString, internalAfterConvertToNode, isConvertedToNode, isCustomized, onAdded, onRemoved

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.helger.html.hc.IHCElement

addEventHandler, containsCustomAttr, containsDataAttr, containsEventHandler, ensureID, getAccessKey, getAllCustomAttrs, getAllDataAttrs, getContentEditable, getContextMenu, getCustomAttrCount, getCustomAttrValue, getDataAttrValue, getDirection, getDraggable, getDropZone, getElement, getEventHandler, getID, getLanguage, getRole, getTabIndex, getTagName, hasCustomAttrs, hasDataAttrs, hasID, isHidden, isSpellCheck, isTranslateOff, isTranslateOn, isTranslateUndefined, isUnfocusable, prependEventHandler, removeAllEventHandler, removeCustomAttr, removeDataAttr, setAccessKey, setContentEditable, setContextMenu, setCustomAttr, setCustomAttr, setCustomAttr, setDataAttr, setDataAttr, setDataAttr, setDirection, setDraggable, setDropZone, setEventHandler, setHidden, setID, setLanguage, setRole, setSpellCheck, setTabIndex, setTitle, setTranslate, setTranslate, setUnfocusable, setUniqueID

Methods inherited from interface com.helger.html.hc.IHCHasCSSStyles

addStyle, addStyle, addStyles, addStyles, addStyles, containsStyle, getAllStyles, getAllStylesAsString, getAllStyleValues, getStyleValue, hasAnyStyle, hasStyle, removeAllStyles, removeStyle

Methods inherited from interface com.helger.html.hc.IHCHasCSSClasses

addClass, addClasses, addClasses, addClasses, containsClass, getAllClasses, getAllClassesAsString, getAllClassNames, hasAnyClass, removeAllClasses, removeClass

Methods inherited from interface com.helger.html.hc.IHCHasChildrenMutable

addAndReturnChild, addAndReturnChild, addChild, addChild, addChildren, addChildren, addChildren, getAllChildrenAsNodeList, recursiveContainsChildWithTagName, removeAllChildren, removeChild, removeChild, sortAllChildren

Methods inherited from interface com.helger.html.hc.IHCHasChildren

getFirstChild, getLastChild

Methods inherited from interface com.helger.html.hc.IHCNode

applyCustomization, beforeConvertToNode, canConvertToNode, convertToNode, getAsConditionalCommentNode, getAsHTMLString, isConvertedToNode, isCustomized, onAdded, onRemoved

Methods inherited from interface com.helger.commons.IHasPlainText

getPlainText

Methods inherited from interface com.helger.commons.parent.IHasChildrenSorted

getAllChildren, getChildAtIndex

Methods inherited from interface com.helger.commons.parent.IHasChildren

getChildCount, hasChildren

Field Detail

DEFAULT_LEFT_PART

public static final int DEFAULT_LEFT_PART

See Also:

Constant Field Values

DEFAULT_RIGHT_PART

public static final int DEFAULT_RIGHT_PART

See Also:

Constant Field Values

Constructor Detail

BootstrapForm

public BootstrapForm()

BootstrapForm

public BootstrapForm(@Nullable
             com.helger.commons.url.ISimpleURL aAction)

BootstrapForm

public BootstrapForm(@Nonnull
             EBootstrapFormType eFormType)

BootstrapForm

public BootstrapForm(@Nullable
             String sAction)

BootstrapForm

public BootstrapForm(@Nullable
             com.helger.commons.url.ISimpleURL aAction,
             @Nonnull
             EBootstrapFormType eFormType)

BootstrapForm

public BootstrapForm(@Nullable
             String sAction,
             @Nonnull
             EBootstrapFormType eFormType)

Method Detail

getFormType

@Nonnull
public final EBootstrapFormType getFormType()

Returns:

The form type as specified in the constructor. Never null.

setFormType

@Nonnull
public final BootstrapForm setFormType(@Nonnull
                                EBootstrapFormType eFormType)

Parameters:

eFormType - The form type to be used. May not be null.

Returns:

this

getLeft

@Nonnull
public final BootstrapGridSpec getLeft()

Returns:

The left parts. Always ≥ 1 and < CBootstrap.GRID_SYSTEM_MAX. Never null.

getRight

@Nonnull
public final BootstrapGridSpec getRight()

Returns:

The right parts. Always CBootstrap.GRID_SYSTEM_MAX - getLeft (). Never null.

setLeft

@Nonnull
@OverridingMethodsMustInvokeSuper
public BootstrapForm setLeft(@Nonnegative
                                                             int nLeftParts)

Set the left part of a horizontal form. This implies setting the correct right parts (= CBootstrap.GRID_SYSTEM_MAX - left).

Parameters:

nLeftParts - The left parts. Must be ≥ 1 and < 12!

Returns:

this

setLeft

@Nonnull
@OverridingMethodsMustInvokeSuper
public BootstrapForm setLeft(@Nonnegative
                                                             int nLeftPartsXS,
                                                             @Nonnegative
                                                             int nLeftPartsSM,
                                                             @Nonnegative
                                                             int nLeftPartsMD,
                                                             @Nonnegative
                                                             int nLeftPartsLG)

Set the left part of a horizontal form. This implies setting the correct right parts (= CBootstrap.GRID_SYSTEM_MAX - left).

Parameters:

nLeftPartsXS - The left parts XS. Must be ≥ 1 and < 12!

nLeftPartsSM - The left parts SM. Must be ≥ 1 and < 12!

nLeftPartsMD - The left parts MD. Must be ≥ 1 and < 12!

nLeftPartsLG - The left parts LG. Must be ≥ 1 and < 12!

Returns:

this

setSplitting

@Nonnull
@OverridingMethodsMustInvokeSuper
public BootstrapForm setSplitting(@Nonnull
                                                                  BootstrapGridSpec aLeft,
                                                                  @Nonnull
                                                                  BootstrapGridSpec aRight)

Set the left part of a horizontal form.

Parameters:

aLeft - The left parts. Must not be null.

aRight - The right parts. Must not be null.

Returns:

this

getFormGroupRenderer

@Nonnull
public IBootstrapFormGroupRenderer getFormGroupRenderer()

setFormGroupRenderer

@Nonnull
public BootstrapForm setFormGroupRenderer(@Nonnull
                                         IBootstrapFormGroupRenderer aFormGroupRenderer)

addFormGroup

@Nonnull
public BootstrapForm addFormGroup(@Nonnull
                                 BootstrapFormGroup aFormGroup)