ComboBoxDataModel (Advanced GWT Components 2.0.9 API)

java.lang.Object
- org.gwt.advanced.client.datamodel.ComboBoxDataModel

All Implemented Interfaces:

ListDataModel

Direct Known Subclasses:

SuggestionBoxDataModel
```
public class ComboBoxDataModel
extends Object
implements ListDataModel
```
This is an implementation of the data model interface for the ComboBox widget.

Since:

1.2.0

Author:

Sergey Skladchikov

Constructor Summary

Constructors
Constructor and Description

ComboBoxDataModel()

Constructors
Constructor and Description
`ComboBoxDataModel()`

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.
`protected void`	`addInternally(String id, Object item)` Adds a new item into the list without firing an event.
`void`	`addListModelListener(ListModelListener listener)` This method registers a list data model listener.
`void`	`clear()` This method clears the list of items.
`protected void`	`fireEvent(ListModelEvent event)` This method fires the specified event and invokes the listeners.
`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.
`protected List<String>`	`getItemIds()` Getter for property 'itemIds'.
`protected Map<String,Object>`	`getItems()` Getter for property 'items'.
`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.
`protected int`	`getValidIndex(int invalidIndex)` This method calculates a valid index value taking into account the following rule: if the index < 0, it returns 0; if the index > then `getItemIds()` size, it returns `getItemIds()` size.
`boolean`	`isEmpty()` This method returns `true` if the list of items is empty.
`protected boolean`	`isIndexValid(int index)` This method checks whether the specified index is valid.
`void`	`remove(int... indexes)` This method removes items specified by the indexes.
`void`	`remove(String... ids)` This method removes the specified items.
`protected int`	`removeInternally(String id)` This method removes one item without sending any event.
`void`	`removeListModelListener(ListModelListener listener)` This method unregisters the specified 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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ComboBoxDataModel
```
public ComboBoxDataModel()
```
- Method Detail
  - add
```
public void add(String id,
       Object item)
```
    This method adds a new item in the list.
    
    Specified by:
    
    add in interface ListDataModel
    
    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
```
public 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.
    
    Specified by:
    
    add in interface ListDataModel
    
    Parameters:
    index - is an index value.
    id - is an item ID.
    item - is an item.
  - add
```
public 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.
    
    Specified by:
    
    add in interface ListDataModel
    
    Parameters:
    items - is a map of items to add all.
  - get
```
public Object get(String id)
```
    This method returns an item by its ID.
    
    Specified by:
    
    get in interface ListDataModel
    
    Parameters:
    id - is an item ID.
    
    Returns:
    an item.
  - get
```
public Object get(int index)
```
    This method returns an item by its index.
    
    Specified by:
    
    get in interface ListDataModel
    
    Parameters:
    index - is an item index.
    
    Returns:
    an item.
  - remove
```
public void remove(String... ids)
```
    This method removes the specified items.
    
    Specified by:
    
    remove in interface ListDataModel
    
    Parameters:
    ids - is a list of item IDs.
  - remove
```
public void remove(int... indexes)
```
    This method removes items specified by the indexes.
    
    Specified by:
    
    remove in interface ListDataModel
    
    Parameters:
    indexes - is a list of item indexes.
  - getSelectedId
```
public String getSelectedId()
```
    This method gets a selected item ID.
    
    Specified by:
    
    getSelectedId in interface ListDataModel
    
    Returns:
    an item ID.
  - getSelectedIndex
```
public int getSelectedIndex()
```
    This method gets a selected item index.
    
    Specified by:
    
    getSelectedIndex in interface ListDataModel
    
    Returns:
    an item index.
  - getSelected
```
public Object getSelected()
```
    This method returns a selected item.
    
    Specified by:
    
    getSelected in interface ListDataModel
    
    Returns:
    a selected item.
  - setSelectedId
```
public void setSelectedId(String id)
```
    This method sets a currently selected item specifying it by ID.
    
    Specified by:
    
    setSelectedId in interface ListDataModel
    
    Parameters:
    id - is an item ID.
  - setSelectedIndex
```
public 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.
    
    Specified by:
    
    setSelectedIndex in interface ListDataModel
    
    Parameters:
    index - is an item index.
  - clear
```
public void clear()
```
    This method clears the list of items.
    
    Specified by:
    
    clear in interface ListDataModel
  - isEmpty
```
public boolean isEmpty()
```
    This method returns true if the list of items is empty.
    
    Specified by:
    
    isEmpty in interface ListDataModel
    
    Returns:
    a result of check.
  - getCount
```
public int getCount()
```
    Returns a number of items in the list.
    
    Specified by:
    
    getCount in interface ListDataModel
    
    Returns:
    a number of items.
  - addListModelListener
```
public void addListModelListener(ListModelListener listener)
```
    This method registers a list data model listener.
    
    Specified by:
    
    addListModelListener in interface ListDataModel
    
    Parameters:
    listener - is a listener to be invoked on any event.
  - removeListModelListener
```
public void removeListModelListener(ListModelListener listener)
```
    This method unregisters the specified listener.
    
    Specified by:
    
    removeListModelListener in interface ListDataModel
    
    Parameters:
    listener - is a listener to be unregistered.
  - fireEvent
```
protected void fireEvent(ListModelEvent event)
```
    This method fires the specified event and invokes the listeners.
    
    Parameters:
    event - is an event to fire.
  - addInternally
```
protected void addInternally(String id,
                 Object item)
```
    Adds a new item into the list without firing an event.
    
    Parameters:
    id - is an item ID to add.
    item - is an item itself.
  - removeInternally
```
protected int removeInternally(String id)
```
    This method removes one item without sending any event.
    
    Parameters:
    id - is an ID of the item to remove.
    
    Returns:
    an index of the item that was removed.
  - getItemIds
```
protected List<String> getItemIds()
```
    Getter for property 'itemIds'.
    
    Returns:
    Value for property 'itemIds'.
  - getItems
```
protected Map<String,Object> getItems()
```
    Getter for property 'items'.
    
    Returns:
    Value for property 'items'.
  - isIndexValid
```
protected boolean isIndexValid(int index)
```
    This method checks whether the specified index is valid.
    
    Parameters:
    index - is an index value to check.
    
    Returns:
    true if the index is valid.
  - getValidIndex
```
protected int getValidIndex(int invalidIndex)
```
    This method calculates a valid index value taking into account the following rule: if the index < 0, it returns 0; if the index > then getItemIds() size, it returns getItemIds() size.
    
    Parameters:
    invalidIndex - is an index.
    
    Returns:
    a valid index value.

Class ComboBoxDataModel

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ComboBoxDataModel

Method Detail

add

add

add

get

get

remove

remove

getSelectedId

getSelectedIndex

getSelected

setSelectedId

setSelectedIndex

clear

isEmpty

getCount

addListModelListener

removeListModelListener

fireEvent

addInternally

removeInternally

getItemIds

getItems

isIndexValid

getValidIndex