javax.accessibility
インタフェース AccessibleText

既知のサブインタフェースの一覧:

AccessibleHypertext

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

TextComponent.AccessibleAWTTextComponent, AbstractButton.AccessibleAbstractButton, JTextComponent.AccessibleJTextComponent, JLabel.AccessibleJLabel

public interface AccessibleText

AccessibleText インタフェースは、テキスト情報を画面に表示するすべてのクラスによって実装される必要があります。このインタフェースは、テキストコンテンツ、属性、および空間位置を使ってそのテキストにアクセスするためのユーザ補助機能を提供します。アプリケーションは、オブジェクトの AccessibleContext (Accessible を参照) を取得してから、AccessibleContext の AccessibleContext.getAccessibleText() メソッドを呼び出すと、オブジェクトが AccessibleText インタフェースをサポートするかどうかを判定できます。戻り値が null でなければ、そのオブジェクトはこのインタフェースをサポートしています。

関連項目:

Accessible, Accessible.getAccessibleContext(), AccessibleContext, AccessibleContext.getAccessibleText()

フィールドの概要

static int	CHARACTER 取り出す必要のあるテキストの一部が文字であることを示すのに使用する定数です。
static int	SENTENCE 取り出す必要のあるテキストの一部が文であることを示すのに使用する定数です。
static int	WORD 取り出す必要のあるテキストの一部が単語であることを示すのに使用する定数です。

メソッドの概要

String	getAfterIndex(int part, int index) 指定されたインデックスの後の文字列を返します。
String	getAtIndex(int part, int index) 指定されたインデックスでの文字列を返します。
String	getBeforeIndex(int part, int index) 指定されたインデックスの前の文字列を返します。
int	getCaretPosition() キャレットのゼロから始まるオフセットを返します。
AttributeSet	getCharacterAttribute(int i) 指定されたインデックスの位置にある指定された文字の AttributeSet を返します。
Rectangle	getCharacterBounds(int i) 指定された文字列のインデックスの位置にある文字のバウンディングボックスを判定します。
int	getCharCount() 文字の数を返します (有効なインデックス)。
int	getIndexAtPoint(Point p) ローカルオフセットでポイントを指定し、その Point 下の文字のゼロから始まるインデックスを返します。
String	getSelectedText() 選択されているテキストの一部を返します。
int	getSelectionEnd() 選択されているテキスト内での終了オフセットを返します。
int	getSelectionStart() 選択されているテキスト内での開始オフセットを返します。

フィールドの詳細

CHARACTER

public static final int CHARACTER

取り出す必要のあるテキストの一部が文字であることを示すのに使用する定数です。

関連項目:

getAtIndex(int, int), getAfterIndex(int, int), getBeforeIndex(int, int)

WORD

public static final int WORD

取り出す必要のあるテキストの一部が単語であることを示すのに使用する定数です。

関連項目:

getAtIndex(int, int), getAfterIndex(int, int), getBeforeIndex(int, int)

SENTENCE

public static final int SENTENCE

取り出す必要のあるテキストの一部が文であることを示すのに使用する定数です。

関連項目:

getAtIndex(int, int), getAfterIndex(int, int), getBeforeIndex(int, int)

メソッドの詳細

getIndexAtPoint

public int getIndexAtPoint(Point p)

ローカルオフセットでポイントを指定し、その Point 下の文字のゼロから始まるインデックスを返します。ポイントが無効な場合、このメソッドは -1 を返します。

パラメータ:

p - ローカルオフセットの Point

戻り値:

Point p にある文字のゼロから始まるインデックス。Point が無効な場合は -1 を返す

getCharacterBounds

public Rectangle getCharacterBounds(int i)

指定された文字列のインデックスの位置にある文字のバウンディングボックスを判定します。境界はローカルオフセットで返されます。インデックスが無効な場合、空の矩形が返されます。

パラメータ:

i - String に対するインデックス

戻り値:

文字のバウンディングボックスの画面オフセット。インデックスが無効な場合は空の矩形を返す

getCharCount

public int getCharCount()

文字の数を返します (有効なインデックス)。

戻り値:

文字数

getCaretPosition

public int getCaretPosition()

キャレットのゼロから始まるオフセットを返します。 注: キャレットの右側では、オフセット値とインデックス値が同じになります。キャレットは 2 つの文字の間にあります。

戻り値:

キャレットのゼロから始まるオフセット

getAtIndex

public String getAtIndex(int part,
                         int index)

指定されたインデックスでの文字列を返します。

パラメータ:

part - 取り出す CHARACTER、WORD、または SENTENCE

index - テキスト内の文字インデックス

戻り値:

文字、単語、または文

getAfterIndex

public String getAfterIndex(int part,
                            int index)

指定されたインデックスの後の文字列を返します。

パラメータ:

part - 取り出す CHARACTER、WORD、または SENTENCE

index - テキスト内の文字インデックス

戻り値:

文字、単語、または文

getBeforeIndex

public String getBeforeIndex(int part,
                             int index)

指定されたインデックスの前の文字列を返します。

パラメータ:

part - 取り出す CHARACTER、WORD、または SENTENCE

index - テキスト内の文字インデックス

戻り値:

文字、単語、または文

getCharacterAttribute

public AttributeSet getCharacterAttribute(int i)

指定されたインデックスの位置にある指定された文字の AttributeSet を返します。

パラメータ:

i - テキストに対するゼロから始まるインデックス

戻り値:

文字の AttributeSet

getSelectionStart

public int getSelectionStart()

選択されているテキスト内での開始オフセットを返します。選択されているテキストがなく、キャレットはある場合は、開始オフセットと終了オフセットは同じになります。

戻り値:

選択範囲の先頭のテキストに対するインデックス

getSelectionEnd

public int getSelectionEnd()

選択されているテキスト内での終了オフセットを返します。選択されているテキストがなく、キャレットはある場合は、開始オフセットと終了オフセットは同じになります。

戻り値:

選択範囲の末尾のテキストに対するインデックス

getSelectedText

public String getSelectedText()

選択されているテキストの一部を返します。

戻り値:

選択されているテキストの String 部分