org.zkoss.zul
Class ListModelSet<E>

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

All Implemented Interfaces:

Serializable, Iterable<E>, Collection<E>, Set<E>, Selectable<E>, Sortable<E>, ListModel<E>

public class ListModelSet<E>
extends AbstractListModel<E>
implements Sortable<E>, Set<E>, 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 Set<E>

_set

Fields inherited from class org.zkoss.zul.AbstractListModel

_selection

Constructor Summary

ListModelSet()
Constructor.

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

ListModelSet(E[] array)
Constructor.

ListModelSet(int initialCapacity)
Constructor.

ListModelSet(int initialCapacity, float loadFactor)
Constructor.

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

Method Summary

boolean	add(E o) This implementation optimized on the LinkedHashSet(which guarantees the sequence of the added item).
boolean	addAll(Collection<? extends E> c) This implementation optimized on the LinkedHashSet(which guarantees the sequence of the added item).
void	addSelection(E obj) Deprecated. As of release 6.0.0, replaced with AbstractListModel.addToSelection(E).
void	clear()
Object	clone()
boolean	contains(Object elem)
boolean	containsAll(Collection<?> c)
boolean	equals(Object o)
protected void	fireSelectionEvent(E e) Selectable's implementor use only.
E	getElementAt(int j) Returns the value at the specified index.
Set<E>	getInnerSet() Get the inner real set.
int	getSize() Returns the length of the list.
String	getSortDirection(Comparator<E> cmpr) Returns the sort direction of this model for the given comparator.
int	hashCode()
int	indexOf(Object o) Returns the index of the specified object, or -1 if not found.
boolean	isEmpty()
Iterator<E>	iterator()
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
void	removeSelection(Object obj) Deprecated. As of release 6.0.0, replaced with AbstractListModel.removeFromSelection(java.lang.Object).
boolean	retainAll(Collection<?> c)
int	size()
void	sort(Comparator<E> cmpr, boolean ascending) Sorts the data.
Object[]	toArray()
<T> T[]	toArray(T[] a)
String	toString()

Methods inherited from class org.zkoss.zul.AbstractListModel

addListDataListener, addToSelection, clearSelection, fireEvent, getSelection, isMultiple, isSelected, isSelectionEmpty, newEmptySelection, readSelection, removeAllSelection, removeFromSelection, removeListDataListener, retainAllSelection, setMultiple, setSelection, writeSelection

Methods inherited from class java.lang.Object

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

Field Detail

_set

protected Set<E> _set

Constructor Detail

ListModelSet

public ListModelSet(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 handle it. Instead, modify it thru this object.

Since:

2.4.0

ListModelSet

public ListModelSet()

Constructor.

ListModelSet

public ListModelSet(Collection<? extends E> c)

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

Notice that if the data is static or not shared, it is better to use ListModelSet(set, true) instead, since making a copy is slower.

ListModelSet

public ListModelSet(E[] array)

Constructor. It makes 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 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 guarantees the sequence of the added item). Other implementation needs one more linear search.

Specified by:

add in interface Collection<E>

Specified by:

add in interface Set<E>

addAll

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

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

Specified by:

addAll in interface Collection<E>

Specified by:

addAll in interface Set<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface Set<E>

contains

public boolean contains(Object elem)

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface Set<E>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<E>

Specified by:

containsAll in interface Set<E>

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<E>

Specified by:

equals in interface Set<E>

Overrides:

equals in class Object

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<E>

Specified by:

hashCode in interface Set<E>

Overrides:

hashCode in class Object

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface Set<E>

toString

public String toString()

Overrides:

toString in class Object

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Set<E>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface Set<E>

indexOf

public int indexOf(Object o)

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

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<E>

Specified by:

removeAll in interface Set<E>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<E>

Specified by:

retainAll in interface Set<E>

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface Set<E>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface Set<E>

toArray

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

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface Set<E>

sort

public void sort(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 cmpr to compare.

getSortDirection

public String getSortDirection(Comparator<E> cmpr)

Description copied from interface: Sortable

Returns the sort direction of this model for the given comparator. It must be one of "ascending", "descending" and "natural".

Default: "natural".

Specified by:

getSortDirection in interface Sortable<E>

clone

public Object clone()

Overrides:

clone in class AbstractListModel<E>

fireSelectionEvent

protected void fireSelectionEvent(E e)

Description copied from class: AbstractListModel

Selectable's implementor use only.

Fires a selection event for component to scroll into view. The override subclass must put the index0 of AbstractListModel.fireEvent(int, int, int) as the view index to scroll. By default, the value -1 is assumed which means no scroll into view.

The method is invoked when both methods are invoked. AbstractListModel.addToSelection(Object) and AbstractListModel.setSelection(Collection).

Overrides:

fireSelectionEvent in class AbstractListModel<E>

Parameters:

e - selected object.

addSelection

public void addSelection(E obj)

Deprecated. As of release 6.0.0, replaced with AbstractListModel.addToSelection(E).

removeSelection

public void removeSelection(Object obj)

Deprecated. As of release 6.0.0, replaced with AbstractListModel.removeFromSelection(java.lang.Object).