ItemList (XDEV Application Framework 5.0.2 API)

java.lang.Object
- xdev.ui.ItemList

All Implemented Interfaces:

Cloneable, Copyable<ItemList>
```
public class ItemList
extends Object
implements Copyable<ItemList>
```
The ItemList is the backend for some ListModels in XDEV.
The ItemList consists of entries (ItemList.Entry) which provide two stores: item and data. The item is used to display the list entry in a GUI component. The data object is not displayed and used as a hidden store for data like ids or references.

Since:

2.0

Author:

XDEV Software

See Also:

XdevListBox, XdevComboBox, XdevListBox.setItemList(ItemList), XdevComboBox.setItemList(ItemList)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ItemList.Entry` An entry in an `ItemList` holding a data object a display item an icon settings: enabled and client properties

Constructor Summary

Constructors
Constructor and Description
`ItemList()` Creates a new empty `ItemList`.
`ItemList(Collection<?> item, Collection<?> data)` Creates a new `ItemList` based on the provided `List`s `item` and `data`.
`ItemList(Collection<? extends ItemList.Entry> entries)`
`ItemList(ListModel model)` Create a new `ItemList` based on the provided `ListModel`.
`ItemList(Object[] item, Object[] data)` Creates a new `ItemList` based on the provided arrays `item` and `data`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(int index, ItemList.Entry entry)` Adds the entry at the specified `index` to this `ItemList`.
`void`	`add(int index, String item, Object data)` Adds a new row / item data pair at the specified `index` to this `ItemList`.
`void`	`add(ItemList.Entry entry)` Adds the `entry` to the end of this `ItemList`.
`void`	`add(String item, Object data)` Adds a new row / item data pair to the end of this `ItemList`.
`void`	`addAll(Collection<?> item, Collection<?> data)` Adds all entries of `item` and `data` to this `ItemList`.
`void`	`addAll(Collection<? extends ItemList.Entry> entries)` Adds all `entries` to this `ItemList`.
`void`	`addAll(ItemList il)` Adds all entries of given `ItemList` `il` to this `ItemList`.
`void`	`addAll(ListModel model)` Adds all entries of the `model` to this `ItemList`.
`void`	`addListDataListener(ListDataListener listener)` Adds a `ListDataListener` to this `ItemList`.
`void`	`clear()` Removes all of the elements from this `ItemList`.
`ItemList`	`clone()` Returns a field-for-field copy of this instance.
`boolean`	`contains(ItemList.Entry entry)` Returns `true` if this `ItemList` contains the specified `entry`.
`boolean`	`containsData(Object data)` Returns `true` if this `ItemList` contains the specified `data`.
`boolean`	`containsItem(Object item)` Returns `true` if this `ItemList` contains the specified `item`.
`ItemList`	`copy()` Creates a (defensive) copy of this `ItemList`.
`protected void`	`fireContentsChanged(int index0, int index1)`
`protected void`	`fireIntervalAdded(int index0, int index1)`
`protected void`	`fireIntervalRemoved(int index0, int index1)`
`ItemList.Entry`	`get(int index)` Returns the entry at the specified position in this `ItemList`.
`Object`	`getData(int index)` Returns the data at the specified position in this `ItemList`.
`List`	`getDataAsList()` Returns a `List` containing all `data`s of this `ItemList`.
`Object`	`getItem(int index)` Returns the item at the specified position in this `ItemList`.
`List`	`getItemsAsList()` Returns a `List` containing all `item`s of this `ItemList`.
`VirtualTable`	`getVirtualTable()` Returns the `VirtualTable` which was associated via `setModel(VirtualTable, String, String)`, or `null` if no `VirtualTable` has been associated yet.
`int`	`indexOfData(Object data)` Returns the index of the first occurrence of the specified `data` in this list, or -1 if this `ItemList` does not contain the `data`.
`int`	`indexOfItem(Object item)` Returns the index of the first occurrence of the specified `item` in this list, or -1 if this `ItemList` does not contain the `item`.
`void`	`refresh()` Reloads the data from the underlying data source with the last executed resp.
`ItemList.Entry`	`remove(int index)` Removes the element at the specified position in this `ItemList`.
`ItemList.Entry[]`	`removeAll(int... indices)` Removes the elements at the specified positions in this `ItemList`.
`void`	`removeListDataListener(ListDataListener listener)` Removes the `ListDataListener` from this `ItemList`.
`void`	`setModel(VirtualTable vt, String itemCol, String dataCol)` Adds all row data (formatted) of the given `VirtualTable` `vt` to this `ItemList`.
`void`	`setModel(VirtualTable vt, String itemCol, String dataCol, boolean queryData)` Adds all row data (formatted) of the given `VirtualTable` `vt` to this `ItemList`.
`void`	`setModel(VirtualTable vt, String itemCol, String dataCol, boolean queryData, boolean selectiveQuery)` Adds all row data (formatted) of the given `VirtualTable` `vt` to this `ItemList`.
`void`	`setModel(VirtualTable vt, String itemCol, String dataCol, SELECT select, Object... params)` Adds all row data (formatted) of the given `VirtualTable` `vt` to this `ItemList`.
`void`	`setSize(int size)` Sets the size of this `ItemList`.
`int`	`size()` Returns the size of the list.
`void`	`syncWithVT()` public @since 4.0
`String`	`toString()`
`void`	`updateModel(Condition condition, Object... params)` Reloads the data form the underlying data source.

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

- Constructor Detail
  - ItemList
```
public ItemList()
```
    Creates a new empty ItemList.
  - ItemList
```
public ItemList(Collection<?> item,
                Collection<?> data)
```
    Creates a new ItemList based on the provided Lists item and data. Item and data must be non null and have an equal size. The first object in item is mapped to first object in data ... and so on.
    
    Parameters:
    
    item - List to use as items
    
    data - List to use as data
  - ItemList
```
public ItemList(Object[] item,
                Object[] data)
```
    Creates a new ItemList based on the provided arrays item and data. Item and data must be non null and have an equal size. The first object in item is mapped to first object in data ... and so on.
    
    Parameters:
    
    item - array to use as items
    
    data - array to use as data
  - ItemList
```
public ItemList(ListModel model)
```
    Create a new ItemList based on the provided ListModel. The data are the model's values and the item's are the model's values as String.
    
    Parameters:
    
    model - The data model
  - ItemList
```
public ItemList(Collection<? extends ItemList.Entry> entries)
```
- Method Detail
  - addListDataListener
```
public void addListDataListener(ListDataListener listener)
```
    Adds a ListDataListener to this ItemList.
    
    Parameters:
    
    listener - the ListDataListener to add
  - removeListDataListener
```
public void removeListDataListener(ListDataListener listener)
```
    Removes the ListDataListener from this ItemList.
    
    Parameters:
    
    listener - the ListDataListener to remove
  - fireContentsChanged
```
protected void fireContentsChanged(int index0,
                                   int index1)
```
  - fireIntervalAdded
```
protected void fireIntervalAdded(int index0,
                                 int index1)
```
  - fireIntervalRemoved
```
protected void fireIntervalRemoved(int index0,
                                   int index1)
```
  - copy
```
public ItemList copy()
```
    Creates a (defensive) copy of this ItemList.
    
    Returns:
    
    a (defensive) copy of this ItemList.
  - clone
```
public ItemList clone()
```
    Returns a field-for-field copy of this instance.
    
    Specified by:
    
    clone in interface Copyable<ItemList>
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    a field-for-field copy of this instance.
  - add
```
public void add(String item,
                Object data)
```
    Adds a new row / item data pair to the end of this ItemList.
    
    Parameters:
    
    item - to add
    
    data - to add
  - add
```
public void add(int index,
                String item,
                Object data)
```
    Adds a new row / item data pair at the specified index to this ItemList.
    
    Parameters:
    
    index - index at which the specified element is to be inserted
    
    item - the display item to add
    
    data - the data object to add
  - add
```
public void add(ItemList.Entry entry)
```
    Adds the entry to the end of this ItemList.
    
    Parameters:
    
    entry - the entry to add
  - add
```
public void add(int index,
                ItemList.Entry entry)
```
    Adds the entry at the specified index to this ItemList.
    
    Parameters:
    
    index - index at which the specified element is to be inserted
    
    entry - the entry to add
  - addAll
```
public void addAll(Collection<?> item,
                   Collection<?> data)
```
    Adds all entries of item and data to this ItemList.
    
    Parameters:
    
    item - Collection of items to add
    
    data - Collection of data to add
  - addAll
```
public void addAll(Collection<? extends ItemList.Entry> entries)
```
    Adds all entries to this ItemList.
    
    Parameters:
    
    entries - the entries to add
  - addAll
```
public void addAll(ItemList il)
```
    Adds all entries of given ItemList il to this ItemList.
    
    Parameters:
    
    il - ItemList to add
  - addAll
```
public void addAll(ListModel model)
```
    Adds all entries of the model to this ItemList.
    
    Parameters:
    
    model - the data model
  - remove
```
public ItemList.Entry remove(int index)
                      throws IndexOutOfBoundsException
```
    Removes the element at the specified position in this ItemList. Shifts any subsequent elements to the top (subtracts one from their indices). Returns the element that was removed from the list.
    
    Parameters:
    
    index - the index of the element to be removed
    
    Returns:
    
    the element previously at the specified position
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of range ( index < 0 || index >= size())
  - removeAll
```
public ItemList.Entry[] removeAll(int... indices)
                           throws IndexOutOfBoundsException
```
    Removes the elements at the specified positions in this ItemList. Shifts any subsequent elements to the top (subtracts one from their indices). Returns the elements that were removed from the list.
    
    Parameters:
    
    indices - the indices of the elements to be removed
    
    Returns:
    
    a array of element's previously at the specified position's
    
    Throws:
    
    IndexOutOfBoundsException - if an index is out of range ( index < 0 || index >= size())
  - get
```
public ItemList.Entry get(int index)
                   throws IndexOutOfBoundsException
```
    Returns the entry at the specified position in this ItemList.
    
    Parameters:
    
    index - index of the entry to return
    
    Returns:
    
    the entry at the specified position in this list
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of range ( index < 0 || index >= size())
  - getItem
```
public Object getItem(int index)
               throws IndexOutOfBoundsException
```
    Returns the item at the specified position in this ItemList.
    
    Parameters:
    
    index - index of the item to return
    
    Returns:
    
    the element at the specified position in this list
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of range ( index < 0 || index >= size())
  - getData
```
public Object getData(int index)
               throws IndexOutOfBoundsException
```
    Returns the data at the specified position in this ItemList.
    
    Parameters:
    
    index - index of the data to return
    
    Returns:
    
    the element at the specified position in this list
    
    Throws:
    
    IndexOutOfBoundsException - if the index is out of range ( index < 0 || index >= size())
  - size
```
public int size()
```
    Returns the size of the list.
    
    Returns:
    
    the size of the list
  - clear
```
public void clear()
```
    Removes all of the elements from this ItemList. The ItemList will be empty after this call returns.
  - syncWithVT
```
public void syncWithVT()
```
    public @since 4.0
  - setModel
```
public void setModel(VirtualTable vt,
                     String itemCol,
                     String dataCol)
```
    Adds all row data (formatted) of the given VirtualTable vt to this ItemList.
    
    Parameters:
    
    vt - VirtualTable to read the rows from.
    
    itemCol - columnname to fill item from or string with variables like "{%SURNAME} {%NAME} - {%AGE}"
    
    dataCol - column name to fill data from, or multiple columns names, comma-separated
  - setModel
```
public void setModel(VirtualTable vt,
                     String itemCol,
                     String dataCol,
                     boolean queryData)
```
    Adds all row data (formatted) of the given VirtualTable vt to this ItemList.
    
    Parameters:
    
    vt - VirtualTable to read the rows from.
    
    itemCol - columnname to fill item from or string with variables like "{%SURNAME} {%NAME} - {%AGE}"
    
    dataCol - column name to fill data from, or multiple columns names, comma-separated
    
    queryData - if true, the best fitting select for this vt is used
  - setModel
```
public void setModel(VirtualTable vt,
                     String itemCol,
                     String dataCol,
                     boolean queryData,
                     boolean selectiveQuery)
```
    Adds all row data (formatted) of the given VirtualTable vt to this ItemList.
    
    Parameters:
    
    vt - VirtualTable to read the rows from.
    
    itemCol - columnname to fill item from or string with variables like "{%SURNAME} {%NAME} - {%AGE}"
    
    dataCol - column name to fill data from, or multiple columns names, comma-separated
    
    queryData - if true, the best fitting select for this vt is used
    
    selectiveQuery - if true, only the used columns are queried
    
    Since:
    
    5.0
  - setModel
```
public void setModel(VirtualTable vt,
                     String itemCol,
                     String dataCol,
                     SELECT select,
                     Object... params)
```
    Adds all row data (formatted) of the given VirtualTable vt to this ItemList.
    
    Parameters:
    
    vt - VirtualTable to read the rows from.
    
    itemCol - columnname to fill item from or string with variables like "{%SURNAME} {%NAME} - {%AGE}"
    
    dataCol - column name to fill data from, or multiple columns names, comma-separated
    
    select - a custom SELECT for filtering or ordering the results of the vt, may be null for the default select
    
    params - a set of parameters related to the param select, may be null
  - refresh
```
public void refresh()
```
    Reloads the data from the underlying data source with the last executed resp. default query.
  - updateModel
```
public void updateModel(Condition condition,
                        Object... params)
```
    Reloads the data form the underlying data source.
    The last executed query is extended with condition.
    
    Parameters:
    
    condition - The additional filter for the query
    
    params - param objects used in condition
  - getVirtualTable
```
public VirtualTable getVirtualTable()
```
    Returns the VirtualTable which was associated via setModel(VirtualTable, String, String), or null if no VirtualTable has been associated yet.
    
    Returns:
    
    The VirtualTable which was associated via setModel(VirtualTable, String, String), or null
  - containsItem
```
public boolean containsItem(Object item)
```
    Returns true if this ItemList contains the specified item. More formally, returns true if and only if this list contains at least one element e such that (o==null ? e==null : o.equals(e)).
    
    Parameters:
    
    item - item whose presence in this list is to be tested
    
    Returns:
    
    true if this list contains the specified element
  - contains
```
public boolean contains(ItemList.Entry entry)
```
    Returns true if this ItemList contains the specified entry. More formally, returns true if and only if this list contains at least one element e such that (o==null ? e==null : o.equals(e)).
    
    Parameters:
    
    entry - item whose presence in this list is to be tested
    
    Returns:
    
    true if this list contains the specified element
  - indexOfItem
```
public int indexOfItem(Object item)
```
    Returns the index of the first occurrence of the specified item in this list, or -1 if this ItemList does not contain the item. More formally, returns the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.
    
    Parameters:
    
    item - item to search for
    
    Returns:
    
    the index of the first occurrence of the specified item in this list, or -1 if this list does not contain the item
  - containsData
```
public boolean containsData(Object data)
```
    Returns true if this ItemList contains the specified data. More formally, returns true if and only if this list contains at least one element e such that (o==null ? e==null : o.equals(e)).
    
    Parameters:
    
    data - data whose presence in this list is to be tested
    
    Returns:
    
    true if this list contains the specified element
  - indexOfData
```
public int indexOfData(Object data)
```
    Returns the index of the first occurrence of the specified data in this list, or -1 if this ItemList does not contain the data. More formally, returns the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.
    
    Parameters:
    
    data - data to search for
    
    Returns:
    
    the index of the first occurrence of the specified item in this list, or -1 if this list does not contain the data
  - getItemsAsList
```
public List getItemsAsList()
```
    Returns a List containing all items of this ItemList.
    
    Returns:
    
    a List containing all items of this ItemList.
  - getDataAsList
```
public List getDataAsList()
```
    Returns a List containing all datas of this ItemList.
    
    Returns:
    
    a List containing all datas of this ItemList.
  - setSize
```
public void setSize(int size)
```
    Sets the size of this ItemList. If the ItemList has more entries that the specified size, list entries will be removed beginning with the largest index. If the ItemList has less than the specified size, list entries (item = "", data = "") will be added at the end of this ItemList.
    
    Parameters:
    
    size - new size of the ItemList
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class ItemList

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ItemList

ItemList

ItemList

ItemList

ItemList

Method Detail

addListDataListener

removeListDataListener

fireContentsChanged

fireIntervalAdded

fireIntervalRemoved

copy

clone

add

add

add

add

addAll

addAll

addAll

addAll

remove

removeAll

get

getItem

getData

size

clear

syncWithVT

setModel

setModel

setModel

setModel

refresh

updateModel

getVirtualTable

containsItem

contains

indexOfItem

containsData

indexOfData

getItemsAsList

getDataAsList

setSize

toString