Swing/WaitCursor のバックアップ(No.8)

TITLE:Cursorを砂時計に変更

Cursorを砂時計に変更

Posted by terai at 2004-06-07

概要

処理中、マウスカーソルを砂時計に変更します。

  • &jnlp;
  • &jar;
  • &zip;

#screenshot

サンプルコード

frame.setGlassPane(new LockingGlassPane());
frame.getGlassPane().setVisible(false);
button.addActionListener(new ActionListener() {
  public void actionPerformed(ActionEvent e) {
    //System.out.println("actionPerformed: " + EventQueue.isDispatchThread());
    frame.getGlassPane().setVisible(true);
    button.setEnabled(false);
    Thread t = new Thread() {
      public void run() {
        //System.out.println("Thread: " + EventQueue.isDispatchThread());
        dummyLongTask();
        EventQueue.invokeLater(new Runnable() {
          public void run() {
            //System.out.println("invokeLater: " + EventQueue.isDispatchThread());
            frame.getGlassPane().setVisible(false);
            button.setEnabled(true);
          }
        });
      }
    };
    //t.setPriority(Thread.MIN_PRIORITY);
    t.start();
  }
});

class LockingGlassPane extends JComponent {
  public LockingGlassPane() {
    setOpaque(false);
    setFocusTraversalPolicy(new DefaultFocusTraversalPolicy() {
      public boolean accept(Component c) {return false;}
    });
    addKeyListener(new KeyAdapter() {});
    addMouseListener(new MouseAdapter() {});
    requestFocusInWindow();
    setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
  }
  public void setVisible(boolean flag) {
    super.setVisible(flag);
    setFocusTraversalPolicyProvider(flag);
  }
}

解説

上記のサンプルでは、カーソルを砂時計に変更し、なにもしないマウスリスナーなどを設定したGlassPaneをJFrame#setGlassPane()メソッドでフレームに追加しています。

スタートボタンがクリックされて処理が継続している間は、このGlassPaneが有効になり、マウス、キー、フォーカス移動などのイベントが、すべてGlassPaneに奪われるため、フレーム内のコンポーネントをアクセス不可にすることが出来ます。

このため、サンプルにあるsetEnabled(true)なJTextFieldの上にマウスポインタを移動しても、処理中はカーソルアイコンは砂時計のまま変化しません。

タブキーなどによるフォーカス移動を禁止する場合は、GlassPaneに以下のような設定を行います。

  • どのコンポーネントにもフォーカス移動できないFocusTraversalPolicyを設定する
setFocusTraversalPolicy(new DefaultFocusTraversalPolicy() {
  public boolean accept(Component c) {return false;}
});

Set<AWTKeyStroke> s = Collections.emptySet();
setFocusTraversalKeys(KeyboardFocusManager.FORWARD_TRAVERSAL_KEYS, s);
setFocusTraversalKeys(KeyboardFocusManager.BACKWARD_TRAVERSAL_KEYS, s);

Mnemonic なども禁止したい場合は、以下のようなGlassPaneを使用する方法があります(参考:Disabling Swing Containers, the final solution?)。

class LockingGlassPane extends JComponent {
  public LockingGlassPane() {
    setOpaque(false);
    super.setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
  }
  @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);
    }
    super.paintComponent(g);
  }
}

参考リンク

コメント

  • Tabキーで状態遷移しないようにするため、なにもしないFocusTraversalPolicyを追加しました。 -- terai
  • 相当悩みました。JDialog だと同じことができないのは何でなんでしょうねぇ。。。 -- おれ？
    • カーソルが変わらないのでしょうか? それともコンパイルエラーが出るとかでしょうか? -- terai
  • 申し訳ない。カーソルが変わらないのだけれど、1.5系でコンパイルするとだめみたい。同じソースでも1.4系でコンパイルするとちゃんと変わる。1.5でのバグかな。。。 -- おれ？
    • 追記。JDialog のコンストラクタに null を指定しているとこうなるようです。オーナフレームを指定してあげたら、1.5でもきちんと出ました。お騒がせしました。 -- おれ？
    • なるほど、new JDialog((Frame)null);で試してみるとカーソルが変わらないですね。情報どうもでした。 -- terai
  • DefaultFocusTraversalPolicy を使うように変更しました。 -- terai
  • GlassPaneで、FocusTraversalPolicyを使わず、print を使ってMnemonicなどをブロックするように変更しました。 -- terai