Name: rmT116609 Date: 05/06/2004


FULL PRODUCT VERSION :
java version "1.4.2"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.4.2-b28)
Java HotSpot(TM) Client VM (build 1.4.2-b28, mixed mode)

java version "1.5.0-beta"
Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0-beta-b32c)
Java HotSpot(TM) Client VM (build 1.5.0-beta-b32c, mixed mode)

ADDITIONAL OS VERSION INFORMATION :
Microsoft Windows 2000 [Version 5.00.2195]

A DESCRIPTION OF THE PROBLEM :
The root pane of a JDialog only receives key events if the dialog's content pane contains an input field (e.g. a JTextField).

STEPS TO FOLLOW TO REPRODUCE THE PROBLEM :
The test code below opens a JDialog with a JLabel as sole component. The Escape-Key is registered as action key in the root pane's input map. The associated action closes the dialog. This example works in JDK 1.3.1 but neither in JDK 1.4.1 nor in JDK 1.4.2/1.5.0 Beta 1.

Now add a JTextField to the dialog. Then the dialog can be closed with ESC in JDK 1.4.1. You can also add a window listener to the dialog that requests the focus for the root pane if the dialog window has been opened. Then you can close the dialog with ESC as well.


REPRODUCIBILITY :
This bug can be reproduced always.

---------- BEGIN SOURCE ----------


import javax.swing.JDialog;
import javax.swing.BoxLayout;
import javax.swing.JLabel;
import javax.swing.KeyStroke;
import javax.swing.JComponent;
import javax.swing.AbstractAction;
import javax.swing.JFrame;
import javax.swing.JTextField;
import java.awt.Container;
import java.awt.Component;
import java.awt.TextField;
import java.awt.event.KeyEvent;
import java.awt.event.ActionEvent;
import java.awt.event.WindowEvent;
import java.awt.event.WindowAdapter;

/**
 *
 * User: schablin
 * Date: 23.02.2004
 * Time: 13:41:42
 *
 */
public class EscapeKeyDialogTest extends JDialog {

  /**
   *
   * @param owner
   */
  public EscapeKeyDialogTest(JFrame owner){
    super(owner, true);
    installKeyboardActions();
    Container contentPane = getContentPane();
    JLabel aLabel = new JLabel("Press ESC to close");
    
    contentPane.setLayout(new BoxLayout(contentPane, BoxLayout.Y_AXIS));
    aLabel.setName("aLabel");
    contentPane.add(aLabel);
    
    JTextField textField = new JTextField("");
    
    // adding a text field enables closing of dialog with ESC
    //textField.setName("testField");
    //contentPane.add(textField);
    
    addWindowListener(new WindowAdapter() {
      public void windowOpened(WindowEvent e) {
        // request focus for root pane to enable closing of dialog with ESC
        //getRootPane().requestFocus();
   
        Container contentPane = getContentPane();
        
        System.out.println("EscapeKeyDialogTest.windowOpened: dialog.hasFocus=" + EscapeKeyDialogTest.this.hasFocus());
        System.out.println("EscapeKeyDialogTest.windowOpened: contentPane.hasFocus=" + contentPane.hasFocus());
        System.out.println("EscapeKeyDialogTest.windowOpened: rootPane.hasFocus=" + getRootPane().hasFocus());
        for(int i = 0; i < contentPane.getComponentCount(); i++) {
          Component next = contentPane.getComponent(i);
          System.out.println("EscapeKeyDialogTest.windowOpened: component=" + next.getName() +
                             ", focus=" + next.hasFocus());
        }
      }
    });
  }
  
  /**
   *
   * @param args
   */
  public static void main(String[] args){
    JFrame frame = new JFrame("Frame");
    
    frame.setSize(100, 100);
    frame.show();
    
    frame.addWindowListener(new WindowAdapter(){
      public void windowClosed(WindowEvent e) {
        System.exit(0);
      }
      public void windowClosing(WindowEvent e) {
        System.exit(0);
      }
      
    });
    JDialog dlg = new EscapeKeyDialogTest(frame);
    
    dlg.pack();
    dlg.show();
    
  }
  
  
   /**
   * Installs the dialog's keyboard actions.
   */
  protected void installKeyboardActions(){
    //System.out.println("EscapeableDialog.installKeyboardActions");
    KeyStroke keyStroke = getKeyStroke(false);

    getRootPane().
      getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(keyStroke, "close");
    keyStroke = getKeyStroke(true);
    getRootPane().
      getInputMap(JComponent.WHEN_IN_FOCUSED_WINDOW).put(keyStroke, "close");
    getRootPane().getActionMap().put("close", new EscapeKeyDialogTest.CloseAction());
  }
    
  
  /**
    *
    */
   private KeyStroke getKeyStroke(boolean onKeyRelease){
     return KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0, onKeyRelease);
   }

   /**
   * Window-close action for the action map.
   */
  protected class CloseAction extends AbstractAction {

    public CloseAction(){
    }

    public void actionPerformed(ActionEvent e){
      System.out.println("EscapeKeyDialogTest$CloseAction.actionPerformed");
      switch(getDefaultCloseOperation()){
      case HIDE_ON_CLOSE:
        EscapeKeyDialogTest.this.setVisible(false);
        break;
      case DISPOSE_ON_CLOSE:
        EscapeKeyDialogTest.this.setVisible(false);
        dispose();
        break;
      case DO_NOTHING_ON_CLOSE:
        EscapeKeyDialogTest.this.
          processWindowEvent(new WindowEvent(EscapeKeyDialogTest.this,
                                             WindowEvent.WINDOW_CLOSING));
        break;
      }
    }
  }
}

---------- END SOURCE ----------

CUSTOMER SUBMITTED WORKAROUND :
Add a window listener that requests the focus for the root pane if the dialog window has been opened.
(Incident Review ID: 239981)
======================================================================
###@###.### 10/25/04 17:51 GMT