ca.odell.glazedlists.swt
Class EventListViewer<E>

java.lang.Object
  ca.odell.glazedlists.swt.EventListViewer<E>

All Implemented Interfaces:

ListEventListener<E>, EventListener

public class EventListViewer<E>
extends Object
implements ListEventListener<E>

A view helper that displays an EventList in a List.

This class is not thread safe. It must be used exclusively with the SWT event handler thread.

Author:

Kevin Maltby

Constructor Summary

EventListViewer(EventList<E> source, List list)
Creates a new List that displays and responds to changes in source.

EventListViewer(EventList<E> source, List list, ILabelProvider labelProvider)
Creates a new List that displays and responds to changes in source.

Method Summary

void	dispose() Releases the resources consumed by this EventListViewer so that it may eventually be garbage collected.
EventList<E>	getDeselected() Provides access to an EventList that contains items from the viewed Table that are not currently selected.
ILabelProvider	getLabelProvider() Gets the List's ILabelProvider.
List	getList() Gets the List being managed by this EventListViewer.
EventList<E>	getSelected() Provides access to an EventList that contains items from the viewed Table that are currently selected.
EventList<E>	getTogglingDeselected() Gets an EventList that contains only deselected values and modifies the selection state on mutation.
EventList<E>	getTogglingSelected() Gets an EventList that contains only selected values and modifies the selection state on mutation.
void	invertSelection() Inverts the current selection.
void	listChanged(ListEvent<E> listChanges) When the source list is changed, this forwards the change to the displayed List.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventListViewer

public EventListViewer(EventList<E> source,
                       List list)

Creates a new List that displays and responds to changes in source. List elements will simply be displayed as the result of calling toString() on the contents of the source list.

EventListViewer

public EventListViewer(EventList<E> source,
                       List list,
                       ILabelProvider labelProvider)

Creates a new List that displays and responds to changes in source. List elements are formatted using the provided ILabelProvider.

Method Detail

getLabelProvider

public ILabelProvider getLabelProvider()

Gets the List's ILabelProvider.

getList

public List getList()

Gets the List being managed by this EventListViewer.

getDeselected

public EventList<E> getDeselected()

Provides access to an EventList that contains items from the viewed Table that are not currently selected.

getTogglingDeselected

public EventList<E> getTogglingDeselected()

Gets an EventList that contains only deselected values and modifies the selection state on mutation. Adding an item to this list deselects it and removing an item selects it. If an item not in the source list is added an IllegalArgumentException is thrown

getSelected

public EventList<E> getSelected()

Provides access to an EventList that contains items from the viewed Table that are currently selected.

getTogglingSelected

public EventList<E> getTogglingSelected()

Gets an EventList that contains only selected values and modifies the selection state on mutation. Adding an item to this list selects it and removing an item deselects it. If an item not in the source list is added an IllegalArgumentException is thrown.

listChanged

public void listChanged(ListEvent<E> listChanges)

When the source list is changed, this forwards the change to the displayed List.

Specified by:

listChanged in interface ListEventListener<E>

invertSelection

public void invertSelection()

Inverts the current selection.

dispose

public void dispose()

Releases the resources consumed by this EventListViewer so that it may eventually be garbage collected.

An EventListViewer will be garbage collected without a call to dispose(), but not before its source EventList is garbage collected. By calling dispose(), you allow the EventListViewer to be garbage collected before its source EventList. This is necessary for situations where an EventListViewer is short-lived but its source EventList is long-lived.

Warning: It is an error to call any method on a EventListViewer after it has been disposed.