Swing/ModalInternalFrame のバックアップ(No.20)

TITLE:JInternalFrameをModalにする

Posted by at 2007-10-15

JInternalFrameをModalにする

`JInternalFrameをModalにして、他のJInternalFrame`などを操作できないようにブロックします。

  • &jnlp;
  • &jar;
  • &zip;
ModalInternalFrame.png

サンプルコード

//menuItem.setMnemonic(KeyEvent.VK_1);
class ModalInternalFrameAction1 extends AbstractAction {
  public ModalInternalFrameAction1(String label) {
    super(label);
  }
  @Override public void actionPerformed(ActionEvent e) {
    setJMenuEnabled(false);
    JOptionPane.showInternalMessageDialog(
      desktop, "information", "modal1", JOptionPane.INFORMATION_MESSAGE);
    setJMenuEnabled(true);
  }
}
View in GitHub: Java, Kotlin
//menuItem.setMnemonic(KeyEvent.VK_2);
class ModalInternalFrameAction2 extends AbstractAction {
  private final JPanel glass = new MyGlassPane();
  public ModalInternalFrameAction2(String label) {
    super(label);
    Rectangle screen = frame.getGraphicsConfiguration().getBounds();
    glass.setBorder(BorderFactory.createEmptyBorder());
    glass.setLocation(0,0);
    glass.setSize(screen.width, screen.height);
    glass.setOpaque(false);
    glass.setVisible(false);
    desktop.add(glass, JLayeredPane.MODAL_LAYER);
  }
  @Override public void actionPerformed(ActionEvent e) {
    setJMenuEnabled(false);
    glass.setVisible(true);
    JOptionPane.showInternalMessageDialog(
      desktop, "information", "modal2", JOptionPane.INFORMATION_MESSAGE);
    glass.setVisible(false);
    setJMenuEnabled(true);
  }
}

//menuItem.setMnemonic(KeyEvent.VK_3);
//Creating Modal Internal Frames -- Approach 1 and Approach 2
//http://java.sun.com/developer/JDCTechTips/2001/tt1220.html
class ModalInternalFrameAction3 extends AbstractAction {
  private final Component orgGlassPane;
  private final JPanel glass = new PrintGlassPane();
  public ModalInternalFrameAction3(String label) {
    super(label);
    orgGlassPane = frame.getGlassPane();
    glass.setVisible(false);
  }
  @Override public void actionPerformed(ActionEvent e) {
    JOptionPane optionPane = new JOptionPane();
    optionPane.setMessage("Hello, World");
    optionPane.setMessageType(JOptionPane.INFORMATION_MESSAGE);
    JInternalFrame modal = optionPane.createInternalFrame(desktop, "modal3");
    removeSystemMenuListener(modal);
    modal.addInternalFrameListener(new InternalFrameAdapter() {
      @Override public void internalFrameClosed(InternalFrameEvent e) {
        glass.setVisible(false);
        frame.setGlassPane(orgGlassPane);
      }
    });
    glass.add(modal);
    //Rectangle screen = desktop.getBounds();
    //modal.setLocation(screen.x + screen.width/2  - modal.getSize().width/2,
    //                  screen.y + screen.height/2 - modal.getSize().height/2);
    frame.setGlassPane(glass);
    glass.setVisible(true);
    modal.setVisible(true);
    try{
      modal.setSelected(true);
    }catch(java.beans.PropertyVetoException ex) {}
  }
}

解説

  • Alt+1: `JOptionPane.showInternalMessageDialogメソッドを使用して、簡単なメッセージを表示するModalなDialogをJDesktopPane`内に表示
    • `JButtonのマウスクリックは無効になるが、Mnemonic`が無効にならない
      • Alt+Bでボタンを押すことが出来てしまう
      • `Mnemonicを設定したコンポーネントはsetEnabled(false)`とする必要がある
    • `MnemonicをJMenuに設定しているとsetEnabled(false)`としても、Altキーに反応する
      • これは`WindowsLookAndFeel`だけ？
      • この`InternalMessageDialogを表示している間は、JMenuBar`をダミーと入れ替えて無効化
    • この`InternalMessageDialog`を閉じない限り、アプリケーションをAlt+F4などで閉じることは出来ない
    • `InternalMessageDialog`のシステムメニュー(左上のアイコンをクリックすると表示される)がマウスで操作不可能
    • `JToolTip`は正常
      • `showInternalMessageDialog(...)メソッド内で、pane.putClientProperty(PopupFactory_FORCE_HEAVYWEIGHT_POPUP, Boolean.TRUE)(JDK 1.6.0の場合のKeyは、PopupFactory.forceHeavyWeightPopupKey) されているため、JComboBox`などのドロップダウンメニューも正常
  • Alt+2: Alt+1と同様に`JOptionPane.showInternalMessageDialogメソッドを使用し、かつ半透明なGlassPaneをJLayeredPane.MODAL_LAYER`に追加
    • 動作、制限などは、Alt+2の`InternalMessageDialog`と同じ
    • `JDesktopPane`内にマスクが掛かる
  • Alt+3: `JFrameに半透明なGlassPaneを追加し、そこにJInternalFrameを追加することでModal`に設定
    • `JFrame内全体(JMenuBar`なども含む)にマスクが掛かる
    • `InternalMessageDialogのシステムメニューが自身のレイヤーより奥に表示されるため、アイコン(JLabel`)をクリックしても反応しないようにリスナーを除去
    • `JComboBoxをInternalMessageDialog`に追加すると、そのドロップダウンメニューが裏に表示される
    • この`InternalMessageDialog`を開いていても、アプリケーションをAlt+F4などで閉じることが出来てしまう
  • Alt+3の方法で、`InternalOptionDialogにJComboBoxを追加する場合、ドロップダウンメニューを正しく表示させるには、リフレクションを使ってClientProperty`を設定するしかない？
    • `JInternalFrame#putClientProperty(PopupFactory_FORCE_HEAVYWEIGHT_POPUP, Boolean.TRUE)とすれば、システムメニューも正常に表示されるが、JOptionPane.showInternalXXXDialogでは、なぜかJOptionPaneに設定するようになっている(JInternalFrame`は使い回ししているから？)
JInternalFrame modal = optionPane.createInternalFrame(desktop, "modal3");
JComboBox combo = new JComboBox(new String[] {"Banana", "Apple", "Pear", "Grape"});
combo.setEditable(true);
try{
  Field field;
  if(System.getProperty("java.version").startsWith("1.6.0")) {
    Class clazz = Class.forName("javax.swing.PopupFactory");
    field = clazz.getDeclaredField("forceHeavyWeightPopupKey");
  }else{ //1.7.0, 1.8.0
    Class clazz = Class.forName("javax.swing.ClientPropertyKey");
    field = clazz.getDeclaredField("PopupFactory_FORCE_HEAVYWEIGHT_POPUP");
  }
  field.setAccessible(true);
  modal.putClientProperty(field.get(null), Boolean.TRUE);
}catch(Exception ex) {
  ex.printStackTrace();
}
optionPane.setMessage(combo);
optionPane.setMessageType(JOptionPane.QUESTION_MESSAGE);

Alexander Potochkin's Blog: Disabling Swing Containers, the final solution?を参考に(`paintではなく、printが使用されている)して、GlassPaneを以下のように修正すると、上記のサンプルのAlt+3(Alt+2の場合は、描画が乱れる)は、Mnemonic`もうまくブロックできるようです。

  • `JFrameのメニューバーのMnemonic`もブロックできる
    • `JRootPaneから取得したLayeredPaneが非表示なので、その子コンポーネント(JMenuBarやContentPane`など)のキーイベントがすべて無効になる
    • JRootPane (Java Platform SE 6)の図にあるように、`GlassPaneは、JRootPaneの最上位の子コンポーネントなので、LayeredPane`を画像として表示している
  • `JFrame`のシステムメニューはブロックできない
  • モーダルにした`JInternalFrame`のシステムメニューは表示されない
    • ただし表示されないだけで、クリックしてからカーソル移動やダブルクリックなどが動いてしまう
  • モーダルにした`JInternalFrameの右上の閉じるボタンのJToolTipがJDesktopPane内で表示される場合、空白になる JDK 6ではJToolTip`は表示されない
class PrintGlassPane extends JPanel {
  TexturePaint texture = TextureFactory.createCheckerTexture(4);
  public PrintGlassPane() {
    super((LayoutManager)null);
    setOpaque(false);
  }
  @Override public void setVisible(boolean isVisible) {
    boolean oldVisible = isVisible();
    super.setVisible(isVisible);
    JRootPane rootPane = SwingUtilities.getRootPane(this);
    if(rootPane!=null && isVisible()!=oldVisible) {
      rootPane.getLayeredPane().setVisible(!isVisible);
    }
  }
  @Override public void paintComponent(Graphics g) {
    JRootPane rootPane = SwingUtilities.getRootPane(this);
    if(rootPane!=null) {
      //http://weblogs.java.net/blog/alexfromsun/archive/2008/01/
      // it is important to call print() instead of paint() here
      // because print() doesn't affect the frame's double buffer
      rootPane.getLayeredPane().print(g);
    }
    Graphics2D g2 = (Graphics2D) g;
    g2.setPaint(texture);
    g2.fillRect(0,0,getWidth(),getHeight());
  }
}

`JDK 6`の場合、Disabled Glass Pane « Java Tips Weblogのようにキー入力を無効にするキーリスナーを追加する方法もあります。

この方法は、`JDK 5などの場合、WindowsLookAndFeel`で、Altキーを押すとメニューバーにフォーカスが移ることがあります。

参考リンク

コメント

  • JInternalFrameを半透明にすると、同様に`GlassPaneがUbuntu(GNOME`)などで半透明にならない場合があります。 -- aterai
    • Alt+2で開いた場合、`JInternalFrameにGlassPaneを乗せるのではなく、直接JDesktopPaneのJLayeredPane.MODAL_LAYER`に追加するように変更しました。 -- aterai
  • メモ: Alexander Potochkin's Blog: Disabling Swing Containers, the final solution?のサンプルでは、`Mnemonic`もちゃんとブロックできているようなので、「あとで調べる & 参考にする」こと。 -- aterai
  • `Mnemonic`を数字キー(1, 2, 3)に変更 -- aterai
  • すべての`Mnemonicを一時的に無効化したい場合に、UIManager.javaのprivate static final String disableMnemonicKey = "swing.disablenavaids";は使えない？ 以下のように、KeyboardFocusManager.setCurrentKeyboardFocusManager(...)`で、Altキーなどを無視する方法もあるが…、もっと簡単な方法を調査中。 -- aterai 
KeyboardFocusManager manager = KeyboardFocusManager.getCurrentKeyboardFocusManager();
KeyboardFocusManager.setCurrentKeyboardFocusManager(new DefaultKeyboardFocusManager() {
  @Override public boolean dispatchEvent(AWTEvent e) {
    if(e instanceof KeyEvent) {
      KeyEvent ke = (KeyEvent)e;
      if((ke.getModifiers() & InputEvent.ALT_MASK) != 0) {
        System.out.println("----\n"+ke);
        return false;
      }
    }
    return super.dispatchEvent(e);
  }
});
JComboBox<String> combo = new JComboBox<>(new String[] {"Banana", "Apple", "Pear", "Grape"});
combo.setEditable(true);

JOptionPane.showInternalMessageDialog(
  desktop, combo, "modal1", JOptionPane.INFORMATION_MESSAGE);
KeyboardFocusManager.setCurrentKeyboardFocusManager(manager);