FlexNativeMenu  - AS3 Flex

オートメーション関連機能を処理する委譲オブジェクト。

このコンポーネントがオートメーション用に有効である場合は true、それ以外の場合は false です。

このオブジェクトの識別子として使用できる名前です。

オートメーション目的で使用するこのコンポーネントのオーナーです。

オートメーション目的で使用するこのコンポーネントの親です。

データ検索に使用できる IAutomationTabularData インターフェイスの実装です。

この値はオブジェクトのレンダリング表示に対応しています。また、アプリケーションでの視覚表示と同じにするために、識別子とオブジェクトを関連付けるのに使用できます。

このコンポーネントがオートメーション用に可視である場合は true、それ以外の場合は false です。

データプロバイダー内のデータにアクセスして操作するオブジェクトです。 FlexNativeMenu コントロールは、データに関する情報について、データ記述子に委任します。次に、このデータはデータソースに関する解析と移動のために使用されます。FlexNativeMenu に対して定義されたデータ記述子は、すべての子メニューおよびサブメニューで使用されます。

このプロパティを MXML の属性として指定する場合、記述子のストリング名ではなく、データ記述子への参照を使用する必要があります。プロパティを設定するには次の形式を使用します。

<mx:FlexNativeMenu id="flexNativeMenu" dataDescriptor="{new MyCustomDataDescriptor()}"/>

また、次の例に示すように、ネストしたサブタグとして MXML のプロパティを指定できます。

<mx:FlexNativeMenu>
      <mx:dataDescriptor>
         <myCustomDataDescriptor>
      </mx:dataDescriptor>
      ...

デフォルト値は、DefaultDataDescriptor クラスの内部インスタンスです。

NativeMenu のメニューアイテムの構造を定義するために使用されるオブジェクトの階層です。 個別のデータオブジェクトはメニューアイテムを定義し、子アイテムを持つアイテムはメニューとサブメニューになります。

FlexNativeMenu コントロールは、ソースデータオブジェクトを次のように処理します。

• 有効な XML テキストを含むストリングが XML オブジェクトに変換されます。
• XMLNode は、XML オブジェクトに変換されます。
• また XMLList は、XMLListCollection に変換されます。
• ICollectionView インターフェイスを実装するすべてのオブジェクトが ICollectionView にキャストされます。
• Array は ArrayCollection に変換されます。
• 他のタイプのオブジェクトは、Array 内でその単一エントリとしてラップされます。

デフォルト値： "undefined"。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 collectionChange イベントが送出されます。

現在のデータプロバイダーにルートノード（例えば、階層構造内の単一の最上位ノードなど）があることを示すフラグです。 XML と Object はルートノードがあるタイプの例であり、リストと配列はルートノードがないタイプの例です。

オブジェクトがレイアウトの 3 つの段階（処理、測定、レイアウト）すべてを完了したものであるかどうかを示すフラグです（いずれかが必須であった場合）。

各メニューアイテムのキー相当物を決定するデータプロバイダーのフィールド名です。 値のセットは、Keyboard クラスの KEYNAME_XXXX 定数で定義されます。 例えば、Home、Insert などの制御文字の値に対して一覧表示される定数です。

keyEquivalentFunction プロパティを設定すると、このプロパティは無視されます。

デフォルト値： "keyEquivalent"。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 keyEquivalentChanged イベントが送出されます。

関連する API エレメント

各メニューアイテムのキー相当物を判定する関数です。 このプロパティを省略すると、keyEquivalentField プロパティで指定したフィールドまたは属性の値が使用されます。 このプロパティを指定した場合、keyEquivalentField プロパティの値は無視されます。

keyEquivalentFunction プロパティは、フォーマット処理やローカライズにも使用でき、プラットフォームに依存しません。

このキー相当物関数は単一の引数を取得します。この引数は、データプロバイダー内のアイテムであり、ストリングを返します。

myKeyEquivalentFunction(item:Object):String

デフォルト値： "undefined"。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 keyEquivalentFunctionChanged イベントが送出されます。

関連する API エレメント

各メニューアイテムのキー相当物のモディファイアを判定する関数です。 このプロパティを省略した場合、Flex では独自のデフォルト関数が使用され、次の（ブール）フィールドが存在するかどうかについてデータプロバイダーのデータを確認することによって、モディファイアの配列が決定されます。altKey、commandKey、controlKey および shiftKey です。

keyEquivalentModifiersFunction プロパティは、フォーマット処理やローカライズにも使用でき、プラットフォームに依存しません。

このキー相当物のモディファイア関数は単一の引数を取得します。この引数は、データプロバイダー内のアイテムであり、モディファイアキー名の配列を返します。

myKeyEquivalentModifiersFunction(item:Object):Array

デフォルト値： "undefined"。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 keyEquivalentModifiersFunctionChanged イベントが送出されます。

各メニューアイテムに表示されるテキストを決定するデータプロバイダーのフィールド名です。 データプロバイダーがストリングの配列である場合、各ストリング値がラベルとして使用されます。 データプロバイダーが E4X XML オブジェクトの場合、このプロパティを明示的に設定する必要があります。 例えば、E4X XML オブジェクト内の各 XML エレメントに各メニューアイテムに対して表示するテキストを含む "label" 属性が含まれている場合は、labelField を "@label" に設定します。

ラベルでは、アンダースコアを前に付けることによって、ニーモニックインデックスとして使用される文字を指定できます。 例えば、"C_ut" というラベル値の場合、ニーモニックインデックスが 1 に設定されます。 この目的に使用されるのは、最初のアンダースコアだけです。 ラベル内にリテラルアンダースコア文字を表示するには、アンダースコアを 2 つ使用することによってエスケープできます。 例えば、"C__u_t" というラベル値は、"C_ut" というラベルを持ち、ニーモニックインデックスが 3 （"t" 文字）であるメニューアイテムになります。 mnemonicIndexField プロパティで定義されているフィールドが存在し、それが 0 より大きい値に設定されている場合は、アンダースコアで指定されているニーモニックインデックス値よりもその値が優先されます。

labelFunction プロパティを設定すると、このプロパティは無視されます。

デフォルト値： "label"。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 labelFieldChanged イベントが送出されます。

各メニューアイテムに表示するテキストを判定する関数です。 ラベル関数でデータプロバイダー内の適切なフィールドを検索し、表示可能なストリングを返す必要があります。

このプロパティを省略すると、labelField プロパティで指定したフィールドまたは属性の値が使用されます。 このプロパティを指定した場合、labelField プロパティの値は無視されます。

labelFunction プロパティは、フォーマット処理やローカライズに役立ち、プラットフォームに依存しません。

このラベル関数は単一の引数を取得します。この引数は、データプロバイダー内のアイテムであり、ストリングを返します。

myLabelFunction(item:Object):String

デフォルト値： "undefined"。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 labelFunctionChanged イベントが送出されます。

各メニューアイテムに表示されるニーモニックインデックスを決定するデータプロバイダーのフィールド名です。

このプロパティに指定されているフィールドに 0 より大きい数が含まれている場合は、そのニーモニックインデックスは、ラベル内のアンダースコアによって指定された数よりも優先されます。

mnemonicIndexFunction プロパティを設定すると、このプロパティは無視されます。

デフォルト値： "mnemonicIndex"。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 mnemonicIndexChanged イベントが送出されます。

関連する API エレメント

各メニューアイテムのニーモニックインデックスを判定する関数です。

このプロパティを省略すると、mnemonicIndexField プロパティで指定したフィールドまたは属性の値が使用されます。 このプロパティを指定した場合、mnemonicIndexField プロパティの値は無視されます。

このプロパティが定義されており、関数がデータアイテムに対して 0 より大きい数を返す場合は、ラベル内のアンダースコアによって指定された数よりも返されたニーモニックインデックスが優先されます。

mnemonicIndexFunction プロパティは、フォーマット処理やローカライズにも使用でき、プラットフォームに依存しません。

このニーモニックインデックス関数は単一のパラメーターを取得します。このパラメーターは、データプロバイダー内のアイテムであり、int を返します。

myMnemonicIndexFunction(item:Object):int

デフォルト値： "undefined"。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 mnemonicIndexFunctionChanged イベントが送出されます。

このオブジェクトで管理される flash.display.NativeMenu を返します。存在しない場合は null を返します。基になる NativeMenu インスタンスに対して直接加えられた変更は、メニューまたは基になるデータプロバイダーが変更されるときに失われることがあります。

このプロパティはデータバインディングのソースとして使用できます。 このプロパティを変更すると、 nativeMenuUpdate イベントが送出されます。

オブジェクト階層におけるこのオブジェクトの深度を表します。この数値は、測定およびレイアウトコードによって使用されます。このコンポーネントが DisplayList でない場合、この値は 0 になります。

このコンテナに含まれるオートメーションの子の数です。 この合計には、オートメーション階層で重要でない子は含まれますが、組み合わされた子が含まれることはありません。

子をすぐに生成するか、遅延生成した後、このいずれかの発生に応じて、true に設定されます。 Container オブジェクトの場合、true に設定されるのは、createComponentsFromDescriptors() メソッドの終了時、つまり、Container オブジェクトが子の記述子から子を作成した後です。

例えば、Accordion コンテナが遅延インスタンス化を使用する場合、Accordion コンテナの 2 番目のペインの processedDescriptors プロパティは、ユーザーがそのペインまでナビゲートし、ペインがその子を作成するまで true になりません。 ただし、Accordion が creationPolicy プロパティを "all" に設定している場合、その 2 番目のペインの processedDescriptors プロパティはアプリケーションの起動中に true に設定されます。

コンテナではないクラスには記述子がなく、この場合、このプロパティが true に設定されるのは、createChildren() メソッドが内部コンポーネントの子を作成した後です。

オートメーションオブジェクトがオートメーション階層に表示されているかどうかを示すフラグです。 階層に表示されないコンテナの子は、次に高いレベルで表示される親の子として表示されます。 通常、ボックスや Canvas のようなレイアウトに使用されるコンテナは階層に表示されません。

必要に応じて子を階層に表示させるコントロールもあります。 例えば、List は、ボックスなどのアイテムレンダラーを必ず階層に表示させます。 インプリメンタでは、このプロパティを true に設定することをサポートする必要があります。

データプロバイダーのルートノードを表示するかどうかを指定する Boolean フラグです。

データプロバイダーにルートノードがあり、showRoot プロパティが false に設定されている場合、FlexNativeMenu コントロールによって表示される最上位のメニューアイテムは、ルートノードの直下の下位要素に対応します。

このフラグは、リストや配列などのルートノードがないデータプロバイダーを使用する場合には、影響しません。

デフォルト値： true。

関連する API エレメント

オブジェクトが 3 段階のレイアウト検証を完了したものであるかどうかを示すフラグです（いずれかの検証が必須であった場合）。

コンストラクターです。

コンポーネントに設定されたプロパティを処理します。

関連する API エレメント

このコンテナの子を識別するプロパティのセットを返します。 アプリケーションの存続中は、これらの値を変更しないでください。

パラメーター

このコンテナの子を識別するプロパティのセットを返します。 アプリケーションの存続中は、これらの値を変更しないでください。

パラメーター

このメニューを、指定された位置にポップアップ表示します。

パラメーター

指定されたインデックス位置でオートメーションオブジェクトを提供します。 このリストには、組み合わされた子を入れないでください。

パラメーター

オートメーションオブジェクトリストを提供します。このリストには、組み合わされた子は含まれません。

後で画面更新時に commitProperties() メソッドが呼び出されるように、コンポーネントをマークします。

無効化は、後で画面が更新されるまでコンポーネントの変更処理を保留することで、作業の重複を解消する便利なメカニズムです。例えば、テキストの色とサイズを変更する場合、色を変更した後、すぐに色を更新し、次にサイズを設定して、今度はサイズを更新するという処理は時間の浪費です。両方のプロパティを変更した後、新しいサイズと色でテキストを一度に再描画する方が効率的です。

無効化メソッドが呼び出されることはほとんどありません。一般的には、コンポーネントのプロパティを設定すると、適切な無効化メソッドが自動的に呼び出されます。

keyEquivalentField プロパティと keyEquivalentFunction プロパティに基づいて、指定されたデータオブジェクトのキー相当物を返します。このメソッドは、パラメーターをストリングに変換できない場合、空のストリングを返します。

パラメーター

keyEquivalentModifiersFunction プロパティに基づいて、指定されたデータオブジェクトのキー相当物のモディファイアを返します。このメソッドは、パラメーターをモディファイアの配列に変換できない場合、空の配列を返します。

パラメーター

labelField プロパティと labelFunction プロパティに基づいて、指定されたデータオブジェクトに対するメニューアイテムラベルとして使用するストリングを返します。このメソッドは、パラメーターをストリングに変換できない場合にスペースを 1 つ返します。

パラメーター

mnemonicIndexField プロパティと mnemonicIndexFunction プロパティに基づいて、指定されたデータオブジェクトのニーモニックインデックスを返します。このメソッドは、パラメーターを整数に変換できない場合、-1 を返します。

パラメーター

アンダースコア文字が存在するかどうかに基づいてラベルからニーモニックインデックスを抽出します。先頭のアンダースコア文字（ある場合）を探し、インデックスとして使用します。

パラメーター

アンダースコア文字がある場合は削除し、エスケープされているアンダースコア文字がある場合は変換して、NativeMenuItem に対して使用される実際のラベルを決定します。

パラメーター

指定されたイベントを再生します。 デフォルトの再生動作がスーパークラスで定義されている場合、コンポーネント作成者は super.replayAutomatableEvent を呼び出すはずです。

パラメーター

提供された ID を使用して子を解決します。 この ID は、createAutomationIDPart() メソッドが提供するプロパティのセットです。

パラメーター

InteractiveObject のコンテキストメニューを基になるネイティブメニューに設定します。

パラメーター

基になるネイティブメニューに設定されていた InteractiveObject のコンテキストメニューの設定を解除します。

パラメーター

子の位置とサイズを検証し、その他のビジュアルオブジェクトを描画します。 LayoutManager.invalidateDisplayList() メソッドがこの ILayoutManagerClient クライアントを指定して呼び出された場合、表示リストの更新時に validateDisplayList() メソッドが呼び出されます。

必要に応じて、このオブジェクトのプロパティとレイアウトを検証および更新し、それを再描画します。

コンポーネントのプロパティを検証します。 LayoutManager.invalidateProperties() メソッドがこの ILayoutManagerClient クライアントを指定して呼び出された場合、プロパティ値の処理時に validateProperties() メソッドが呼び出されます。

コンポーネントの測定サイズを検証します。LayoutManager.invalidateSize() メソッドがこの ILayoutManagerClient を指定して呼び出された場合、測定の実行時に validateSize() メソッドが呼び出されます。

パラメーター

メニューアイテムが選択されたときに送出されます。

このイベントタイプのイベントオブジェクトの各プロパティには次の値が設定されています。イベントの種類によっては無効なプロパティもあります。詳細については、各プロパティの説明を参照してください。

メニューまたはサブメニューが表示される前に送出されます。

このイベントタイプのイベントオブジェクトの各プロパティには次の値が設定されています。イベントの種類によっては無効なプロパティもあります。詳細については、各プロパティの説明を参照してください。