foxtrot.pumps

Class ConditionalEventPump

java.lang.Object

foxtrot.pumps.ConditionalEventPump

All Implemented Interfaces:

EventPump, EventFilterable

Direct Known Subclasses:

SunJDK14ConditionalEventPump

public class ConditionalEventPump
extends java.lang.Object
implements EventPump, EventFilterable

This implementation of EventPump calls the package protected method java.awt.EventDispatchThread.pumpEvents(Conditional) to pump events while a Task is executed.

Version:

$Revision: 1.1 $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	ConditionalEventPump.Conditional Implements the java.awt.Conditional interface, that is package private, with a JDK 1.3+ dynamic proxy.
static class	ConditionalEventPump.ThrowableHandler Handler for RuntimeExceptions or Errors thrown during dispatching of AWT events.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.Class	conditionalClass
(package private) static boolean	debug
private EventFilter	filter
private static java.lang.reflect.Method	pumpEventsMethod

Constructor Summary

Constructors

Constructor and Description
ConditionalEventPump()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	canPumpEvent(java.awt.AWTEvent event) Returns whether this event can be pumped from the EventQueue.
EventFilter	getEventFilter() Returns the EventFilter
private java.awt.EventQueue	getEventQueue()
private java.awt.AWTEvent	getNextEvent()
protected java.awt.AWTEvent	peekEvent(java.awt.EventQueue queue) Peeks the EventQueue for the next event, without removing it.
private java.lang.Boolean	pumpEvent(Task task) This method is called before an event is got from the EventQueue and dispatched, to see if pumping of events should continue or not.
void	pumpEvents(Task task) Pumps AWT events from the standard AWT Event Queue and dispatches the events until the given task is completed; must be called from the Event Dispatch Thread.
void	setEventFilter(EventFilter filter) Sets the EventFilter
private java.awt.AWTEvent	waitForEvent() Waits until an event is available on the EventQueue.
private void	waitForTask(Task task)

Methods inherited from class java.lang.Object

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

Field Detail

conditionalClass

private static java.lang.Class conditionalClass

pumpEventsMethod

private static java.lang.reflect.Method pumpEventsMethod

debug

static final boolean debug

See Also:

Constant Field Values

filter

private EventFilter filter

Constructor Detail

ConditionalEventPump

public ConditionalEventPump()

Method Detail

setEventFilter

public void setEventFilter(EventFilter filter)

Description copied from interface: EventFilterable

Sets the EventFilter

Specified by:

setEventFilter in interface EventFilterable

See Also:

EventFilterable.getEventFilter()

getEventFilter

public EventFilter getEventFilter()

Description copied from interface: EventFilterable

Returns the EventFilter

Specified by:

getEventFilter in interface EventFilterable

See Also:

EventFilterable.setEventFilter(foxtrot.pumps.EventFilter)

pumpEvents

public void pumpEvents(Task task)

Description copied from interface: EventPump

Pumps AWT events from the standard AWT Event Queue and dispatches the events until the given task is completed; must be called from the Event Dispatch Thread.
No Exceptions (included RuntimeExceptions) or Errors should escape this method: it must return only when the task is completed.

Specified by:

pumpEvents in interface EventPump

waitForTask

private void waitForTask(Task task)

pumpEvent

private java.lang.Boolean pumpEvent(Task task)

This method is called before an event is got from the EventQueue and dispatched, to see if pumping of events should continue or not. Returns true to indicate that pumping should continue, false to indicate that pumping should stop.

canPumpEvent

protected boolean canPumpEvent(java.awt.AWTEvent event)

Returns whether this event can be pumped from the EventQueue. JDK 1.4 introduced SequencedEvent, which is an event holding a list SequencedEvents that should be dispatched in order. Bug #4531693 was caused by the fact that the first SequencedEvent of a list, when dispatched, might end up calling an event listener that displayed a dialog (or called Foxtrot, that uses the same event pumping mechanism); the new event pump might try to dispatch the SequencedEvent second in the list (while the first wasn't completely dispatched yet), causing the application to hang. Bug #4531693 has been fixed in JDK 1.4.2, and backported to 1.4.1, so there is no longer need to check for this situation, unless using JDK 1.4.0 or non-fixed versions of JDK 1.4.1.

getEventQueue

private java.awt.EventQueue getEventQueue()

getNextEvent

private java.awt.AWTEvent getNextEvent()

waitForEvent

private java.awt.AWTEvent waitForEvent()

Waits until an event is available on the EventQueue. This method uses the same synchronization mechanisms used by EventQueue to be notified when an event is posted on the EventQueue. Waiting for events is necessary in this case: a Task is posted and we would like to start pumping, but no events have been posted yet (peekEvent(java.awt.EventQueue) returns null).

peekEvent

protected java.awt.AWTEvent peekEvent(java.awt.EventQueue queue)

Peeks the EventQueue for the next event, without removing it.