ca.odell.glazedlists.javafx

Class EventObservableList<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

ca.odell.glazedlists.javafx.EventObservableList<E>

All Implemented Interfaces:

ListEventListener<E>, java.lang.Iterable<E>, java.util.Collection<E>, java.util.EventListener, java.util.List<E>, javafx.beans.Observable, javafx.collections.ObservableList<E>

public class EventObservableList<E>
extends java.util.AbstractList<E>
implements javafx.collections.ObservableList<E>, ListEventListener<E>

This list serves as an adapter to allow GlazedList's EventLists to be used as the backing implementations for JavaFX ObservableLists.

All methods that read from or write to the wrapped source EventList apply the corresponding locking of the list, because these operations may be called from JavaFX runtime code.

Author:

Rob Eden

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
EventObservableList(EventList<E> source) Creates an adapter for the specified EventList.

Method Summary

Modifier and Type	Method and Description
boolean	add(E e)
void	add(int index, E element)
boolean	addAll(java.util.Collection<? extends E> c)
boolean	addAll(E... es)
boolean	addAll(int index, java.util.Collection<? extends E> c)
void	addListener(javafx.beans.InvalidationListener listener)
void	addListener(javafx.collections.ListChangeListener<? super E> listener)
void	clear()
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection<?> c)
void	dispose() Releases the resources consumed by this EventObservableList so that it may eventually be garbage collected.
E	get(int index)
int	indexOf(java.lang.Object o)
boolean	isEmpty()
java.util.Iterator<E>	iterator()
int	lastIndexOf(java.lang.Object o)
void	listChanged(ListEvent<E> source_changes) When the underlying list changes, this notification allows the object to repaint itself or update itself as necessary.
java.util.ListIterator<E>	listIterator()
java.util.ListIterator<E>	listIterator(int index)
E	remove(int index)
void	remove(int from, int to)
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> c)
boolean	removeAll(E... es)
void	removeListener(javafx.beans.InvalidationListener listener)
void	removeListener(javafx.collections.ListChangeListener<? super E> listener)
boolean	retainAll(java.util.Collection<?> c)
boolean	retainAll(E... es)
E	set(int index, E element)
boolean	setAll(java.util.Collection<? extends E> es)
boolean	setAll(E... es)
int	size()
java.util.List<E>	subList(int fromIndex, int toIndex)
java.lang.Object[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class java.util.AbstractList

equals, hashCode, removeRange

Methods inherited from class java.util.AbstractCollection

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface javafx.collections.ObservableList

filtered, sorted, sorted

Methods inherited from interface java.util.List

equals, hashCode, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

EventObservableList

public EventObservableList(EventList<E> source)

Creates an adapter for the specified EventList.

Parameters:

source - the EventList to adapt to a JavaFX ObservableList

Method Detail

dispose

public void dispose()

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

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

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

addListener

public void addListener(javafx.collections.ListChangeListener<? super E> listener)

Specified by:

addListener in interface javafx.collections.ObservableList<E>

removeListener

public void removeListener(javafx.collections.ListChangeListener<? super E> listener)

Specified by:

removeListener in interface javafx.collections.ObservableList<E>

addListener

public void addListener(javafx.beans.InvalidationListener listener)

Specified by:

addListener in interface javafx.beans.Observable

removeListener

public void removeListener(javafx.beans.InvalidationListener listener)

Specified by:

removeListener in interface javafx.beans.Observable

addAll

public boolean addAll(E... es)

Specified by:

addAll in interface javafx.collections.ObservableList<E>

setAll

public boolean setAll(E... es)

Specified by:

setAll in interface javafx.collections.ObservableList<E>

setAll

public boolean setAll(java.util.Collection<? extends E> es)

Specified by:

setAll in interface javafx.collections.ObservableList<E>

removeAll

public boolean removeAll(E... es)

Specified by:

removeAll in interface javafx.collections.ObservableList<E>

retainAll

public boolean retainAll(E... es)

Specified by:

retainAll in interface javafx.collections.ObservableList<E>

remove

public void remove(int from,
                   int to)

Specified by:

remove in interface javafx.collections.ObservableList<E>

size

public int size()

Specified by:

size in interface java.util.Collection<E>

Specified by:

size in interface java.util.List<E>

Specified by:

size in class java.util.AbstractCollection<E>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<E>

Specified by:

isEmpty in interface java.util.List<E>

Overrides:

isEmpty in class java.util.AbstractCollection<E>

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<E>

Specified by:

contains in interface java.util.List<E>

Overrides:

contains in class java.util.AbstractCollection<E>

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.List<E>

Overrides:

iterator in class java.util.AbstractList<E>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<E>

Specified by:

toArray in interface java.util.List<E>

Overrides:

toArray in class java.util.AbstractCollection<E>

toArray

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

Specified by:

toArray in interface java.util.Collection<E>

Specified by:

toArray in interface java.util.List<E>

Overrides:

toArray in class java.util.AbstractCollection<E>

add

public boolean add(E e)

Specified by:

add in interface java.util.Collection<E>

Specified by:

add in interface java.util.List<E>

Overrides:

add in class java.util.AbstractList<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.List<E>

Overrides:

remove in class java.util.AbstractCollection<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.List<E>

Overrides:

containsAll in class java.util.AbstractCollection<E>

addAll

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

Specified by:

addAll in interface java.util.Collection<E>

Specified by:

addAll in interface java.util.List<E>

Overrides:

addAll in class java.util.AbstractCollection<E>

addAll

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

Specified by:

addAll in interface java.util.List<E>

Overrides:

addAll in class java.util.AbstractList<E>

removeAll

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

Specified by:

removeAll in interface java.util.Collection<E>

Specified by:

removeAll in interface java.util.List<E>

Overrides:

removeAll in class java.util.AbstractCollection<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.List<E>

Overrides:

retainAll in class java.util.AbstractCollection<E>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<E>

Specified by:

clear in interface java.util.List<E>

Overrides:

clear in class java.util.AbstractList<E>

get

public E get(int index)

Specified by:

get in interface java.util.List<E>

Specified by:

get in class java.util.AbstractList<E>

set

public E set(int index,
             E element)

Specified by:

set in interface java.util.List<E>

Overrides:

set in class java.util.AbstractList<E>

add

public void add(int index,
                E element)

Specified by:

add in interface java.util.List<E>

Overrides:

add in class java.util.AbstractList<E>

remove

public E remove(int index)

Specified by:

remove in interface java.util.List<E>

Overrides:

remove in class java.util.AbstractList<E>

indexOf

public int indexOf(java.lang.Object o)

Specified by:

indexOf in interface java.util.List<E>

Overrides:

indexOf in class java.util.AbstractList<E>

lastIndexOf

public int lastIndexOf(java.lang.Object o)

Specified by:

lastIndexOf in interface java.util.List<E>

Overrides:

lastIndexOf in class java.util.AbstractList<E>

listIterator

public java.util.ListIterator<E> listIterator()

Specified by:

listIterator in interface java.util.List<E>

Overrides:

listIterator in class java.util.AbstractList<E>

listIterator

public java.util.ListIterator<E> listIterator(int index)

Specified by:

listIterator in interface java.util.List<E>

Overrides:

listIterator in class java.util.AbstractList<E>

subList

public java.util.List<E> subList(int fromIndex,
                                 int toIndex)

Specified by:

subList in interface java.util.List<E>

Overrides:

subList in class java.util.AbstractList<E>

listChanged

public void listChanged(ListEvent<E> source_changes)

Description copied from interface: ListEventListener

When the underlying list changes, this notification allows the object to repaint itself or update itself as necessary.

It is mandatory that the calling thread has obtained the write lock on the source list. This is because the calling thread will have written to the source list to cause this event. This condition guarantees that no writes can occur while the listener is handling this event. It is an error to write to the source list while processing an event.

Specified by:

listChanged in interface ListEventListener<E>

Parameters:

source_changes - a ListEvent describing the changes to the list