javax.swing.text
インタフェース Caret

既知の実装クラスの一覧:

BasicTextUI.BasicCaret, DefaultCaret

public interface Caret

ドキュメントモデル内に内容を挿入できる、ドキュメントビュー内の場所を示します。キャレットの位置は、ドットと言われるドキュメント内にあります。ドットは、キャレットがモデル内に配置されているところです。マークと呼ばれる選択範囲の終点を表すキャレットが維持する 2 番目の位置があります。選択範囲がない場合は、ドットとマークは同じです。選択範囲が存在する場合は、この 2 つは異なります。

ドットは、setDot または moveDot のどちらかを呼び出して配置することができます。ドットを設定すると、以前に存在していた可能性のあるすべての選択範囲を削除するという効果があります。ドットとマークは同じになります。ドットを移動すると、以前に存在していたどんな位置であってもマークが残っているので選択範囲を作成するという効果があります。

メソッドの概要

void	addChangeListener(ChangeListener l) キャレットの移動を常に追跡するために、リスナーを追加します。
void	deinstall(JTextComponent c) JTextComponent のインタフェースから UI が削除される時に呼び出されます。
int	getBlinkRate() キャレットの点滅間隔を返します。
int	getDot() キャレットの現在の位置を取り出します。
Point	getMagicCaretPosition() キャレットの現在の可視位置を返します。
int	getMark() マークの現在の位置を取り出します。
void	install(JTextComponent c) JTextComponent のインタフェースに UI がインストールされる時に呼び出されます。
boolean	isSelectionVisible() 選択範囲が現在も可視であるかどうかを判定します。
boolean	isVisible() キャレットが現在可視であるかどうかを判定します。
void	moveDot(int dot) キャレットの位置 (ドット) を移動します。
void	paint(Graphics g) キャレットを描画します。
void	removeChangeListener(ChangeListener l) キャレットの移動を追跡しているリスナーを削除します。
void	setBlinkRate(int rate) キャレットの点滅間隔を設定します。
void	setDot(int dot) キャレットの位置を設定します。
void	setMagicCaretPosition(Point p) 現在のキャレット可視位置を設定します。
void	setSelectionVisible(boolean v) 選択範囲の可視または不可視を設定します。
void	setVisible(boolean v) キャレットの可視または不可視を設定します。

メソッドの詳細

install

void install(JTextComponent c)

JTextComponent のインタフェースに UI がインストールされる時に呼び出されます。このメソッドを使うと、このインタフェースの実装によってナビゲートされているモデルにアクセスできます。

パラメータ:

c - JTextComponent

deinstall

void deinstall(JTextComponent c)

JTextComponent のインタフェースから UI が削除される時に呼び出されます。このメソッドを使うと、接続されていたリスナーの登録をすべて解除できます。

パラメータ:

c - JTextComponent

paint

void paint(Graphics g)

キャレットを描画します。

パラメータ:

g - グラフィックスコンテキスト

addChangeListener

void addChangeListener(ChangeListener l)

キャレットの移動を常に追跡するために、リスナーを追加します。

パラメータ:

l - 変更リスナー

removeChangeListener

void removeChangeListener(ChangeListener l)

キャレットの移動を追跡しているリスナーを削除します。

パラメータ:

l - 変更リスナー

isVisible

boolean isVisible()

キャレットが現在可視であるかどうかを判定します。

戻り値:

キャレットが可視の場合は true、そうでない場合は false

setVisible

void setVisible(boolean v)

キャレットの可視または不可視を設定します。

パラメータ:

v - キャレットを表示する場合は true、キャレットを非表示にする場合は false

isSelectionVisible

boolean isSelectionVisible()

選択範囲が現在も可視であるかどうかを判定します。

戻り値:

キャレットが可視の場合は true、そうでない場合は false

setSelectionVisible

void setSelectionVisible(boolean v)

選択範囲の可視または不可視を設定します。

パラメータ:

v - キャレットを表示する場合は true、キャレットを非表示にする場合は false

setMagicCaretPosition

void setMagicCaretPosition(Point p)

現在のキャレット可視位置を設定します。キャレットの上下に動くなどの終端位置が均等でない行間を移動するときに使用できます。テキストが左から右、右から左へフローすると、x 軸は垂直方向の動きに対して必要なナビゲーション位置を示します。テキストが上下方向にフローすると、y 軸が水平方向の動きに対して必要なナビゲーションの位置を示します。

パラメータ:

p - 位置の保存に使用する Point。可視でない位置があることを示す場合は null も可

getMagicCaretPosition

Point getMagicCaretPosition()

キャレットの現在の可視位置を返します。

戻り値:

可視位置

関連項目:

setMagicCaretPosition(java.awt.Point)

setBlinkRate

void setBlinkRate(int rate)

キャレットの点滅間隔を設定します。キャレットに注意を向けるための一般的な方法のひとつである、キャレットの点滅の有無および速度を決定します。

パラメータ:

rate - ミリ秒単位の遅延 >= 0。この値が 0 の場合、キャレットの点滅はなし

getBlinkRate

int getBlinkRate()

キャレットの点滅間隔を返します。キャレットに注意を向けるための一般的な方法のひとつである、キャレットの点滅の有無および速度を決定します。

戻り値:

ミリ秒単位の遅延 >= 0。この値が 0 の場合、キャレットの点滅はなし

getDot

int getDot()

キャレットの現在の位置を取り出します。

戻り値:

位置 >= 0

getMark

int getMark()

マークの現在の位置を取り出します。選択範囲がある場合、マークはドットとは異なります。

戻り値:

位置 >= 0

setDot

void setDot(int dot)

キャレットの位置を設定します。マークとドットの位置が同じになり、選択範囲は事実上ゼロに設定されます。

パラメータ:

dot - キャレットの新しい位置 >= 0

moveDot

void moveDot(int dot)

キャレットの位置 (ドット) を移動します。マークは元の位置にとどまります。選択範囲のマーキングに便利です。

パラメータ:

dot - キャレットを移動する位置 >= 0