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

TITLE:JTextAreaに行番号を表示

JTextAreaに行番号を表示

編集者:Terai Atsuhiro
作成日:2006-02-20
更新日:2021-04-09 (金) 19:42:12

概要

JTextAreaに行番号を表示します。

#screenshot

サンプルコード

class LineNumberView extends JComponent {
  private static final int MARGIN = 5;
  private final JTextArea text;
  private final FontMetrics fontMetrics;
  private final int topInset;
  private final int fontAscent;
  private final int fontHeight;
  public LineNumberView(JTextArea textArea) {
    text        = textArea;
    fontMetrics = getFontMetrics(text.getFont());
    fontHeight  = fontMetrics.getHeight();
    fontAscent  = fontMetrics.getAscent();
    topInset    = text.getInsets().top;
    text.getDocument().addDocumentListener(new DocumentListener() {
      public void insertUpdate(DocumentEvent e) {
        repaint();
      }
      public void removeUpdate(DocumentEvent e) {
        repaint();
      }
      public void changedUpdate(DocumentEvent e) {}
    });
    text.addComponentListener(new ComponentAdapter() {
      public void componentResized(ComponentEvent e) {
        revalidate();
        repaint();
      }
    });
    setBorder(BorderFactory.createMatteBorder(0, 0, 0, 1, Color.GRAY));
  }
  private int getComponentWidth() {
    Document doc  = text.getDocument();
    Element root  = doc.getDefaultRootElement();
    int lineCount = root.getElementIndex(doc.getLength());
    int maxDigits = Math.max(3, String.valueOf(lineCount).length());
    return maxDigits*fontMetrics.stringWidth("0")+MARGIN*2;
  }
  private int getLineAtPoint(int y) {
    Element root = text.getDocument().getDefaultRootElement();
    int pos = text.viewToModel(new Point(0, y));
    return root.getElementIndex(pos);
  }
  @Override
  public Dimension getPreferredSize() {
    return new Dimension(getComponentWidth(), text.getHeight());
  }
  @Override
  public void paintComponent(Graphics g) {
    Rectangle clip = g.getClipBounds();
    g.setColor(getBackground());
    g.fillRect(clip.x, clip.y, clip.width, clip.height);
    g.setColor(getForeground());
    int base  = clip.y - topInset;
    int start = getLineAtPoint(base);
    int end   = getLineAtPoint(base+clip.height);
    int y = topInset-fontHeight+fontAscent+start*fontHeight;
    for(int i=start;i<=end;i++) {
      String text = String.valueOf(i+1);
      int x = getComponentWidth()-MARGIN-fontMetrics.stringWidth(text);
      y = y + fontHeight;
      g.drawString(text, x, y);
    }
  }
}
  • &jnlp;
  • &jar;
  • &zip;

解説

Line Number in JTextPaneを参考にして、JTextAreaに行番号を表示しています。

上記のサンプルで使用するJTextAreaは、使用するフォントや余白などは変更不可で、各行の高さは最後まで一定であると想定しています。

参考リンク

コメント

  • すごいね！私はこのような資料を探しています、どうも　ありがとうございます。 -- ＣＫ？
    • どういたしまして。 -- terai
  • こちらのソースは非常に参考になります。現在趣味でエディタを作成しているのですが、JTextPaneのDocumentをJTextAreaに与えてカーソル位置を取得しています。JTextPaneで行番号、列番号を正確に取得できないものでしょうか？ -- shusen？
  • どうもです。JTextPaneだと、行の折り返しをどう扱うかで、行番号の表示が異なります。 -- terai
    • 折り返しても表示は前の行のままの場合
      • Line Number in JTextPane
      • このページのサンプルは、上記のリンク先にあるLineNumberView(@author Alan Moore)を参考にしていますが、JTextAreaに必要なさそうな折り返しや各行の高さが異なる場合などの処理を削っているので、JTextPaneで使う場合は、リンク先などのオリジナルのソースを参考にしてください。
    • 折り返された行にも行番号を表示したい場合
      • line number in jtextpane
      • 上記のリンク先にあるサンプルでは、EditorKitを使って行番号を表示しており、JTextPaneで折り返された行でも、表示に従って行番号が割り振られています。
  • ご返答ありがとうございます。現在はこちらにある折り返し抑制のソースを利用させていただいているので、EditorKitを利用する分を試してみたいと思います。 -- shusen？