Eclipse Platform
Release 3.3

org.eclipse.core.databinding.observable.value
Class ValueChangingEvent

java.lang.Object
  extended byjava.util.EventObject
      extended byorg.eclipse.core.databinding.observable.ObservableEvent
          extended byorg.eclipse.core.databinding.observable.value.ValueChangingEvent
All Implemented Interfaces:
Serializable

public class ValueChangingEvent
extends ObservableEvent

Value changing event describing a pending change of an IObservableValue object's current value. Listeners can veto the pending change by setting veto to true.

Since:
1.0
See Also:
Serialized Form

Field Summary
 ValueDiff diff
          Description of the change to the source observable value.
 boolean veto
          Flag for vetoing this change.
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
ValueChangingEvent(IObservableValue source, ValueDiff diff)
          Creates a new value changing event.
 
Method Summary
protected  void dispatch(IObservablesListener listener)
          Dispatch this event to the given listener.
protected  Object getListenerType()
          Returns a unique object used for distinguishing this event type from others.
 IObservableValue getObservableValue()
           
 
Methods inherited from class org.eclipse.core.databinding.observable.ObservableEvent
getObservable
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

diff

public ValueDiff diff
Description of the change to the source observable value. Listeners must not change this field.


veto

public boolean veto
Flag for vetoing this change. Default value is false, can be set to true by listeners to veto this change.

Constructor Detail

ValueChangingEvent

public ValueChangingEvent(IObservableValue source,
                          ValueDiff diff)
Creates a new value changing event.

Parameters:
source - the source observable value
diff - the value change
Method Detail

getObservableValue

public IObservableValue getObservableValue()
Returns:
the observable value from which this event originated

dispatch

protected void dispatch(IObservablesListener listener)
Description copied from class: ObservableEvent
Dispatch this event to the given listener. Subclasses must implement this method by calling the appropriate type-safe event handling method on the given listener according to the type of this event.

Specified by:
dispatch in class ObservableEvent
Parameters:
listener - the listener that should handle the event

getListenerType

protected Object getListenerType()
Description copied from class: ObservableEvent
Returns a unique object used for distinguishing this event type from others.

Specified by:
getListenerType in class ObservableEvent
Returns:
a unique object representing the concrete type of this event.

Eclipse Platform
Release 3.3

Guidelines for using Eclipse APIs.

Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.