nsIAccessible

by 2 contributors:

 

nsIAccessible インタフェースは、MSAA や ATK のようなプラットフォーム固有のアクセシビリティ API をサポートする、クロスプラットフォームなインタフェースです。ATK の一般的な accessibility オブジェクトと同様に、IAccessible をサポートするのに必要なもののすべてが含まれています。

accessible tree 内のオブジェクトについての情報を取得するために、処理中の accessibility クライアントによって使用されます。accessible tree は DOM tree 内の (ドキュメントやフォーカス可能な要素、テキストのような) ノード のサブセットです。Mozilla は nsIAccessible の実装を要求があるときに生成します。

参照: http://www.mozilla.org/projects/ui/accessibility に詳しい情報があります。

Please add a summary to this article.
  最終更新: Gecko 1.9 (Firefox 3)

継承元: nsISupports

メソッドの概要

nsIDOMDOMStringList getKeyBindings(in PRUint8 aActionIndex);
void getFinalState(out unsigned long aState, out unsigned long aExtraState);
void groupPosition(out long aGroupLevel, out long aSimilarItemsInGroup, out long aPositionInGroup);
nsIAccessible getChildAtPoint(in long x, in long y);
nsIAccessible getChildAt(in long aChildIndex);
nsIAccessible getAccessibleToRight();
nsIAccessible getAccessibleToLeft();
nsIAccessible getAccessibleAbove();
nsIAccessible getAccessibleBelow();
nsIAccessible getAccessibleRelated(in unsigned long aRelationType);
nsIAccessibleRelation getRelation(in unsigned long index);
nsIArray getRelations();
void getBounds(out long x, out long y, out long width, out long height);
void setSelected(in boolean isSelected);
void extendSelection();
void takeSelection();
void takeFocus();
AString getActionName(in PRUint8 index);
AString getActionDescription(in PRUint8 aIndex);
void doAction(in PRUint8 index);

属性

属性 説明
parent nsIAccessible accessible tree 内の親ノード。
nextSibling nsIAccessible accessible tree 内の次の兄弟ノード。
previousSibling nsIAccessible accessible tree 内の前の兄弟ノード。
firstChild nsIAccessible accessible tree 内の最初の子ノード。
lastChild nsIAccessible accessible tree 内の最後の子ノード。
children nsIArray この要素の子ノードすべての配列。
childCount long accessible 子ノードの数。
indexInParent long この親に含まれる子ノードのリストの、0 を基点とした accessible の index。または、この accessible が親ノードを持たない場合は -1 を返す。
name AString Accessible の名前 -- このノードのメインテキストと同等。
value AString Accessible の値 -- このノードの数量または二次テキストと同等。role 属性を使用するウィジェットは、この値に valuenow 属性の使用を強制することができます。
description AString Accessible の説明 -- このノードに関連付けられた長いテキスト。
keyboardShortcut AString Alt+D のように accesskey 名のローカライズされた文字列を提供。修飾子はユーザおよびプラットフォームの設定に影響されます。通常は alt+文字、または単にアクセスキーの文字がメニュー項目に使用されます。
defaultKeyBinding AString ファイルを開くための Ctrl+O など、既定の動作のためのグローバルキーボードアクセラレータのローカライズされた文字列を提供。
role unsigned long 関連付けられた要素の accessible role の数。値はプラットフォームごとに異なります。nsIAccessibleRole 内で定義された ROLE_* 定数を参照してください。

これは、finalRole がするように role 属性を考慮に入れません。

finalRole unsigned long accessible role の数。値はプラットフォームごとに異なります。nsIAccessibleRole 内で定義された ROLE_* 定数を参照してください。ウィジェットは、final role を強制するために role 属性を使用することができます。
help AString ノードに関連付けられたヘルプテキスト。
focusedChild nsIAccessible フォーカスされたノードの accessible 子ノード。
attributes nsIPersistentProperties Accessible の属性。
relationsCount unsigned long このオブジェクトに関連する accessible の数を返す。
numActions PRUint8 この accessible に関連付けられた accessible action の数。

メソッド

getKeyBindings()

このメソッドは、与えられた accessible にサポートされた action index のための、グローバルキーボードアクセラレータのローカライズされた文字列を提供します。

 nsIDOMDOMStringList getKeyBindings(
   in PRUint8 aActionIndex
 );
引数
<tt>aActionIndex</tt>
与えられた action の index。
戻り値

グローバルキーボードアクセラレータのローカライズされた文字列の配列を返す。

getFinalState()

このメソッドは final state を回収します。Accessible state -- ノードの真偽値プロパティについて書かれたビットフィールド。多くの state は、既知の確かな role 属性がサポートする有効なものだけです。

 void getFinalState(
   out unsigned long aState, 
   out unsigned long aExtraState
 );
引数
<tt>aState</tt>
最初のビットフィールド (参照: nsIAccessibleStates STATE_* constants)。
<tt>aExtraState</tt>
2 番目のビットフィールド (参照: nsIAccessibleStates EXT_STATE_* constants)。

groupPosition()

このメソッドはグループ化情報を返します。tree 項目、list 項目、tab パネルの label、radio ボタンなどに使用されます。また、テキストではないオブジェクトの収集にも使用されます。

 void groupPosition(
   out long aGroupLevel, 
   out long aSimilarItemsInGroup,
   out long aPositionInGroup
 );
引数
<tt>aGroupLevel</tt>
1 を基点とする。ARIA level プロパティと同様。
<tt>aSimilarItemsInGroup</tt>
現在の項目を含み、1 を基点とする。ARIA setsize プロパティと同様。
<tt>aPositionInGroup</tt>
1 を基点とする。ARIA posinset プロパティと同様。

getChildAtPoint()

このメソッドは、スクリーンピクセルの (x, y) 座標を含む、accessible の子ノードを返します。

この点の位置が現在の accessible 内で子ノードの外にある場合は、現在の accessible が返されます。

この点の位置が現在の accessible または 子ノード内のどちらにもない場合は、NULL が返されます。

 nsIAccessible getChildAtPoint(
   in long x, 
   in long y
 );
引数
<tt>x</tt>
Accessible の X 座標。
<tt>y</tt>
Accessible の Y 座標。
戻り値

(x, y) 座標で与えられた accessible の子ノードを返す。

getChildAt()

このメソッドは、0 を基点とした index または 0 より小さい場合は最後の子ノードを使用して、accessible の N 番目の子ノードを返します。

 nsIAccessible getChildAt(
   in long aChildIndex
 );
引数
<tt>aChildIndex</tt>
N 番目の子ノードの index。
戻り値

0 を基点とした index または 0 より小さい場合は最後の子ノードを使用して、accessible の N 番目の子ノードを返す。

getAccessibleToRight()

このメソッドは、このノードの右側に配置された accessible ノードを返します。

 nsIAccessible getAccessibleToRight();
引数

なし。

戻り値

このノードの右側に配置された accessible ノードを返す。

getAccessibleToLeft()

このメソッドは、このノードの左側に配置された accessible ノードを返します。

 nsIAccessible getAccessibleToLeft();
引数

なし。

戻り値

このノードの左側に配置された accessible ノードを返す。

getAccessibleAbove()

このメソッドは、このノードの上側に配置された accessible ノードを返します。

 nsIAccessible getAccessibleAbove();
引数

なし。

戻り値

このノードの上側に配置された accessible ノードを返す。

getAccessibleBelow()

このメソッドは、このノードの下側に配置された accessible ノードを返します。

 nsIAccessible getAccessibleBelow();
引数

なし。

戻り値

このノードの下側に配置された accessible ノードを返す。

getAccessibleRelated()

このメソッドは、与えられた relation type (参照: nsIAccessibleRelation で定義された定数) によって、これに関連する accessible を返します。

 nsIAccessible getAccessibleRelated(
   in unsigned long aRelationType
 );
引数
<tt>aRelationType</tt>
accessible 間の relation type。
戻り値

与えられた relation type によって提供された accessible に関連する accessible を返す。

getRelation()

このメソッドは、このオブジェクトに対する accessible relation を一つ返します。

 nsIAccessibleRelation getRelation(
   in unsigned long index
 );
引数
<tt>index</tt>
回収される relation の index。
戻り値

このオブジェクトに対する accessible relation を一つ返す。

getRelations()

このメソッドは、このオブジェクトに対する複数の accessible relations を返します。

 nsIArray getRelations();
引数

なし。

戻り値

このオブジェクトに対する複数の accessible relations を返す。

getBounds()

このメソッドは、画面上の accessible の (x および y) 座標ならびに accessible の width および height を返します。

 void getBounds(
   out long x, 
   out long y, 
   out long width, 
   out long height
 );
引数
<tt>x</tt>
Accessible の X 座標。
<tt>y</tt>
Accessible の Y 座標。
<tt>width</tt>
Accessible の幅。
<tt>height</tt>
Accessible の高さ。
戻り値

画面上の accessible の (x および y) 座標ならびに accessible の width および height を返す。

setSelected()

このメソッドは、この accessible を現在選択されたものに追加、または削除します。

 void setSelected(
   in boolean isSelected
 );
引数
<tt>isSelected</tt>
現在選択されたもの。

extendSelection()

このメソッドは、現在の accessible アンカーノードからこの accessible へ、現在選択されたものを広げます。

 void extendSelection();
引数

なし。

takeSelection()

このメソッドは、この accessible ノードのみを選択します。

 void takeSelection();
引数

なし。

takeFocus()

このメソッドは、この accessible ノードにフォーカスします。

STATE_FOCUSABLE の状態は、このノードが普通にフォーカス可能かどうか示します。このノードがフォーカス可能かどうかを決めるのは、呼び出し側に責任があります。通常、フォーカス不能なノード (table など) 上の accTakeFocus はそのノードにフォーカスを設定していますが、通常は、ほとんどのスタイルシートで視覚的に示されません。

 void takeFocus();
引数

なし。

getActionName()

このメソッドは、0 を基点とした index で accessible action の name を取得します。

 AString getActionName(
   in PRUint8 index
 );
引数
<tt>index</tt>
0 を基点とする index。
戻り値

accessible action の name を返す。

getActionDescription()

このメソッドは、0 を基点とした index で accessible action の description を取得します。

 AString getActionDescription(
   in PRUint8 aIndex
 );
引数
<tt>aIndex</tt>
0 を基点とする index。
戻り値

accessible action の description を返す。

doAction()

このメソッドは、0 を基点とした index で accessible action を実行します。Action 番号 0 はデフォルトの action です。

 void doAction(
   in PRUint8 index
 ); 
引数
<tt>index</tt>
0 を基点とする index。

参照

 

ドキュメントのタグと貢献者

Contributors to this page: teoli, Marsf
最終更新者: teoli,