FileDocCategorySizeDatePackage
EventDispatchThread.javaAPI DocJava SE 6 API17002Tue Jun 10 00:25:14 BST 2008java.awt

EventDispatchThread

public class EventDispatchThread extends Thread
EventDispatchThread is a package-private AWT class which takes events off the EventQueue and dispatches them to the appropriate AWT components. The Thread starts a "permanent" event pump with a call to pumpEvents(Conditional) in its run() method. Event handlers can choose to block this event pump at any time, but should start a new pump (not a new EventDispatchThread) by again calling pumpEvents(Conditional). This secondary event pump will exit automatically as soon as the Condtional evaluate()s to false and an additional Event is pumped and dispatched.
author
Tom Ball
author
Amy Fowler
author
Fred Ecks
author
David Mendenhall
version
1.60, 11/17/05
since
1.1

Fields Summary
private static final sun.awt.DebugHelper
dbg
private EventQueue
theQueue
private boolean
doDispatch
private static final int
ANY_EVENT
private Vector
eventFilters
private int
modalFiltersCount
private static final String
handlerPropName
private static String
handlerClassName
private static String
NO_HANDLER
Constructors Summary
EventDispatchThread(ThreadGroup group, String name, EventQueue queue)


          
        super(group, name);
        theQueue = queue;
    
Methods Summary
voidaddEventFilter(java.awt.EventFilter filter)

        synchronized (eventFilters) {
            if (!eventFilters.contains(filter)) {
                if (filter instanceof ModalEventFilter) {
                    ModalEventFilter newFilter = (ModalEventFilter)filter;
                    int k = 0;
                    for (k = 0; k < eventFilters.size(); k++) {
                        EventFilter f = eventFilters.get(k);
                        if (f instanceof ModalEventFilter) {
                            ModalEventFilter cf = (ModalEventFilter)f;
                            if (cf.compareTo(newFilter) > 0) {
                                break;
                            }
                        }
                    }
                    eventFilters.add(k, filter);
                    modalFiltersCount++;
                } else {
                    eventFilters.add(filter);
                }
            }
        }
    
static booleancheckMouseEventForModalJInternalFrame(java.awt.event.MouseEvent me, java.awt.Component modalComp)

        // Check if the MouseEvent is targeted to the HW parent of the
        // LW component, if so, then return true. The job of distinguishing
        // between the LW components is done by the LW dispatcher.
        if (Component.isInstanceOf(modalComp, "javax.swing.JInternalFrame")) {
            Container c;
            synchronized (modalComp.getTreeLock()) {
                c = ((Container)modalComp).getHeavyweightContainer();
            }
            if (me.getSource() == c) 
                return true;
        }
        return false;
    
java.awt.EventQueuegetEventQueue()

 return theQueue; 
private booleanhandleException(java.lang.Throwable thrown)
Handles an exception thrown in the event-dispatch thread.

If the system property "sun.awt.exception.handler" is defined, then when this method is invoked it will attempt to do the following:

  1. Load the class named by the value of that property, using the current thread's context class loader,
  2. Instantiate that class using its zero-argument constructor,
  3. Find the resulting handler object's public void handle method, which should take a single argument of type Throwable, and
  4. Invoke the handler's handle method, passing it the thrown argument that was passed to this method.
If any of the first three steps fail then this method will return false and all following invocations of this method will return false immediately. An exception thrown by the handler object's handle will be caught, and will cause this method to return false. If the handler's handle method is successfully invoked, then this method will return true. This method will never throw any sort of exception.

Note: This method is a temporary hack to work around the absence of a real API that provides the ability to replace the event-dispatch thread. The magic "sun.awt.exception.handler" property will be removed in a future release.

param
thrown The Throwable that was thrown in the event-dispatch thread
return
false if any of the above steps failed, otherwise true


                                                                                                                                                                                                                                                                                         
        

        try {

            if (handlerClassName == NO_HANDLER) {
                return false;   /* Already tried, and failed */
            }

            /* Look up the class name */
            if (handlerClassName == null) {
                handlerClassName = ((String) AccessController.doPrivileged(
                    new GetPropertyAction(handlerPropName)));
                if (handlerClassName == null) {
                    handlerClassName = NO_HANDLER; /* Do not try this again */
                    return false;
                }
            }

            /* Load the class, instantiate it, and find its handle method */
            Method m;
            Object h;
            try {
                ClassLoader cl = Thread.currentThread().getContextClassLoader();
                Class c = Class.forName(handlerClassName, true, cl);
                m = c.getMethod("handle", new Class[] { Throwable.class });
                h = c.newInstance();
            } catch (Throwable x) {
                handlerClassName = NO_HANDLER; /* Do not try this again */
                return false;
            }

            /* Finally, invoke the handler */
            m.invoke(h, new Object[] { thrown });

        } catch (Throwable x) {
            return false;
        }

        return true;
    
booleanisDispatching(java.awt.EventQueue eq)

	return theQueue.equals(eq);
    
private voidprocessException(java.lang.Throwable e, boolean isModal)

        if (!handleException(e)) {
            // See bug ID 4499199.
            // If we are in a modal dialog, we cannot throw
            // an exception for the ThreadGroup to handle (as added
            // in RFE 4063022).  If we did, the message pump of
            // the modal dialog would be interrupted.
            // We instead choose to handle the exception ourselves.
            // It may be useful to add either a runtime flag or API
            // later if someone would like to instead dispose the
            // dialog and allow the thread group to handle it.
            if (isModal) {
                System.err.println(
                    "Exception occurred during event dispatching:");
                e.printStackTrace();
            } else if (e instanceof RuntimeException) {
                throw (RuntimeException)e;
            } else if (e instanceof Error) {
                throw (Error)e;
            }
        }
    
voidpumpEvents(java.awt.Conditional cond)

	pumpEvents(ANY_EVENT, cond);
    
voidpumpEvents(int id, java.awt.Conditional cond)

        pumpEventsForHierarchy(id, cond, null);
    
voidpumpEventsForFilter(java.awt.Conditional cond, java.awt.EventFilter filter)

        pumpEventsForFilter(ANY_EVENT, cond, filter);
    
voidpumpEventsForFilter(int id, java.awt.Conditional cond, java.awt.EventFilter filter)

        addEventFilter(filter);
        while (doDispatch && cond.evaluate()) {
            if (isInterrupted() || !pumpOneEventForFilters(id)) {
                doDispatch = false;
            }
        }
        removeEventFilter(filter);
    
voidpumpEventsForHierarchy(java.awt.Conditional cond, java.awt.Component modalComponent)

        pumpEventsForHierarchy(ANY_EVENT, cond, modalComponent);
    
voidpumpEventsForHierarchy(int id, java.awt.Conditional cond, java.awt.Component modalComponent)

        pumpEventsForFilter(id, cond, new HierarchyEventFilter(modalComponent));
    
booleanpumpOneEventForFilters(int id)

        try {
            AWTEvent event;
            boolean eventOK;
            do {
                event = (id == ANY_EVENT)
                    ? theQueue.getNextEvent()
                    : theQueue.getNextEvent(id);

                eventOK = true;
                synchronized (eventFilters) {
                    for (int i = eventFilters.size() - 1; i >= 0; i--) {
                        EventFilter f = eventFilters.get(i);
                        EventFilter.FilterAction accept = f.acceptEvent(event);
                        if (accept == EventFilter.FilterAction.REJECT) {
                            eventOK = false;
                            break;
                        } else if (accept == EventFilter.FilterAction.ACCEPT_IMMEDIATELY) {
                            break;
                        }
                    }
                }
                eventOK = eventOK && SunDragSourceContextPeer.checkEvent(event);
                if (!eventOK) {
                    event.consume();
                }
            }
            while (eventOK == false);
                      
            if (dbg.on) {
                dbg.println("Dispatching: "+event);
            }

            theQueue.dispatchEvent(event);
            return true;
        }
        catch (ThreadDeath death) {
            return false;

        }
        catch (InterruptedException interruptedException) {
            return false; // AppContext.dispose() interrupts all
                          // Threads in the AppContext

        }
        // Can get and throw only unchecked exceptions
        catch (RuntimeException e) {
            processException(e, modalFiltersCount > 0);
        } catch (Error e) {
            processException(e, modalFiltersCount > 0);
        }
        return true;
    
voidremoveEventFilter(java.awt.EventFilter filter)

        synchronized (eventFilters) {
            if (eventFilters.contains(filter)) {
                if (filter instanceof ModalEventFilter) {
                    modalFiltersCount--;
                }
                eventFilters.remove(filter);
            }
        }
    
public voidrun()

	try {
	    pumpEvents(new Conditional() {
		public boolean evaluate() {
		    return true;
		}
	    });	    
	} finally {
	    /*
	     * This synchronized block is to secure that the event dispatch 
	     * thread won't die in the middle of posting a new event to the
	     * associated event queue. It is important because we notify
	     * that the event dispatch thread is busy after posting a new event
	     * to its queue, so the EventQueue.dispatchThread reference must
	     * be valid at that point.
	     */
	    synchronized (theQueue) {
                if (theQueue.getDispatchThread() == this) {
                    theQueue.detachDispatchThread();
                }
                /*
                 * Event dispatch thread dies in case of an uncaught exception. 
                 * A new event dispatch thread for this queue will be started
                 * only if a new event is posted to it. In case if no more
                 * events are posted after this thread died all events that 
                 * currently are in the queue will never be dispatched.
                 */
                /*
                 * Fix for 4648733. Check both the associated java event
                 * queue and the PostEventQueue.
                 */
                if (theQueue.peekEvent() != null || 
                    !SunToolkit.isPostEventQueueEmpty()) { 
                    theQueue.initDispatchThread();
                }
		AWTAutoShutdown.getInstance().notifyThreadFree(this);
	    }
	}
    
public voidstopDispatching()

        stopDispatchingImpl(true);
    
voidstopDispatchingImpl(boolean wait)

        // Note: We stop dispatching via a flag rather than using
        // Thread.interrupt() because we can't guarantee that the wait()
        // we interrupt will be EventQueue.getNextEvent()'s.  -fredx 8-11-98

        StopDispatchEvent stopEvent = new StopDispatchEvent();

        // wait for the dispatcher to complete
        if (Thread.currentThread() != this) {

            // fix 4122683, 4128923
            // Post an empty event to ensure getNextEvent is unblocked
            //
            // We have to use postEventPrivate instead of postEvent because
            // EventQueue.pop calls EventDispatchThread.stopDispatching.
            // Calling SunToolkit.flushPendingEvents in this case could
            // lead to deadlock.
            theQueue.postEventPrivate(stopEvent);
                
            if (wait) {
                try {
                    join();
                } catch(InterruptedException e) {
                }
            }
        } else {
            stopEvent.dispatch();
        }
        synchronized (theQueue) {
            if (theQueue.getDispatchThread() == this) {
                theQueue.detachDispatchThread();
            }
        }
    
public voidstopDispatchingLater()

        stopDispatchingImpl(false);