InvocationEvent JDK 1.6)

Description

public class InvocationEvent

An event which executes the run() method on a

Runnable

when dispatched by the AWT event dispatcher thread.

An event which executes the run() method on a

Runnable

when dispatched by the AWT event dispatcher thread. This class can be used as a reference implementation of ActiveEvent rather than declaring a new class and defining dispatch().

Instances of this class are placed on the EventQueue by calls to invokeLater and invokeAndWait. Client code can use this fact to write replacement functions for invokeLater and invokeAndWait without writing special-case code in any AWTEventListener objects.

See also: ActiveEvent EventQueue.invokeLater(java.lang.Runnable) EventQueue.invokeAndWait(java.lang.Runnable) AWTEventListener

Constructors

protected InvocationEvent (Object source, int id, Runnable runnable, Object notifier, boolean catchThrowables)

Constructs an InvocationEvent with the specified source and ID which will execute the runnable's run method when dispatched.

Constructs an InvocationEvent with the specified source and ID which will execute the runnable's run method when dispatched. If notifier is non-null, notifyAll will be called on it immediately after run returns.

Note that passing in an invalid id results in unspecified behavior. This method throws an IllegalArgumentException if source is null.
Parameters:
- source - the Object that originated the event
- id - the ID for the event
- runnable - the Runnable whose run method will be executed
- notifier - the Object whose notifyAll method will be called after Runnable.run has returned
- catchThrowables - specifies whether dispatch should catch Throwable when executing the Runnable's run method, or should instead propagate those Throwables to the EventDispatchThread's dispatch loop
Throws:
- IllegalArgumentException - if source is null

public InvocationEvent (Object source, Runnable runnable)

Constructs an InvocationEvent with the specified source which will execute the runnable's run method when dispatched.

This is a convenience constructor. An invocation of the form InvocationEvent(source, runnable) behaves in exactly the same way as the invocation of InvocationEvent(source, runnable, null, false).

This method throws an IllegalArgumentException if source is null.
Parameters:
- source - the Object that originated the event
- runnable - the Runnable whose run method will be executed
Throws:
- IllegalArgumentException - if source is null
See Also: InvocationEvent.InvocationEvent(Object, Runnable, Object, boolean),

public InvocationEvent (Object source, Runnable runnable, Object notifier, boolean catchThrowables)

Constructs an InvocationEvent with the specified source which will execute the runnable's run method when dispatched.

Constructs an InvocationEvent with the specified source which will execute the runnable's run method when dispatched. If notifier is non-null, notifyAll() will be called on it immediately after run returns.

An invocation of the form InvocationEvent(source, runnable, notifier, catchThrowables) behaves in exactly the same way as the invocation of InvocationEvent(source, InvocationEvent.INVOCATION_DEFAULT, runnable, notifier, catchThrowables).

This method throws an IllegalArgumentException if source is null.
Parameters:
- source - the Object that originated the event
- runnable - the Runnable whose run method will be executed
- notifier - the Object whose notifyAll method will be called after Runnable.run has returned
- catchThrowables - specifies whether dispatch should catch Throwable when executing the Runnable's run method, or should instead propagate those Throwables to the EventDispatchThread's dispatch loop
Throws:
- IllegalArgumentException - if source is null
See Also: InvocationEvent.InvocationEvent(Object, int, Runnable, Object, boolean),

Methods

Hide/Show inherited methods

protected void consume () [Inherited From AWTEvent]

Consumes this event, if this event can be consumed.

public void dispatch () [Specified in ActiveEvent]

Executes the Runnable's run() method and notifies the notifier (if any) when run() returns.

public Exception getException ()

Returns any Exception caught while executing the Runnable's

run()

method.

Returns any Exception caught while executing the Runnable's

run()

method.
Returns: A reference to the Exception if one was thrown; null if no Exception was thrown or if this InvocationEvent does not catch exceptions

public int getID () [Inherited From AWTEvent]

Returns the event type.

public Object getSource () [Inherited From EventObject]

The object on which the Event initially occurred.

public Throwable getThrowable ()

Returns any Throwable caught while executing the Runnable's

run()

method.

Returns any Throwable caught while executing the Runnable's

run()

method.
Returns: A reference to the Throwable if one was thrown; null if no Throwable was thrown or if this InvocationEvent does not catch Throwables
Since: 1.5

public long getWhen ()

Returns the timestamp of when this event occurred.

protected boolean isConsumed () [Inherited From AWTEvent]

Returns whether this event has been consumed.

public String paramString () [Overrides AWTEvent]

Returns a parameter string identifying this event.

public void setSource (Object newSource) [Inherited From AWTEvent]

Retargets an event to a new source.

public String toString () [Inherited From AWTEvent]

Returns a String representation of this object.

Fields

Hide/Show inherited fields

publicfinalstatic long ACTION_EVENT_MASK = "128" [Inherited From AWTEvent]

The event mask for selecting action events.

publicfinalstatic long ADJUSTMENT_EVENT_MASK = "256" [Inherited From AWTEvent]

The event mask for selecting adjustment events.

protected boolean catchExceptions

Set to true if dispatch() catches Throwable and stores it in the exception instance variable.

publicfinalstatic long COMPONENT_EVENT_MASK = "1" [Inherited From AWTEvent]

The event mask for selecting component events.

protected boolean consumed [Inherited From AWTEvent]

Controls whether or not the event is sent back down to the peer once the source has processed it - false means it's sent to the peer; true means it's not.

publicfinalstatic long CONTAINER_EVENT_MASK = "2" [Inherited From AWTEvent]

The event mask for selecting container events.

publicfinalstatic long FOCUS_EVENT_MASK = "4" [Inherited From AWTEvent]

The event mask for selecting focus events.

publicfinalstatic long HIERARCHY_BOUNDS_EVENT_MASK = "65536" [Inherited From AWTEvent]

The event mask for selecting hierarchy bounds events.

publicfinalstatic long HIERARCHY_EVENT_MASK = "32768" [Inherited From AWTEvent]

The event mask for selecting hierarchy events.

protected int id [Inherited From AWTEvent]

The event's id.

publicfinalstatic long INPUT_METHOD_EVENT_MASK = "2048" [Inherited From AWTEvent]

The event mask for selecting input method events.

publicfinalstatic int INVOCATION_DEFAULT = "1200"

The default id for all InvocationEvents.

publicfinalstatic long INVOCATION_EVENT_MASK = "16384" [Inherited From AWTEvent]

The event mask for selecting invocation events.

publicfinalstatic int INVOCATION_FIRST = "1200"

Marks the first integer id for the range of invocation event ids.

publicfinalstatic int INVOCATION_LAST = "1200"

Marks the last integer id for the range of invocation event ids.

publicfinalstatic long ITEM_EVENT_MASK = "512" [Inherited From AWTEvent]

The event mask for selecting item events.

publicfinalstatic long KEY_EVENT_MASK = "8" [Inherited From AWTEvent]

The event mask for selecting key events.

publicfinalstatic long MOUSE_EVENT_MASK = "16" [Inherited From AWTEvent]

The event mask for selecting mouse events.

publicfinalstatic long MOUSE_MOTION_EVENT_MASK = "32" [Inherited From AWTEvent]

The event mask for selecting mouse motion events.

publicfinalstatic long MOUSE_WHEEL_EVENT_MASK = "131072" [Inherited From AWTEvent]

The event mask for selecting mouse wheel events.

protected Object notifier

The (potentially null) Object whose notifyAll() method will be called immediately after the Runnable.run() method returns.

publicfinalstatic long PAINT_EVENT_MASK = "8192" [Inherited From AWTEvent]

The event mask for selecting paint events.

publicfinalstatic int RESERVED_ID_MAX = "1999" [Inherited From AWTEvent]

The maximum value for reserved AWT event IDs.

protected Runnable runnable

The Runnable whose run() method will be called.

protectedtransient Object source [Inherited From EventObject]

The object on which the Event initially occurred.

publicfinalstatic long TEXT_EVENT_MASK = "1024" [Inherited From AWTEvent]

The event mask for selecting text events.

publicfinalstatic long WINDOW_EVENT_MASK = "64" [Inherited From AWTEvent]

The event mask for selecting window events.

publicfinalstatic long WINDOW_FOCUS_EVENT_MASK = "524288" [Inherited From AWTEvent]

The event mask for selecting window focus events.

publicfinalstatic long WINDOW_STATE_EVENT_MASK = "262144" [Inherited From AWTEvent]

The event mask for selecting window state events.