com.helger.bootstrap3.form

Class BootstrapFormGroupRendererDefault

java.lang.Object

com.helger.bootstrap3.form.BootstrapFormGroupRendererDefault

All Implemented Interfaces:

IBootstrapFormGroupRenderer

@Immutable
public class BootstrapFormGroupRendererDefault
extends Object
implements IBootstrapFormGroupRenderer

This is the default implementation of IBootstrapFormGroupRenderer which performs standard rendering. It offers the possibility to modify certain styling by overriding the provided protected methods.

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static com.helger.html.css.ICSSClassProvider	CSS_CLASS_FORM_GROUP_ERROR_TEXT
static com.helger.html.css.ICSSClassProvider	CSS_CLASS_FORM_GROUP_HELP_TEXT

Constructor Summary

Constructors

Constructor and Description
BootstrapFormGroupRendererDefault()

Method Summary

Methods

Modifier and Type	Method and Description
protected com.helger.html.hc.IHCElement<?>	createHelpTextNode(com.helger.html.hc.IHCNode aHelpText) Create the help text node
protected com.helger.html.hc.IHCElement<?>	createSingleErrorNode(com.helger.validation.error.IError aError) Create the node for a single error.
protected EBootstrapFormGroupState	getFormGroupStateFromErrorList(com.helger.validation.error.IErrorList aErrorList) Retrieve an optional CSS class that is provided to the final node.
boolean	isUseIcons()
protected void	modifyFinalNode(BootstrapForm aForm, BootstrapFormGroup aFormGroup, com.helger.html.hc.html.HCDiv aFinalNode) Callback possibility to change the finally created node before it is returned.
protected void	modifyFirstControlIfLabelIsPresent(com.helger.html.hc.IHCElementWithChildren<?> aLabel, com.helger.html.hc.IHCControl<?> aFirstControl) Modify the first control that is inserted.
com.helger.html.hc.IHCElement<?>	renderFormGroup(BootstrapForm aForm, BootstrapFormGroup aFormGroup)
void	setUseIcons(boolean bUseIcons)

Methods inherited from class java.lang.Object

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

Field Detail

CSS_CLASS_FORM_GROUP_HELP_TEXT

public static final com.helger.html.css.ICSSClassProvider CSS_CLASS_FORM_GROUP_HELP_TEXT

CSS_CLASS_FORM_GROUP_ERROR_TEXT

public static final com.helger.html.css.ICSSClassProvider CSS_CLASS_FORM_GROUP_ERROR_TEXT

Constructor Detail

BootstrapFormGroupRendererDefault

public BootstrapFormGroupRendererDefault()

Method Detail

isUseIcons

public boolean isUseIcons()

Specified by:

isUseIcons in interface IBootstrapFormGroupRenderer

setUseIcons

public void setUseIcons(boolean bUseIcons)

Specified by:

setUseIcons in interface IBootstrapFormGroupRenderer

modifyFirstControlIfLabelIsPresent

@OverrideOnDemand
protected void modifyFirstControlIfLabelIsPresent(@Nonnull
                                                       com.helger.html.hc.IHCElementWithChildren<?> aLabel,
                                                       @Nonnull
                                                       com.helger.html.hc.IHCControl<?> aFirstControl)

Modify the first control that is inserted. This method is only called when a label is present.

Parameters:

aLabel - The label that was provided. Never null.

aFirstControl - The first control that was provided. Never null.

createHelpTextNode

@Nonnull
@OverrideOnDemand
protected com.helger.html.hc.IHCElement<?> createHelpTextNode(@Nonnull
                                                                           com.helger.html.hc.IHCNode aHelpText)

Create the help text node

Parameters:

aHelpText - The source help text. Never null.

Returns:

Never null.

getFormGroupStateFromErrorList

@Nullable
@OverrideOnDemand
protected EBootstrapFormGroupState getFormGroupStateFromErrorList(@Nullable
                                                                                com.helger.validation.error.IErrorList aErrorList)

Retrieve an optional CSS class that is provided to the final node. This method is only called if a non-null and non-empty error list is present.

Parameters:

aErrorList - The error list. May be null.

Returns:

May be null to indicate no CSS class.

createSingleErrorNode

@Nonnull
@OverrideOnDemand
protected com.helger.html.hc.IHCElement<?> createSingleErrorNode(@Nonnull
                                                                              com.helger.validation.error.IError aError)

Create the node for a single error.

Parameters:

aError - The provided error. Never null.

Returns:

Never null.

modifyFinalNode

@OverrideOnDemand
protected void modifyFinalNode(@Nonnull
                                    BootstrapForm aForm,
                                    @Nonnull
                                    BootstrapFormGroup aFormGroup,
                                    @Nonnull
                                    com.helger.html.hc.html.HCDiv aFinalNode)

Callback possibility to change the finally created node before it is returned. By default nothing happens in here.

Parameters:

aForm - The source form. Never null.

aFormGroup - The source form group. Never null.

aFinalNode - The created node so far. Never null.

renderFormGroup

@Nonnull
public com.helger.html.hc.IHCElement<?> renderFormGroup(@Nonnull
                                                       BootstrapForm aForm,
                                                       @Nonnull
                                                       BootstrapFormGroup aFormGroup)

Specified by:

renderFormGroup in interface IBootstrapFormGroupRenderer

Parameters:

aForm - Form the form group belongs to. May not be null.

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

Returns:

Never null.