org.gwt.advanced.client.datamodel

Interface ListDataModel

All Known Implementing Classes:

ComboBoxDataModel, SuggestionBoxDataModel

public interface ListDataModel

This interface describes a list data model.

Each list data model should implement it. The interface provides several methods for list items manipulation. Each list item is a pair of unique String ID and an object to be displayed in the list.

Since:

1.2.0

Author:

Sergey Skladchikov

Method Summary

Methods

Modifier and Type	Method and Description
void	add(int index, String id, Object item) This method adds a new item into the specified position.
void	add(Map<String,Object> items) Adds all the items from the map where each key is an item unique ID and each value is an item itself.
void	add(String id, Object item) This method adds a new item in the list.
void	addListModelListener(ListModelListener listener) Adds a list model listener to fire events regarding data changes.
void	clear() This method clears the list of items.
Object	get(int index) This method returns an item by its index.
Object	get(String id) This method returns an item by its ID.
int	getCount() Returns a number of items in the list.
Object	getSelected() This method returns a selected item.
String	getSelectedId() This method gets a selected item ID.
int	getSelectedIndex() This method gets a selected item index.
boolean	isEmpty() This method returns true if the list of items is empty.
void	remove(int... indexes) This method removes items specified by the indexes.
void	remove(String... ids) This method removes the specified items.
void	removeListModelListener(ListModelListener listener) Removes a list model listener.
void	setSelectedId(String id) This method sets a currently selected item specifying it by ID.
void	setSelectedIndex(int index) This method sets a currently selected item specifying it by the index.

Method Detail

add

void add(String id,
       Object item)

This method adds a new item in the list.

Parameters:

id - an unique ID of the item. If there is an item with the same ID, this method replaces it with a new value.

item - is an item to be placed into the list.

add

void add(int index,
       String id,
       Object item)

This method adds a new item into the specified position.

If the index < 0 it adds a new item into the 0 position. If the index > number of existing items it adds an item into the end of this list.

Parameters:

index - is an index value.

id - is an item ID.

item - is an item.

get

Object get(String id)

This method returns an item by its ID.

Parameters:

id - is an item ID.

Returns:

an item.

get

Object get(int index)

This method returns an item by its index.

Parameters:

index - is an item index.

Returns:

an item.

remove

void remove(String... ids)

This method removes the specified items.

Parameters:

ids - is a list of item IDs.

remove

void remove(int... indexes)

This method removes items specified by the indexes.

Parameters:

indexes - is a list of item indexes.

getSelectedId

String getSelectedId()

This method gets a selected item ID.

Returns:

an item ID.

getSelectedIndex

int getSelectedIndex()

This method gets a selected item index.

Returns:

an item index.

getSelected

Object getSelected()

This method returns a selected item.

Returns:

a selected item.

setSelectedId

void setSelectedId(String id)

This method sets a currently selected item specifying it by ID.

Parameters:

id - is an item ID.

setSelectedIndex

void setSelectedIndex(int index)

This method sets a currently selected item specifying it by the index.

If the index < 0 it deselects any item. If the index > then list size, it selects the last item.

Parameters:

index - is an item index.

clear

void clear()

This method clears the list of items.

isEmpty

boolean isEmpty()

This method returns true if the list of items is empty.

Returns:

a result of check.

getCount

int getCount()

Returns a number of items in the list.

Returns:

a number of items.

addListModelListener

void addListModelListener(ListModelListener listener)

Adds a list model listener to fire events regarding data changes.

Parameters:

listener - is a listener to add.

removeListModelListener

void removeListModelListener(ListModelListener listener)

Removes a list model listener.

Parameters:

listener - is a listener to remove.

add

void add(Map<String,Object> items)

Adds all the items from the map where each key is an item unique ID and each value is an item itself.

Parameters:

items - is a map of items to add all.