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

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

Posted by at 2013-01-28

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

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

Screenshot

screenshot

Download

ScrollBarSearchHighlighter.png

サンプルコード

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);
    Highlighter highlighter = textArea.getHighlighter();
    g.setColor(Color.YELLOW);
    try{
      for(Highlighter.Highlight hh: highlighter.getHighlights()) {
        Rectangle r = textArea.modelToView(hh.getStartOffset());
        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を設定したJLabelをJScrollPane#setRowHeaderView(...)で追加する方法もあります。こちらは、縦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) {
    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);
    Highlighter highlighter = textArea.getHighlighter();

    g.setColor(Color.RED);
    try{
      for(Highlighter.Highlight hh: highlighter.getHighlights()) {
        Rectangle r = textArea.modelToView(hh.getStartOffset());
        Rectangle s = at.createTransformedShape(r).getBounds();
        int h = 2; //Math.max(2, s.height-2);
        g.fillRect(x, y+sbInsets.top+s.y, getIconWidth(), h);
      }
    }catch(BadLocationException e) {
      e.printStackTrace();
    }

    //paint Thumb
    JViewport vport = scroll.getViewport();
    Rectangle vrect = c.getBounds();
    vrect.y = vport.getViewPosition().y;
    g.setColor(THUMB_COLOR);
    Rectangle rr = at.createTransformedShape(vrect).getBounds();
    g.fillRect(x, y+sbInsets.top+rr.y, getIconWidth(), rr.height);
  }
  @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);

縦JScrollBarの中ではなく、左横などにハイライト位置用のIconを表示したい場合は、MatteBorderを利用する方法があります。

JScrollBar scrollBar = new JScrollBar(JScrollBar.VERTICAL) {
  @Override public Dimension getPreferredSize() {
    Dimension d = super.getPreferredSize();
    d.width += getInsets().left;
    return d;
  }
  @Override public void updateUI() {
    super.updateUI();
    setBorder(BorderFactory.createMatteBorder(0, 4, 0, 0, new Icon() {
      @Override public void paintIcon(Component c, Graphics g, int x, int y) {
        //...略...
      }
      @Override public int getIconWidth() {
        return getInsets().left;
      }
      @Override public int getIconHeight() {
        return getHeight();
      }
    }));
  }
};
scroll.setVerticalScrollBar(scrollBar);

コメント

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