メニューの基本

メニュークラスには、次のクラスが含まれます。

AIR では、次のタイプのメニューをサポートしています。

コンテキストメニュー

コンテキストメニューは、SWF コンテンツ内のインタラクティブオブジェクトまたは HTML コンテンツ内のドキュメントエレメントを右クリックまたは Command キーを押しながらクリックすると開くメニューです。

Flash Player ランタイムでは、コンテキストメニューが自動的に表示されます。ContextMenu および ContextMenuItem クラスを使用して、メニューに独自のコマンドを追加できます。また、ビルトインコマンドの一部（全部ではなく）を削除できます。

AIR ランタイムでは、NativeMenu クラスまたは ContextMenu クラスを使用して、コンテキストメニューを作成できます。AIR の HTML コンテンツでは、Webkit HTML や JavaScript の API を使用して、コンテキストメニューを HTML エレメントに追加できます。

アプリケーション メニュー（AIR のみ）

アプリケーションメニューは、アプリケーション全体に適用されるグローバルなメニューです。アプリケーションメニューは Mac OS X でサポートされ、Windows および Linux ではサポートされません。Mac OS X では、オペレーティングシステムで自動的にアプリケーションメニューが作成されます。AIR のメニュー API を使用すると、標準のメニューにアイテムやサブメニューを追加したり、既存のメニューコマンドを処理するリスナーを追加したり、既存のアイテムを削除したりすることができます。

ウィンドウメニュー（AIR のみ）

ウィンドウメニューは、1 つのウィンドウに関連付けられるメニューで、タイトルバーの下に表示されます。NativeMenu オブジェクトを作成して NativeWindow オブジェクトの menu プロパティに割り当てることで、ウィンドウにメニューを追加できます。ウィンドウメニューは Windows および Linux オペレーティングシステムでサポートされ、Mac OS X ではサポートされません。ネイティブウィンドウメニューは、システムクロムを持つウィンドウでのみ使用できます。

ドックおよびシステムトレイアイコンメニュー（AIR のみ）

これらのアイコンメニューは、コンテキストメニューに似ており、Mac OS X の場合はドック内、Windows および Linux の場合はタスクバーの通知領域内に表示されるアプリケーションアイコンに割り当てられます。ドックおよびシステムトレイアイコンメニューでは、NativeMenu クラスが使用されます。Mac OS X では、メニューのアイテムは、オペレーティングシステムの標準のアイテムの上に追加されます。Windows または Linux では、標準のメニューはありません。

ポップアップメニュー（AIR のみ）

AIR のポップアップメニューはコンテキストメニューに似ていますが、特定のアプリケーションオブジェクトまたはコンポーネントに必ずしも関連付けられません。ポップアップメニューは、任意の NativeMenu オブジェクトの display() メソッドを呼び出すことで、ウィンドウ内の任意の位置に表示できます。

カスタムメニュー

ネイティブメニューは、完全にオペレーティングシステムによって描画されるため、Flash や HTML のレンダリングモデル内に含めることはできません。ネイティブメニューを使用する代わりに、MXML、ActionScript または JavaScript（AIR の場合）を使用して独自のカスタム非ネイティブメニューをいつでも作成できます。そのようなメニューは、アプリケーションコンテンツ内で完全にレンダリングされる必要があります。

ネイティブメニューは、性質として階層的な構造をしています。NativeMenu オブジェクトには、子の NativeMenuItem オブジェクトが含まれます。さらに、サブメニューを表す NativeMenuItem オブジェクトに NativeMenu オブジェクトを含めることができます。構造内の最上位レベル、つまりルートレベルのメニューオブジェクトは、アプリケーションメニューおよびウィンドウメニューのメニューバーを表します（コンテキスト、アイコンおよびポップアップの各メニューにはメニューバーはありません）。

次の図に、典型的なメニューの構造を示します。ルートメニューはメニューバーを表しており、 File サブメニューおよび Edit サブメニューを参照する 2 つのメニューアイテムが含まれています。この構造の File サブメニューには、2 つのコマンドアイテムと、 Open Recent Menu サブメニュー（このサブメニュー自体にも 3 つのアイテムが含まれています）を参照するアイテムが含まれています。Edit サブメニューには、3 つのコマンドと 1 つのセパレーターが含まれています。

フルサイズのグラフィックを表示

サブメニューを定義するには、NativeMenu オブジェクトと NativeMenuItem オブジェクトの両方が必要です。NativeMenuItem オブジェクトでは親メニューに表示されるラベルが定義され、ユーザーはこのオブジェクトを使用してサブメニューを開くことができます。NativeMenu オブジェクトは、サブメニューのアイテムのコンテナとして機能します。NativeMenuItem オブジェクトでは、NativeMenuItem の submenu プロパティを通して NativeMenu オブジェクトを参照します。

このメニューを作成するコードの例については、 ネイティブメニューの例：ウィンドウメニューとアプリケーションメニュー（AIR） を参照してください。

NativeMenu オブジェクトと NativeMenuItem オブジェクトは、どちらも preparing イベント、 displaying イベント、 select イベントを送出します。

displaying：

メニューが表示される直前に、メニューおよびそのメニューアイテムから、登録されているすべてのリスナーに displaying イベントが送出されます。

preparing イベントと displaying イベントにより、メニューの内容やアイテムの外観を、ユーザーに表示される前に更新できます。例えば、最近使用したファイルを開くメニューの displaying イベントのリスナーでは、最近表示したドキュメントの最新の一覧を反映するようにメニューアイテムを変更することができます。

preparing イベントをトリガーしたキーボードショートカットに対応するメニューアイテムを削除すると、メニュー操作は事実上キャンセルされ、 select イベントは送出されません。

イベントの target プロパティと currentTarget プロパティはどちらもリスナーの登録先のオブジェクト（メニューそのものかメニューアイテムの 1 つ）です。

preparing イベントは displaying イベントの前に送出されます。通常はこれらのイベントの両方をリッスンすることはなく、一方のみをリッスンします。

select：

コマンドアイテムがユーザーによって選択されると、そのアイテムから、登録されているすべてのリスナーに select イベントが送出されます。サブメニューアイテムとセパレーターアイテムは選択できないため、これらから select イベントが送出されることはありません。

select イベントは、メニューアイテムからそれを含むメニューへと、ルートメニューに達するまでバブルします。 select イベントは、アイテムで直接リッスンすることも、メニュー構造の上位でリッスンすることもできます。 select イベントをメニューでリッスンする場合は、そのイベントの target プロパティを使用して、選択されたアイテムを識別できます。メニュー階層の上方にイベントがバブルしていくのに合わせて、イベントオブジェクトの currentTarget プロパティは、現在のメニューオブジェクトを識別します。

注意： ContextMenu オブジェクトと ContextMenuItem オブジェクトでは、 menuItemSelect イベントと menuSelect イベントに加え、 select イベント、 preparing イベント、 displaying イベントも送出します。

メニューコマンドにキーボードショートカット（アクセラレーター）を割り当てることができます。キーまたはキーの組み合わせが押されると、メニューアイテムから、登録されているすべてのリスナーに select イベントが送出されます。アイテムが格納されるメニューは、コマンドが呼び出されるアプリケーションまたはアクティブなウィンドウのメニューの一部である必要があります。

キーボードショートカットは 2 つの部分から構成されます。主キーを表すストリングと、一緒に押される必要がある修飾キーの配列です。主キーを割り当てるには、メニューアイテムの keyEquivalent プロパティに、そのキーの 1 文字のストリングを設定します。大文字を使用した場合、修飾キーの配列に Shift キーが自動的に追加されます。

Mac OS X では、デフォルトの修飾キーは Command キー（ Keyboard.COMMAND ）です。Windows および Linux では、Ctrl キー（ Keyboard.CONTROL ）です。これらのデフォルトのキーは、修飾キーの配列に自動的に追加されます。別の修飾キーを割り当てるには、そのキーコードを含む新しい配列を keyEquivalentModifiers プロパティに割り当てます。デフォルトの配列は上書きされます。デフォルトの修飾キーを使用するか独自の修飾キーの配列を割り当てるかに関係なく、 keyEquivalent プロパティに割り当てたストリングが大文字の場合は Shift キーが追加されます。修飾キーに使用するキーコードの定数は、Keyboard クラスで定義されています。

割り当てられたキーボードショートカットのストリングは、自動的にメニューアイテム名の横に表示されます。形式は、ユーザーのオペレーティングシステムおよびシステムの環境設定によって異なります。

次の例では、メニューアイテムのキーボードショートカットとして Ctrl+Shift+G を割り当てます。

var item = new air.NativeMenuItem("Ungroup"); 
item.keyEquivalent = "G";

次の例では、修飾キーの配列を直接設定することにより、キーボードショートカットとして Ctrl+Shift+G を割り当てます。

var item = new air.NativeMenuItem("Ungroup"); 
item.keyEquivalent = "G"; 
item.keyEquivalentModifiers = [air.Keyboard.CONTROL];

ニーモニックは、オペレーティングシステムのメニューのキーボードインターフェイスの一部です。Linux、Mac OS X および Windows では、いずれもキーボードでメニューを開いてコマンドを選択する操作ができますが、その方法には微妙な違いがあります。

Mac OS X では、ユーザーはメニューまたはコマンドの最初の 1 文字か 2 文字を入力して、Return キーを押します。 mnemonicIndex プロパティは無視されます。

Windows では、これを 1 文字だけで実行できます。デフォルトでは、有効な文字はラベルの最初の文字ですが、メニューアイテムにニーモニックを割り当てると、有効な文字は指定した文字になります。メニュー内の 2 つのアイテムの有効な文字が同じ場合（ニーモニックが割り当てられているかどうかに関係なく）、メニューのキーボード操作が少し異なります。1 文字入力してメニューまたはコマンドを選択するのではなく、ユーザーは必要な回数だけその文字を入力して対象のアイテムを強調表示してから、Enter キーを押して選択を完了する必要があります。動作の一貫性を維持するために、ウィンドウメニューでは、メニュー内のアイテムそれぞれに異なるニーモニックを割り当てることをお勧めします。

Linux では、既定のニーモニックは設定されません。メニューアイテムの mnemonicIndex プロパティ値を設定することでニーモニックを指定する必要があります。

ニーモニック文字は、ラベルストリングのインデックスとして指定します。ラベルの最初の文字のインデックスは 0 です。したがって、「Format」というラベルのメニューアイテムのニーモニックとして「r」を使用するには、 mnemonicIndex プロパティを 2 に設定します。

var item = new air.NativeMenuItem("Format"); 
item.mnemonicIndex = 2;

メニューアイテムには、状態を表すプロパティとして、 checked および enabled という 2 つのプロパティがあります。

checked

true に設定すると、アイテムラベルの横にチェックマークが表示されます。

var item = new air.NativeMenuItem("Format"); 
item.checked = true;

enabled

値を true と false で切り替えて、コマンドを有効にするかどうかを制御します。無効にしたアイテムは「グレー表示」され、そのアイテムからは select イベントは送出されません。

var item = new air.NativeMenuItem("Format"); 
item.enabled = false;

NativeMenuItem クラスの data プロパティを使用して、各アイテムの任意のオブジェクトを参照できます。例えば、最近使用したファイルを開くメニューでは、それぞれのメニューアイテムに各ドキュメントの File オブジェクトを割り当てることができます。

var file = air.File.applicationStorageDirectory.resolvePath("GreatGatsby.pdf") 
var menuItem = docMenu.addItem(new air.NativeMenuItem(file.name)); 
menuItem.data = file;