Eclipse Plug-in Developer Guide (Galileo) - ObservableEvent (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.core.databinding.observable
Class ObservableEvent


java.lang.Object
  

java.util.EventObject
      
org.eclipse.core.databinding.observable.ObservableEvent

All Implemented Interfaces:: Serializable

Direct Known Subclasses:: ChangeEvent, DisposeEvent, ListChangeEvent, MapChangeEvent, SetChangeEvent, StaleEvent, ValueChangeEvent, ValueChangingEvent

public abstract class ObservableEvent
extends EventObject
extends EventObject

Abstract event object for events fired by IObservable objects. All events fired by observables must be derived from this class so that the way of dispatching events can be improved in later versions of the framework.

Since:: 1.0
See Also:: Serialized Form

Field Summary

Fields inherited from class java.util. EventObject

source

Constructor Summary

ObservableEvent ( IObservable source)
          Creates a new observable event.

Method Summary

protected abstract void dispatch ( IObservablesListener listener)
          Dispatch this event to the given listener.

protected abstract Object getListenerType ()
          Returns a unique object used for distinguishing this event type from others.

IObservable getObservable ()
          Returns the observable that generated this event.

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

Constructor Detail

ObservableEvent

public ObservableEvent(
IObservable source)

Creates a new observable event.

Parameters:: source -

Method Detail

getObservable

public 
IObservable getObservable()

Returns the observable that generated this event.

Returns:: the observable that generated this event

dispatch

protected abstract void dispatch(
IObservablesListener listener)

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.

Parameters:: listener - the listener that should handle the event

getListenerType

protected abstract 
Object getListenerType()

Returns a unique object used for distinguishing this event type from others.

Returns:: a unique object representing the concrete type of this event.