to.etc.domui.component2.form4

Class FormBuilder

java.lang.Object

to.etc.domui.component2.form4.FormBuilder

public final class FormBuilder
extends Object

Yet another attempt at a generic form builder, using the Builder pattern. The builder starts in vertical mode - call horizontal() to move horizontally.

Author:

Frits Jalvingh Created on Jun 17, 2014

Constructor Summary

Constructors

Constructor and Description
FormBuilder(to.etc.domui.component2.form4.FormBuilder.IAppender appender)
FormBuilder(NodeContainer nb)

Method Summary

Modifier and Type	Method and Description
FormBuilder	append()
void	appendAfterControl(NodeBase what)
<T,C extends IControl<T>> void	bindControlData(C control, PropertyMetaModel<T> pmm)
TBody	body()
<T> IControl<?>	control()
<T,C extends IControl<T>> C	control(Class<C> controlClass)
void	control(IControl<?> control) Add the specified control.
FormBuilder	converter(IBindingConverter<?,?> converter)
FormBuilder	cssControl(String cssClass) Adds the specified css class to the control cell.
FormBuilder	cssLabel(String cssClass) Adds the specified css class to the label cell.
FormBuilder	errorLocation(String errorLocation)
NodeContainer	getLastControlCell()
FormBuilder	horizontal()
void	item(NodeBase item)
FormBuilder	label(Label label)
FormBuilder	label(String label)
FormBuilder	mandatory()
FormBuilder	mandatory(boolean yes)
FormBuilder	nl()
<T> FormBuilder	property(T instance, String property)
FormBuilder	readOnly()
FormBuilder	readOnly(boolean ro)
FormBuilder	unlabeled()
FormBuilder	vertical()

Methods inherited from class java.lang.Object

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

Constructor Detail

FormBuilder

public FormBuilder(@Nonnull
                   to.etc.domui.component2.form4.FormBuilder.IAppender appender)

FormBuilder

public FormBuilder(@Nonnull
                   NodeContainer nb)

Method Detail

append

@Nonnull
public FormBuilder append()

horizontal

@Nonnull
public FormBuilder horizontal()

vertical

@Nonnull
public FormBuilder vertical()

label

@Nonnull
public FormBuilder label(@Nonnull
                                  String label)

Parameters:

label -

Returns:

label

@Nonnull
public FormBuilder label(@Nonnull
                                  Label label)

errorLocation

@Nonnull
public FormBuilder errorLocation(@Nonnull
                                          String errorLocation)

unlabeled

@Nonnull
public FormBuilder unlabeled()

readOnly

@Nonnull
public FormBuilder readOnly()

Returns:

readOnly

@Nonnull
public FormBuilder readOnly(boolean ro)

mandatory

@Nonnull
public FormBuilder mandatory()

mandatory

@Nonnull
public FormBuilder mandatory(boolean yes)

control

public void control(@Nonnull
                    IControl<?> control)
             throws Exception

Add the specified control. Since the control is manually created this code assumes that the control is properly configured for it's task! This means that this code will not make any changes to the control! Specifically: if the form item is marked as "mandatory" but the control here is not then the control stays optional. The reverse however is not true: if the control passed in is marked as mandatory then the form item will be marked as such too.

Parameters:

control -

Throws:

Exception

control

@Nonnull
public <T> IControl<?> control()
                                 throws Exception

Throws:

Exception

control

@Nonnull
public <T,C extends IControl<T>> C control(@Nullable
                                                    Class<C> controlClass)
                                             throws Exception

Throws:

Exception

converter

@Nonnull
public FormBuilder converter(@Nonnull
                                      IBindingConverter<?,?> converter)

cssControl

@Nonnull
public FormBuilder cssControl(@Nonnull
                                       String cssClass)

Adds the specified css class to the control cell.

Parameters:

cssClass -

Returns:

cssLabel

@Nonnull
public FormBuilder cssLabel(@Nonnull
                                     String cssClass)

Adds the specified css class to the label cell.

Parameters:

cssClass -

Returns:

item

public void item(@Nonnull
                 NodeBase item)
          throws Exception

Throws:

Exception

bindControlData

public <T,C extends IControl<T>> void bindControlData(@Nonnull
                                                      C control,
                                                      @Nonnull
                                                      PropertyMetaModel<T> pmm)
                                               throws Exception

Throws:

Exception

property

@Nonnull
public <T> FormBuilder property(@Nonnull
                                         T instance,
                                         String property)

nl

public FormBuilder nl()

body

@Nonnull
public TBody body()

appendAfterControl

public void appendAfterControl(@Nonnull
                               NodeBase what)

getLastControlCell

@Nonnull
public NodeContainer getLastControlCell()