Class DecoratingObservable
java.lang.Object
org.eclipse.core.databinding.observable.AbstractObservable
org.eclipse.core.databinding.observable.DecoratingObservable
- All Implemented Interfaces:
IDecoratingObservable,IObservable
- Direct Known Subclasses:
DecoratingObservableCollection,DecoratingObservableMap,DecoratingObservableValue
An observable which decorates another observable
- 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
ConstructorsConstructorDescriptionDecoratingObservable(IObservable decorated, boolean disposeDecoratedOnDispose) Constructs a DecoratingObservable which decorates the given observable. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidaddListener(Object listenerType, IObservablesListener listener) protected Objectclone()voiddispose()Disposes of this observable object, removing all listeners registered with this object, and all listeners this object might have registered on other objects.booleanprotected voidfireEvent(ObservableEvent event) protected voidgetRealm()protected voidprotected voidhandleStaleEvent(StaleEvent event) Called whenever a StaleEvent is received from the decorated observable.inthashCode()protected booleanbooleanisStale()Returns whether the state of this observable is stale and is expected to change soon.protected voidprotected voidremoveListener(Object listenerType, IObservablesListener listener) Methods inherited from class org.eclipse.core.databinding.observable.AbstractObservable
addChangeListener, addDisposeListener, addStaleListener, checkRealm, fireChange, fireStale, isDisposed, removeChangeListener, removeDisposeListener, removeStaleListenerMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.eclipse.core.databinding.observable.IObservable
addChangeListener, addDisposeListener, addStaleListener, getRealm, isDisposed, removeChangeListener, removeDisposeListener, removeStaleListener
-
Constructor Details
-
DecoratingObservable
Constructs a DecoratingObservable which decorates the given observable.- Parameters:
decorated- the observable being decorated.disposeDecoratedOnDispose- whether the decorated observable should be disposed when the decorator is disposed
-
-
Method Details
-
getDecorated
- Specified by:
getDecoratedin interfaceIDecoratingObservable- Returns:
- the observable that this observable decorates.
-
isStale
public boolean isStale()Description copied from interface:IObservableReturns whether the state of this observable is stale and is expected to change soon. A non-stale observable that becomes stale will notify its stale listeners. A stale object that becomes non-stale does so by changing its state and notifying its change listeners, it does not notify its stale listeners about becoming non-stale. Clients that do not expect asynchronous changes may ignore staleness of observable objects.- Specified by:
isStalein interfaceIObservable- Returns:
- true if this observable's state is stale and will change soon.
-
getterCalled
protected void getterCalled() -
firstListenerAdded
protected void firstListenerAdded() -
lastListenerRemoved
protected void lastListenerRemoved() -
handleStaleEvent
Called whenever a StaleEvent is received from the decorated observable. By default, this method fires the stale event again, with the decorating observable as the event source. Subclasses may override to provide different behavior.- Parameters:
event- the stale event received from the decorated observable
-
equals
-
hashCode
public int hashCode() -
dispose
public void dispose()Description copied from interface:IObservableDisposes of this observable object, removing all listeners registered with this object, and all listeners this object might have registered on other objects.- Specified by:
disposein interfaceIObservable- Overrides:
disposein classAbstractObservable
-
addListener
- Parameters:
listenerType- arbitrary object to identify a type of the listenerlistener- the listener to add; notnull
-
removeListener
- Parameters:
listenerType- arbitrary object to identify a type of the listenerlistener- the listener to remove; notnull
-
hasListeners
protected boolean hasListeners() -
fireEvent
-
getRealm
- Returns:
- Returns the realm.
-
clone
- Overrides:
clonein classObject- Throws:
CloneNotSupportedException
-