キャレットの設定

キャレットとはテキストフィールド内で文字を入力する位置に表示されている縦棒のことです。文字を入力するとキャレットの位置に文字が挿入され、その挿入された文字の後に自動的にキャレットは移動します。その為、文字を連続で入力すれば入力した順にテキストフィールド内に入力されていきます。

ただテキストフィールドに初期値を設定した場合、キャレットは先頭の位置にあります。

このままだと、初期値の後に文字を入力するには、利用者がキャレットを文字の最後に移動させなければなりません。このような場合にキャレットを任意の位置に移動させる方法を確認します。

キャレットを移動させるにはJTextFieldクラスの親クラスであるJTextComponentで用意されているsetCaretPositionメソッドを使います。

setCaretPosition
public void setCaretPosition(int position)

TextComponent のテキスト挿入キャレットの位置を設定します。 TextComponent のテキスト挿入キャ
レットの位置を設定します。キャレットは変更を追跡するので、コンポーネントの基本となるテキスト
が変更されるとこれも移動することに注意してください。ドキュメントが null の場合には何も行いま
せん。位置は 0 とコンポーネントテキストの長さとの間でなければならず、そうでない場合は例外が
スローされます。 

パラメータ:
  position - 位置 
例外:
  IllegalArgumentException - position に指定した値が 0 未満、またはコンポーネントテキスト
    より長い場合

引数にはキャレットの位置をint型の値で指定します。文字の単位で何文字目の先頭にキャレットを配置するのかを指定して下さい。先頭の文字の前に配置する場合が0です。先頭の文字と2番目の文字の間に配置するなら1を指定します。

実際の使い方は次のようになります。

JTextField text = new JTextField("初期値");
text.setCaretPosition(1);

上記の場合、キャレットは「初」と「期」の間に配置されます。また現在入力されている値の一番最後に配置する場合は次のように記述します。

JTextField text = new JTextField("初期値");
text.setCaretPosition(text.getText().length());

上記の場合、キャレットは「値」の後ろに配置されます。

キャレットの色の設定

キャレットの色を任意の色に設定することが可能です。キャレットの色を設定するにはJTextFieldクラスの親クラスであるJTextComponentで用意されているsetCaretColorメソッドを使います。

setCaretColor
public void setCaretColor(Color c)

キャレットを描画するのに使う現在の色を設定します。これを null に設定すると、効果的にデフォ
ルトの色を復元します。色を設定すると、PropertyChange イベント (caretColor) が発生します。

パラメータ:
  c - 色

引数にはキャレットの色として指定したいColorクラスのオブジェクトを指定します。Colorクラスについては「Colorクラス」を参照して下さい。

実際の使い方は次のようになります。

JTextField text = new JTextField("初期値");
text.setCaretColor(Color.RED);

サンプルプログラム

では実際に試してみます。

SSample8_1.java

import javax.swing.JFrame;
import javax.swing.JPanel;
import javax.swing.JTextField;
import java.awt.Container;
import java.awt.BorderLayout;
import java.awt.Color;

class SSample8_1 extends JFrame{
  public static void main(String args[]){
    SSample8_1 frame = new SSample8_1("タイトル");
    frame.setVisible(true);
  }

  SSample8_1(String title){
    setTitle(title);
    setBounds(100, 100, 300, 250);
    setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);

    JPanel p = new JPanel();

    JTextField text = new JTextField("こんにちは", 20);
    text.setCaretPosition(text.getText().length());
    text.setCaretColor(Color.RED);

    p.add(text);

    Container contentPane = getContentPane();
    contentPane.add(p, BorderLayout.CENTER);
  }
}

ではコンパイルを行った上で実行してみます。

キャレットの位置が文字列の最後に配置され、色も赤色になっていることが確認できます。

JavaDrive