---
category: swing
folder: LineNumber
title: JTextAreaに行番号を表示
tags: [JTextArea, FontMetrics, JScrollPane]
author: aterai
pubdate: 2006-02-20T20:26:20+09:00
description: JTextAreaの行番号を表示するコンポーネントを作成し、これを対象となるJTextAreaと同じJScrollPaneのRowHeaderViewに設定します。
image: https://lh4.googleusercontent.com/_9Z4BYR88imo/TQTPV_bkDWI/AAAAAAAAAd0/Jktuzx5j5gU/s800/LineNumber.png
---
* Summary [#summary]
`JTextArea`の行番号を表示するコンポーネントを作成し、これを対象となる`JTextArea`と同じ`JScrollPane`の`RowHeaderView`に設定します。
#download(https://lh4.googleusercontent.com/_9Z4BYR88imo/TQTPV_bkDWI/AAAAAAAAAd0/Jktuzx5j5gU/s800/LineNumber.png)
* Source Code Examples [#sourcecode]
#code(link){{
class LineNumberView extends JComponent {
private static final int MARGIN = 5;
private final JTextArea textArea;
private final FontMetrics fontMetrics;
// private final int topInset;
private final int fontAscent;
private final int fontHeight;
private final int fontDescent;
private final int fontLeading;
public LineNumberView(JTextArea textArea) {
this.textArea = textArea;
Font font = textArea.getFont();
fontMetrics = getFontMetrics(font);
fontHeight = fontMetrics.getHeight();
fontAscent = fontMetrics.getAscent();
fontDescent = fontMetrics.getDescent();
fontLeading = fontMetrics.getLeading();
// topInset = textArea.getInsets().top;
textArea.getDocument().addDocumentListener(new DocumentListener() {
@Override public void insertUpdate(DocumentEvent e) {
repaint();
}
@Override public void removeUpdate(DocumentEvent e) {
repaint();
}
@Override public void changedUpdate(DocumentEvent e) {
// repaint();
}
});
textArea.addComponentListener(new ComponentAdapter() {
@Override public void componentResized(ComponentEvent e) {
revalidate();
repaint();
}
});
Insets i = textArea.getInsets();
setBorder(BorderFactory.createCompoundBorder(
BorderFactory.createMatteBorder(0, 0, 0, 1, Color.GRAY),
BorderFactory.createEmptyBorder(i.top, MARGIN, i.bottom, MARGIN - 1)));
setOpaque(true);
setBackground(Color.WHITE);
setFont(font);
}
private int getComponentWidth() {
Document doc = textArea.getDocument();
Element root = doc.getDefaultRootElement();
int lineCount = root.getElementIndex(doc.getLength());
int maxDigits = Math.max(3, String.valueOf(lineCount).length());
Insets i = getInsets();
return maxDigits * fontMetrics.stringWidth("0") + i.left + i.right;
// return 48;
}
private int getLineAtPoint(int y) {
Element root = textArea.getDocument().getDefaultRootElement();
int pos = textArea.viewToModel(new Point(0, y));
return root.getElementIndex(pos);
}
@Override public Dimension getPreferredSize() {
return new Dimension(getComponentWidth(), textArea.getHeight());
}
@Override protected void paintComponent(Graphics g) {
g.setColor(getBackground());
Rectangle clip = g.getClipBounds();
g.fillRect(clip.x, clip.y, clip.width, clip.height);
g.setColor(getForeground());
int base = clip.y;
int start = getLineAtPoint(base);
int end = getLineAtPoint(base + clip.height);
int y = start * fontHeight;
int rmg = getInsets().right;
for (int i = start; i <= end; i++) {
String text = String.valueOf(i + 1);
int x = getComponentWidth() - rmg - fontMetrics.stringWidth(text);
y += fontAscent;
g.drawString(text, x, y);
y += fontDescent + fontLeading;
}
}
}
}}
* Description [#explanation]
* Description [#description]
[https://community.oracle.com/thread/1479759 Swing (Archive) - Advice for editor gutter implementation...]を参考にして、`JTextArea`に行番号を表示しています。
上記のサンプルで使用する`JTextArea`は、使用するフォントや余白などは変更不可で各行の高さはすべて同一で不変と想定しています。
----
- `JTextPane`での行番号表示
-- 折り返しても表示は前の行を継続
--- [https://community.oracle.com/thread/1369109 Swing - Line Number in JTextPane]の`LineNumberView`(@author Alan Moore)
--- `JTextPane`で各行の高さが異なる場合の行番号表示サンプル
-- 折り返された行にも行番号を表示
--- [https://community.oracle.com/thread/1493292 Swing - line number in jtextpane]
--- `EditorKit`を使って行番号を表示し、`JTextPane`で折り返された行でも表示に従って行番号を割り当てる
* Reference [#reference]
- [https://community.oracle.com/thread/1479759 Swing (Archive) - Advice for editor gutter implementation...]
- [https://community.oracle.com/thread/1369109 Swing - Line Number in JTextPane]
- [https://community.oracle.com/thread/1493292 Swing - line number in jtextpane]
* Comment [#comment]
#comment
- すごいね！私はこのような資料を探しています、どうも ありがとうございます。 -- &user(ＣＫ); &new{2007-04-21 (Sat) 18:29:31};
-- どういたしまして。 -- &user(aterai); &new{2007-04-23 (月) 09:47:47};
- こちらのソースは非常に参考になります。現在趣味でエディタを作成しているのですが、`JTextPane`の`Document`を`JTextArea`に与えてカーソル位置を取得しています。`JTextPane`で行番号、列番号を正確に取得できないものでしょうか？ -- &user(shusen); &new{2007-11-09 (金) 10:22:30};
- どうもです。`JTextPane`だと、デフォルトの行の折り返しをどう扱うかで、行番号の表示が異なります。 -- &user(aterai); &new{2007-11-09 (金) 14:52:40};
-- リンクなどを本文に移動。 -- &user(aterai); &new{2016-05-28 (土) 18:18:10};
- ご返答ありがとうございます。現在はこちらにある折り返し抑制のソースを利用させていただいているので、`EditorKit`を利用する分を試してみたいと思います。 -- &user(shusen); &new{2007-11-09 (金) 19:16:05};
- `EditorKit`を利用した分をｺﾋﾟﾍﾟして、とりあえずそのままコンパイル・実行してみました。ここでおかしいことがありまして、コマンドプロンプトから起動すると文字が挿入された行のみ行番号が表示されるのですが、自作エディタから`ProcessBuilder`と`Process`で`"java Test"`となるように呼び出すと、未入力の行も含めて全ての行番号が表示されます。コレはプロンプトの実効環境がおかしいのでしょうか？ -- &user(shusen); &new{2007-11-14 (水) 17:20:54};
- すみません、自己解決しました（たぶん）。ランタイムの問題で、`jre1.6.0_01`以下だと上記の状態になりました。`jre1.6.0_02`と`jre1.6.0_03`ではちゃんと表示されました。 -- &user(shusen); &new{2007-11-14 (水) 17:31:45};
-- 情報ありがとうございます。直接は関係のない話ですが、バージョンかぁと何気にダウンロードサイトに行ったら、 %%サーバー落ちてるっぽいですねorz%% あとで見たらダウンロードのページがすこし変更されているみたいなので、単に更新中だっただけ？みたいです。 -- &user(aterai); &new{2007-11-14 (水) 18:43:29};
- ありがとう。参考になりました。 -- &user(ミルコ・マグカップ); &new{2013-08-08 (木) 16:38:51};
- ところで、これって`JTextArea`とフォントを同じにしないと`getComponentWidth()`で適切な幅が得られないと思います。 -- &user(ミルコ・マグカップ); &new{2013-08-08 (木) 16:40:32};
- `getComponentWidth()`は`JTextArea`のフォントを基に幅を算出しているけど、実際に描画されるフォントはデフォルトのフォントだから -- &user(ミルコ・マグカップ); &new{2013-08-08 (木) 16:44:11};
-- こんばんは。「`JTextArea`のフォントの幅...」は、確かにそうですね。この幅は行番号の表示幅とその右寄せにしか使ってないので、いっそ固定にしてもいいかもしれません。 -- &user(aterai); &new{2013-08-08 (木) 22:24:41};
-- `LineNumberView`に`setFont`で同じフォントを使用するように修正しました(ミルコさん、ありがとうございました)。ついでに`JTextArea`のフォントより`RowHeaderView`(行番号表示用)のフォントサイズがすこし小さい場合などでも問題ないように、ベースラインを真面目に揃えて描画するよう修正しました。 -- &user(aterai); &new{2013-08-09 (金) 12:59:25};
#comment