org.gwtproject.event.shared

Class Event<H>

java.lang.Object

org.gwtproject.event.shared.Event<H>

Type Parameters:

H - interface implemented by handlers of this kind of event

public abstract class Event<H>
extends Object

Base Event object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Event.Type<H> Type class used to register events with an EventBus.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Event() Constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract void	dispatch(H handler) Implemented by subclasses to to invoke their handlers in a type safe manner.
abstract Event.Type<H>	getAssociatedType() Returns the Event.Type used to register this event, allowing an EventBus to find handlers of the appropriate class.
Object	getSource() Returns the source for this event.
protected void	setSource(Object source) Set the source that triggered this event.
String	toDebugString() This is a method used primarily for debugging.
String	toString() The toString() for abstract event is overridden to avoid accidently including class literals in the compiled output.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Event

protected Event()

Constructor.

Method Detail

getAssociatedType

public abstract Event.Type<H> getAssociatedType()

Returns the Event.Type used to register this event, allowing an EventBus to find handlers of the appropriate class.

Returns:

the type

getSource

public Object getSource()

Returns the source for this event. The type and meaning of the source is arbitrary, and is most useful as a secondary key for handler registration. (See EventBus.addHandlerToSource(org.gwtproject.event.shared.Event.Type<H>, java.lang.Object, H), which allows a handler to register for events of a particular type, tied to a particular source.)

Note that the source is actually set at dispatch time, e.g. via EventBus.fireEventFromSource(Event, Object).

Returns:

object representing the source of this event

toDebugString

public String toDebugString()

This is a method used primarily for debugging. It gives a string representation of the event details. This does not override the toString method because the compiler cannot always optimize toString out correctly. Event types should override as desired.

Returns:

a string representing the event's specifics.

toString

public String toString()

The toString() for abstract event is overridden to avoid accidently including class literals in the compiled output. Use Event #toDebugString to get more information about the event.

Overrides:

toString in class Object

dispatch

protected abstract void dispatch(H handler)

Implemented by subclasses to to invoke their handlers in a type safe manner. Intended to be called by EventBus.fireEvent(Event) or EventBus.fireEventFromSource(Event, Object).

Parameters:

handler - handler

See Also:

EventBus.dispatchEvent(Event, Object)

setSource

protected void setSource(Object source)

Set the source that triggered this event. Intended to be called by the EventBus during dispatch.

Parameters:

source - the source of this event.

See Also:

EventBus.fireEventFromSource(Event, Object), EventBus.setSourceOfEvent(Event, Object)