JavaTM 2 Platform
Standard Ed. 5.0

javax.accessibility
インタフェース AccessibleText

既知のサブインタフェースの一覧:
AccessibleEditableText, AccessibleHypertext
既知の実装クラスの一覧:
AbstractButton.AccessibleAbstractButton, JButton.AccessibleJButton, JCheckBox.AccessibleJCheckBox, JCheckBoxMenuItem.AccessibleJCheckBoxMenuItem, JEditorPane.AccessibleJEditorPane, JEditorPane.AccessibleJEditorPaneHTML, JEditorPane.JEditorPaneAccessibleHypertextSupport, JLabel.AccessibleJLabel, JMenu.AccessibleJMenu, JMenuItem.AccessibleJMenuItem, JPasswordField.AccessibleJPasswordField, JRadioButton.AccessibleJRadioButton, JRadioButtonMenuItem.AccessibleJRadioButtonMenuItem, JSpinner.AccessibleJSpinner, JTextArea.AccessibleJTextArea, JTextComponent.AccessibleJTextComponent, JTextField.AccessibleJTextField, JToggleButton.AccessibleJToggleButton, ProgressMonitor.AccessibleProgressMonitor, TextArea.AccessibleAWTTextArea, TextComponent.AccessibleAWTTextComponent, TextField.AccessibleAWTTextField

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

static final int CHARACTER
取得すべきテキストの一部が文字であることを示すのに使用する定数です。

関連項目:
getAtIndex(int, int), getAfterIndex(int, int), getBeforeIndex(int, int), 定数フィールド値

WORD

static final int WORD
取得すべきテキストの一部が単語であることを示すのに使用する定数です。

関連項目:
getAtIndex(int, int), getAfterIndex(int, int), getBeforeIndex(int, int), 定数フィールド値

SENTENCE

static final int SENTENCE
取得すべきテキストの一部が文であることを示すのに使用する定数です。

関連項目:
getAtIndex(int, int), getAfterIndex(int, int), getBeforeIndex(int, int), 定数フィールド値
メソッドの詳細

getIndexAtPoint

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

パラメータ:
p - ローカル座標の Point
戻り値:
Point p にある文字のゼロから始まるインデックス。Point が無効な場合は -1 を返す

getCharacterBounds

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

パラメータ:
i - String に対するインデックス
戻り値:
文字のバウンディングボックスの画面オフセット。インデックスが無効な場合は空の矩形を返す

getCharCount

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

戻り値:
文字数

getCaretPosition

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

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

getAtIndex

String getAtIndex(int part,
                  int index)
指定されたインデックスでの文字列を返します。

パラメータ:
part - 取り出す CHARACTER、WORD、または SENTENCE
index - テキスト内の文字インデックス
戻り値:
文字、単語、または文

getAfterIndex

String getAfterIndex(int part,
                     int index)
指定されたインデックスのあとの文字列を返します。

パラメータ:
part - 取り出す CHARACTER、WORD、または SENTENCE
index - テキスト内の文字インデックス
戻り値:
文字、単語、または文

getBeforeIndex

String getBeforeIndex(int part,
                      int index)
指定されたインデックスの前の文字列を返します。

パラメータ:
part - 取り出す CHARACTER、WORD、または SENTENCE
index - テキスト内の文字インデックス
戻り値:
文字、単語、または文

getCharacterAttribute

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

パラメータ:
i - テキストに対するゼロから始まるインデックス
戻り値:
文字の AttributeSet

getSelectionStart

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

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

getSelectionEnd

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

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

getSelectedText

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

戻り値:
選択されているテキストの String 部分

JavaTM 2 Platform
Standard Ed. 5.0

バグの報告と機能のリクエスト
さらに詳しい API リファレンスおよび開発者ドキュメントについては、Java 2 SDK SE 開発者用ドキュメントを参照してください。開発者向けの詳細な解説、概念の概要、用語の定義、バグの回避策、およびコード実例が含まれています。

Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Documentation Redistribution Policy も参照してください。