Eclipse Platform
Release 3.6

org.eclipse.core.databinding.observable.set
Class DecoratingObservableSet

java.lang.Object
  extended by org.eclipse.core.databinding.observable.AbstractObservable
      extended by org.eclipse.core.databinding.observable.DecoratingObservable
          extended by org.eclipse.core.databinding.observable.DecoratingObservableCollection
              extended by org.eclipse.core.databinding.observable.set.DecoratingObservableSet
All Implemented Interfaces:
Iterable, Collection, Set, IDecoratingObservable, IObservable, IObservableCollection, IObservableSet

public class DecoratingObservableSet
extends DecoratingObservableCollection
implements IObservableSet

An observable set which decorates another observable set.

Since:
1.2

Constructor Summary
DecoratingObservableSet(IObservableSet decorated, boolean disposeDecoratedOnDispose)
          Constructs a DecoratingObservableSet which decorates the given observable.
 
Method Summary
protected  void addListener(Object listenerType, IObservablesListener listener)
           
 void addSetChangeListener(ISetChangeListener listener)
           
 void clear()
           
protected  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 fireSetChange(SetDiff diff)
           
protected  void firstListenerAdded()
           
 Realm getRealm()
           
protected  void handleSetChange(SetChangeEvent event)
          Called whenever a SetChangeEvent is received from the decorated observable.
protected  boolean hasListeners()
           
protected  void lastListenerRemoved()
           
protected  void removeListener(Object listenerType, IObservablesListener listener)
           
 void removeSetChangeListener(ISetChangeListener listener)
           
 
Methods inherited from class org.eclipse.core.databinding.observable.DecoratingObservableCollection
add, addAll, 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 org.eclipse.core.databinding.observable.set.IObservableSet
add, addAll, contains, containsAll, equals, getElementType, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray
 
Methods inherited from interface org.eclipse.core.databinding.observable.IObservable
addChangeListener, addDisposeListener, addStaleListener, getRealm, isDisposed, isStale, removeChangeListener, removeDisposeListener, removeStaleListener
 

Constructor Detail

DecoratingObservableSet

public DecoratingObservableSet(IObservableSet decorated,
                               boolean disposeDecoratedOnDispose)
Constructs a DecoratingObservableSet which decorates the given observable.

Parameters:
decorated - the observable set being decorated
disposeDecoratedOnDispose -
Method Detail

clear

public void clear()
Specified by:
clear in interface Collection
Specified by:
clear in interface Set
Overrides:
clear in class DecoratingObservableCollection

addSetChangeListener

public void addSetChangeListener(ISetChangeListener listener)
Specified by:
addSetChangeListener in interface IObservableSet

removeSetChangeListener

public void removeSetChangeListener(ISetChangeListener listener)
Specified by:
removeSetChangeListener in interface IObservableSet

fireSetChange

protected void fireSetChange(SetDiff 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

handleSetChange

protected void handleSetChange(SetChangeEvent event)
Called whenever a SetChangeEvent is received from the decorated observable. By default, this method fires the set 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

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

addListener

protected void addListener(Object listenerType,
                           IObservablesListener listener)
Parameters:
listenerType -
listener -

removeListener

protected void removeListener(Object listenerType,
                              IObservablesListener listener)
Parameters:
listenerType -
listener -

hasListeners

protected boolean hasListeners()

fireEvent

protected void fireEvent(ObservableEvent event)

getRealm

public Realm getRealm()
Returns:
Returns the realm.

clone

protected Object clone()
                throws CloneNotSupportedException
Overrides:
clone in class Object
Throws:
CloneNotSupportedException

Eclipse Platform
Release 3.6

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.