com.helger.photon.bootstrap4.form

Class DefaultBootstrapFormGroupRenderer

java.lang.Object

com.helger.photon.bootstrap4.form.DefaultBootstrapFormGroupRenderer

All Implemented Interfaces:

IBootstrapFormGroupRenderer, Serializable

@NotThreadSafe
public class DefaultBootstrapFormGroupRenderer
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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DefaultBootstrapFormGroupRenderer()

Method Summary

Modifier and Type	Method and Description
protected com.helger.html.hc.html.IHCElementWithChildren<?>	createHelpTextNode(com.helger.html.hc.IHCNode aHelpText) Create the help text node
protected com.helger.html.hc.html.IHCElement<?>	createSingleErrorNode(com.helger.commons.error.IError aError, Locale aContentLocale) Create the node for a single error.
boolean	isForceNoCheckBoxHandling()
boolean	isUseIcons()
protected void	modifyFinalNode(IBootstrapFormGroupContainer<?> aForm, BootstrapFormGroup aFormGroup, com.helger.html.hc.html.grouping.AbstractHCDiv<?> aFinalNode) Callback possibility to change the finally created node before it is returned.
protected void	modifyFirstControlIfLabelIsPresent(com.helger.html.hc.html.IHCElementWithChildren<?> aLabel, com.helger.html.hc.html.forms.IHCControl<?> aFirstControl) Modify the first control that is inserted.
com.helger.html.hc.html.grouping.AbstractHCDiv<?>	renderFormGroup(IBootstrapFormGroupContainer<?> aForm, BootstrapFormGroup aFormGroup, Locale aDisplayLocale)
DefaultBootstrapFormGroupRenderer	setForceNoCheckBoxHandling(boolean bForceNoCheckBoxHandling)
DefaultBootstrapFormGroupRenderer	setUseIcons(boolean bUseIcons)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultBootstrapFormGroupRenderer

public DefaultBootstrapFormGroupRenderer()

Method Detail

isUseIcons

public boolean isUseIcons()

Specified by:

isUseIcons in interface IBootstrapFormGroupRenderer

setUseIcons

@Nonnull
public DefaultBootstrapFormGroupRenderer setUseIcons(boolean bUseIcons)

Specified by:

setUseIcons in interface IBootstrapFormGroupRenderer

isForceNoCheckBoxHandling

public boolean isForceNoCheckBoxHandling()

setForceNoCheckBoxHandling

@Nonnull
public DefaultBootstrapFormGroupRenderer setForceNoCheckBoxHandling(boolean bForceNoCheckBoxHandling)

modifyFirstControlIfLabelIsPresent

@OverrideOnDemand
protected void modifyFirstControlIfLabelIsPresent(@Nonnull
                                                                     com.helger.html.hc.html.IHCElementWithChildren<?> aLabel,
                                                                     @Nonnull
                                                                     com.helger.html.hc.html.forms.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.html.IHCElementWithChildren<?> createHelpTextNode(@Nonnull
                                                                                                             com.helger.html.hc.IHCNode aHelpText)

Create the help text node

Parameters:

aHelpText - The source help text. Never null.

Returns:

Never null.

createSingleErrorNode

@Nullable
 @OverrideOnDemand
protected com.helger.html.hc.html.IHCElement<?> createSingleErrorNode(@Nonnull
                                                                                                     com.helger.commons.error.IError aError,
                                                                                                     @Nonnull
                                                                                                     Locale aContentLocale)

Create the node for a single error.

Parameters:

aError - The provided error. Never null.

aContentLocale - Locale to be used to show error text.

Returns:

May be null.

modifyFinalNode

@OverrideOnDemand
protected void modifyFinalNode(@Nonnull
                                                  IBootstrapFormGroupContainer<?> aForm,
                                                  @Nonnull
                                                  BootstrapFormGroup aFormGroup,
                                                  @Nonnull
                                                  com.helger.html.hc.html.grouping.AbstractHCDiv<?> 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.html.grouping.AbstractHCDiv<?> renderFormGroup(@Nonnull
                                                                                   IBootstrapFormGroupContainer<?> aForm,
                                                                                   @Nonnull
                                                                                   BootstrapFormGroup aFormGroup,
                                                                                   @Nonnull
                                                                                   Locale aDisplayLocale)

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.

aDisplayLocale - Display locale to be used. May not be null.

Returns:

Never null.