to.etc.domui.component.input

Interface SearchInput.IQuery<T>

Enclosing class:

SearchInput<T>

public static interface SearchInput.IQuery<T>

Inner interface to define the query to execute to lookup data, and the handlers for completion events. Users of this control must define a handler and pass it to the control to make it work.

Author:

Frits Jalvingh Created on Aug 9, 2011

Method Summary

Modifier and Type	Method and Description
void	onEnter(String value) When a value is entered and ENTER is pressed in the input box this gets called with the literal string entered.
void	onSelect(T instance) When a literal value in the result combo is selected this will be called with that literal value.
List<T>	queryFromString(String input, int max) This gets called when it is time to lookup something.

Method Detail

queryFromString

List<T> queryFromString(String input,
                        int max)
                 throws Exception

This gets called when it is time to lookup something. The string entered in the text field is passed. This method must return the result as a list; the list should be at most (max+1) elements big; in that case the code will show "too many results". If the list is empty it will show "no results", in all other cases it will display the result's rows to select from. as an indicator.

Parameters:

input -

Returns:

Throws:

Exception

onSelect

void onSelect(T instance)
       throws Exception

When a literal value in the result combo is selected this will be called with that literal value. At that point the input box for this control will already have been cleared.

Parameters:

instance -

Throws:

Exception

onEnter

void onEnter(String value)
      throws Exception

When a value is entered and ENTER is pressed in the input box this gets called with the literal string entered. It can be used to either create or select some value. When called it should return true if the input box is to be cleared.

Parameters:

value -

Throws:

Exception