to.etc.domui.component.form

Class GenericFormBuilder

java.lang.Object

to.etc.domui.component.form.FormBuilderBase

to.etc.domui.component.form.GenericFormBuilder

Direct Known Subclasses:

GenericTableFormBuilder

Deprecated.

@Deprecated
public abstract class GenericFormBuilder
extends FormBuilderBase

Deprecated: use FormBuilder. Encapsulates basic actions that can be done with all form builder implementations, and delegates the actual parts that require layout decisions to the actual implementation.

Author:

Frits Jalvingh Created on Aug 13, 2009

Field Summary

Fields inherited from class to.etc.domui.component.form.FormBuilderBase

LOG

Constructor Summary

Constructors

Constructor and Description
GenericFormBuilder() Deprecated. Default ctor.
GenericFormBuilder(Class<T> clz, IReadOnlyModel<T> mdl) Deprecated. Create one primed with a model and class.
GenericFormBuilder(T instance) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addContent(NodeBase item) Deprecated. Add any kind of content into the next "control area".
abstract void	addContent(NodeBase label, NodeBase[] control, boolean editable) Deprecated.
void	addContent(NodeBase label, NodeBase control, boolean editable) Deprecated.
void	addContent(String label, NodeBase control, boolean editable) Deprecated.
protected abstract void	addControl(NodeBase label, NodeBase labelnode, NodeBase[] list, boolean mandatory, boolean editable, PropertyMetaModel<?> pmm) Deprecated.
protected abstract void	addControl(String label, NodeBase labelnode, NodeBase[] list, boolean mandatory, boolean editable, PropertyMetaModel<?> pmm) Deprecated. This is the actual workhorse doing the per-builder actual placement and layouting of a {control, label} pair.
IControl<?>	addDisplayProp(String name) Deprecated. Add a display-only field for the specified property.
IControl<?>	addDisplayProp(String name, String label) Deprecated. Add an input for the specified property just as addProp(String, String), only this input won't be editable (ever).
<V,T extends NodeBase & IDisplayControl<V>> IControl<V>	addDisplayProp(String propertyname, T ctl) Deprecated.
IControl<?>[]	addDisplayProps(String... names) Deprecated. Add the specified properties to the form as display-only properties, in the current mode.
void	addLabelAndControl(Label label, String errorLocation, NodeBase control, boolean mandatory) Deprecated. Add a fully manually specified label and control to the layout.
void	addLabelAndControl(String label, NodeBase control, boolean mandatory) Deprecated. Add a fully manually specified label and control to the layout.
protected abstract IControl<?>[]	addListOfProperties(boolean editable, String... names) Deprecated. Handle placement of a list of property names, all obeying the current mode in effect.
<T> IControl<T>	addProp(QField<?,T> field) Deprecated.
IControl<?>	addProp(String name) Deprecated. Add an input for the specified property.
IControl<?>	addProp(String name, boolean editable) Deprecated. Add an input for the specified property.
IControl<?>	addProp(String name, boolean editable, boolean mandatory) Deprecated. Add an input for the specified property.
IControl<?>	addProp(String name, String label) Deprecated. Add an input for the specified property.
<C> IControl<C>	addProp(String name, String label, boolean editable, boolean mandatory) Deprecated. Add an input for the specified property.
<V,T extends NodeBase & IControl<V>> IControl<V>	addProp(String name, String label, T ctl) Deprecated. Add a user-specified control for a given property.
<V,T extends NodeBase & IControl<V>> IControl<V>	addProp(String propertyname, T ctl) Deprecated. Add a user-specified control for a given property.
void	addPropertyAndControl(String propertyName, NodeBase nb, boolean mandatory) Deprecated. This adds a fully user-specified control for a given property with it's default label, without creating any binding.
protected <C> IControl<C>	addPropertyControl(String name, String label, PropertyMetaModel<C> pmm, boolean editable, boolean editableFixed) Deprecated.
IControl<?>[]	addProps(String... names) Deprecated. Add the specified properties to the form, in the current mode.

Methods inherited from class to.etc.domui.component.form.FormBuilderBase

createControlFor, getBindings, getBuilder, getClassMeta, getControlLabelFactory, getCurrentInputClass, getModel, resolveProperty, setBindings, setClassModel, setControlLabelFactory, setInstance, setMetaModel, updateReadOnly

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericFormBuilder

public GenericFormBuilder()

Deprecated.

Default ctor.

GenericFormBuilder

public GenericFormBuilder(Class<T> clz,
                          IReadOnlyModel<T> mdl)

Deprecated.

Create one primed with a model and class.

Type Parameters:

T -

Parameters:

clz -

mdl -

GenericFormBuilder

public GenericFormBuilder(T instance)

Deprecated.

Type Parameters:

T -

Parameters:

instance -

Method Detail

addControl

protected abstract void addControl(String label,
                                   NodeBase labelnode,
                                   NodeBase[] list,
                                   boolean mandatory,
                                   boolean editable,
                                   PropertyMetaModel<?> pmm)

Deprecated.

This is the actual workhorse doing the per-builder actual placement and layouting of a {control, label} pair.

Parameters:

label -

labelnode -

list -

mandatory - T when the node is mandatory, needed by the label factory

editable - T when the node is editable, needed by the label factory

pmm -

addControl

protected abstract void addControl(NodeBase label,
                                   NodeBase labelnode,
                                   NodeBase[] list,
                                   boolean mandatory,
                                   boolean editable,
                                   PropertyMetaModel<?> pmm)

Deprecated.

addContent

public abstract void addContent(NodeBase label,
                                NodeBase[] control,
                                boolean editable)

Deprecated.

addContent

public void addContent(@Nonnull
                       NodeBase item)

Deprecated.

Add any kind of content into the next "control area". The content can be anything but none of it is "maintained" by the formbuilder. Adding the content can be combined with the usual layout methods to force explicit placement of the item added here.

Parameters:

item -

addListOfProperties

protected abstract IControl<?>[] addListOfProperties(boolean editable,
                                                     String... names)

Deprecated.

Handle placement of a list of property names, all obeying the current mode in effect.

Parameters:

editable -

names -

addProp

public IControl<?> addProp(String name)

Deprecated.

Add an input for the specified property. The property is based at the current input class. The input model is default (using metadata) and the property is labeled using the metadata-provided label. FORMAL-INTERFACE.

Parameters:

name -

addProp

public <T> IControl<T> addProp(QField<?,T> field)

Deprecated.

Parameters:

field -

Returns:

addProp

public IControl<?> addProp(String name,
                           String label)

Deprecated.

Add an input for the specified property. The property is based at the current input class. The input model is default (using metadata) and the property is labeled. FORMAL-INTERFACE.

Parameters:

name -

label - The label text to use. Use the empty string to prevent a label from being generated. This still adds an empty cell for the label though.

addProp

@Nonnull
public <C> IControl<C> addProp(String name,
                                        String label,
                                        boolean editable,
                                        boolean mandatory)

Deprecated.

Add an input for the specified property. The property is based at the current input class. The input model is default (using metadata) and the property is labeled using the metadata-provided label. FORMAL-INTERFACE.

Parameters:

name -

label - Add custom label.

editable - When false this adds a display-only field, when true a fully editable control.

mandatory - Specify if field is mandatory. This always overrides the mandatoryness of the metadata which is questionable.

addProp

public IControl<?> addProp(String name,
                           boolean editable)

Deprecated.

Add an input for the specified property. The property is based at the current input class. The input model is default (using metadata) and the property is labeled using the metadata-provided label. FORMAL-INTERFACE.

Parameters:

name -

editable - When false add a display-only control, else add an editable control.

addProp

public IControl<?> addProp(String name,
                           boolean editable,
                           boolean mandatory)

Deprecated.

Add an input for the specified property. The property is based at the current input class. The input model is default (using metadata) and the property is labeled using the metadata-provided label. FORMAL-INTERFACE.

Parameters:

name -

editable - When false this adds a display-only field, when true a fully editable control.

mandatory - Specify if field is mandatory. This always overrides the mandatoryness of the metadata which is questionable.

addContent

public void addContent(NodeBase label,
                       NodeBase control,
                       boolean editable)

Deprecated.

addContent

public void addContent(String label,
                       NodeBase control,
                       boolean editable)

Deprecated.

addDisplayProp

public IControl<?> addDisplayProp(String name)

Deprecated.

Add a display-only field for the specified property. The field cannot be made editable.

Parameters:

name -

addDisplayProp

public IControl<?> addDisplayProp(String name,
                                  String label)

Deprecated.

Add an input for the specified property just as addProp(String, String), only this input won't be editable (ever).

Parameters:

name -

label -

addProp

public <V,T extends NodeBase & IControl<V>> IControl<V> addProp(String propertyname,
                                                                T ctl)

Deprecated.

Add a user-specified control for a given property. This adds the control, using the property-specified label and creates a binding for the property on the control. If you only want to add the proper structure and find the label for a property use addPropertyAndControl(String, NodeBase, boolean). FORMAL-INTERFACE.

Parameters:

propertyname -

ctl -

addDisplayProp

public <V,T extends NodeBase & IDisplayControl<V>> IControl<V> addDisplayProp(String propertyname,
                                                                              T ctl)

Deprecated.

addProp

public <V,T extends NodeBase & IControl<V>> IControl<V> addProp(String name,
                                                                String label,
                                                                T ctl)

Deprecated.

Add a user-specified control for a given property. This adds the control, using the specified label and creates a binding for the property on the control. FORMAL-INTERFACE.

Parameters:

name -

label - The label text to use. Use the empty string to prevent a label from being generated. This still adds an empty cell for the label though.

ctl -

addLabelAndControl

public void addLabelAndControl(String label,
                               NodeBase control,
                               boolean mandatory)

Deprecated.

Add a fully manually specified label and control to the layout. This does not create any binding.

Parameters:

label -

control -

mandatory -

addLabelAndControl

public void addLabelAndControl(Label label,
                               String errorLocation,
                               NodeBase control,
                               boolean mandatory)

Deprecated.

Add a fully manually specified label and control to the layout. This does not create any binding. Since label caption can contain extra characters, error location can be assigned additionaly.

Parameters:

label -

errorLocation -

control -

mandatory -

addPropertyControl

protected <C> IControl<C> addPropertyControl(String name,
                                             String label,
                                             PropertyMetaModel<C> pmm,
                                             boolean editable,
                                             boolean editableFixed)

Deprecated.

Parameters:

name -

label -

pmm -

editable - when false, the rendered control will be display-only.

Returns:

If the property was created and is controllable this will return an IControl instance. This will explicitly not be created if the control is display-only, not allowed by permissions or simply uncontrollable (the last one is uncommon).

addPropertyAndControl

public void addPropertyAndControl(String propertyName,
                                  NodeBase nb,
                                  boolean mandatory)

Deprecated.

This adds a fully user-specified control for a given property with it's default label, without creating any binding. The only reason the property is passed is to use it's metadata to define it's access rights and default label.

Parameters:

propertyName -

nb -

mandatory -

addProps

public IControl<?>[] addProps(String... names)

Deprecated.

Add the specified properties to the form, in the current mode. Watch out: if a MODIFIER is in place the modifier is obeyed for all properties, not for the first one only!! This means that when this gets called like:

        f.append().addProps("a", "b","c");
 

all three fields are appended to the current row. FORMAL-INTERFACE.

Parameters:

names -

addDisplayProps

public IControl<?>[] addDisplayProps(String... names)

Deprecated.

Add the specified properties to the form as display-only properties, in the current mode. Watch out: if a MODIFIER is in place the modifier is obeyed for all properties, not for the first one only!! This means that when this gets called like:

        f.append().addProps("a", "b","c");
 

all three fields are appended to the current row. FORMAL-INTERFACE.

Parameters:

names -