com.helger.photon.bootstrap4.form

Class BootstrapForm

java.lang.Object

com.helger.html.hc.impl.AbstractHCNode

com.helger.html.hc.html.AbstractHCElement<IMPLTYPE>

com.helger.html.hc.html.AbstractHCElementWithInternalChildren<IMPLTYPE,com.helger.html.hc.IHCNode>

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

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

com.helger.photon.bootstrap4.form.BootstrapForm

All Implemented Interfaces:

com.helger.commons.hierarchy.IHasChildren<com.helger.html.hc.IHCNode>, com.helger.commons.hierarchy.IHasChildrenRecursive<com.helger.html.hc.IHCNode>, com.helger.commons.hierarchy.IHasChildrenSorted<com.helger.html.hc.IHCNode>, com.helger.commons.traits.IGenericImplTrait<BootstrapForm>, com.helger.html.hc.html.forms.IHCForm<BootstrapForm>, com.helger.html.hc.html.IHCElement<BootstrapForm>, com.helger.html.hc.html.IHCElementWithChildren<BootstrapForm>, com.helger.html.hc.html.IHCElementWithInternalChildren<BootstrapForm,com.helger.html.hc.IHCNode>, com.helger.html.hc.html.IHCHasCSSClasses<BootstrapForm>, com.helger.html.hc.html.IHCHasCSSStyles<BootstrapForm>, com.helger.html.hc.IHCHasChildrenMutable<BootstrapForm,com.helger.html.hc.IHCNode>, com.helger.html.hc.IHCHasID<BootstrapForm>, com.helger.html.hc.IHCHasName<BootstrapForm>, com.helger.html.hc.IHCNode, com.helger.html.hc.IHCNodeWithChildren<BootstrapForm>, IBootstrapFormGroupContainer<BootstrapForm>, Serializable

@NotThreadSafe
public class BootstrapForm
extends com.helger.html.hc.html.forms.AbstractHCForm<BootstrapForm>
implements IBootstrapFormGroupContainer<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.forms.AbstractHCForm

CSS_CLASS_INVISIBLE_BUTTON, DEFAULT_AUTO_COMPLETE, DEFAULT_METHOD, DEFAULT_NOVALIDATE, DEFAULT_SUBMIT_PRESSING_ENTER

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

DEFAULT_HIDDEN, DEFAULT_SPELLCHECK, DEFAULT_TRANSLATE, DEFAULT_UNFOCUSABLE

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

DEFAULT_TABINDEX

Constructor Summary

Constructors

Constructor and Description
BootstrapForm(com.helger.photon.core.execcontext.ISimpleWebExecutionContext aLEC)

Method Summary

Modifier and Type	Method and Description
BootstrapForm	addFormGroup(BootstrapFormGroup aFormGroup) Add a new form group at the end.
IBootstrapFormGroupRenderer	getFormGroupRenderer()
EBootstrapFormType	getFormType()
BootstrapGridSpec	getLeft()
com.helger.html.hc.html.IHCElementWithChildren<?>	getRenderedFormGroup(BootstrapFormGroup aFormGroup) Get the rendered form group based on the contained form group renderer.
BootstrapGridSpec	getRight()
protected void	onFinalizeNodeState(com.helger.html.hc.IHCConversionSettingsToNode aConversionSettings, com.helger.html.hc.IHCHasChildrenMutable<?,? super com.helger.html.hc.IHCNode> aTargetNode)
BootstrapForm	setFormGroupRenderer(IBootstrapFormGroupRenderer aFormGroupRenderer) Set the form group renderer to be used.
BootstrapForm	setFormType(EBootstrapFormType eFormType)
BootstrapForm	setLeft(int nLeftPartsXS, int nLeftPartsSM, int nLeftPartsMD, int nLeftPartsLG, int nLeftPartsXL) 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.forms.AbstractHCForm

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

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

addChild, addChildAt, afterAddChild, afterRemoveChild, beforeAddChild, canConvertToMicroNode, children, findFirstChild, findFirstChildMapped, forAllChildren, forAllChildren, forAllChildrenBreakable, forAllChildrenMapped, getAllChildren, getAllChildrenAsNodeList, getChildAtIndex, getChildCount, getChildren, getChildrenFormEmitting, getFirstChild, getLastChild, getPlainText, hasChildren, removeAllChildren, removeChild, removeChildAt, sortAllChildren

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

addClass, addEventHandler, addStyle, containsClass, containsEventHandler, containsStyle, createMicroElement, customAttrs, finishMicroElement, getAccessKey, getAllClasses, getAllClassesAsString, getAllClassNames, getAllStyles, getAllStylesAsString, getAllStyleValues, getContentEditable, getContextMenu, getDirection, getDraggable, getDropZone, getElement, getEventHandler, getEventMap, getID, getLanguage, getRole, getStyleValue, getTabIndex, getTagName, getTitle, getTranslate, hasAnyClass, hasAnyStyle, hasStyle, internalConvertToMicroNode, isHidden, isSpellCheck, isTranslateOff, isTranslateOn, isTranslateUndefined, isUnfocusable, isValidID, prependEventHandler, removeAllClasses, removeAllEventHandler, removeAllStyles, removeClass, removeStyle, setAccessKey, setContentEditable, setContextMenu, setDirection, setDraggable, setDropZone, setEventHandler, setHidden, setID, setID, setLanguage, setRole, setSpellCheck, setTabIndex, setTitle, setTranslate, setUnfocusable

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

consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, getNodeState, internalSetNodeState, onCustomizeNode, onRegisterExternalResources, registerExternalResources

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.photon.bootstrap4.form.IBootstrapFormGroupContainer

setLeft

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

addEventHandler, containsEventHandler, customAttrs, getAccessKey, getContentEditable, getContextMenu, getDirection, getDraggable, getDropZone, getElement, getEventHandler, getEventMap, getLanguage, getRole, getTabIndex, getTagName, getTitle, getTranslate, isHidden, isSpellCheck, isTranslateOff, isTranslateOn, isTranslateUndefined, isUnfocusable, prependEventHandler, removeAllEventHandler, setAccessKey, setContentEditable, setContextMenu, setDirection, setDraggable, setDropZone, setEventHandler, setHidden, setLanguage, setRole, setSpellCheck, setTabIndex, setTitle, setTranslate, setTranslate, setUnfocusable

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

canConvertToMicroNode, consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, getNodeState, getPlainText, registerExternalResources

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

findFirstChild, findFirstChildMapped, getAllChildren, getChildAtIndex, getFirstChild, getLastChild

Methods inherited from interface com.helger.commons.hierarchy.IHasChildrenRecursive

forAllChildrenRecursive, forAllChildrenRecursive

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

forAllChildren, forAllChildren, forAllChildrenBreakable, forAllChildrenMapped, getChildCount, getChildren, hasChildren, hasNoChildren

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

ensureID, getID, hasID, hasNoID, setID, setUniqueID

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

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

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

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

Methods inherited from interface com.helger.commons.traits.IGenericImplTrait

thisAsT

Methods inherited from interface com.helger.html.hc.html.forms.IHCForm

setAutoComplete, setEncTypeFileUpload, setEncTypeTextPlain, setSubmitPressingEnter

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

recursiveContainsChildWithTagName

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

addChild, addChildAt, addChildren, addChildren, setChild

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

addAndReturnChild, addAndReturnChildAt, addChild, addChildAt, addChildren, addChildren, addChildren, addChildrenAt, addChildrenAt, getAllChildrenAsNodeList, removeAllChildren, removeChild, removeChildAt, setChild, sortAllChildren

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(@Nonnull
                     com.helger.photon.core.execcontext.ISimpleWebExecutionContext aLEC)

Method Detail

getFormType

@Nonnull
public final EBootstrapFormType getFormType()

Specified by:

getFormType in interface IBootstrapFormGroupContainer<BootstrapForm>

Returns:

The form type for aligning the form groups. 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()

Specified by:

getLeft in interface IBootstrapFormGroupContainer<BootstrapForm>

Returns:

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

getRight

@Nonnull
public final BootstrapGridSpec getRight()

Specified by:

getRight in interface IBootstrapFormGroupContainer<BootstrapForm>

Returns:

The right parts. Always CBootstrap.GRID_SYSTEM_MAX - getLeft () except left is CBootstrap.GRID_SYSTEM_MAX than right is also CBootstrap.GRID_SYSTEM_MAX. Never null.

setLeft

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

Description copied from interface: IBootstrapFormGroupContainer

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

Specified by:

setLeft in interface IBootstrapFormGroupContainer<BootstrapForm>

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!

nLeftPartsXL - The left parts XL. Must be ≥ 1 and ≤ 12!

Returns:

this

setSplitting

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

Description copied from interface: IBootstrapFormGroupContainer

Set the left part of a horizontal form.

Specified by:

setSplitting in interface IBootstrapFormGroupContainer<BootstrapForm>

Parameters:

aLeft - The left parts. Must not be null.

aRight - The right parts. Must not be null.

Returns:

this

getFormGroupRenderer

@Nonnull
public IBootstrapFormGroupRenderer getFormGroupRenderer()

Specified by:

getFormGroupRenderer in interface IBootstrapFormGroupContainer<BootstrapForm>

Returns:

The renderer used to convert form groups into HC nodes. Never null.

setFormGroupRenderer

@Nonnull
public BootstrapForm setFormGroupRenderer(@Nonnull
                                                    IBootstrapFormGroupRenderer aFormGroupRenderer)

Description copied from interface: IBootstrapFormGroupContainer

Set the form group renderer to be used.

Specified by:

setFormGroupRenderer in interface IBootstrapFormGroupContainer<BootstrapForm>

Parameters:

aFormGroupRenderer - The from group renderer. May not be null.

Returns:

this

getRenderedFormGroup

@Nonnull
public com.helger.html.hc.html.IHCElementWithChildren<?> getRenderedFormGroup(@Nonnull
                                                                                        BootstrapFormGroup aFormGroup)

Description copied from interface: IBootstrapFormGroupContainer

Get the rendered form group based on the contained form group renderer. The form group is NOT added to this container!

Specified by:

getRenderedFormGroup in interface IBootstrapFormGroupContainer<BootstrapForm>

Parameters:

aFormGroup - The form group to be rendered. May not be null.

Returns:

The rendered form group and never null.

addFormGroup

@Nonnull
public BootstrapForm addFormGroup(@Nonnull
                                            BootstrapFormGroup aFormGroup)

Description copied from interface: IBootstrapFormGroupContainer

Add a new form group at the end.

Specified by:

addFormGroup in interface IBootstrapFormGroupContainer<BootstrapForm>

Parameters:

aFormGroup - The form group to be added. May not be null.

Returns:

this

onFinalizeNodeState

@OverrideOnDemand
 @OverridingMethodsMustInvokeSuper
protected void onFinalizeNodeState(@Nonnull
                                                                                          com.helger.html.hc.IHCConversionSettingsToNode aConversionSettings,
                                                                                          @Nonnull
                                                                                          com.helger.html.hc.IHCHasChildrenMutable<?,? super com.helger.html.hc.IHCNode> aTargetNode)

Overrides:

onFinalizeNodeState in class com.helger.html.hc.html.forms.AbstractHCForm<BootstrapForm>