com.ehsbe.commons.action
Class ManagedActionEvent

java.lang.Object
  java.util.EventObject
      java.awt.AWTEvent
          java.awt.event.ActionEvent
              com.ehsbe.commons.action.ManagedActionEvent

All Implemented Interfaces:

ManagedEvent, Serializable

public class ManagedActionEvent
extends ActionEvent
implements ManagedEvent

Helper to let listeners better handle cascaded events.

Version:

$Revision: 432 $

Author:

Jens Elkner

See Also:

Serialized Form

Field Summary

Fields inherited from class java.awt.event.ActionEvent

ACTION_FIRST, ACTION_LAST, ACTION_PERFORMED, ALT_MASK, CTRL_MASK, META_MASK, SHIFT_MASK

Fields inherited from class java.awt.AWTEvent

ACTION_EVENT_MASK, ADJUSTMENT_EVENT_MASK, COMPONENT_EVENT_MASK, consumed, CONTAINER_EVENT_MASK, FOCUS_EVENT_MASK, HIERARCHY_BOUNDS_EVENT_MASK, HIERARCHY_EVENT_MASK, id, INPUT_METHOD_EVENT_MASK, INVOCATION_EVENT_MASK, ITEM_EVENT_MASK, KEY_EVENT_MASK, MOUSE_EVENT_MASK, MOUSE_MOTION_EVENT_MASK, MOUSE_WHEEL_EVENT_MASK, PAINT_EVENT_MASK, RESERVED_ID_MAX, TEXT_EVENT_MASK, WINDOW_EVENT_MASK, WINDOW_FOCUS_EVENT_MASK, WINDOW_STATE_EVENT_MASK

Fields inherited from class java.util.EventObject

source

Constructor Summary

ManagedActionEvent(ActionEvent e, Action action)
Create a new managed action event.

Method Summary

boolean	dispatchable() Hint for dispatchers, whether they should further dispatch this event.
Action	getAction() Get the action, which triggered this event.
ActionEvent	getOriginalEvent() Get the original event, i.e. the event from which this one has been created.
void	stopDispatching() Set a flag for dispatchers, to not continue dispatching this event.

Methods inherited from class java.awt.event.ActionEvent

getActionCommand, getModifiers, getWhen, paramString

Methods inherited from class java.awt.AWTEvent

consume, getID, isConsumed, setSource, toString

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Constructor Detail

ManagedActionEvent

public ManagedActionEvent(ActionEvent e,
                          Action action)

Create a new managed action event.

Parameters:

e - the original event used to create this one. All properties of the original ActionEvent gets copied to this one incl. the ID, but not properties from derived or super classes.

action - the action, which triggered this event.

Throws:

NullPointerException - if the given event is null

IllegalArgumentException - if the given action is null and the event is not a ManagedActionEvent

Method Detail

getOriginalEvent

public ActionEvent getOriginalEvent()

Get the original event, i.e. the event from which this one has been created.

Specified by:

getOriginalEvent in interface ManagedEvent

Returns:

the original event fired by the emitter

stopDispatching

public void stopDispatching()

Set a flag for dispatchers, to not continue dispatching this event. Handle with care!!!

Specified by:

stopDispatching in interface ManagedEvent

dispatchable

public boolean dispatchable()

Hint for dispatchers, whether they should further dispatch this event.

Specified by:

dispatchable in interface ManagedEvent

Returns:

true, if the event should be dispatched.

getAction

public Action getAction()

Get the action, which triggered this event.

Specified by:

getAction in interface ManagedEvent

Returns:

the action, which triggered this event.