AccessibilityImplementation  - AS3

エラーコードを示します。エラーは、戻り値とは別途に通知されます。エラーを通知するには、errno プロパティを、AccessibilityImplementation 定数の付録で説明されているエラーコードのいずれかに設定します。これにより戻り値は無視されます。AccessibilityImplementation の errno プロパティは、AccessibilityImplementation のメソッドが呼び出される前に Player によって毎回クリア（ゼロに設定）されます。

関連する API エレメント

コンポーネントのアクセシビリティスタブを作成するために使用されます。ActionScript アクセシビリティを実装せずにコンポーネントをリリースする場合、コンポーネントのアクセシビリティスタブを追加することをお勧めします。このスタブを追加すると、Flash Player はアクセシビリティを確保するために、コンポーネント内のボタンやテキストフィールドなどの内部構造を公開せず、コンポーネントを単純なグラフィックとして扱います。

コンポーネントのアクセシビリティスタブを作成するには、関連する AccImpl クラスのサブクラスを作成し、プロパティスタブを値 true でオーバーライドします。

関連する API エレメント

静的コンストラクターです。コンストラクターを呼び出して AccessibilityImplementation を直接インスタンス化しないでください。代わりに、新しいコンポーネントごとに の mx.accessibility.AccImpl クラスを拡張して、新しいアクセシビリティの実装を作成してください。

関連する API エレメント

この AccessibilityImplementation が表すコンポーネントまたはその子要素のいずれかに関連付けられているデフォルトアクションを実行する IAccessible メソッドです。

このメソッドは、AccessibilityImplementation が表す UI 要素に MSAA モデルのデフォルトアクションが存在する場合にのみ実装してください。

AccessibilityImplementation 自体に対してのみ、またはその子要素に対してのみ accDoDefaultAction() を実装する場合、状況によっては、渡された childID に対するデフォルトアクションが存在しないことを示す必要があります。その場合は、errno プロパティを E_MEMBERNOTFOUND に設定します。

パラメーター

     override public function accDoDefaultAction(childID:uint):void
     {
         if (childID > 0)
             ListBase(master).selectedIndex = childID - 1;
     }

AccessibilityImplementation の子要素の境界ボックスを指定する DisplayObject または Rectangle を返すための MSAA メソッドです。

このメソッドは、childID がゼロの場合には呼び出されません。AccessibilityImplementation に子要素が含まれない場合は、このメソッドを実装しないでください。AccessibilityImplementation が子要素を含む可能性がある場合、このメソッドは必須です。

通常は、子要素自体を表すオブジェクトを返すことにより、このメソッドの要件を満たすことができます。これは、子要素が DisplayObject である限り機能します。このような場合は、表示リスト内で該当するビジュアルオブジェクトに関連付けられたインスタンス名に対応する DisplayObject を返すだけで問題ありません。

子要素が上記の方法に適さない場合は、境界ボックスの計算を手動で行い、x、y、width、height プロパティを指定して Rectangle を返すことができます。x および y メンバーは境界ボックスの左上隅の位置を示し、width および height メンバーは境界ボックスのサイズを示します。4 つのメンバーの単位はすべて Stage ピクセルであり、AccessibilityImplementation が表すコンポーネントの原点を基準として指定する必要があります。DisplayObject の原点は左上隅でなくてもよいので、x および y プロパティでは負の値を指定することもできます。

childID で指定されている子要素が非表示の場合（つまり、その子に対する get_accState が STATE_SYSTEM_INVISIBLE を含む値を返す場合）、accLocation から null を返すことができます。また、子要素が表示された場合の座標を表す Rectangle を返すこともできます。

パラメーター

詳細

関連する API エレメント

     override public function accLocation(childID:uint):*
     
     {
         var listBase:ListBase = ListBase(master);
     
         var index:uint = childID - 1;
         
         if (index < listBase.verticalScrollPosition ||
             index >= listBase.verticalScrollPosition + listBase.rowCount)
         {
             return null;
         }
         var item:Object = getItemAt(index);
     
         return listBase.itemToItemRenderer(item);
     }
     

この AccessibilityImplementation が表すコンポーネント内の選択を変更するための IAccessible メソッドです。

childID パラメーターは常にゼロ以外の値になります。このメソッドは常にコンポーネント全体ではなく子要素に適用されます。コンポーネント全体の選択は Flash Player によって管理されます。

selFlag パラメーターは、childID で参照されているアイテムが選択される方法（フォーカスを取得する方法）を示すために MSAA クライアントで使用される 1 つ以上の選択フラグ定数で構成されるビットフィールドです。以下では、選択フラグ定数の概要について説明し、これらの定数によってアクセシビリティの実装に提供される情報について説明します。実際には、Flex の mx.accessibility.ListBaseAccImpl クラスを継承するアクセシビリティの実装に含まれるこのメソッドのほとんどの実装は selFlag 定数を無視し、代わりにコンポーネントのキーボード選択動作に基づいて複数選択を処理します。

selFlag パラメーターは、SELFLAG_TAKEFOCUS フラグを含む場合と、含まない場合があります。このフラグを含む場合は、指定された childID に子フォーカスを設定する必要があり、SELFLAG_EXTENDSELECTION も存在していない場合は、その子要素を選択アンカーにします。このフラグを含まない場合は、子フォーカスと選択アンカーを変更しないようにする必要があります。ただし、後で説明するその他のフラグを選択を変更することは可能です。

selFlag 引数は常に次の 4 つのフラグのいずれかを含みます。これらのフラグは、どのような種類の選択変更が必要であるかを示しています。

• SELFLAG_TAKESELECTION：既存の選択をクリアし、選択対象を指定された childID に設定します。

• SELFLAG_EXTENDSELECTION：選択アンカーと指定された childID の間（両方を含む）の子要素の範囲を計算します。SELFLAG_ADDSELECTION がある場合は、これらの子要素をすべて選択対象に追加します。SELFLAG_REMOVESELECTION がある場合は、これらの子要素をすべて選択対象から削除します。SELFLAG_ADDSELECTION も SELFLAG_REMOVESELECTION もない場合は、これらすべての子要素が選択アンカーの選択状態を引き継ぐ必要があります。選択アンカーが選択されている場合は、これらの子要素を選択対象に追加します。そうでない場合は、選択対象から削除します。

• SELFLAG_ADDSELECTION（SELFLAG_EXTENDSELECTION なし）：指定された childID を選択対象に追加します。

• SELFLAG_REMOVESELECTION（SELFLAG_EXTENDSELECTION なし）：指定された childID を選択対象から削除します。

複数選択が可能でないコンポーネントの場合、有効な selFlag パラメーター値は SELFLAG_TAKEFOCUS と SELFLAG_TAKESELECTION だけであることに注意してください。理論的には、複数選択が不可能なコンポーネントの場合でも、ユーザーが強制的に null 選択を行えるコンポーネントに関しては SELFLAG_REMOVESELECTION をサポートできますが、実際にはそのように機能しないため、MSAA クライアントはこの種の操作を試みることができません。

無効と見なされるフラグを検出した場合は、errno を E_INVALIDARG に設定します。

また、accSelect が呼び出すと、Flash Player のホストフォーカス（コンテナアプリケーションのウィンドウフォーカス）が存在し、コンポーネントが Flash Player 内でフォーカスされていることが確認されます。

パラメーター

詳細

関連する API エレメント

override public function accSelect(selFlag:uint, childID:uint):void
     {
         
         var listBase:ListBase = ListBase(master);
         
         var index:uint = childID - 1;
         
         if (index >= 0 && index < listBase.dataProvider.length)
             listBase.selectedIndex = index;
     }
     

この AccessibilityImplementation が表すコンポーネントまたはその子要素のいずれかのデフォルトアクションを返すための MSAA メソッドです。

このメソッドは、AccessibilityImplementation が表す UI 要素に MSAA モデルのデフォルトアクションが存在するる場合にのみ実装してください。また、MSAA モデルで指定されているとおりの文字列を返すように注意してください。例えば、Button コンポーネントのデフォルトアクション文字列は "Press" です。

AccessibilityImplementation 自体に対してのみ、またはその子要素に対してのみ get_accDefaultAction を実装する場合は、状況によっては、渡された childID に対するデフォルトアクションが存在しないことを示す必要があります。その場合は、単純に null を返します。

パラメーター

詳細

関連する API エレメント

override public function get_accDefaultAction(childID:uint):String
     {
         if (childID == 0)
             return null;
     
         return "Double Click";
     }

コンポーネント内に子フォーカスを持つ子要素がある場合に、その符号なし整数 ID を返す MSAA メソッドです。子フォーカスを持つ子がない場合、このメソッドはゼロを返します。

詳細

関連する API エレメント

override public function get_accFocus():uint
     {
     var index:uint = ListBase(master).selectedIndex;
     
     return index >= 0 ? index + 1 : 0;
     }

この AccessibilityImplementation が表すコンポーネントまたはその子要素のいずれかの名前を返すための MSAA メソッドです。

このメソッドが実装されていない場合、またはこのメソッドが値を返さない場合、Flash Player は AccessibilityProperties.name プロパティの値を使用して AccessibilityImplementation 自体（childID == 0）の名前を返します（このプロパティ値がある場合）。

子要素を持つことができる AccessibilityImplementations の場合は、このメソッドを実装し、childID がゼロ以外のときには文字列値を返す必要があります。

ユーザーインターフェイス要素のタイプによっては、MSAA の名前は、作成者が割り当てた名前または要素の実際のテキストコンテンツのいずれかを意味します。通常、AccessibilityImplementation 自体は前者のカテゴリーに分類されます。その name プロパティは、作成者が割り当てた名前です。子要素は常に 2 番目のカテゴリーに分類されます。その名前はテキストコンテンツを示します。

AccessibilityImplementation の name プロパティが、作成者によって割り当てられた名前を意味する場合、コンポーネントは 2 つの方法で作成者から名前を取得できます。第 1 の方法では、コンポーネント自体の内部に存在する名前を使用します。例えば、チェックボックスコンポーネントには名前として使用できるテキストラベルが含まれる場合があります。第 1 の方法の代わりとなる第 2 の方法では、UI で指定されている名前を使用し、これは最終的に AccessibilityProperties.name になります。この方法を使用した場合、ユーザーは他の Sprite や MovieClip と同じように名前を指定できます。

これにより、AccessibilityImplementation 自体（childID == zero）は、次の 3 つの可能性のいずれかに該当することになります。

• コンポーネント内に存在する、作成者が割り当てた名前。get_accName メソッドを実装し、childID がゼロのときは AccessibilityImplementation の名前を含む文字列値を返す必要があります。childID がゼロであるにもかかわらず AccessibilityImplementation に名前がない場合は、AccessibilityProperties.name プロパティが Player で使用されることを防止するために、get_accName から空の文字列を返すようにする必要があります。

• UI から作成者が割り当てた名前。AccessibilityImplementation が子要素を持つことができる場合は、get_accName メソッドを実装する必要がありますが、childID がゼロのときは値を返さないようにする必要があります。AccessibilityImplementation が子要素を持たない場合は、get_accName を実装しないでください。

• コンテンツを示す名前。get_accName メソッドを実装し、childID がゼロのときは適切な文字列値を返す必要があります。childID がゼロであるにもかかわらず AccessibilityImplementation にコンテンツがない場合は、AccessibilityProperties.name プロパティが Player で使用されることを防止するために、get_accName から空の文字列を返すようにする必要があります。

子要素の場合（AccessibilityImplementation が子要素を持つことができる場合）は常に 3 番目のケースに該当することに注意してください。get_accName メソッドを実装し、childID がゼロ以外のときは適切な文字列値を返す必要があります。

パラメーター

詳細

関連する API エレメント

override public function get_accName(childID:uint):String
     {
         // Start with the name of the component's parent form 
          // if the component is contained within a form
         var accName:String = UIComponentAccImpl.getFormName(master);
     
         // If the element requested is the component itself, 
         // append the value of any assigned accessibilityProperties.name    
         if (childID == 0 && master.accessibilityProperties 
             && master.accessibilityProperties.name 
                 && master.accessibilityProperties.name != "")
             accName += master.accessibilityProperties.name + " ";
     
         // Append the value of the childIDs name 
     // returned by the component-specific override 
     // of the mx.accessibility.AccImpl.getName() utility function,
         // and append the component's status returned by the 
     // component-specific override of the 
     // mx.accessibility.AccImpl.getStatusName() utility function
         accName += getName(childID) + getStatusName();
     
     // Return the assembled String if it is neither empty nor null, 
     // otherwise return null
         return (accName != null && accName != "") ? accName : null;
     }

この AccessibilityImplementation が表すコンポーネントまたはその子要素のいずれかのシステムロールを返すための MSAA メソッドです。システムロールは、MSAA のすべてのコンポーネントに対して事前に定義されています。

パラメーター

詳細

関連する API エレメント

選択されているすべての子要素の ID を含む配列を返すための MSAA メソッドです。返される配列には、0 個、1 個、または複数個の ID が含まれる可能性があり、すべて符号なし整数です。

詳細

関連する API エレメント

     override public function get_accSelection():Array
     {
         var accSelection:Array = [];
     
         var selectedIndices:Array = ListBase(master).selectedIndices;
         
         var n:int = selectedIndices.length;
         for (var i:int = 0; i < n; i++)
         {
             accSelection[i] = selectedIndices[i] + 1;
         }
         
         return accSelection;
     }
     

この AccessibilityImplementation が表すコンポーネントまたはその子要素のいずれかの現在のランタイム状態を返すための IAccessible メソッドです。

このメソッドは、MSAA でコンポーネントに対して事前に定義されているオブジェクト状態定数（0 個、1 個、または複数個の組み合わせ）を返す必要があります。複数の状態に該当する場合は、ビット単位の OR 演算子 | を使用して、複数の状態定数を 1 つのビットフィールドに結合する必要があります。

現在該当する状態定数がないことを示すには、ゼロを返す必要があります。

STATE_SYSTEM_FOCUSABLE 状態および STATE_SYSTEM_FOCUSED 状態を追跡してレポートする必要はありません。これらの状態は Flash Player で自動的に処理されます。

パラメーター

詳細

関連する API エレメント

     override public function get_accState(childID:uint):uint
     {
         var accState:uint = getState(childID);
     
         if (childID > 0) 
         {
             var listBase:ListBase = ListBase(master);
     
             var index:uint = childID - 1;
     
             // For returning states (OffScreen and Invisible)
             // when the list Item is not in the displayed rows.
             if (index < listBase.verticalScrollPosition ||
                 index >= listBase.verticalScrollPosition + listBase.rowCount)
             {
                 accState |= (STATE_SYSTEM_OFFSCREEN |
                              STATE_SYSTEM_INVISIBLE);
             }
             else
             {
                 accState |= STATE_SYSTEM_SELECTABLE;
     
                 var item:Object = getItemAt(index);
     
                 var renderer:IListItemRenderer =
                     listBase.itemToItemRenderer(item);
     
                 if (renderer != null && listBase.isItemSelected(renderer.data))
                     accState |= STATE_SYSTEM_SELECTED | STATE_SYSTEM_FOCUSED;
             }
         }
     
         return accState;
     }

この AccessibilityImplementation が表すコンポーネントまたはその子要素のいずれかのランタイム値を返すための MSAA メソッドです。

このメソッドは、AccessibilityImplementation が表す UI 要素に MSAA モデルの値が存在する場合にのみ実装してください。明白な「値」を持つ一部の UI 要素は、実際には様々な方法でこの値を公開することに注意してください。例えば、get_accName（テキストなど）、get_accState（チェックボックスなど）、get_accSelection（リストボックスなど）を使用します。

AccessibilityImplementation 自体に対してのみ、またはその子要素に対してのみ get_accValue を実装する場合、状況によっては、渡された childID に値の概念が存在しないことを示す必要があります。その場合は、単純に null を返します。

パラメーター

詳細

関連する API エレメント

override public function get_accValue(childID:uint):String
     {
         var accValue:String;
         
         var listBase:ListBase = ListBase(master);
         
         var index:int = listBase.selectedIndex;
         if (childID == 0)
         {
             if (index > -1)
             {
                 var item:Object = getItemAt(index);
     
                 if (item is String)
                 {
                     accValue = item + " " + (index + 1) + " of " + listBase.dataProvider.length;
                 }
                 else
                 {
                     accValue = listBase.itemToLabel(item) + " " + (index + 1) +
                                " of " + listBase.dataProvider.length;
                 }
             }
         }
     
         return accValue;
     }

AccessibilityImplementation のすべての子要素の符号なし整数 ID を含む配列を返します。

この配列の長さはゼロになることもあります。配列内の ID は、それらが表す子要素と同じ論理順序になっている必要があります。AccessibilityImplementation が子要素を含む可能性がある場合、このメソッドは必須です。そうでない場合は、実装しないでください。

子 ID を子要素に割り当てるときは、AccessibilityImplementation の各インスタンス内で一意性が保たれる方法を使用してください。子 ID は連続している必要はなく、子 ID の順序は子要素の論理順序と一致していなくてもかまいません。同じ子 ID を再利用しないように注意する必要があります。つまり、子要素を削除する場合は、その AccessibilityImplementation インスタンスの存続期間中に同じ ID を再利用しないようにする必要があります。百万を超える子 ID を使用した場合、Flash Player コードでの実装選択により、望ましくない結果が発生する可能性があることに注意してください。

     override public function getChildIDArray():Array
     {
         var childIDs:Array = [];
     
         if (ListBase(master).dataProvider)
         {
             var n:uint = ListBase(master).dataProvider.length;
             for (var i:int = 0; i < n; i++)
             {
                 childIDs[i] = i + 1;
             }
         }
         return childIDs;
     }
     

true または false を返して、x、y、width および height で指定されたバウンディングボックスを持つテキストオブジェクトを、この AccessibilityImplementation が表すコンポーネントのラベルと見なすかどうかを示します。

x および y 座標は、AccessibilityImplementation が適用されるコンポーネントの左上隅からの相対位置を示し、負の値になる場合があります。座標はすべて Stage ピクセル単位です。

このメソッドにより、アクセス可能なコンポーネントを Flash Player の自動ラべリング関係の検索に適合させることができます。これにより、オブジェクトの外部のテキストからオブジェクトの名前を提供することができます。このメソッドが提供される理由は、ラベルを認識する基準がコンポーネントごとに異なると予想されることにあります。このメソッドを実装する場合、ボタンおよびテキストフィールドのプレーヤーコード内で使用されている幾何学的基準と同様の基準を使用してください。これらの基準は次のとおりです。

• ボタンの場合、ボタン内に完全に収まるテキストはラベルと見なされます。
• テキストフィールドの場合、上部に近く、左揃えで表示されるテキスト、または左寄りに表示されるテキストはラベルと見なされます。

AccessibilityImplementation で表されるコンポーネントを自動ラべリングの関係に参加させない場合、isLabeledBy を実装しないでください。これは、常に false を返すことと同じです。isLabeledBy を実装しない状況の一例として、AccessibilityImplementation が上記の get_accName で記述された「コンポーネント内で作成者が割り当てた名前」に該当する場合が挙げられます。

このメソッドは IAccessible メソッドに基づくものではなく、Flash に固有のものです。

パラメーター