com.foreach.across.modules.bootstrapui.elements.builder

Class FormGroupElementBuilder

java.lang.Object

com.foreach.across.modules.web.ui.ViewElementBuilderSupport<T,SELF>

com.foreach.across.modules.web.ui.elements.builder.ContainerViewElementBuilderSupport<T,SELF>

com.foreach.across.modules.web.ui.elements.builder.AbstractNodeViewElementBuilder<FormGroupElement,FormGroupElementBuilder>

com.foreach.across.modules.bootstrapui.elements.builder.FormGroupElementBuilder

All Implemented Interfaces:

com.foreach.across.modules.web.ui.elements.builder.HtmlViewElementBuilder<FormGroupElement,FormGroupElementBuilder>, com.foreach.across.modules.web.ui.ViewElementBuilder<FormGroupElement>

public class FormGroupElementBuilder
extends com.foreach.across.modules.web.ui.elements.builder.AbstractNodeViewElementBuilder<FormGroupElement,FormGroupElementBuilder>

Nested Class Summary

Nested classes/interfaces inherited from class com.foreach.across.modules.web.ui.ViewElementBuilderSupport

com.foreach.across.modules.web.ui.ViewElementBuilderSupport.ElementOrBuilder

Nested classes/interfaces inherited from interface com.foreach.across.modules.web.ui.ViewElementBuilder

com.foreach.across.modules.web.ui.ViewElementBuilder.Wither<T extends com.foreach.across.modules.web.ui.ViewElementBuilder>

Field Summary

Fields inherited from class com.foreach.across.modules.web.ui.ViewElementBuilderSupport

customTemplate, name

Constructor Summary

Constructors

Constructor and Description
FormGroupElementBuilder()

Method Summary

Modifier and Type	Method and Description
FormGroupElementBuilder	control(com.foreach.across.modules.web.ui.ViewElement control)
FormGroupElementBuilder	control(com.foreach.across.modules.web.ui.ViewElementBuilder controlBuilder)
protected FormGroupElement	createElement(com.foreach.across.modules.web.ui.ViewElementBuilderContext builderContext)
FormGroupElementBuilder	descriptionBlock(String text) Quick create a description text block, to show at the top of the form group.
FormGroupElementBuilder	descriptionBlock(com.foreach.across.modules.web.ui.ViewElement descriptionBlock) Add a description block to show at the top of the form group.
FormGroupElementBuilder	descriptionBlock(com.foreach.across.modules.web.ui.ViewElementBuilder descriptionBlock) Add a description block to show at the top of the form group.
FormGroupElementBuilder	detectFieldErrors(boolean detectFieldErrors) Should field errors for the control present in this form group be detected automatically.
FormGroupElementBuilder	fieldErrorsToShow(String... fieldNames) Display the field errors for the given names as validation feedback.
FormGroupElementBuilder	formLayout(FormLayout formLayout)
com.foreach.across.modules.web.ui.ViewElementBuilderSupport.ElementOrBuilder	getControl()
<V> V	getControl(Class<V> targetClass) Gets the control configured on this builder if it is of the target type specified.
FormLayout	getFormLayout()
com.foreach.across.modules.web.ui.ViewElementBuilderSupport.ElementOrBuilder	getHelpBlock()
com.foreach.across.modules.web.ui.ViewElementBuilderSupport.ElementOrBuilder	getLabel()
<V> V	getLabel(Class<V> targetClass) Gets the label configured on this builder if it is of the target type specified.
FormGroupElementBuilder	helpBlock(String text) Quick create a basic help block and add it to the form group.
FormGroupElementBuilder	helpBlock(com.foreach.across.modules.web.ui.ViewElement helpBlock) Add a help block to the form group.
FormGroupElementBuilder	helpBlock(com.foreach.across.modules.web.ui.ViewElementBuilder helpBlock) Add a help block to the form group.
Boolean	isRequired()
FormGroupElementBuilder	label(String text) Quick create a basic label element and add it to the form group.
FormGroupElementBuilder	label(com.foreach.across.modules.web.ui.ViewElement label)
FormGroupElementBuilder	label(com.foreach.across.modules.web.ui.ViewElementBuilder labelBuilder)
FormGroupElementBuilder	required()
FormGroupElementBuilder	required(boolean required)
FormGroupElementBuilder	tooltip(String text) Add a tooltip with the given (html supporting) text.
FormGroupElementBuilder	tooltip(com.foreach.across.modules.web.ui.ViewElement tooltip) Add a tooltip to the form group.
FormGroupElementBuilder	tooltip(com.foreach.across.modules.web.ui.ViewElementBuilder tooltip) Add a tooltip to the form group.

Methods inherited from class com.foreach.across.modules.web.ui.elements.builder.AbstractNodeViewElementBuilder

apply, attribute, attributes, clearAttributes, css, htmlId, removeAttribute, removeCss

Methods inherited from class com.foreach.across.modules.web.ui.elements.builder.ContainerViewElementBuilderSupport

add, add, addAll, addFirst, addFirst, sort

Methods inherited from class com.foreach.across.modules.web.ui.ViewElementBuilderSupport

build, configure, customTemplate, elementSupplier, elementSupplier, name, postProcess, postProcessor, registerWebResources, with

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.foreach.across.modules.web.ui.elements.builder.HtmlViewElementBuilder

data, removeData

Methods inherited from interface com.foreach.across.modules.web.ui.ViewElementBuilder

andThen, build, doWith, map, map, of, of, postProcess, postProcess

Constructor Detail

FormGroupElementBuilder

public FormGroupElementBuilder()

Method Detail

isRequired

public Boolean isRequired()

getLabel

public com.foreach.across.modules.web.ui.ViewElementBuilderSupport.ElementOrBuilder getLabel()

getHelpBlock

public com.foreach.across.modules.web.ui.ViewElementBuilderSupport.ElementOrBuilder getHelpBlock()

getLabel

public <V> V getLabel(Class<V> targetClass)

Gets the label configured on this builder if it is of the target type specified. If no label is set or the label is not of the specified type, null will be returned.

Type Parameters:

V - target type the label should match

Parameters:

targetClass - target type the label should match

Returns:

label instance or null

getControl

public com.foreach.across.modules.web.ui.ViewElementBuilderSupport.ElementOrBuilder getControl()

getControl

public <V> V getControl(Class<V> targetClass)

Gets the control configured on this builder if it is of the target type specified. If no control is set or the control is not of the specified type, null will be returned.

Type Parameters:

V - target type the control should match

Parameters:

targetClass - target type the control should match

Returns:

control instance or null

getFormLayout

public FormLayout getFormLayout()

label

public FormGroupElementBuilder label(com.foreach.across.modules.web.ui.ViewElement label)

label

public FormGroupElementBuilder label(String text)

Quick create a basic label element and add it to the form group.

Parameters:

text - for the label

Returns:

current builder

label

public FormGroupElementBuilder label(com.foreach.across.modules.web.ui.ViewElementBuilder labelBuilder)

control

public FormGroupElementBuilder control(com.foreach.across.modules.web.ui.ViewElement control)

control

public FormGroupElementBuilder control(com.foreach.across.modules.web.ui.ViewElementBuilder controlBuilder)

helpBlock

public FormGroupElementBuilder helpBlock(String text)

Quick create a basic help block and add it to the form group. Usually added after the control, providing contextual help.

Parameters:

text - for the help block

Returns:

current builder

helpBlock

public FormGroupElementBuilder helpBlock(com.foreach.across.modules.web.ui.ViewElement helpBlock)

Add a help block to the form group. Usually added after the control, providing contextual help.

Parameters:

helpBlock - the help block

Returns:

current builder

helpBlock

public FormGroupElementBuilder helpBlock(com.foreach.across.modules.web.ui.ViewElementBuilder helpBlock)

Add a help block to the form group. Usually added after the control, providing contextual help.

Parameters:

helpBlock - the help block

Returns:

current builder

descriptionBlock

public FormGroupElementBuilder descriptionBlock(String text)

Quick create a description text block, to show at the top of the form group.

Parameters:

text - for the description block

Returns:

current builder

descriptionBlock

public FormGroupElementBuilder descriptionBlock(com.foreach.across.modules.web.ui.ViewElement descriptionBlock)

Add a description block to show at the top of the form group.

Parameters:

descriptionBlock - for the description block

Returns:

current builder

descriptionBlock

public FormGroupElementBuilder descriptionBlock(com.foreach.across.modules.web.ui.ViewElementBuilder descriptionBlock)

Add a description block to show at the top of the form group.

Parameters:

descriptionBlock - for the description block

Returns:

current builder

tooltip

public FormGroupElementBuilder tooltip(String text)

Add a tooltip with the given (html supporting) text. Tooltip will be added after the label text.

Parameters:

text - for the tooltip

Returns:

current builder

tooltip

public FormGroupElementBuilder tooltip(com.foreach.across.modules.web.ui.ViewElement tooltip)

Add a tooltip to the form group. Tooltip will be added after the label text.

Parameters:

tooltip - element

Returns:

current builder

tooltip

public FormGroupElementBuilder tooltip(com.foreach.across.modules.web.ui.ViewElementBuilder tooltip)

Add a tooltip to the form group. Tooltip will be added after the label text.

Parameters:

tooltip - element

Returns:

current builder

formLayout

public FormGroupElementBuilder formLayout(FormLayout formLayout)

required

public FormGroupElementBuilder required()

required

public FormGroupElementBuilder required(boolean required)

detectFieldErrors

public FormGroupElementBuilder detectFieldErrors(boolean detectFieldErrors)

Should field errors for the control present in this form group be detected automatically. If this is the case (default) a Errors object will be searched for on the model and the control name will be used as the selector for possible errors.

Parameters:

detectFieldErrors - should an Errors model object be used

Returns:

current builder

fieldErrorsToShow

public FormGroupElementBuilder fieldErrorsToShow(String... fieldNames)

Display the field errors for the given names as validation feedback. This will inspect the attached Errors object.

Parameters:

fieldNames - to show the errors for

Returns:

current builder

createElement

protected FormGroupElement createElement(com.foreach.across.modules.web.ui.ViewElementBuilderContext builderContext)

Specified by:

createElement in class com.foreach.across.modules.web.ui.ViewElementBuilderSupport<FormGroupElement,FormGroupElementBuilder>