Swing/WaitCursor のバックアップの現在との差分(No.11)

TITLE:Cursorを砂時計に変更
Posted by aterai at 2004-06-07

Cursorを砂時計に変更

 処理中、マウスカーソルを砂時計に変更します。
  • category: swing folder: WaitCursor title: Cursorを砂時計に変更 tags: [Cursor, GlassPane, FocusTraversalPolicy, SwingWorker] author: aterai pubdate: 2004-06-07T13:57:16+09:00 description: バックグラウンドで処理が実行されている間は、Cursorに砂時計が設定されたGlassPaneを有効にします。 image: https://lh5.googleusercontent.com/_9Z4BYR88imo/TQTWfYWDbsI/AAAAAAAAApU/rldJwQuVm-8/s800/WaitCursor.png

概要

バックグラウンドで処理が実行されている間は、Cursorに砂時計が設定されたGlassPaneを有効にします。
WaitCursor.png

サンプルコード

 
#spanend
#spanadd
* サンプルコード [#sourcecode]
#spanend
#spanadd
#code(link){{
#spanend
frame.setGlassPane(new LockingGlassPane());
frame.getGlassPane().setVisible(false);
button.addActionListener(new ActionListener() {
  @Override public void actionPerformed(ActionEvent e) {
    frame.getGlassPane().setVisible(true);
    button.setEnabled(false);
    new SwingWorker() {
      @Override public Object doInBackground() {
        dummyLongTask();
        doSomeLongTask();
        return "Done";
      }
#spanadd

#spanend
      @Override public void done() {
        frame.getGlassPane().setVisible(false);
        button.setEnabled(true);
      }
  }.execute();
#spandel
}
#spanend
    }.execute();
  }
});
#spandel

#spanend
#spanadd
// ...
#spanend
class LockingGlassPane extends JComponent {
  public LockingGlassPane() {
    setOpaque(false);
    setFocusTraversalPolicy(new DefaultFocusTraversalPolicy() {
      @Override public boolean accept(Component c) {return false;}
      @Override public boolean accept(Component c) {
        return false;
      }
    });
    addKeyListener(new KeyAdapter() {});
    addMouseListener(new MouseAdapter() {});
    requestFocusInWindow();
    setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
  }
#spanadd

#spanend
  @Override public void setVisible(boolean flag) {
    super.setVisible(flag);
    setFocusTraversalPolicyProvider(flag);
  }
}

解説

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

解説

 上記のサンプルでは、カーソルを砂時計に変更し、なにもしないマウスリスナーなどを設定したGlassPaneをJFrame#setGlassPane()メソッドでフレームに追加しています。 スタートボタンがクリックされて処理が継続している間は、このGlassPaneが有効になり、マウス、キー、フォーカス移動などのイベントが、すべてGlassPaneに奪われるため、フレーム内のコンポーネントをアクセス不可にすることが出来ます。 スタートボタンがクリックされて処理が継続している間はこのGlassPaneが有効になり、マウス、キー入力、フォーカス移動などのイベントがすべてGlassPaneに奪われるため、フレーム内のコンポーネントがアクセス不可状態になります。 このため、サンプルにあるsetEnabled(true)なJTextFieldの上にマウスポインタを移動しても、処理中はカーソルアイコンは砂時計のまま変化しません。 このため、サンプルにあるsetEnabled(true)なJTextFieldの上にマウスポインタを移動しても処理中はカーソルアイコンは砂時計のまま変化しません。
タブキーなどによるフォーカス移動を禁止する場合は、GlassPaneに以下のような設定を行います。
  • どのコンポーネントにもフォーカス移動できないFocusTraversalPolicyを設定する Tabキーなどによるフォーカス移動を禁止する場合は、GlassPaneに以下のような設定を行います。
  • どのコンポーネントにもフォーカス移動できないFocusTraversalPolicyを設定する 
setFocusTraversalPolicy(new DefaultFocusTraversalPolicy() {
  @Override public boolean accept(Component c) {return false;}
  @Override 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?)。 Mnemonicなども禁止したい場合は、以下のようなGlassPaneを使用する方法があります(参考: Disabling Swing Containers, the final solution?)。 
class LockingGlassPane extends JComponent {
  public LockingGlassPane() {
    setOpaque(false);
    super.setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
  }
#spanadd

#spanend
  @Override public void setVisible(boolean isVisible) {
    boolean oldVisible = isVisible();
    super.setVisible(isVisible);
    JRootPane rootPane = SwingUtilities.getRootPane(this);
    if(rootPane!=null && isVisible()!=oldVisible) {
    if (rootPane != null && isVisible() != oldVisible) {
      rootPane.getLayeredPane().setVisible(!isVisible);
    }
  }
  @Override public void paintComponent(Graphics g) {
#spanadd

#spanend
  @Override protected void paintComponent(Graphics g) {
    JRootPane rootPane = SwingUtilities.getRootPane(this);
    if(rootPane!=null) {
    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);
  }
}
JDK 6 の場合、Disabled Glass Pane « Java Tips Weblogのようにキー入力を無効にするキーリスナーを追加する方法もあります。
  • JDK 1.6.0の場合、Disabled Glass Pane « Java Tips Weblogのようにキー入力を無効にするキーリスナーを追加する方法もある
    • この方法は、JDK 1.5.0などの場合、WindowsLookAndFeelで、Altキーを押すとメニューバーにフォーカスが移動する場合がある
この方法は、JDK 5 などの場合、WindowsLnF で、Altキーを押すとメニューバーにフォーカスが移ることがあります。
  • -

参考リンク

参考リンク

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

コメント