1 /* 2 * Copyright (c) 1996, 2010, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package java.awt; 27 28 import java.awt.event.InputEvent; 29 import java.awt.event.MouseEvent; 30 import java.awt.event.ActionEvent; 31 import java.awt.event.WindowEvent; 32 import java.lang.reflect.Method; 33 import java.security.AccessController; 34 import sun.security.action.GetPropertyAction; 35 import sun.awt.AWTAutoShutdown; 36 import sun.awt.SunToolkit; 37 import sun.awt.AppContext; 38 39 import java.util.ArrayList; 40 import java.util.List; 41 import sun.util.logging.PlatformLogger; 42 43 import sun.awt.dnd.SunDragSourceContextPeer; 44 import sun.awt.EventQueueDelegate; 45 46 /** 47 * EventDispatchThread is a package-private AWT class which takes 48 * events off the EventQueue and dispatches them to the appropriate 49 * AWT components. 50 * 51 * The Thread starts a "permanent" event pump with a call to 52 * pumpEvents(Conditional) in its run() method. Event handlers can choose to 53 * block this event pump at any time, but should start a new pump (<b>not</b> 54 * a new EventDispatchThread) by again calling pumpEvents(Conditional). This 55 * secondary event pump will exit automatically as soon as the Condtional 56 * evaluate()s to false and an additional Event is pumped and dispatched. 57 * 58 * @author Tom Ball 59 * @author Amy Fowler 60 * @author Fred Ecks 61 * @author David Mendenhall 62 * 63 * @since 1.1 64 */ 65 class EventDispatchThread extends Thread { 66 67 private static final PlatformLogger eventLog = PlatformLogger.getLogger("java.awt.event.EventDispatchThread"); 68 69 private EventQueue theQueue; 70 private boolean doDispatch = true; 71 private volatile boolean shutdown = false; 72 73 private static final int ANY_EVENT = -1; 74 75 private ArrayList<EventFilter> eventFilters = new ArrayList<EventFilter>(); 76 77 EventDispatchThread(ThreadGroup group, String name, EventQueue queue) { 78 super(group, name); 79 setEventQueue(queue); 80 } 81 82 /* 83 * Must be called on EDT only, that's why no synchronization 84 */ 85 public void stopDispatching() { 86 doDispatch = false; 87 } 88 89 public void interrupt() { 90 shutdown = true; 91 super.interrupt(); 92 } 93 94 public void run() { 95 while (true) { 96 try { 97 pumpEvents(new Conditional() { 98 public boolean evaluate() { 99 return true; 100 } 101 }); 102 } finally { 103 if(getEventQueue().detachDispatchThread(this, shutdown)) { 104 break; 105 } 106 } 107 } 108 } 109 110 void pumpEvents(Conditional cond) { 111 pumpEvents(ANY_EVENT, cond); 112 } 113 114 void pumpEventsForHierarchy(Conditional cond, Component modalComponent) { 115 pumpEventsForHierarchy(ANY_EVENT, cond, modalComponent); 116 } 117 118 void pumpEvents(int id, Conditional cond) { 119 pumpEventsForHierarchy(id, cond, null); 120 } 121 122 void pumpEventsForHierarchy(int id, Conditional cond, Component modalComponent) { 123 pumpEventsForFilter(id, cond, new HierarchyEventFilter(modalComponent)); 124 } 125 126 void pumpEventsForFilter(Conditional cond, EventFilter filter) { 127 pumpEventsForFilter(ANY_EVENT, cond, filter); 128 } 129 130 void pumpEventsForFilter(int id, Conditional cond, EventFilter filter) { 131 addEventFilter(filter); 132 doDispatch = true; 133 shutdown |= isInterrupted(); 134 while (doDispatch && !shutdown && cond.evaluate()) { 135 pumpOneEventForFilters(id); 136 } 137 removeEventFilter(filter); 138 } 139 140 void addEventFilter(EventFilter filter) { 141 eventLog.finest("adding the event filter: " + filter); 142 synchronized (eventFilters) { 143 if (!eventFilters.contains(filter)) { 144 if (filter instanceof ModalEventFilter) { 145 ModalEventFilter newFilter = (ModalEventFilter)filter; 146 int k = 0; 147 for (k = 0; k < eventFilters.size(); k++) { 148 EventFilter f = eventFilters.get(k); 149 if (f instanceof ModalEventFilter) { 150 ModalEventFilter cf = (ModalEventFilter)f; 151 if (cf.compareTo(newFilter) > 0) { 152 break; 153 } 154 } 155 } 156 eventFilters.add(k, filter); 157 } else { 158 eventFilters.add(filter); 159 } 160 } 161 } 162 } 163 164 void removeEventFilter(EventFilter filter) { 165 eventLog.finest("removing the event filter: " + filter); 166 synchronized (eventFilters) { 167 eventFilters.remove(filter); 168 } 169 } 170 171 void pumpOneEventForFilters(int id) { 172 AWTEvent event = null; 173 boolean eventOK = false; 174 try { 175 EventQueue eq = null; 176 EventQueueDelegate.Delegate delegate = null; 177 do { 178 // EventQueue may change during the dispatching 179 eq = getEventQueue(); 180 delegate = EventQueueDelegate.getDelegate(); 181 182 if (delegate != null && id == ANY_EVENT) { 183 event = delegate.getNextEvent(eq); 184 } else { 185 event = (id == ANY_EVENT) ? eq.getNextEvent() : eq.getNextEvent(id); 186 } 187 188 eventOK = true; 189 synchronized (eventFilters) { 190 for (int i = eventFilters.size() - 1; i >= 0; i--) { 191 EventFilter f = eventFilters.get(i); 192 EventFilter.FilterAction accept = f.acceptEvent(event); 193 if (accept == EventFilter.FilterAction.REJECT) { 194 eventOK = false; 195 break; 196 } else if (accept == EventFilter.FilterAction.ACCEPT_IMMEDIATELY) { 197 break; 198 } 199 } 200 } 201 eventOK = eventOK && SunDragSourceContextPeer.checkEvent(event); 202 if (!eventOK) { 203 event.consume(); 204 } 205 } 206 while (eventOK == false); 207 208 if (eventLog.isLoggable(PlatformLogger.FINEST)) { 209 eventLog.finest("Dispatching: " + event); 210 } 211 212 Object handle = null; 213 if (delegate != null) { 214 handle = delegate.beforeDispatch(event); 215 } 216 eq.dispatchEvent(event); 217 if (delegate != null) { 218 delegate.afterDispatch(event, handle); 219 } 220 } 221 catch (ThreadDeath death) { 222 shutdown = true; 223 throw death; 224 } 225 catch (InterruptedException interruptedException) { 226 shutdown = true; // AppContext.dispose() interrupts all 227 // Threads in the AppContext 228 } 229 catch (Throwable e) { 230 processException(e); 231 } 232 } 233 234 private void processException(Throwable e) { 235 if (eventLog.isLoggable(PlatformLogger.FINE)) { 236 eventLog.fine("Processing exception: " + e); 237 } 238 getUncaughtExceptionHandler().uncaughtException(this, e); 239 } 240 241 public synchronized EventQueue getEventQueue() { 242 return theQueue; 243 } 244 public synchronized void setEventQueue(EventQueue eq) { 245 theQueue = eq; 246 } 247 248 private static class HierarchyEventFilter implements EventFilter { 249 private Component modalComponent; 250 public HierarchyEventFilter(Component modalComponent) { 251 this.modalComponent = modalComponent; 252 } 253 public FilterAction acceptEvent(AWTEvent event) { 254 if (modalComponent != null) { 255 int eventID = event.getID(); 256 boolean mouseEvent = (eventID >= MouseEvent.MOUSE_FIRST) && 257 (eventID <= MouseEvent.MOUSE_LAST); 258 boolean actionEvent = (eventID >= ActionEvent.ACTION_FIRST) && 259 (eventID <= ActionEvent.ACTION_LAST); 260 boolean windowClosingEvent = (eventID == WindowEvent.WINDOW_CLOSING); 261 /* 262 * filter out MouseEvent and ActionEvent that's outside 263 * the modalComponent hierarchy. 264 * KeyEvent is handled by using enqueueKeyEvent 265 * in Dialog.show 266 */ 267 if (Component.isInstanceOf(modalComponent, "javax.swing.JInternalFrame")) { 268 /* 269 * Modal internal frames are handled separately. If event is 270 * for some component from another heavyweight than modalComp, 271 * it is accepted. If heavyweight is the same - we still accept 272 * event and perform further filtering in LightweightDispatcher 273 */ 274 return windowClosingEvent ? FilterAction.REJECT : FilterAction.ACCEPT; 275 } 276 if (mouseEvent || actionEvent || windowClosingEvent) { 277 Object o = event.getSource(); 278 if (o instanceof sun.awt.ModalExclude) { 279 // Exclude this object from modality and 280 // continue to pump it's events. 281 return FilterAction.ACCEPT; 282 } else if (o instanceof Component) { 283 Component c = (Component) o; 284 // 5.0u3 modal exclusion 285 boolean modalExcluded = false; 286 if (modalComponent instanceof Container) { 287 while (c != modalComponent && c != null) { 288 if ((c instanceof Window) && 289 (sun.awt.SunToolkit.isModalExcluded((Window)c))) { 290 // Exclude this window and all its children from 291 // modality and continue to pump it's events. 292 modalExcluded = true; 293 break; 294 } 295 c = c.getParent(); 296 } 297 } 298 if (!modalExcluded && (c != modalComponent)) { 299 return FilterAction.REJECT; 300 } 301 } 302 } 303 } 304 return FilterAction.ACCEPT; 305 } 306 } 307 }