JavaTM 2
Platform
Std. Ed. v1.4.0

javax.swing.text
クラス JTextComponent.AccessibleJTextComponent

java.lang.Object
  |
  +--javax.accessibility.AccessibleContext
        |
        +--java.awt.Component.AccessibleAWTComponent
              |
              +--java.awt.Container.AccessibleAWTContainer
                    |
                    +--javax.swing.JComponent.AccessibleJComponent
                          |
                          +--javax.swing.text.JTextComponent.AccessibleJTextComponent
すべての実装インタフェース:
AccessibleAction, AccessibleComponent, AccessibleEditableText, AccessibleExtendedComponent, AccessibleText, CaretListener, DocumentListener, EventListener, Serializable
直系の既知のサブクラス:
JEditorPane.AccessibleJEditorPane, JTextArea.AccessibleJTextArea, JTextField.AccessibleJTextField
含まれているクラス:
JTextComponent

public class JTextComponent.AccessibleJTextComponent
extends JComponent.AccessibleJComponent
implements AccessibleText, CaretListener, DocumentListener, AccessibleAction, AccessibleEditableText

このクラスは JTextComponent クラス用のユーザ補助機能のサポートを実装しています。メニューユーザインタフェース要素に適した Java Accessibility API を実装しています。

警告: このクラスの直列化されたオブジェクトは、今後の Swing のリリースとは互換性を持ちません。現在の直列化サポートは、短期間の運用や、同じバージョンの Swing を実行するアプリケーション間の RMI に適しています。1.4 では、すべての JavaBeansTM の長期運用サポートが、 java.beans パッケージに追加されました。XMLEncoder を参照してください。


入れ子クラスの概要
 
クラス javax.swing.JComponent.AccessibleJComponent から継承した入れ子クラス
JComponent.AccessibleJComponent.AccessibleContainerHandler, JComponent.AccessibleJComponent.AccessibleFocusHandler
 
クラス java.awt.Container.AccessibleAWTContainer から継承した入れ子クラス
Container.AccessibleAWTContainer.AccessibleContainerHandler
 
クラス java.awt.Component.AccessibleAWTComponent から継承した入れ子クラス
Component.AccessibleAWTComponent.AccessibleAWTComponentHandler, Component.AccessibleAWTComponent.AccessibleAWTFocusHandler
 
フィールドの概要
 
クラス javax.swing.JComponent.AccessibleJComponent から継承したフィールド
accessibleContainerHandler, accessibleFocusHandler
 
クラス java.awt.Component.AccessibleAWTComponent から継承したフィールド
accessibleAWTComponentHandler, accessibleAWTFocusHandler
 
クラス javax.accessibility.AccessibleContext から継承したフィールド
ACCESSIBLE_ACTION_PROPERTY, ACCESSIBLE_ACTIVE_DESCENDANT_PROPERTY, ACCESSIBLE_CARET_PROPERTY, ACCESSIBLE_CHILD_PROPERTY, ACCESSIBLE_DESCRIPTION_PROPERTY, ACCESSIBLE_HYPERTEXT_OFFSET, ACCESSIBLE_NAME_PROPERTY, ACCESSIBLE_SELECTION_PROPERTY, ACCESSIBLE_STATE_PROPERTY, ACCESSIBLE_TABLE_CAPTION_CHANGED, ACCESSIBLE_TABLE_COLUMN_DESCRIPTION_CHANGED, ACCESSIBLE_TABLE_COLUMN_HEADER_CHANGED, ACCESSIBLE_TABLE_MODEL_CHANGED, ACCESSIBLE_TABLE_ROW_DESCRIPTION_CHANGED, ACCESSIBLE_TABLE_ROW_HEADER_CHANGED, ACCESSIBLE_TABLE_SUMMARY_CHANGED, ACCESSIBLE_TEXT_PROPERTY, ACCESSIBLE_VALUE_PROPERTY, ACCESSIBLE_VISIBLE_DATA_PROPERTY, accessibleDescription, accessibleName, accessibleParent
 
インタフェース javax.accessibility.AccessibleText から継承したフィールド
CHARACTER, SENTENCE, WORD
 
コンストラクタの概要
JTextComponent.AccessibleJTextComponent()
          AccessibleJTextComponent を構築します。
 
メソッドの概要
 void caretUpdate(CaretEvent e)
          キャレット更新を処理します (AccessibleContext.ACCESSIBLE_CARET_PROPERTY と AccessibleContext.ACCESSIBLE_SELECTION_PROPERTY という適切なプロパティ変更イベントをトリガする)。
 void changedUpdate(DocumentEvent e)
          ドキュメントの削除を処理します (AccessibleContext.ACCESSIBLE_TEXT_PROPERTY という適切なプロパティ変更イベントをトリガする)。
 void cut(int startIndex, int endIndex)
          2 つのインデックス間のテキストを切り取り、システムクリップボードへ格納します。
 void delete(int startIndex, int endIndex)
          2 つのインデックス間のテキストを削除します。
 boolean doAccessibleAction(int i)
          オブジェクトに対して指定された Action を実行します。
 AccessibleAction getAccessibleAction()
          1 つ以上のアクションをサポートするこのオブジェクトに関連した AccessibleAction を取得します。
 int getAccessibleActionCount()
          オブジェクトで利用可能なユーザ補助機能のアクションの数を返します。
 String getAccessibleActionDescription(int i)
          指定されたオブジェクトのアクションについての説明を返します。
 AccessibleEditableText getAccessibleEditableText()
          このテキストコンポーネントの AccessibleEditableText インタフェースを返します。
 AccessibleRole getAccessibleRole()
          このオブジェクトの役割を返します。
 AccessibleStateSet getAccessibleStateSet()
          JTextComponent の状態セットを返します。
 AccessibleText getAccessibleText()
          このオブジェクトに関連した AccessibleText を返します。
 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()
          選択したテキスト内の開始オフセットを返します。
 String getTextRange(int startIndex, int endIndex)
          2 つのインデックス間のテキスト文字列を返します。
 void insertTextAtIndex(int index, String s)
          指定したインデックスに指定文字列を挿入します。
 void insertUpdate(DocumentEvent e)
          ドキュメントの挿入を処理します (AccessibleContext.ACCESSIBLE_TEXT_PROPERTY という適切なプロパティ変更イベントをトリガする)。
 void paste(int startIndex)
          システムクリップボードのテキストを指定したインデックスで始まるテキストにペーストします。
 void removeUpdate(DocumentEvent e)
          ドキュメントの削除を処理します (AccessibleContext.ACCESSIBLE_TEXT_PROPERTY という適切なプロパティ変更イベントをトリガする)。
 void replaceText(int startIndex, int endIndex, String s)
          2 つのインデックス間のテキストを、指定した文字列に置き換えます。
 void selectText(int startIndex, int endIndex)
          2 つのインデックス間のテキストを選択します。
 void setAttributes(int startIndex, int endIndex, AttributeSet as)
          2 つのインデックス間のテキストの属性を設定します。
 void setTextContents(String s)
          テキストコンテンツを指定文字列に設定します。
 
クラス javax.swing.JComponent.AccessibleJComponent から継承したメソッド
addPropertyChangeListener, getAccessibleChild, getAccessibleChildrenCount, getAccessibleDescription, getAccessibleKeyBinding, getAccessibleName, getBorderTitle, getTitledBorderText, getToolTipText, removePropertyChangeListener
 
クラス java.awt.Container.AccessibleAWTContainer から継承したメソッド
getAccessibleAt
 
クラス java.awt.Component.AccessibleAWTComponent から継承したメソッド
addFocusListener, contains, getAccessibleComponent, getAccessibleIndexInParent, getAccessibleParent, getBackground, getBounds, getCursor, getFont, getFontMetrics, getForeground, getLocale, getLocation, getLocationOnScreen, getSize, isEnabled, isFocusTraversable, isShowing, isVisible, removeFocusListener, requestFocus, setBackground, setBounds, setCursor, setEnabled, setFont, setForeground, setLocation, setSize, setVisible
 
クラス javax.accessibility.AccessibleContext から継承したメソッド
firePropertyChange, getAccessibleIcon, getAccessibleRelationSet, getAccessibleSelection, getAccessibleTable, getAccessibleValue, setAccessibleDescription, setAccessibleName, setAccessibleParent
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
インタフェース javax.accessibility.AccessibleComponent から継承したメソッド
addFocusListener, contains, getAccessibleAt, getBackground, getBounds, getCursor, getFont, getFontMetrics, getForeground, getLocation, getLocationOnScreen, getSize, isEnabled, isFocusTraversable, isShowing, isVisible, removeFocusListener, requestFocus, setBackground, setBounds, setCursor, setEnabled, setFont, setForeground, setLocation, setSize, setVisible
 

コンストラクタの詳細

JTextComponent.AccessibleJTextComponent

public JTextComponent.AccessibleJTextComponent()
AccessibleJTextComponent を構築します。キャレット変更を追跡するためにリスナーを追加します。

メソッドの詳細

caretUpdate

public void caretUpdate(CaretEvent e)
キャレット更新を処理します (AccessibleContext.ACCESSIBLE_CARET_PROPERTY と AccessibleContext.ACCESSIBLE_SELECTION_PROPERTY という適切なプロパティ変更イベントをトリガする)。これは、ドット位置を内部的に追跡します。キャレットが移動すると、その内部位置がイベントの発生後に更新されます。

定義:
インタフェース CaretListener 内の caretUpdate
パラメータ:
e - CaretEvent

insertUpdate

public void insertUpdate(DocumentEvent e)
ドキュメントの挿入を処理します (AccessibleContext.ACCESSIBLE_TEXT_PROPERTY という適切なプロパティ変更イベントをトリガする)。イベントを経由して、変更されたオフセットを追跡します。

定義:
インタフェース DocumentListener 内の insertUpdate
パラメータ:
e - DocumentEvent

removeUpdate

public void removeUpdate(DocumentEvent e)
ドキュメントの削除を処理します (AccessibleContext.ACCESSIBLE_TEXT_PROPERTY という適切なプロパティ変更イベントをトリガする)。イベントを経由して、変更されたオフセットを追跡します。

定義:
インタフェース DocumentListener 内の removeUpdate
パラメータ:
e - DocumentEvent

changedUpdate

public void changedUpdate(DocumentEvent e)
ドキュメントの削除を処理します (AccessibleContext.ACCESSIBLE_TEXT_PROPERTY という適切なプロパティ変更イベントをトリガする)。イベントを経由して、変更されたオフセットを追跡します。

定義:
インタフェース DocumentListener 内の changedUpdate
パラメータ:
e - DocumentEvent

getAccessibleStateSet

public AccessibleStateSet getAccessibleStateSet()
JTextComponent の状態セットを返します。オブジェクトの AccessibleStateSet は一意な AccessibleState のセットから構成されます。オブジェクトの AccessibleStateSet 内の変更は、AccessibleContext.ACCESSIBLE_STATE_PROPERTY プロパティに対して PropertyChangeEvent を発生させる原因になります。

オーバーライド:
クラス JComponent.AccessibleJComponent 内の getAccessibleStateSet
戻り値:
オブジェクトの現在の状態セットを保持する AccessibleStateSet のインスタンス
関連項目:
AccessibleStateSet, AccessibleState, JComponent.AccessibleJComponent.addPropertyChangeListener(java.beans.PropertyChangeListener)

getAccessibleRole

public AccessibleRole getAccessibleRole()
このオブジェクトの役割を返します。

オーバーライド:
クラス JComponent.AccessibleJComponent 内の getAccessibleRole
戻り値:
オブジェクトの役割を記述する AccessibleRole のインスタンス (AccessibleRole.TEXT)
関連項目:
AccessibleRole

getAccessibleText

public AccessibleText getAccessibleText()
このオブジェクトに関連した AccessibleText を返します。このクラス用の Java Accessibility API の実装では、このオブジェクトを返します。これはオブジェクト自体ではなく、AccessibleText インタフェースの実装を行います。

オーバーライド:
クラス AccessibleContext 内の getAccessibleText
戻り値:
このオブジェクト
関連項目:
AccessibleText

getIndexAtPoint

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

定義:
インタフェース AccessibleText 内の getIndexAtPoint
パラメータ:
p - ローカル座標の Point
戻り値:
ポイント p 下の文字のゼロから始まるインデックス

getCharacterBounds

public Rectangle getCharacterBounds(int i)
文字列に対する指定されたインデックスで文字のバウンディングボックスを決定します。このバウンディングボックスはローカル座標で返されます。インデックスが無効な場合、null の矩形が返されます。JtextComponent が JscrollPane に含まれている場合、返された画面座標は「スクロールされない座標」で、この場合、得られる矩形は親座標で変換されます。ここで使用する正しいアルゴリズムは以下の通りです。 Accessible a: AccessibleText at = a.getAccessibleText(); AccessibleComponent ac = a.getAccessibleComponent(); Rectangle r = at.getCharacterBounds(); Point p = ac.getLocation(); r.x += p.x; r.y += p.y; 注: JTextComponent は、このメソッドが null 以外の意味のある値を返せるように、有効なサイズ (たとえば、上位コンテナが有効な最上位ウィンドウである親のコンテナに追加された場合のサイズ) を持つ必要があります。

定義:
インタフェース AccessibleText 内の getCharacterBounds
パラメータ:
i - String に対するインデックス >= 0
戻り値:
文字のバウンディングボックスの画面座標

getCharCount

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

定義:
インタフェース AccessibleText 内の getCharCount
戻り値:
文字数 >= 0

getCaretPosition

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

定義:
インタフェース AccessibleText 内の getCaretPosition
戻り値:
キャレットのゼロから始まるオフセット

getCharacterAttribute

public AttributeSet getCharacterAttribute(int i)
インデックスで指定された文字の AttributeSet を返します。

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

getSelectionStart

public int getSelectionStart()
選択したテキスト内の開始オフセットを返します。選択箇所がない場合に、キャレットがあるときは、開始オフセットと終了オフセットが同じになります。テキストが空の場合は 0、選択箇所がない場合はキャレット位置を返します。

定義:
インタフェース AccessibleText 内の getSelectionStart
戻り値:
選択箇所の先頭のテキストに対するインデックス >= 0

getSelectionEnd

public int getSelectionEnd()
選択したテキスト内の終了オフセットを返します。選択箇所がない場合に、キャレットがあるときは、開始オフセットと終了オフセットが同じになります。テキストが空の場合は 0、選択箇所がない場合はキャレット位置を返します。

定義:
インタフェース AccessibleText 内の getSelectionEnd
戻り値:
選択箇所の末尾のテキストに対するインデックス >= 0

getSelectedText

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

定義:
インタフェース AccessibleText 内の getSelectedText
戻り値:
テキスト。選択部分がない場合は null

getAtIndex

public String getAtIndex(int part,
                         int index)
インタフェース AccessibleText の記述:
指定されたインデックスでの文字列を返します。

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

getAfterIndex

public String getAfterIndex(int part,
                            int index)
インタフェース AccessibleText の記述:
指定されたインデックスの後の文字列を返します。

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

getBeforeIndex

public String getBeforeIndex(int part,
                             int index)
インタフェース AccessibleText の記述:
指定されたインデックスの前の文字列を返します。

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

getAccessibleEditableText

public AccessibleEditableText getAccessibleEditableText()
このテキストコンポーネントの AccessibleEditableText インタフェースを返します。

オーバーライド:
クラス AccessibleContext 内の getAccessibleEditableText
戻り値:
AccessibleEditableText インタフェース
関連項目:
AccessibleEditableText

setTextContents

public void setTextContents(String s)
テキストコンテンツを指定文字列に設定します。

定義:
インタフェース AccessibleEditableText 内の setTextContents
パラメータ:
s - テキストコンテンツを設定する文字列

insertTextAtIndex

public void insertTextAtIndex(int index,
                              String s)
指定したインデックスに指定文字列を挿入します。

定義:
インタフェース AccessibleEditableText 内の insertTextAtIndex
パラメータ:
index - 文字列を挿入するテキストのインデックス
s - テキストに挿入する文字列

getTextRange

public String getTextRange(int startIndex,
                           int endIndex)
2 つのインデックス間のテキスト文字列を返します。

定義:
インタフェース AccessibleEditableText 内の getTextRange
パラメータ:
startIndex - テキストの開始インデックス
endIndex - テキストの終了インデックス
戻り値:
インデックス間のテキスト文字列

delete

public void delete(int startIndex,
                   int endIndex)
2 つのインデックス間のテキストを削除します。

定義:
インタフェース AccessibleEditableText 内の delete
パラメータ:
startIndex - テキストの開始インデックス
endIndex - テキストの終了インデックス

cut

public void cut(int startIndex,
                int endIndex)
2 つのインデックス間のテキストを切り取り、システムクリップボードへ格納します。

定義:
インタフェース AccessibleEditableText 内の cut
パラメータ:
startIndex - テキストの開始インデックス
endIndex - テキストの終了インデックス

paste

public void paste(int startIndex)
システムクリップボードのテキストを指定したインデックスで始まるテキストにペーストします。

定義:
インタフェース AccessibleEditableText 内の paste
パラメータ:
startIndex - テキストの開始インデックス

replaceText

public void replaceText(int startIndex,
                        int endIndex,
                        String s)
2 つのインデックス間のテキストを、指定した文字列に置き換えます。

定義:
インタフェース AccessibleEditableText 内の replaceText
パラメータ:
startIndex - テキストの開始インデックス
endIndex - テキストの終了インデックス
s - 2 つのインデックス間のテキストを置き換える文字列

selectText

public void selectText(int startIndex,
                       int endIndex)
2 つのインデックス間のテキストを選択します。

定義:
インタフェース AccessibleEditableText 内の selectText
パラメータ:
startIndex - テキストの開始インデックス
endIndex - テキストの終了インデックス

setAttributes

public void setAttributes(int startIndex,
                          int endIndex,
                          AttributeSet as)
2 つのインデックス間のテキストの属性を設定します。

定義:
インタフェース AccessibleEditableText 内の setAttributes
パラメータ:
startIndex - テキストの開始インデックス
endIndex - テキストの終了インデックス
as - 属性セット
関連項目:
AttributeSet

getAccessibleAction

public AccessibleAction getAccessibleAction()
クラス AccessibleContext の記述:
1 つ以上のアクションをサポートするこのオブジェクトに関連した AccessibleAction を取得します。

オーバーライド:
クラス AccessibleContext 内の getAccessibleAction
戻り値:
オブジェクトでサポートされている場合は AccessibleAction。そうでない場合は null
関連項目:
AccessibleAction

getAccessibleActionCount

public int getAccessibleActionCount()
オブジェクトで利用可能なユーザ補助機能のアクションの数を返します。アクションが複数ある場合は、最初のアクションがオブジェクトの「デフォルトアクション」と見なされます。

定義:
インタフェース AccessibleAction 内の getAccessibleActionCount
戻り値:
このオブジェクト内の Action の数を示す、ゼロから始まる数

getAccessibleActionDescription

public String getAccessibleActionDescription(int i)
指定されたオブジェクトのアクションについての説明を返します。

定義:
インタフェース AccessibleAction 内の getAccessibleActionDescription
パラメータ:
i - アクションのゼロから始まるインデックス
戻り値:
アクションを説明する String
関連項目:
getAccessibleActionCount()

doAccessibleAction

public boolean doAccessibleAction(int i)
オブジェクトに対して指定された Action を実行します。

定義:
インタフェース AccessibleAction 内の doAccessibleAction
パラメータ:
i - アクションのゼロから始まるインデックス
戻り値:
アクションが実行された場合は true、そうでない場合は false
関連項目:
getAccessibleActionCount()

JavaTM 2
Platform
Std. Ed. v1.4.0

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

Java、Java 2D、および JDBC は米国ならびにその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-2002 Sun Microsystems, Inc. 901 San Antonio Road
Palo Alto, California, 94303, U.S.A. All Rights Reserved.