Package org.eclipse.core.databinding.observable.list

Class DecoratingObservableList<E>

java.lang.Object

org.eclipse.core.databinding.observable.AbstractObservable

org.eclipse.core.databinding.observable.DecoratingObservable

org.eclipse.core.databinding.observable.DecoratingObservableCollection<E>

org.eclipse.core.databinding.observable.list.DecoratingObservableList<E>

Type Parameters:

E - the list element type

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>, java.util.List<E>, IDecoratingObservable, IObservable, IObservableCollection<E>, IObservableList<E>

public class DecoratingObservableList<E>
extends DecoratingObservableCollection<E>
implements IObservableList<E>

An observable list which decorates another observable list.

Since:

1.2

Implementation Note:

If methods are added to the interface which this class implements then implementations of those methods must be added to this class.

Constructor Summary

Constructors

Constructor	Description
DecoratingObservableList(IObservableList<E> decorated, boolean disposeDecoratedOnDispose)	Constructs a DecoratingObservableList which decorates the given observable.

Method Summary

Modifier and Type	Method	Description
void	add(int index, E o)
boolean	addAll(int index, java.util.Collection<? extends E> c)
void	addListChangeListener(IListChangeListener<? super E> listener)	Adds the given list change listener to the list of list change listeners.
protected void	addListener(java.lang.Object listenerType, IObservablesListener listener)
protected java.lang.Object	clone()
void	dispose()	Disposes of this observable object, removing all listeners registered with this object, and all listeners this object might have registered on other objects.
protected void	fireChange()
protected void	fireEvent(ObservableEvent event)
protected void	fireListChange(ListDiff<E> diff)
protected void	firstListenerAdded()
E	get(int index)
Realm	getRealm()
protected void	handleListChange(ListChangeEvent<? extends E> event)	Called whenever a ListChangeEvent is received from the decorated observable.
protected boolean	hasListeners()
int	indexOf(java.lang.Object o)
int	lastIndexOf(java.lang.Object o)
protected void	lastListenerRemoved()
java.util.ListIterator<E>	listIterator()
java.util.ListIterator<E>	listIterator(int index)
E	move(int oldIndex, int newIndex)	Moves the element located at oldIndex to newIndex.
E	remove(int index)
void	removeListChangeListener(IListChangeListener<? super E> listener)	Removes the given list change listener from the list of list change listeners.
protected void	removeListener(java.lang.Object listenerType, IObservablesListener listener)
E	set(int index, E element)
java.util.List<E>	subList(int fromIndex, int toIndex)

Methods inherited from class org.eclipse.core.databinding.observable.DecoratingObservableCollection

add, addAll, clear, contains, containsAll, equals, getElementType, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString

Methods inherited from class org.eclipse.core.databinding.observable.DecoratingObservable

getDecorated, getterCalled, handleStaleEvent, isStale

Methods inherited from class org.eclipse.core.databinding.observable.AbstractObservable

addChangeListener, addDisposeListener, addStaleListener, checkRealm, fireStale, isDisposed, removeChangeListener, removeDisposeListener, removeStaleListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface org.eclipse.core.databinding.observable.IObservable

addChangeListener, addDisposeListener, addStaleListener, getRealm, isDisposed, isStale, removeChangeListener, removeDisposeListener, removeStaleListener

Methods inherited from interface org.eclipse.core.databinding.observable.list.IObservableList

add, addAll, contains, containsAll, equals, getElementType, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

clear, replaceAll, sort, spliterator

Constructor Detail

DecoratingObservableList

public DecoratingObservableList(IObservableList<E> decorated,
                                boolean disposeDecoratedOnDispose)

Constructs a DecoratingObservableList which decorates the given observable.

Parameters:

decorated - the observable list being decorated

disposeDecoratedOnDispose - whether the decorated observable should be disposed when the decorator is disposed

Method Detail

addListChangeListener

public void addListChangeListener(IListChangeListener<? super E> listener)

Description copied from interface: IObservableList

Adds the given list change listener to the list of list change listeners.

Specified by:

addListChangeListener in interface IObservableList<E>

Parameters:

listener - the change listener to add; not null

removeListChangeListener

public void removeListChangeListener(IListChangeListener<? super E> listener)

Description copied from interface: IObservableList

Removes the given list change listener from the list of list change listeners. Has no effect if the given listener is not registered as a list change listener.

Specified by:

removeListChangeListener in interface IObservableList<E>

Parameters:

listener - the change listener to remove; not null

fireListChange

protected void fireListChange(ListDiff<E> diff)

fireChange

protected void fireChange()

Overrides:

fireChange in class AbstractObservable

firstListenerAdded

protected void firstListenerAdded()

Overrides:

firstListenerAdded in class DecoratingObservable

lastListenerRemoved

protected void lastListenerRemoved()

Overrides:

lastListenerRemoved in class DecoratingObservable

handleListChange

protected void handleListChange(ListChangeEvent<? extends E> event)

Called whenever a ListChangeEvent is received from the decorated observable. By default, this method fires the list change event again, with the decorating observable as the event source. Subclasses may override to provide different behavior.

Parameters:

event - the change event received from the decorated observable

add

public void add(int index,
                E o)

Specified by:

add in interface java.util.List<E>

addAll

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

Specified by:

addAll in interface IObservableList<E>

Specified by:

addAll in interface java.util.List<E>

get

public E get(int index)

Specified by:

get in interface IObservableList<E>

Specified by:

get in interface java.util.List<E>

indexOf

public int indexOf(java.lang.Object o)

Specified by:

indexOf in interface IObservableList<E>

Specified by:

indexOf in interface java.util.List<E>

lastIndexOf

public int lastIndexOf(java.lang.Object o)

Specified by:

lastIndexOf in interface IObservableList<E>

Specified by:

lastIndexOf in interface java.util.List<E>

listIterator

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

Specified by:

listIterator in interface IObservableList<E>

Specified by:

listIterator in interface java.util.List<E>

listIterator

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

Specified by:

listIterator in interface IObservableList<E>

Specified by:

listIterator in interface java.util.List<E>

move

public E move(int oldIndex,
              int newIndex)

Description copied from interface: IObservableList

Moves the element located at oldIndex to newIndex. This method is equivalent to calling add(newIndex, remove(oldIndex)).

Implementors should deliver list change notification for the remove and add operations in the same ListChangeEvent, as this allows ListDiff.accept(ListDiffVisitor) to recognize the operation as a move.

Specified by:

move in interface IObservableList<E>

Parameters:

oldIndex - the element's position before the move. Must be within the range 0 <= oldIndex < size().

newIndex - the element's position after the move. Must be within the range 0 <= newIndex < size().

Returns:

the element that was moved.

See Also:

ListDiffVisitor.handleMove(int, int, Object), ListDiff.accept(ListDiffVisitor)

remove

public E remove(int index)

Specified by:

remove in interface IObservableList<E>

Specified by:

remove in interface java.util.List<E>

set

public E set(int index,
             E element)

Specified by:

set in interface IObservableList<E>

Specified by:

set in interface java.util.List<E>

subList

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

Specified by:

subList in interface IObservableList<E>

Specified by:

subList in interface java.util.List<E>

dispose

public void dispose()

Description copied from interface: IObservable

Disposes of this observable object, removing all listeners registered with this object, and all listeners this object might have registered on other objects.

Specified by:

dispose in interface IObservable

Overrides:

dispose in class DecoratingObservableCollection<E>

addListener

protected void addListener(java.lang.Object listenerType,
                           IObservablesListener listener)

Parameters:

listenerType - arbitrary object to identify a type of the listener

listener - the listener to add; not null

removeListener

protected void removeListener(java.lang.Object listenerType,
                              IObservablesListener listener)

Parameters:

listenerType - arbitrary object to identify a type of the listener

listener - the listener to remove; not null

hasListeners

protected boolean hasListeners()

fireEvent

protected void fireEvent(ObservableEvent event)

getRealm

public Realm getRealm()

Returns:

Returns the realm.

clone

protected java.lang.Object clone()
                          throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException