org.zkoss.zul
Class ListModelSet<E>

java.lang.Object
  org.zkoss.zul.AbstractListModel<E>
      org.zkoss.zul.ListModelSet<E>

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.Set<E>, Selectable<E>, Sortable<E>, ListModel<E>

Direct Known Subclasses:

BindingListModelSet

public class ListModelSet<E>
extends AbstractListModel<E>
implements Sortable<E>, java.util.Set<E>, java.io.Serializable

This is the ListModel as a Set to be used with Listbox. Add or remove the contents of this model as a Set would cause the associated Listbox to change accordingly.

Author:

Henri Chen

See Also:

ListModel, ListModelList, ListModelMap, Serialized Form

Field Summary

protected java.util.Set<E>

_set

Constructor Summary

ListModelSet()
Constructor.

ListModelSet(java.util.Collection<? extends E> c)
Constructor.

ListModelSet(E[] array)
Constructor.

ListModelSet(int initialCapacity)
Constructor.

ListModelSet(int initialCapacity, float loadFactor)
Constructor.

ListModelSet(java.util.Set<E> set, boolean live)
Constructor

Method Summary

boolean	add(E o) This implementation optimized on the LinkedHashSet(which guaratee the sequence of the added item).
boolean	addAll(java.util.Collection<? extends E> c) This implementation optimized on the LinkedHashSet(which guaratee the sequence of the added item).
void	clear()
boolean	contains(java.lang.Object elem)
boolean	containsAll(java.util.Collection c)
boolean	equals(java.lang.Object o)
E	getElementAt(int j) Returns the value at the specified index.
java.util.Set<E>	getInnerSet() Get the inner real set.
int	getSize() Returns the length of the list.
int	hashCode()
int	indexOf(java.lang.Object o) Returns the index of the specified object, or -1 if not found.
boolean	isEmpty()
java.util.Iterator<E>	iterator()
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> c)
boolean	retainAll(java.util.Collection<?> c)
int	size()
void	sort(java.util.Comparator<E> cmpr, boolean ascending) Sorts the data.
java.lang.Object[]	toArray()
<T> T[]	toArray(T[] a)
java.lang.String	toString()

Methods inherited from class org.zkoss.zul.AbstractListModel

addListDataListener, addSelection, clearSelection, fireEvent, getSelection, removeAllSelection, removeListDataListener, removeSelection, retainAllSelection

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

_set

protected java.util.Set<E> _set

Constructor Detail

ListModelSet

public ListModelSet(java.util.Set<E> set,
                    boolean live)

Constructor

Parameters:

set - the set to represent

live - whether to have a 'live' ListModel on top of the specified set. If false, the content of the specified set is copied. If true, this object is a 'facade' of the specified set, i.e., when you add or remove items from this ListModelSet, the inner "live" set would be changed accordingly. However, it is not a good idea to modify set if it is passed to this method with live is true, since Listbox is not smart enough to hanle it. Instead, modify it thru this object.

Since:

2.4.0

ListModelSet

public ListModelSet()

Constructor.

ListModelSet

public ListModelSet(java.util.Collection<? extends E> c)

Constructor. It mades a copy of the specified collection (i.e., not live).

ListModelSet

public ListModelSet(E[] array)

Constructor. It mades a copy of the specified array (i.e., not live).

Since:

2.4.1

ListModelSet

public ListModelSet(int initialCapacity)

Constructor.

Parameters:

initialCapacity - the initial capacity for this ListModelSet.

ListModelSet

public ListModelSet(int initialCapacity,
                    float loadFactor)

Constructor.

Parameters:

initialCapacity - the initial capacity for this ListModelMap.

loadFactor - the loadFactor to increase capacity of this ListModelMap.

Method Detail

getInnerSet

public java.util.Set<E> getInnerSet()

Get the inner real set.

getSize

public int getSize()

Description copied from interface: ListModel

Returns the length of the list.

Specified by:

getSize in interface ListModel<E>

getElementAt

public E getElementAt(int j)

Description copied from interface: ListModel

Returns the value at the specified index.

Specified by:

getElementAt in interface ListModel<E>

add

public boolean add(E o)

This implementation optimized on the LinkedHashSet(which guaratee the sequence of the added item). Other implementation needs one more linier search.

Specified by:

add in interface java.util.Collection<E>

Specified by:

add in interface java.util.Set<E>

addAll

public boolean addAll(java.util.Collection<? extends E> c)

This implementation optimized on the LinkedHashSet(which guaratee the sequence of the added item). Other implementation needs one more linier search.

Specified by:

addAll in interface java.util.Collection<E>

Specified by:

addAll in interface java.util.Set<E>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<E>

Specified by:

clear in interface java.util.Set<E>

contains

public boolean contains(java.lang.Object elem)

Specified by:

contains in interface java.util.Collection<E>

Specified by:

contains in interface java.util.Set<E>

containsAll

public boolean containsAll(java.util.Collection c)

Specified by:

containsAll in interface java.util.Collection<E>

Specified by:

containsAll in interface java.util.Set<E>

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.Collection<E>

Specified by:

equals in interface java.util.Set<E>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Collection<E>

Specified by:

hashCode in interface java.util.Set<E>

Overrides:

hashCode in class java.lang.Object

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<E>

Specified by:

isEmpty in interface java.util.Set<E>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

iterator

public java.util.Iterator<E> iterator()

Specified by:

iterator in interface java.lang.Iterable<E>

Specified by:

iterator in interface java.util.Collection<E>

Specified by:

iterator in interface java.util.Set<E>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<E>

Specified by:

remove in interface java.util.Set<E>

indexOf

public int indexOf(java.lang.Object o)

Returns the index of the specified object, or -1 if not found.

removeAll

public boolean removeAll(java.util.Collection<?> c)

Specified by:

removeAll in interface java.util.Collection<E>

Specified by:

removeAll in interface java.util.Set<E>

retainAll

public boolean retainAll(java.util.Collection<?> c)

Specified by:

retainAll in interface java.util.Collection<E>

Specified by:

retainAll in interface java.util.Set<E>

size

public int size()

Specified by:

size in interface java.util.Collection<E>

Specified by:

size in interface java.util.Set<E>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<E>

Specified by:

toArray in interface java.util.Set<E>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface java.util.Collection<E>

Specified by:

toArray in interface java.util.Set<E>

sort

public void sort(java.util.Comparator<E> cmpr,
                 boolean ascending)

Sorts the data.

Specified by:

sort in interface Sortable<E>

Parameters:

cmpr - the comparator.

ascending - whether to sort in the ascending order. It is ignored since this implementation uses cmprt to compare.