to.etc.domui.component.lookup

Interface ILookupControlInstance<T>

All Known Implementing Classes:

AbstractLookupControlImpl, BaseAbstractLookupControlImpl, EqLookupControlImpl, LookupNumberControl

public interface ILookupControlInstance<T>

Encapsulates a single created lookup "part" in the lookup form, and defines the possible actions that we can define on it. This should be able to return it's presentation, and it should be able to add it's restrictions (caused by the user entering data in it's controls) to a QCriteria.

Author:

Frits Jalvingh Created on Jul 31, 2009

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ILookupControlInstance.AppendCriteriaResult Represents result of appendCriteria(QCriteria).

Method Summary

Modifier and Type	Method and Description
ILookupControlInstance.AppendCriteriaResult	appendCriteria(QCriteria<?> crit) Evaluate the contents of the input for this lookup line; if the user has added data there then add the values to the query.
void	clearInput() When called this should clear all data input into the control instances, causing them to be empty (not adding to the restrictions set).
NodeBase[]	getInputControls() Return all of the nodes (input and otherwise) that together form the complete visual representation of this lookup line.
NodeBase	getLabelControl() Returns the control where the label should be attached to.
T	getValue() Return the value entered into this control.
void	setDisabled(boolean disabled) Sets the input(s) to disabled state.
void	setValue(T value) Sets the value in the control

Method Detail

getInputControls

NodeBase[] getInputControls()

Return all of the nodes (input and otherwise) that together form the complete visual representation of this lookup line. This may NOT return null OR an empty list.

Returns:

getLabelControl

NodeBase getLabelControl()

Returns the control where the label should be attached to. Can return null, in that case the first IInput control or the first node in the list will be used.

Returns:

setDisabled

void setDisabled(boolean disabled)

Sets the input(s) to disabled state.

Parameters:

disabled -

clearInput

void clearInput()

When called this should clear all data input into the control instances, causing them to be empty (not adding to the restrictions set).

appendCriteria

ILookupControlInstance.AppendCriteriaResult appendCriteria(@Nonnull
                                                           QCriteria<?> crit)
                                                    throws Exception

Evaluate the contents of the input for this lookup line; if the user has added data there then add the values to the query.

Parameters:

crit -

Returns:

see ILookupControlInstance.AppendCriteriaResult

Throws:

Exception

getValue

@Nullable
T getValue()

Return the value entered into this control. This may return null.

Returns:

setValue

void setValue(@Nullable
              T value)
       throws Exception

Sets the value in the control

Parameters:

value -

Throws:

Exception