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

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

DefaultCaret

public abstract interface Caret

ドキュメントモデル内に内容を挿入できる、ドキュメントビュー内の場所を示します。ビューの配置の詳細を抽象化しながら、ドキュメントビューの中をナビゲートする手段を提供します。ビューによっては、関連するモデルの一部をフィルタしてしまう可能性があるものや、読み取り専用の領域のような特定の領域のナビゲーションを許可しないものがあるので便利です。

メソッドの概要

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

public void install(JTextComponent c)

JTextComponent のインタフェースに UI がインストールされるときに呼び出されます。このインタフェースの実装によってナビゲートされる、モデルへのアクセスを可能にするために使用できます。

パラメータ:

c - JTextComponent

deinstall

public void deinstall(JTextComponent c)

JTextComponent のインタフェースから UI が削除されるときに呼び出されます。接続しているリスナーの登録をすべて解除するために使用します。

パラメータ:

c - JTextComponent

paint

public void paint(Graphics g)

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

パラメータ:

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

addChangeListener

public void addChangeListener(ChangeListener l)

キャレットが移動するたびに移動を追跡するリスナーを追加します。

パラメータ:

l - 変更リスナー

removeChangeListener

public void removeChangeListener(ChangeListener l)

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

パラメータ:

l - 変更リスナー

isVisible

public boolean isVisible()

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

戻り値:

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

setVisible

public void setVisible(boolean v)

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

パラメータ:

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

isSelectionVisible

public boolean isSelectionVisible()

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

戻り値:

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

setSelectionVisible

public void setSelectionVisible(boolean v)

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

パラメータ:

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

setMagicCaretPosition

public void setMagicCaretPosition(Point p)

キャレットの現在の位置を保存します。キャレットが上下に動き、終端位置が均等でない行の間を移動する場合に使用します。

パラメータ:

p - 位置の保存に使用する Point

getMagicCaretPosition

public Point getMagicCaretPosition()

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

戻り値:

位置

関連項目:

setMagicCaretPosition(java.awt.Point)

setBlinkRate

public void setBlinkRate(int rate)

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

パラメータ:

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

getBlinkRate

public int getBlinkRate()

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

パラメータ:

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

getDot

public int getDot()

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

戻り値:

位置 >= 0

getMark

public int getMark()

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

戻り値:

位置 >= 0

setDot

public void setDot(int dot)

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

パラメータ:

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

moveDot

public void moveDot(int dot)

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

パラメータ:

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