|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EventDispatcher
Event dispatching interface. It allows objects to receive and
notify data events (basically String->Object associations) and
create notification chains. To ease the usage of this interface,
you could define an EventDispatcherImpl attribute called
_event
(as suggested in EventDispatcherImpl documentation)
and cut'n'paste the following default implementation:
public EventDispatcher getEventDispatcher() { return _event; }
public void attachEventDispatcher(IEventDispatcher e) { _event.attachEventDispatcher(e.getEventDispatcher()); }
public void detachEventDispatcher(IEventDispatcher e) { _event.detachEventDispatcher(e.getEventDispatcher()); }
public void notifyEvent(String e, Object a) { _event.notifyEvent(e,a); }
public Object getEventValue(String n) { return _event.getEventValue(n); }
public Set getEvents() { return _event.getEvents(); }
public void ignoreEvents() { _event.ignoreEvents(); }
public void unIgnoreEvents() { _event.unIgnoreEvents(); }
public Object waitEventValue(String n) { return _event.waitEventValue(n); }
Method Summary | |
---|---|
void |
attachEventDispatcher(EventDispatcher iev)
Attach an EventDispatcher object to the events dispatching chain. |
void |
detachEventDispatcher(EventDispatcher iev)
Detach the specified EventDispatcher object from the events dispatching chain. |
EventDispatcher |
getEventDispatcher()
Get an object to be used to deliver events (usually this , but YMMV). |
java.util.Set |
getEvents()
Retrieve the names of all the events that have been received |
java.lang.Object |
getEventValue(java.lang.String name)
Retrieve the value currently associated with the specified event value |
void |
ignoreEvents()
Ignore further event notifications |
void |
notifyEvent(java.lang.String event,
java.lang.Object args)
Deliver an event |
void |
unIgnoreEvents()
Almost like the method above :-) |
java.lang.Object |
waitEventValue(java.lang.String name)
Wait until the given event has received a value |
Method Detail |
---|
EventDispatcher getEventDispatcher()
this
, but YMMV).
void attachEventDispatcher(EventDispatcher iev)
ev
won't reach the object calling this method).
Good luck, and beware of notification loops! :-)
iev
- Event object to be attachedvoid detachEventDispatcher(EventDispatcher iev)
iev
- Event object to be detachedvoid notifyEvent(java.lang.String event, java.lang.Object args)
event
- name of the eventargs
- data being stored for that eventjava.lang.Object getEventValue(java.lang.String name)
name
- name of the event to query for
java.util.Set getEvents()
void ignoreEvents()
void unIgnoreEvents()
java.lang.Object waitEventValue(java.lang.String name)
name
- name of the event to wait for
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |