com.helger.photon.bootstrap4.form

Interface IBootstrapFormGroupContainer<IMPLTYPE extends IBootstrapFormGroupContainer<IMPLTYPE>>

Type Parameters:

IMPLTYPE - Implementation type

All Superinterfaces:

com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>, 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.html.hc.html.IHCElement<IMPLTYPE>, com.helger.html.hc.html.IHCHasCSSClasses<IMPLTYPE>, com.helger.html.hc.html.IHCHasCSSStyles<IMPLTYPE>, com.helger.html.hc.IHCHasID<IMPLTYPE>, com.helger.html.hc.IHCNode, Serializable

All Known Implementing Classes:

BootstrapForm, BootstrapViewForm

public interface IBootstrapFormGroupContainer<IMPLTYPE extends IBootstrapFormGroupContainer<IMPLTYPE>>
extends com.helger.html.hc.html.IHCElement<IMPLTYPE>

Base interface for a form group container.

Author:

Philip Helger

Field Summary

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

DEFAULT_TABINDEX

Method Summary

Modifier and Type	Method and Description
IMPLTYPE	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()
IMPLTYPE	setFormGroupRenderer(IBootstrapFormGroupRenderer aFormGroupRenderer) Set the form group renderer to be used.
default IMPLTYPE	setLeft(int nLeftParts) Set the left part of a horizontal form.
IMPLTYPE	setLeft(int nLeftPartsXS, int nLeftPartsSM, int nLeftPartsMD, int nLeftPartsLG, int nLeftPartsXL) Set the left part of a horizontal form.
IMPLTYPE	setSplitting(BootstrapGridSpec aLeft, BootstrapGridSpec aRight) Set the left part of a horizontal form.

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

Method Detail

getFormType

@Nonnull
EBootstrapFormType getFormType()

Returns:

The form type for aligning the form groups. Never null .

setLeft

@Nonnull
default IMPLTYPE setLeft(@Nonnegative
                                   int nLeftParts)

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

Parameters:

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

Returns:

this

setLeft

@Nonnull
IMPLTYPE setLeft(@Nonnegative
                           int nLeftPartsXS,
                           @Nonnegative
                           int nLeftPartsSM,
                           @Nonnegative
                           int nLeftPartsMD,
                           @Nonnegative
                           int nLeftPartsLG,
                           @Nonnegative
                           int nLeftPartsXL)

Set the left part of a horizontal form. This implicitly sets 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!

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

Returns:

this

getLeft

@Nonnull
BootstrapGridSpec getLeft()

Returns:

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

getRight

@Nonnull
BootstrapGridSpec getRight()

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.

setSplitting

@Nonnull
IMPLTYPE 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
IBootstrapFormGroupRenderer getFormGroupRenderer()

Returns:

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

setFormGroupRenderer

@Nonnull
IMPLTYPE setFormGroupRenderer(@Nonnull
                                        IBootstrapFormGroupRenderer aFormGroupRenderer)

Set the form group renderer to be used.

Parameters:

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

Returns:

this

addFormGroup

@Nonnull
IMPLTYPE addFormGroup(@Nonnull
                                BootstrapFormGroup aFormGroup)

Add a new form group at the end.

Parameters:

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

Returns:

this

getRenderedFormGroup

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

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

Parameters:

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

Returns:

The rendered form group and never null.