org.gwt.advanced.client.datamodel

Class ListModelEvent

java.lang.Object

org.gwt.advanced.client.datamodel.ListModelEvent

Direct Known Subclasses:

SuggestionModelEvent

public class ListModelEvent
extends Object

This is a model event that is sent by the ListDataModel implementations if anything is changed in encapsulated data.

Since:

1.4.9

Author:

Sergey Skladchikov

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ListModelEvent.EventType Event type class It's in use because older versions of GWT don't support enums.

Field Summary

Fields

Modifier and Type	Field and Description
static ListModelEvent.EventType	ADD_ITEM item added
static ListModelEvent.EventType	CLEAN all data removed
static ListModelEvent.EventType	REMOVE_ITEM item removed
static ListModelEvent.EventType	SELECT_ITEM item selected

Constructor Summary

Constructors

Constructor and Description
ListModelEvent(ListDataModel source, ListModelEvent.EventType type) Creates an instance of this class.
ListModelEvent(ListDataModel source, Map<String,Integer> itemIndexes, ListModelEvent.EventType type) Creates an instance of this class.
ListModelEvent(ListDataModel source, String itemId, int itemIndex, ListModelEvent.EventType type) Creates an instance of this class.

Method Summary

Methods

Modifier and Type	Method and Description
String	getItemId() Gets a related item ID.
int	getItemIndex() Gets a related item index.
Map<String,Integer>	getItemIndexes() This method gets a map of affected item indexes mapped to their IDs.
ListDataModel	getSource() Gets an event source data model.
ListModelEvent.EventType	getType() Gets an event type that specifies what exactly happened.

Methods inherited from class java.lang.Object

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

Field Detail

ADD_ITEM

public static final ListModelEvent.EventType ADD_ITEM

item added

REMOVE_ITEM

public static final ListModelEvent.EventType REMOVE_ITEM

item removed

CLEAN

public static final ListModelEvent.EventType CLEAN

all data removed

SELECT_ITEM

public static final ListModelEvent.EventType SELECT_ITEM

item selected

Constructor Detail

ListModelEvent

public ListModelEvent(ListDataModel source,
              ListModelEvent.EventType type)

Creates an instance of this class.

Mostly applicable for types like CLEAN which don't require to specify a concrete item.

Parameters:

source - is a data model produced this event.

type - is an event type.

ListModelEvent

public ListModelEvent(ListDataModel source,
              String itemId,
              int itemIndex,
              ListModelEvent.EventType type)

Creates an instance of this class.

Mostly applicable for types like ADD_ITEM, REMOVE_ITEM or SELECT_ITEM which require to specify a concrete item.

Parameters:

source - is a data model produced this event.

itemId - is a related item ID.

itemIndex - is a related item index (usually index of the item identified with itemId.

type - is an event type.

ListModelEvent

public ListModelEvent(ListDataModel source,
              Map<String,Integer> itemIndexes,
              ListModelEvent.EventType type)

Creates an instance of this class.

Mostly applicable for types like ADD_ITEM, REMOVE_ITEM or SELECT_ITEM which require to specify a concrete item.

use this constructor if you want to notify listeners about bulk model update.

Parameters:

source - is a data model produced this event.

itemIndexes - is a list of indexes mapped to their IDs. It must contain items which were affected by model change.

type - is an event type.

Method Detail

getSource

public ListDataModel getSource()

Gets an event source data model.

Returns:

a list data model.

getItemId

public String getItemId()

Gets a related item ID.

Might be equal to null for those events which are not related to a concrete item.

If there are several affected items it gets an ID of the first one.

Returns:

an item ID.

getItemIndex

public int getItemIndex()

Gets a related item index.

Might be equal to -1 for those events which are not related to a concrete item.

If there are several affected items it gets an ID of the first one.

Returns:

an item ID.

getItemIndexes

public Map<String,Integer> getItemIndexes()

This method gets a map of affected item indexes mapped to their IDs.

Returns:

a map of item indexes with IDs.

getType

public ListModelEvent.EventType getType()

Gets an event type that specifies what exactly happened.

Returns:

an event type.