to.etc.domui.component.controlfactory

Class ControlBuilder

java.lang.Object

to.etc.domui.component.controlfactory.ControlBuilder

public class ControlBuilder
extends Object

This singleton, reachable from DomApplication, maintains all metadata control builder lists and contains code to create controls from factories et al.

Author:

Frits Jalvingh Created on Aug 18, 2009

Constructor Summary

Constructors

Constructor and Description
ControlBuilder(DomApplication app)

Method Summary

Modifier and Type	Method and Description
void	addErrorFragment(NodeContainer nc)
ComboFixed<?>	createComboFor(Class<?> dataClass, String property, boolean editable) This creates a ComboFixed for some fixed-size domain property specified by the metamodel.
<T> ComboFixed<T>	createComboFor(Class<T> type) This creates a ComboFixed for some fixed-size domain class specified by type.
ComboFixed<?>	createComboFor(PropertyMetaModel<?> pmm, boolean editable) This creates a ComboFixed for some fixed-size domain property specified by the metamodel.
<T> T	createControl(Class<T> controlClass, Class<?> dataClass, String propertyName, boolean editable)
<T> T	createControl(Class<T> controlClass, PropertyMetaModel<?> pmm, boolean editable)
ControlFactoryResult	createControlFor(IReadOnlyModel<?> model, PropertyMetaModel<?> pmm, boolean editable) Deprecated.
ControlFactoryResult	createControlFor(PropertyMetaModel<?> pmm, boolean editable, Class<?> controlClass)
PropertyControlFactory	findControlFactory(PropertyMetaModel<?> pmm, boolean editable, Class<?> controlClass) Find the best control factory to use to create a control for the given property and mode.
ILookupControlFactory	findLookupControlFactory(SearchPropertyMetaModel pmm)
PropertyControlFactory	getControlFactory(PropertyMetaModel<?> pmm, boolean editable, Class<?> controlClass) Find the best control factory to use to create a control for the given property and mode, throws an Exception if the factory cannot be found.
protected List<PropertyControlFactory>	getControlFactoryList()
IControlLabelFactory	getControlLabelFactory()
IControlErrorFragmentFactory	getErrorFragmentfactory()
ILookupControlFactory	getLookupControlFactory(SearchPropertyMetaModel pmm)
<T,X extends NodeBase & IControl<T>> ILookupControlFactory	getLookupQueryFactory(SearchPropertyMetaModel pmm, X control)
void	register(ILookupControlFactory f) Add another LookupControlFactory to the registry.
void	registerControlFactory(PropertyControlFactory cf)
void	setControlLabelFactory(IControlLabelFactory controlLabelFactory)
void	setErrorFragmentfactory(IControlErrorFragmentFactory errorFragmentfactory)

Methods inherited from class java.lang.Object

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

Constructor Detail

ControlBuilder

public ControlBuilder(@Nonnull
                      DomApplication app)

Method Detail

registerControlFactory

public void registerControlFactory(@Nonnull
                                   PropertyControlFactory cf)

Parameters:

cf -

getControlFactoryList

@Nonnull
protected List<PropertyControlFactory> getControlFactoryList()

findControlFactory

public PropertyControlFactory findControlFactory(@Nonnull
                                                 PropertyMetaModel<?> pmm,
                                                 boolean editable,
                                                 @Nullable
                                                 Class<?> controlClass)

Find the best control factory to use to create a control for the given property and mode.

Parameters:

pmm - The property to find a control for

editable - When false this is a displayonly control request.

Returns:

null if no factory is found.

getControlFactory

@Nonnull
public PropertyControlFactory getControlFactory(@Nonnull
                                                         PropertyMetaModel<?> pmm,
                                                         boolean editable,
                                                         @Nullable
                                                         Class<?> controlClass)

Find the best control factory to use to create a control for the given property and mode, throws an Exception if the factory cannot be found.

Parameters:

pmm -

editable -

Returns:

The factory to use

getControlLabelFactory

@Nonnull
public IControlLabelFactory getControlLabelFactory()

Returns:

setControlLabelFactory

public void setControlLabelFactory(@Nonnull
                                   IControlLabelFactory controlLabelFactory)

getErrorFragmentfactory

@Nonnull
public IControlErrorFragmentFactory getErrorFragmentfactory()

setErrorFragmentfactory

public void setErrorFragmentfactory(@Nonnull
                                    IControlErrorFragmentFactory errorFragmentfactory)

addErrorFragment

public void addErrorFragment(@Nonnull
                             NodeContainer nc)

register

public void register(@Nonnull
                     ILookupControlFactory f)

Add another LookupControlFactory to the registry.

Parameters:

f -

findLookupControlFactory

@Nullable
public ILookupControlFactory findLookupControlFactory(@Nonnull
                                                                SearchPropertyMetaModel pmm)

getLookupControlFactory

@Nonnull
public ILookupControlFactory getLookupControlFactory(@Nonnull
                                                              SearchPropertyMetaModel pmm)

getLookupQueryFactory

@Nonnull
public <T,X extends NodeBase & IControl<T>> ILookupControlFactory getLookupQueryFactory(@Nonnull
                                                                                                 SearchPropertyMetaModel pmm,
                                                                                                 @Nonnull
                                                                                                 X control)

createControlFor

@Deprecated
 @Nonnull
public ControlFactoryResult createControlFor(@Nonnull
                                                                   IReadOnlyModel<?> model,
                                                                   @Nonnull
                                                                   PropertyMetaModel<?> pmm,
                                                                   boolean editable)

Deprecated.

Main workhorse which creates input controls for forms, from metadata.

createControlFor

@Nonnull
public ControlFactoryResult createControlFor(@Nonnull
                                                      PropertyMetaModel<?> pmm,
                                                      boolean editable,
                                                      @Nullable
                                                      Class<?> controlClass)

createControl

public <T> T createControl(@Nonnull
                           Class<T> controlClass,
                           @Nonnull
                           Class<?> dataClass,
                           @Nonnull
                           String propertyName,
                           boolean editable)

Type Parameters:

T -

Parameters:

controlClass -

dataClass -

propertyName -

editableWhen -

Returns:

createControl

public <T> T createControl(@Nonnull
                           Class<T> controlClass,
                           @Nonnull
                           PropertyMetaModel<?> pmm,
                           boolean editable)

Type Parameters:

T -

Parameters:

controlClass -

dataClass -

pmm -

editable -

Returns:

createComboFor

public <T> ComboFixed<T> createComboFor(Class<T> type)

This creates a ComboFixed for some fixed-size domain class specified by type. This will allow any domain-valued type (as specified by metadata returning something for getDomainValues()). The domain value translations are done by class metadata only because the originating property is not known. This may cause values to be misrepresented.

Type Parameters:

T -

Returns:

createComboFor

@Nonnull
public ComboFixed<?> createComboFor(PropertyMetaModel<?> pmm,
                                             boolean editable)

This creates a ComboFixed for some fixed-size domain property specified by the metamodel. This will allow any domain-valued type (as specified by metadata returning something for getDomainValues()). This version will properly use per-property value labels if defined.

Parameters:

pmm -

Returns:

createComboFor

public ComboFixed<?> createComboFor(Class<?> dataClass,
                                    String property,
                                    boolean editable)

This creates a ComboFixed for some fixed-size domain property specified by the metamodel. This will allow any domain-valued type (as specified by metadata returning something for getDomainValues()). This version will properly use per-property value labels if defined.

Parameters:

dataClass - The class whose property is to be looked up

property - The property path

Returns: