1 /* 2 * Copyright (c) 1998, 2013, 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 package javax.swing; 26 27 28 import java.util.*; 29 import java.awt.*; 30 import java.awt.event.*; 31 import java.applet.*; 32 import java.beans.*; 33 import javax.swing.event.*; 34 import sun.awt.EmbeddedFrame; 35 36 /** 37 * The KeyboardManager class is used to help dispatch keyboard actions for the 38 * WHEN_IN_FOCUSED_WINDOW style actions. Actions with other conditions are handled 39 * directly in JComponent. 40 * 41 * Here's a description of the symantics of how keyboard dispatching should work 42 * atleast as I understand it. 43 * 44 * KeyEvents are dispatched to the focused component. The focus manager gets first 45 * crack at processing this event. If the focus manager doesn't want it, then 46 * the JComponent calls super.processKeyEvent() this allows listeners a chance 47 * to process the event. 48 * 49 * If none of the listeners "consumes" the event then the keybindings get a shot. 50 * This is where things start to get interesting. First, KeyStokes defined with the 51 * WHEN_FOCUSED condition get a chance. If none of these want the event, then the component 52 * walks though it's parents looked for actions of type WHEN_ANCESTOR_OF_FOCUSED_COMPONENT. 53 * 54 * If no one has taken it yet, then it winds up here. We then look for components registered 55 * for WHEN_IN_FOCUSED_WINDOW events and fire to them. Note that if none of those are found 56 * then we pass the event to the menubars and let them have a crack at it. They're handled differently. 57 * 58 * Lastly, we check if we're looking at an internal frame. If we are and no one wanted the event 59 * then we move up to the InternalFrame's creator and see if anyone wants the event (and so on and so on). 60 * 61 * 62 * @see InputMap 63 */ 64 class KeyboardManager { 65 66 static KeyboardManager currentManager = new KeyboardManager(); 67 68 /** 69 * maps top-level containers to a sub-hashtable full of keystrokes 70 */ 71 Hashtable<Container, Hashtable<Object, Object>> containerMap = new Hashtable<>(); 72 73 /** 74 * Maps component/keystroke pairs to a topLevel container 75 * This is mainly used for fast unregister operations 76 */ 77 Hashtable<ComponentKeyStrokePair, Container> componentKeyStrokeMap = new Hashtable<>(); 78 79 public static KeyboardManager getCurrentManager() { 80 return currentManager; 81 } 82 83 public static void setCurrentManager(KeyboardManager km) { 84 currentManager = km; 85 } 86 87 /** 88 * register keystrokes here which are for the WHEN_IN_FOCUSED_WINDOW 89 * case. 90 * Other types of keystrokes will be handled by walking the hierarchy 91 * That simplifies some potentially hairy stuff. 92 */ 93 public void registerKeyStroke(KeyStroke k, JComponent c) { 94 Container topContainer = getTopAncestor(c); 95 if (topContainer == null) { 96 return; 97 } 98 Hashtable<Object, Object> keyMap = containerMap.get(topContainer); 99 100 if (keyMap == null) { // lazy evaluate one 101 keyMap = registerNewTopContainer(topContainer); 102 } 103 104 Object tmp = keyMap.get(k); 105 if (tmp == null) { 106 keyMap.put(k,c); 107 } else if (tmp instanceof Vector) { // if there's a Vector there then add to it. 108 @SuppressWarnings("unchecked") 109 Vector<Object> v = (Vector)tmp; 110 if (!v.contains(c)) { // only add if this keystroke isn't registered for this component 111 v.addElement(c); 112 } 113 } else if (tmp instanceof JComponent) { 114 // if a JComponent is there then remove it and replace it with a vector 115 // Then add the old compoennt and the new compoent to the vector 116 // then insert the vector in the table 117 if (tmp != c) { // this means this is already registered for this component, no need to dup 118 Vector<JComponent> v = new Vector<>(); 119 v.addElement((JComponent) tmp); 120 v.addElement(c); 121 keyMap.put(k, v); 122 } 123 } else { 124 System.out.println("Unexpected condition in registerKeyStroke"); 125 Thread.dumpStack(); 126 } 127 128 componentKeyStrokeMap.put(new ComponentKeyStrokePair(c,k), topContainer); 129 130 // Check for EmbeddedFrame case, they know how to process accelerators even 131 // when focus is not in Java 132 if (topContainer instanceof EmbeddedFrame) { 133 ((EmbeddedFrame)topContainer).registerAccelerator(k); 134 } 135 } 136 137 /** 138 * Find the top focusable Window, Applet, or InternalFrame 139 */ 140 private static Container getTopAncestor(JComponent c) { 141 for(Container p = c.getParent(); p != null; p = p.getParent()) { 142 if (p instanceof Window && ((Window)p).isFocusableWindow() || 143 p instanceof Applet || p instanceof JInternalFrame) { 144 145 return p; 146 } 147 } 148 return null; 149 } 150 151 public void unregisterKeyStroke(KeyStroke ks, JComponent c) { 152 153 // component may have already been removed from the hierarchy, we 154 // need to look up the container using the componentKeyStrokeMap. 155 156 ComponentKeyStrokePair ckp = new ComponentKeyStrokePair(c,ks); 157 158 Container topContainer = componentKeyStrokeMap.get(ckp); 159 160 if (topContainer == null) { // never heard of this pairing, so bail 161 return; 162 } 163 164 Hashtable<Object, Object> keyMap = containerMap.get(topContainer); 165 if (keyMap == null) { // this should never happen, but I'm being safe 166 Thread.dumpStack(); 167 return; 168 } 169 170 Object tmp = keyMap.get(ks); 171 if (tmp == null) { // this should never happen, but I'm being safe 172 Thread.dumpStack(); 173 return; 174 } 175 176 if (tmp instanceof JComponent && tmp == c) { 177 keyMap.remove(ks); // remove the KeyStroke from the Map 178 //System.out.println("removed a stroke" + ks); 179 } else if (tmp instanceof Vector ) { // this means there is more than one component reg for this key 180 Vector<?> v = (Vector)tmp; 181 v.removeElement(c); 182 if ( v.isEmpty() ) { 183 keyMap.remove(ks); // remove the KeyStroke from the Map 184 //System.out.println("removed a ks vector"); 185 } 186 } 187 188 if ( keyMap.isEmpty() ) { // if no more bindings in this table 189 containerMap.remove(topContainer); // remove table to enable GC 190 //System.out.println("removed a container"); 191 } 192 193 componentKeyStrokeMap.remove(ckp); 194 195 // Check for EmbeddedFrame case, they know how to process accelerators even 196 // when focus is not in Java 197 if (topContainer instanceof EmbeddedFrame) { 198 ((EmbeddedFrame)topContainer).unregisterAccelerator(ks); 199 } 200 } 201 202 /** 203 * This method is called when the focused component (and none of 204 * its ancestors) want the key event. This will look up the keystroke 205 * to see if any chidren (or subchildren) of the specified container 206 * want a crack at the event. 207 * If one of them wants it, then it will "DO-THE-RIGHT-THING" 208 */ 209 public boolean fireKeyboardAction(KeyEvent e, boolean pressed, Container topAncestor) { 210 211 if (e.isConsumed()) { 212 System.out.println("Acquired pre-used event!"); 213 Thread.dumpStack(); 214 } 215 216 // There may be two keystrokes associated with a low-level key event; 217 // in this case a keystroke made of an extended key code has a priority. 218 KeyStroke ks; 219 KeyStroke ksE = null; 220 221 222 if(e.getID() == KeyEvent.KEY_TYPED) { 223 ks=KeyStroke.getKeyStroke(e.getKeyChar()); 224 } else { 225 if(e.getKeyCode() != e.getExtendedKeyCode()) { 226 ksE=KeyStroke.getKeyStroke(e.getExtendedKeyCode(), e.getModifiers(), !pressed); 227 } 228 ks=KeyStroke.getKeyStroke(e.getKeyCode(), e.getModifiers(), !pressed); 229 } 230 231 Hashtable<Object, Object> keyMap = containerMap.get(topAncestor); 232 if (keyMap != null) { // this container isn't registered, so bail 233 234 Object tmp = null; 235 // extended code has priority 236 if( ksE != null ) { 237 tmp = keyMap.get(ksE); 238 if( tmp != null ) { 239 ks = ksE; 240 } 241 } 242 if( tmp == null ) { 243 tmp = keyMap.get(ks); 244 } 245 246 if (tmp == null) { 247 // don't do anything 248 } else if ( tmp instanceof JComponent) { 249 JComponent c = (JComponent)tmp; 250 if ( c.isShowing() && c.isEnabled() ) { // only give it out if enabled and visible 251 fireBinding(c, ks, e, pressed); 252 } 253 } else if ( tmp instanceof Vector) { //more than one comp registered for this 254 Vector<?> v = (Vector)tmp; 255 // There is no well defined order for WHEN_IN_FOCUSED_WINDOW 256 // bindings, but we give precedence to those bindings just 257 // added. This is done so that JMenus WHEN_IN_FOCUSED_WINDOW 258 // bindings are accessed before those of the JRootPane (they 259 // both have a WHEN_IN_FOCUSED_WINDOW binding for enter). 260 for (int counter = v.size() - 1; counter >= 0; counter--) { 261 JComponent c = (JComponent)v.elementAt(counter); 262 //System.out.println("Trying collision: " + c + " vector = "+ v.size()); 263 if ( c.isShowing() && c.isEnabled() ) { // don't want to give these out 264 fireBinding(c, ks, e, pressed); 265 if (e.isConsumed()) 266 return true; 267 } 268 } 269 } else { 270 System.out.println( "Unexpected condition in fireKeyboardAction " + tmp); 271 // This means that tmp wasn't null, a JComponent, or a Vector. What is it? 272 Thread.dumpStack(); 273 } 274 } 275 276 if (e.isConsumed()) { 277 return true; 278 } 279 // if no one else handled it, then give the menus a crack 280 // The're handled differently. The key is to let any JMenuBars 281 // process the event 282 if ( keyMap != null) { 283 @SuppressWarnings("unchecked") 284 Vector<JMenuBar> v = (Vector)keyMap.get(JMenuBar.class); 285 if (v != null) { 286 Enumeration<JMenuBar> iter = v.elements(); 287 while (iter.hasMoreElements()) { 288 JMenuBar mb = iter.nextElement(); 289 if ( mb.isShowing() && mb.isEnabled() ) { // don't want to give these out 290 boolean extended = (ksE != null) && !ksE.equals(ks); 291 if (extended) { 292 fireBinding(mb, ksE, e, pressed); 293 } 294 if (!extended || !e.isConsumed()) { 295 fireBinding(mb, ks, e, pressed); 296 } 297 if (e.isConsumed()) { 298 return true; 299 } 300 } 301 } 302 } 303 } 304 305 return e.isConsumed(); 306 } 307 308 void fireBinding(JComponent c, KeyStroke ks, KeyEvent e, boolean pressed) { 309 if (c.processKeyBinding(ks, e, JComponent.WHEN_IN_FOCUSED_WINDOW, 310 pressed)) { 311 e.consume(); 312 } 313 } 314 315 public void registerMenuBar(JMenuBar mb) { 316 Container top = getTopAncestor(mb); 317 if (top == null) { 318 return; 319 } 320 Hashtable<Object, Object> keyMap = containerMap.get(top); 321 322 if (keyMap == null) { // lazy evaluate one 323 keyMap = registerNewTopContainer(top); 324 } 325 // use the menubar class as the key 326 @SuppressWarnings("unchecked") 327 Vector<Object> menuBars = (Vector)keyMap.get(JMenuBar.class); 328 329 if (menuBars == null) { // if we don't have a list of menubars, 330 // then make one. 331 menuBars = new Vector<>(); 332 keyMap.put(JMenuBar.class, menuBars); 333 } 334 335 if (!menuBars.contains(mb)) { 336 menuBars.addElement(mb); 337 } 338 } 339 340 341 public void unregisterMenuBar(JMenuBar mb) { 342 Container topContainer = getTopAncestor(mb); 343 if (topContainer == null) { 344 return; 345 } 346 Hashtable<Object, Object> keyMap = containerMap.get(topContainer); 347 if (keyMap!=null) { 348 Vector<?> v = (Vector)keyMap.get(JMenuBar.class); 349 if (v != null) { 350 v.removeElement(mb); 351 if (v.isEmpty()) { 352 keyMap.remove(JMenuBar.class); 353 if (keyMap.isEmpty()) { 354 // remove table to enable GC 355 containerMap.remove(topContainer); 356 } 357 } 358 } 359 } 360 } 361 protected Hashtable<Object, Object> registerNewTopContainer(Container topContainer) { 362 Hashtable<Object, Object> keyMap = new Hashtable<>(); 363 containerMap.put(topContainer, keyMap); 364 return keyMap; 365 } 366 367 /** 368 * This class is used to create keys for a hashtable 369 * which looks up topContainers based on component, keystroke pairs 370 * This is used to make unregistering KeyStrokes fast 371 */ 372 class ComponentKeyStrokePair { 373 Object component; 374 Object keyStroke; 375 376 public ComponentKeyStrokePair(Object comp, Object key) { 377 component = comp; 378 keyStroke = key; 379 } 380 381 public boolean equals(Object o) { 382 if ( !(o instanceof ComponentKeyStrokePair)) { 383 return false; 384 } 385 ComponentKeyStrokePair ckp = (ComponentKeyStrokePair)o; 386 return ((component.equals(ckp.component)) && (keyStroke.equals(ckp.keyStroke))); 387 } 388 389 public int hashCode() { 390 return component.hashCode() * keyStroke.hashCode(); 391 } 392 393 } 394 395 } // end KeyboardManager