Swing/ScrollBarSearchHighlighter のバックアップ(No.9)

TITLE:JScrollBarに検索結果をハイライト表示

Posted by aterai at 2013-01-28

JScrollBarに検索結果をハイライト表示

`JScrollBarなどにJTextArea`の文字列検索の結果をハイライト表示します。

&jnlp;
&jar;
&zip;

サンプルコード

scrollbar.setUI(new WindowsScrollBarUI() {
  @Override protected void paintTrack(
      Graphics g, JComponent c, Rectangle trackBounds) {
    super.paintTrack(g, c, trackBounds);

    Rectangle rect = textArea.getBounds();
    double sy = trackBounds.getHeight() / rect.getHeight();
    AffineTransform at = AffineTransform.getScaleInstance(1.0, sy);
    g.setColor(Color.YELLOW);
    try{
      for(Integer pos: poslist) {
        Rectangle r = textArea.modelToView(pos);
        Rectangle s = at.createTransformedShape(r).getBounds();
        int h = 2; //Math.max(2, s.height-2);
        g.fillRect(trackBounds.x, trackBounds.y+s.y, trackBounds.width, h);
      }
    }catch(BadLocationException e) {
      e.printStackTrace();
    }
  }
});

View in GitHub: Java, Kotlin

解説

上記のサンプルでは、`ScrollBarUI#paintTrack(...)メソッドをオーバーライドして、JTextArea内の文字列の検索結果を縦のJScrollBar`内部に描画しています。

注:
- 一行分のハイライトの高さは`2px`で固定
- 検索結果の位置は`JTextComponent#modelToView(Matcher#start());`を利用しているため、ハイライト対象の文字列が折り返しで二行になっても、ハイライトされるのは開始位置のある一行目のみ

以下のように、`Iconを使ったMatteBorderを設定したコンポーネントを作成し、これをJViewportに追加してJScrollPane#setRowHeader(...)で設定する方法もあります。こちらは、縦JScrollBar`に直接ハイライトを描画しないので、上下の増減ボタンは考慮せず、またノブの代わりに現在表示位置を示す領域を半透明で描画しています。

JLabel label = new JLabel(new Icon() {
  private final Color THUMB_COLOR = new Color(0,0,255,50);
  @Override public void paintIcon(Component c, Graphics g, int x, int y) {
    if(poslist.isEmpty()) return;

    Rectangle rect   = textArea.getBounds();
    Dimension sbSize = scrollbar.getSize();
    Insets sbInsets  = scrollbar.getInsets();
    double sy = (sbSize.height - sbInsets.top - sbInsets.bottom) / rect.getHeight();
    AffineTransform at = AffineTransform.getScaleInstance(1.0, sy);

    Graphics2D g2 = (Graphics2D)g.create();
    //g2.translate(x, y);
    g2.setColor(Color.RED);
    try{
      for(Integer pos: poslist) {
        Rectangle r = textArea.modelToView(pos);
        Rectangle s = at.createTransformedShape(r).getBounds();
        int h = 2; //Math.max(2, s.height-2);
        g2.fillRect(x, y+sbInsets.top+s.y, getIconWidth(), h);
      }
      //paint Thumb
      JViewport vport = scroll.getViewport();
      Rectangle vrect = c.getBounds();
      vrect.y = vport.getViewPosition().y;
      g2.setColor(THUMB_COLOR);
      Rectangle rr = at.createTransformedShape(vrect).getBounds();
      g2.fillRect(x, y+sbInsets.top+rr.y, getIconWidth(), rr.height);
    }catch(BadLocationException e) {
      e.printStackTrace();
    }
    g2.dispose();
  }
  @Override public int getIconWidth() {
    return 4;
  }
  @Override public int getIconHeight() {
    return scrollbar.getHeight();
  }
});

scroll.setVerticalScrollBar(scrollbar);
/*
// Fixed Versions: 7 (b134)
scroll.setRowHeaderView(label);
/*/
// 6826074 JScrollPane does not revalidate the component hierarchy after scrolling
// http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6826074
// Affected Versions: 6u12,6u16,7
JViewport vp = new JViewport() {
  @Override public void setViewPosition(Point p) {
    super.setViewPosition(p);
    revalidate();
  }
};
vp.setView(label);
scroll.setRowHeader(vp);

行ヘッダーを使用したハイライトはJava7以降でのみ有効に機能するようです。 -- 読者？ 2013-08-18 (日) 23:10:11
- ご指摘ありがとうございます。仰るとおり、`1.6.0_45で行ヘッダ版が正常に動作しないことを確認しました。回避方法がないか、Bug Database`あたりを調べてみようと思います。 -- aterai 2013-08-19 (月) 00:04:59
- 修正された時期などから、Bug ID: JDK-6910490 MatteBorder JScrollpane interactionが原因かもと`MatteBorderは使用せずに直接IconをJLabel`に追加するよう変更したけど、改善しない…。 -- aterai 2013-08-19 (月) 11:24:23
- Bug ID: JDK-6826074 JScrollPane does not revalidate the component hierarchy after scrollingが原因(`HeavyWeight, LightWeightだけじゃなくレイアウトがうまく更新されていない？)のようです。JViewport#setViewPosition(...)をオーバーライドしてrevalidate()すれば、1.7.0`と同様の動作をするようになりました。 -- aterai 2013-08-19 (月) 14:43:11

JScrollBarに検索結果をハイライト表示

サンプルコード

解説

コメント