no.g9.client.core.util

Class AutoCompleteConfig

java.lang.Object

no.g9.client.core.util.AutoCompleteConfig

public class AutoCompleteConfig
extends Object

The AutoCompleteConfig is a configuration for a given autocomplete widget from the dialog model. The configuration values may be changed at runtime, but note that changing the result column names to an array with less entries than given in the dialog model may lead to an error, as the markup expects a given number of result columns present in the search result list.

Constructor Summary

Constructors

Constructor and Description
AutoCompleteConfig(DialogObjectConstant widget, String[] resultColumns, int minChars, int maxResults) Create a new AutoCompleteConfig with values for all fields.

Method Summary

Modifier and Type	Method and Description
int	getMaxResults() The maximum number of result list entries to return from the search.
int	getMinChars() The minimum number of characters to be entered before a search is triggered.
List<String>	getResultColumns() The result columns are the names of the columns used in the result list for the AutoComplete search.
DialogObjectConstant	getWidget() The AutoComplete widget.
void	setMaxResults(int maxResults)
void	setMinChars(int minChars)
void	setResultColumns(String[] resultColumns)
void	setWidget(DialogObjectConstant widget)

Methods inherited from class java.lang.Object

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

Constructor Detail

AutoCompleteConfig

public AutoCompleteConfig(DialogObjectConstant widget,
                          String[] resultColumns,
                          int minChars,
                          int maxResults)

Create a new AutoCompleteConfig with values for all fields.

Parameters:

widget - the autocomplete widget from the dialog model

resultColumns - the names of the result columns (to be shown in the result list)

minChars - the minimum number of characters to be entered before a search is triggered

maxResults - the maximum number of result list entries to return

Method Detail

getWidget

public DialogObjectConstant getWidget()

The AutoComplete widget.

Returns:

the widget

setWidget

public void setWidget(DialogObjectConstant widget)

Parameters:

widget - the AutoComplete widget

getResultColumns

public List<String> getResultColumns()

The result columns are the names of the columns used in the result list for the AutoComplete search.

Returns:

the resultColumns

setResultColumns

public void setResultColumns(String[] resultColumns)

Parameters:

resultColumns - the resultColumns to set

getMinChars

public int getMinChars()

The minimum number of characters to be entered before a search is triggered. The default is 1 if this is not given from the dialog model.

Returns:

the minChars

setMinChars

public void setMinChars(int minChars)

Parameters:

minChars - the minChars to set

getMaxResults

public int getMaxResults()

The maximum number of result list entries to return from the search. If 0, the result list is not limited.

Returns:

the maxResults

setMaxResults

public void setMaxResults(int maxResults)

Parameters:

maxResults - the maxResults to set