8.1 1行テキスト

Component クラスに KeyListener オブジェクトを追加すればコンポーネントに対するキーボードからの入力を受けることができますが、より汎用的に、ユーザーに文字を入力させる場合はテキスト入力を専門とするコンポーネントを使ったほうが良いでしょう。Swing コンポーネントは極めて柔軟に、再利用性の高い設計の下でテキストコンポーネントが提供されています。

Swing のテキスト入力コンポーネントは、必ず javax.swing.text.JTextComponent クラスをスーパークラスとしています。

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.text.JTextComponent

public abstract class JTextComponent
	extends JComponent implements Scrollable, Accessible

JTextComponent クラスのすべてのテキスト入力コンポーネントに共通する基本的なメソッドを提供しています。テキスト入力位置を表すキャレット、選択範囲、編集などは、このクラスのメソッドを使って共通した操作で行うことができます。

表1は、JTextComponent クラスの中でもテキスト入力と選択に関する基本的なメソッドを列挙しています。テキスト入力コンポーネントはどのような形であれ内部に入力された文字列を保有します。入力されたテキストは getText() メソッドで取得し、選択されているテキストは getSelectedText() メソッドで得ることができます。

もっとも単純なテキスト入力コンポーネントは、JTextComponent クラスを継承する javax.swing.JTextField クラスです。

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.text.JTextComponent
                          |
                          +--javax.swing.JTextField

public class JTextField extends JTextComponent implements SwingConstants

このクラスは、1行のテキストを入力するためのコンポーネントです。何らかの文字列や数字を入力してもらうコンポーネントとして利用することができ、ユーザー名の入力など、アプリケーションがユーザーと対話する手段として利用することができるでしょう。

JTextField クラスのコンポーネントは、アクションリスナを登録することができます。ユーザーがテキストの入力を Enter キーを押して終了すると登録しているリスナが呼び出されます。

setHorizontalAlignment() メソッドで、テキスト表示するコンポーネント内の水平位置を指定することができます。このメソッドが扱う数値は SwingConstans インタフェースで宣言されているフィールド定数で、JTextField.LEFT、JTextField.CENTER、JTextField.RIGHT、JTextField.LEADING、JTextField.TRAILING のいずれかを指定します。

import javax.swing.*;
import java.awt.*;
import java.awt.event.*;

public class Test extends JFrame implements ActionListener {
	public static void main(String args[]) {
		JFrame win = new Test();
		win.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
		win.setBounds(10 , 10 , 400 , 300);
		win.show();
	}

	private JTextField text = new JTextField();
	private JLabel label = new JLabel();
	public Test() {
		text.addActionListener(this);

		getContentPane().add(text , BorderLayout.NORTH);
		getContentPane().add(label , BorderLayout.SOUTH);
	}

	public void actionPerformed(ActionEvent e) {
		label.setText("入力テキスト=" + text.getText());
	}
}

実行結果

コード1はウィンドウの上部に JTextField コンポーネントを表示します。このコンポーネントにキーボードからテキストを入力し、Enter キーで入力を決定するとウィンドウ下部のラベルに入力されたテキストが表示されます。ActionListener を登録してリスナが呼び出されるタイミングで getText() メソッドから入力されたテキストを取得すれば、適切なタイミングで入力テキストを処理することができるのです。

テキストコンポーネント内の、テキスト挿入位置を表す点滅している線のことをキャレットと呼びます。キャレットは多くのシステムのテキスト入力コンポーネントで共通するものです。Windows などの近年のグラフィカルシステムでは、テキスト入力コンポーネント上で点滅する縦線として表示されますが、MS-DOS や UNIX のキャラクタユーザインタフェースなどでは点滅するアンダーラインとしてキャレットが表現されています。

JTextComponent クラスは、このキャレットの描画も自由に拡張することができます。通常はデフォルトのキャレットで十分なので、特別な理由がない限りは拡張する必要はありません。キャレットは javax.swing.text.Caret インタフェースを実装しなければなりません。

キャレットで重要なプロパティは、ドットとマークでしょう。ドットは単純にキャレットの位置を表してると考えてください。マークは、基本的にドットと同じですが、選択範囲が定められている場合はドットとは反対側の位置を指しています。これらを制御すれば、キャレットの位置をインタフェースから変更することができます。

キャレットをコンポーネントに設定するには JTextComponent クラスの setCaret() メソッドを使います。現在設定されているキャレットは getCaret() メソッドから得ることができます。

public void setCaret(Caret c)

public Caret getCaret()

テキスト入力コンポーネントからキャレットを取得すれば、キャレットの点滅する間隔を設定することもできます。キャレットの位置の変更は、キャレットの addChangeListener() メソッドから ChangeListener を登録すれば監視することができるでしょう。

import javax.swing.*;
import javax.swing.text.*;
import javax.swing.event.*;
import java.awt.*;

public class Test extends JFrame implements ChangeListener {
	public static void main(String args[]) {
		JFrame win = new Test();
		win.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
		win.setBounds(10 , 10 , 400 , 300);
		win.show();
	}

	private JTextField text = new JTextField();
	private JLabel label = new JLabel();
	public Test() {
		Caret caret = text.getCaret();
		caret.setBlinkRate(100);
		caret.addChangeListener(this);

		getContentPane().add(text , BorderLayout.NORTH);
		getContentPane().add(label , BorderLayout.SOUTH);
	}

	public void stateChanged(ChangeEvent e) {
		Caret caret = text.getCaret();
		label.setText("dot=" + caret.getDot() + ",mark=" + caret.getMark());
	}
}

実行結果

コード2は、JTextField オブジェクトから getCaret() メソッドを使って設定されているキャレットを取得し、点滅間隔を 100 ミリ秒に設定しています。そのため、コンポーネントを表示するとデフォルトよりもキャレットの点滅が高速であることを確認できます。

また、キャレットに ChangeListener を登録しているため、キャレットの設定が変更されるたびに stateChanged() メソッドが呼び出されます。ユーザーが入力する位置をマウスやキーボードの方向キーで変更すると、キャレットのドットやマークが変更されリスナが呼び出されます。リスナが呼び出されると、ウィンドウ下部のラベルにキャレットのドットとマークが表示されます。実行結果を見ると、選択範囲が設定されてる場合はドットとマークの値がことなることを確認できます。

因みに、選択範囲を描画しているのはハイライタと呼ばれる javax.swing.text.Highlighter インタフェースを実装するオブジェクトです。 デフォルトでは単一色で選択範囲を塗りつぶしていますが、このインタフェースを独自実装することで選択範囲の表現方法を変更することもできます。新たには依頼他を設定するには JTextComponent クラスの setHighlighter() メソッドを、現在のハイライタを取得するには getHighlighter() メソッドを使います。

public void setHighlighter(Highlighter h)

public Highlighter getHighlighter()

通常は、ハイライタを独自に実装する必要はありません。キャレットやハイライタは独自実装しなくても、JTextComponent から色を選択することができます。キャレットやハイライタの形状を特殊な形に変えたい場合を除けば、デフォルトのキャレットとハイライタで必要な処理はすべて実現できます。キャラットと選択範囲の色に関する JTextComponent クラスのメソッドは表4に示します。

これらのメソッドを使えば、テキスト入力コンポーネントに表示されるキャレットや、選択範囲で塗りつぶされる色を変更することができます。コンポーネントの前景色や背景色を変更すると、キャレットや選択範囲の色と重なってしまうことがあるので、こうしたメソッドで選択範囲やキャレットを強調できる色に変更します。

import javax.swing.*;
import java.awt.*;

public class Test extends JFrame {
	public static void main(String args[]) {
		JTextField text = new JTextField();
		text.setFont(new Font("Serif" , Font.PLAIN , 30));
		text.setSelectedTextColor(Color.BLUE);
		text.setSelectionColor(new Color(0xFF , 0xD0 , 0xD0));
		text.setCaretColor(Color.RED);

		JFrame win = new Test();
		win.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
		win.setBounds(10 , 10 , 400 , 300);
		win.getContentPane().add(text , BorderLayout.NORTH);
		win.show();
	}
}

実行結果

コード3は、JTextField オブジェクトのキャレットや選択範囲の色を変更して表示しています。キャレットには赤、選択範囲には薄いピンク、そして、選択範囲内のテキストは青く表示するように指定しています。