EscapableDialog.java :  » Swing-Library » RText-1.1.0 » org » fife » ui » Java Open Source

package org.fife.ui;

import java.awt.Dialog;
import java.awt.Frame;
import java.awt.event.ActionEvent;
import java.awt.event.KeyEvent;
import javax.swing.AbstractAction;
import javax.swing.ActionMap;
import javax.swing.InputMap;
import javax.swing.JComponent;
import javax.swing.JDialog;
import javax.swing.JRootPane;
import javax.swing.KeyStroke;


/**
 * A dialog that closes itself when the Escape key is pressed.  Subclasses
 * can extend the {@link #escapePressed()} method and provide custom handling
 * logic (parameter validation, custom closing, etc.).
 *
 * @author Robert Futrell
 * @version 1.0
 */
public abstract class EscapableDialog extends JDialog {

  /**
   * The key in an <code>InputMap</code> for the Escape key action.
   */
  private static final String ESCAPE_KEY    = "OnEsc";


  /**
   * Constructor.
   */
  public EscapableDialog() {
    init();
  }


  /**
   * Constructor.
   *
   * @param owner The parent dialog.
   */
  public EscapableDialog(Dialog owner) {
    super(owner);
    init();
  }


  /**
   * Constructor.
   *
   * @param owner The parent dialog.
   */
  public EscapableDialog(Dialog owner, boolean modal) {
    super(owner, modal);
    init();
  }


  /**
   * Constructor.
   *
   * @param owner The parent dialog.
   */
  public EscapableDialog(Dialog owner, String title) {
    super(owner, title);
    init();
  }


  /**
   * Constructor.
   *
   * @param owner The parent dialog.
   */
  public EscapableDialog(Dialog owner, String title, boolean modal) {
    super(owner, title, modal);
    init();
  }


  /**
   * Constructor.
   *
   * @param owner The parent frame.
   */
  public EscapableDialog(Frame owner) {
    super(owner);
    init();
  }


  /**
   * Constructor.
   *
   * @param owner The parent frame.
   */
  public EscapableDialog(Frame owner, boolean modal) {
    super(owner, modal);
    init();
  }


  /**
   * Constructor.
   *
   * @param owner The parent frame.
   */
  public EscapableDialog(Frame owner, String title) {
    super(owner, title);
    init();
  }


  /**
   * Constructor.
   *
   * @param owner The parent frame.
   */
  public EscapableDialog(Frame owner, String title, boolean modal) {
    super(owner, title, modal);
    init();
  }


  /**
   * Called when the Escape key is pressed in this dialog.  Subclasses
   * can override to handle any custom "Cancel" logic.  The default
   * implementation hides the dialog (via <code>setVisible(false);</code>).
   */
  protected void escapePressed() {
    setVisible(false);
  }


  /**
   * Initializes this dialog.
   */
  private void init() {
    setEscapeClosesDialog(true);
  }


  /**
   * Toggles whether the Escape key closes this dialog.
   *
   * @param closes Whether Escape should close this dialog (actually,
   *        whether {@link #escapePressed()} should be called when Escape
   *        is pressed).
   */
  public void setEscapeClosesDialog(boolean closes) {

    JRootPane rootPane = getRootPane();
    InputMap im = rootPane.getInputMap(
                JComponent.WHEN_IN_FOCUSED_WINDOW);
    ActionMap actionMap = rootPane.getActionMap();
    KeyStroke ks = KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0);

    if (closes) {
      im.put(ks, ESCAPE_KEY);
         actionMap.put(ESCAPE_KEY, new AbstractAction() {
        public void actionPerformed(ActionEvent e) {
          escapePressed();
        }
      });
    }
    else {
      im.remove(ks);
      actionMap.remove(ESCAPE_KEY);
    }

  }


}