Package org.zkoss.zul

Class ListModels

java.lang.Object

org.zkoss.zul.ListModels

public class ListModels
extends Object

A utility for handling ListModel.

Since:

5.0.4

Author:

jumperchen

Field Summary

Fields

Modifier and Type	Field	Description
static final Comparator	MAP_COMPARATOR	A comparator for ListSubModel.getSubModel(java.lang.Object, int) to check if a value retrieved from the model matches the user typed.
static final Comparator	MAP_CONTAINS_COMPARATOR	A comparator for ListSubModel.getSubModel(java.lang.Object, int) to check if a value retrieved from the model matches the user typed.
static final Comparator	STRING_COMPARATOR	A comparator for ListSubModel.getSubModel(java.lang.Object, int) to check if a value retrieved from the model matches the user typed.
static final Comparator	STRING_CONTAINS_COMPARATOR	A comparator for ListSubModel.getSubModel(java.lang.Object, int) to check if a value retrieved from the model contains the user typed.

Method Summary

Modifier and Type	Method	Description
static int	getSubModelRows(ListModel<?> model)	Returns the maximal number of matched items the given model returns for a search: the nRows of a sub model created by toListSubModel(org.zkoss.zul.ListModel<T>, java.util.Comparator<T>, int), or SimpleListModel.getMaxNumberInSubModel(int) of a SimpleListModel.
static <T> ListModel<T>	toListSubModel(ListModel<T> model)	Returns a proxy instance of the given model that implements ListSubModel and ListModel interface.
static <T> ListModel<T>	toListSubModel(ListModel<T> model, int initRenderCount)	Returns a proxy instance of the given model that implements ListSubModel and ListModel interface.
static <T> ListModel<T>	toListSubModel(ListModel<T> model, Comparator<T> comparator, int nRows)	Returns a proxy instance of the given model that implements ListSubModel and ListModel interface.
static <T> ListModel<T>	toListSubModel(ListModel<T> model, Comparator<T> comparator, int nRows, int initRenderCount)	Returns a proxy instance of the given model that implements ListSubModel and ListModel interface.

Methods inherited from class java.lang.Object

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

Field Details

STRING_COMPARATOR

public static final Comparator STRING_COMPARATOR

A comparator for ListSubModel.getSubModel(java.lang.Object, int) to check if a value retrieved from the model matches the user typed. To compare, it will convert them to String instances, and return 0 (i.e., matched), when the value starts with the user typed, and both of them are not empty.

STRING_CONTAINS_COMPARATOR

public static final Comparator STRING_CONTAINS_COMPARATOR

A comparator for ListSubModel.getSubModel(java.lang.Object, int) to check if a value retrieved from the model contains the user typed. To compare, it will convert them to String instances, and return 0 (i.e., matched), when the value contains the user typed (case-insensitive), and both of them are not empty.

Since:

10.3.0

MAP_COMPARATOR

public static final Comparator MAP_COMPARATOR

A comparator for ListSubModel.getSubModel(java.lang.Object, int) to check if a value retrieved from the model matches the user typed. It assumes the model is Map, and the value is Map.Entry. To compare, it will convert them to String instances, and return 0 when the value (Map.Entry's getValue()) starts with the user typed, and both of them are not empty.

MAP_CONTAINS_COMPARATOR

public static final Comparator MAP_CONTAINS_COMPARATOR

A comparator for ListSubModel.getSubModel(java.lang.Object, int) to check if a value retrieved from the model matches the user typed. It assumes the model is Map, and the value is Map.Entry. To compare, it will convert them to String instances, and return 0 when the value (Map.Entry's getValue()) contains the user typed, and both of them are not empty.

Since:

10.3.0

Method Details

toListSubModel

public static <T> ListModel<T> toListSubModel(ListModel<T> model,
 Comparator<T> comparator,
 int nRows)

Returns a proxy instance of the given model that implements ListSubModel and ListModel interface.

Parameters:

model - a model

comparator - used to compare the value typed by user and the value from the model. The first argument is the value typed by user, and the second argument is the value retrieved from the model. It shall return 0 if they matched (i.e., shall be shown).

nRows - the maximal allowed number of matched items.

toListSubModel

public static <T> ListModel<T> toListSubModel(ListModel<T> model,
 Comparator<T> comparator,
 int nRows,
 int initRenderCount)

Returns a proxy instance of the given model that implements ListSubModel and ListModel interface.

Parameters:

model - a model

comparator - used to compare the value typed by user and the value from the model. The first argument is the value typed by user, and the second argument is the value retrieved from the model. It shall return 0 if they matched (i.e., shall be shown).

nRows - the maximal allowed number of matched items.

initRenderCount - the number of items to be rendered initially when the input is empty (Support for Chosenbox).

Since:

10.3.0

toListSubModel

public static <T> ListModel<T> toListSubModel(ListModel<T> model,
 int initRenderCount)

Returns a proxy instance of the given model that implements ListSubModel and ListModel interface.

The default comparator depends on the type of the model, if the model is an instance of ListModelMap, MAP_COMPARATOR is used. Otherwise, STRING_COMPARATOR is used.

If you want more control, use toListSubModel(ListModel, Comparator, int, int) instead.

Parameters:

model - a ListModel

initRenderCount - the number of items to be rendered initially when the input is empty (Support for Chosenbox).

Since:

10.3.0

See Also:

• toListSubModel(ListModel, Comparator, int, int)

toListSubModel

public static <T> ListModel<T> toListSubModel(ListModel<T> model)

Returns a proxy instance of the given model that implements ListSubModel and ListModel interface.

The default comparator depends on the type of the model, if the model is an instance of ListModelMap, MAP_COMPARATOR is used. Otherwise, STRING_COMPARATOR is used.

In additions, the maximal allowed number of matched items is 15.

If you want more control, use toListSubModel(ListModel, Comparator, int) instead.

Parameters:

model - a ListModel

See Also:

• toListSubModel(ListModel, Comparator, int)

getSubModelRows

public static int getSubModelRows(ListModel<?> model)

Returns the maximal number of matched items the given model returns for a search: the nRows of a sub model created by toListSubModel(org.zkoss.zul.ListModel<T>, java.util.Comparator<T>, int), or SimpleListModel.getMaxNumberInSubModel(int) of a SimpleListModel. Returns -1 for any other model.

Parameters:

model - the model to inspect

Since:

11.0.0