Adobe® Flash® Platform 用 ActionScript® 3.0 リファレンスガイド
ホーム  |  パッケージおよびクラスリストの非表示 |  パッケージ  |  クラス  |  新機能  |  索引  |  付録  |  英語で表示される理由
フィルター: サーバーからデータを取得しています...
サーバーからデータを取得しています...
flash.display 

NativeMenuItem  - AS3

パッケージflash.display
クラスpublic class NativeMenuItem
継承NativeMenuItem Inheritance EventDispatcher Inheritance Object
サブクラス ContextMenuItem

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0

NativeMenuItem クラスは、メニュー中の 1 アイテムを表します。

メニューアイテムは、コマンド、サブメニューまたはセパレーター線です。

  • コマンドアイテムを作成するには、NativeMenuItem コンストラクターを呼び出します。このとき、ラベルに使用するストリングを渡し、falseisSeparator パラメーターに設定します。
  • サブメニューを作成するには、親メニューとなるコマンドアイテムを作成し、このコマンドアイテムの submenu プロパティに、作成するサブメニューの NativeMenu オブジェクトを割り当てます。親 NativeMenu オブジェクトの addSubmenu() メソッドを呼び出してアイテムを作成し、同時に submenu プロパティを設定できます。
  • セパレーターを作成するには、NativeMenuItem コンストラクターを呼び出します。このとき、ラベルに使用するストリングとして空のストリングを渡し、trueisSeparator パラメーターに設定します。

アイテムまたは親メニューの select イベントを受け取り、メニューコマンドが選択された時期を検出します。サブメニューとセパレーターは、select イベントを送出しません。メニューアイテムが表示される、またはショートカットキーによりアクティブ化されるタイミングを識別するために preparing イベントをリッスンします。

関連する API エレメント



パブリックプロパティ
 プロパティ定義元
      checked : Boolean
このメニューにチェックマークを表示するかどうかを制御します。
NativeMenuItem
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。
Object
      data : Object
このメニューアイテムに関連付けられた任意のデータオブジェクトです。
NativeMenuItem
      enabled : Boolean
このメニューを有効にするかどうかを制御します。
NativeMenuItem
      isSeparator : Boolean
[読み取り専用] このアイテムがメニューセパレーター線かどうかを報告します。
NativeMenuItem
      keyEquivalent : String
このメニューアイテムのキー相当物です。
NativeMenuItem
      keyEquivalentModifiers : Array
キー相当物のモディファイアに対応するキーコードの配列です。
NativeMenuItem
      label : String
このメニューアイテムの表示ストリングです。
NativeMenuItem
      menu : NativeMenu
[読み取り専用] このアイテムを含むメニューです。
NativeMenuItem
      mnemonicIndex : int
メニューアイテムでのニーモニック文字の位置です。
NativeMenuItem
      name : String
このメニューアイテムの名前です。
NativeMenuItem
      submenu : NativeMenu
このメニューアイテムに関連付けられたサブメニューです。
NativeMenuItem
パブリックメソッド
 メソッド定義元
  
    NativeMenuItem(label:String = "", isSeparator:Boolean = false)
新しい NativeMenuItem オブジェクトを作成します。
NativeMenuItem
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
EventDispatcher
  
NativeMenuItem オブジェクトのコピーを作成します。
NativeMenuItem
 Inherited
イベントをイベントフローに送出します。
EventDispatcher
 Inherited
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。
Object
  
    toString():String
[オーバーライド] NativeMenuItem オブジェクトのすべてのプロパティを含むストリングを返します。
NativeMenuItem
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
 Inherited
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
イベント
 イベント 概要 定義元
 Inherited[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。EventDispatcher
 Inherited[ブロードキャストイベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。EventDispatcher
  
    displaying
アイテムを含むメニューが表示される直前に、この NativeMenuItem から送出されます。NativeMenuItem
  
    preparing
ショートカットキーが押され、格納されているメニューアイテムが表示される直前に、この NativeMenuItem から送出されます。NativeMenuItem
  
    select
ユーザーがメニューアイテムを選択したときに送出されます。NativeMenuItem
プロパティの詳細
    

checked

プロパティ
checked:Boolean

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0

このメニューにチェックマークを表示するかどうかを制御します。



実装
    public function get checked():Boolean
    public function set checked(value:Boolean):void
    

data

プロパティ 
data:Object

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0

このメニューアイテムに関連付けられた任意のデータオブジェクトです。

このプロパティには、任意のオブジェクトを割り当てられます。割り当てられたオブジェクトはメニューシステムでは使用されず、(イベントオブジェクトの target プロパティを通じて)イベント処理コードで使用できます。デフォルトでは、このプロパティの値は null です。



実装
    public function get data():Object
    public function set data(value:Object):void
    

enabled

プロパティ 
enabled:Boolean

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0

このメニューを有効にするかどうかを制御します。



実装
    public function get enabled():Boolean
    public function set enabled(value:Boolean):void
    

isSeparator

プロパティ 
isSeparator:Boolean  [読み取り専用]

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0

このアイテムがメニューセパレーター線かどうかを報告します。

NativeMenuItem コンストラクターの isSeparator パラメーターを true に設定して、セパレーター線を作成します。



実装
    public function get isSeparator():Boolean
    

keyEquivalent

プロパティ 
keyEquivalent:String

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0

このメニューアイテムのキー相当物です。

小文字を使用して keyEquivalent を設定し、Shift キーモディファイアを使用しないショートカットを割り当てます。大文字を使用して設定し、Shift キーモディファイアを使用するショートカットを割り当てます。

デフォルトでは、キーボードショートカットのモディファイア(Windows または Linux では Ctrl、Mac OS X では Command)がキーボードショートカットの一部に含まれます。キー相当物をモディファイアのないキーにする場合、keyEquivalentModifiers プロパティを空の配列に設定します。



実装
    public function get keyEquivalent():String
    public function set keyEquivalent(value:String):void
    

keyEquivalentModifiers

プロパティ 
keyEquivalentModifiers:Array

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0

キー相当物のモディファイアに対応するキーコードの配列です。

Keyboard クラスで定義されている定数を使用して、モディファイアキーコードを指定します。有効なモディファイアキーは次のとおりです。

  • Keyboard.ALTERNATE
  • Keyboard.COMMAND
  • Keyboard.CONTROL

モディファイアを割り当てない場合、Windows または Linux では Keyboard.CONTROL キー、Mac OS X では Keyboard.COMMAND キーがデフォルトで割り当てられます。キー相当物にこれらのモディファイアが含まれないようにするには、このプロパティを空の配列に設定します。

keyEquivalent プロパティに大文字を割り当てると、Shift キーがモディファイアとして自動的に使用されます。keyEquivalentModifier を空の配列に設定しても、モディファイアとしての Shift キーは除去されません。



実装
    public function get keyEquivalentModifiers():Array
    public function set keyEquivalentModifiers(value:Array):void

関連する API エレメント

    

label

プロパティ 
label:String

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0

このメニューアイテムの表示ストリングです。



実装
    public function get label():String
    public function set label(value:String):void
    

menu

プロパティ 
menu:NativeMenu  [読み取り専用]

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0

このアイテムを含むメニューです。



実装
    public function get menu():NativeMenu
    

mnemonicIndex

プロパティ 
mnemonicIndex:int

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0

メニューアイテムでのニーモニック文字の位置です。

指定された位置の文字が、そのメニューアイテムのニーモニック文字です。インデックスは 0 から始まるので、最初の文字は 0 のインデックスを持ちます。

このプロパティは、メニューニーモニックを使用しないオペレーティングシステムでは無視されます。



実装
    public function get mnemonicIndex():int
    public function set mnemonicIndex(value:int):void
    

name

プロパティ 
name:String

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0

このメニューアイテムの名前です。

名前の値は表示されず、ロケールに依存しない識別子として使用できます。名前は自動的には割り当てられません。



実装
    public function get name():String
    public function set name(value:String):void
    

submenu

プロパティ 
submenu:NativeMenu

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0

このメニューアイテムに関連付けられたサブメニューです。

このプロパティに NativeMenu オブジェクトを割り当てると、メニューアイテムの外観と動作が変化します。サブメニューアイテムにサブメニューアイコンが表示され、select イベントが送出されなくなります。

注意:メニューをそのメニューのサブメニューとして追加すると(循環参照)、アプリケーションが異常停止することがあります。



実装
    public function get submenu():NativeMenu
    public function set submenu(value:NativeMenu):void

関連する API エレメント

コンストラクターの詳細
    

NativeMenuItem

()コンストラクター
public function NativeMenuItem(label:String = "", isSeparator:Boolean = false)

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0

新しい NativeMenuItem オブジェクトを作成します。

メニューコマンドを作成するには、label パラメーターを表示ラベルを含むストリングに設定し、isSeparatorfalse に設定します。

サブメニューコマンドを作成するには、コマンドアイテムを作成し、サブメニューの NativeMenu オブジェクトをこのアイテムの submenu プロパティに割り当てます。親メニューにアイテムを追加します。

セパレーターを作成するには、label パラメーターを空のストリングに設定し、isSeparatortrue に設定します。

NativeMenu の addItem() メソッドおよび removeItem() メソッドを使用して、メニューにアイテムを追加したり、メニューからアイテムを削除したりします。

パラメーター
label:String (default = "") — アイテムの表示ラベルまたはセパレーターの空のストリングです。
 
isSeparator:Boolean (default = false) — セパレーターを作成する場合は true に設定し、それ以外の場合は false に設定します。

関連する API エレメント

メソッドの詳細

    clone

()メソッド
public function clone():NativeMenuItem

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0

NativeMenuItem オブジェクトのコピーを作成します。

戻り値
NativeMenuItem

    toString

()メソッド 
override public function toString():String

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0

NativeMenuItem オブジェクトのすべてのプロパティを含むストリングを返します。

戻り値
String — Event オブジェクトのすべてのプロパティを含むストリングです。
イベントの詳細
    

displaying

イベント
イベントオブジェクトの型: flash.events.Event
プロパティ Event.type = flash.events.Event.DISPLAYING

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0

アイテムを含むメニューが表示される直前に、この NativeMenuItem から送出されます。

preparing イベントは displaying イベントを置き換え、追加機能を提供します。preparing イベントと displaying のいずれかをリッスンしますが、双方をリッスンすることはできません。

Event.DISPLAYING 定数は、type プロパティ(displaying イベントオブジェクト)の値を定義します。

注意:このイベントは "キャプチャ段階" を経由せず、ターゲットが表示リストにあるかどうかにかかわらず、ターゲットに直接送出されます。

このイベントには、次のプロパティがあります。

プロパティ
bubblesfalse
cancelablefalse
currentTargetイベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
target表示されるオブジェクトです。
    

preparing

イベント  
イベントオブジェクトの型: flash.events.Event
プロパティ Event.type = flash.events.Event.PREPARING

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 2.6

ショートカットキーが押され、格納されているメニューアイテムが表示される直前に、この NativeMenuItem から送出されます。

格納されているメニューを表示する前、またはそのショートカットキーが押された際に、アイテムを更新するためにこのイベントをリッスンします。preparing イベントはショートカットキーが完全に評価される前に送出されます。preparing イベントハンドラー内のメニューは、有効化、無効化、または削除できます。これらの変更は、ショートカットキーの処理時に有効になります。例えば、このメニューアイテムを削除または無効化した場合、イベントのシーケンスは事実上キャンセルされ、select イベントは送出されません。preparing イベントは、メニュー内の他のアイテムからも送出されます。

preparing イベントは displaying イベントを置き換え、追加機能を提供します。preparing イベントと displaying のいずれかをリッスンしますが、双方をリッスンすることはできません。

Event.PREPARING 定数は、preparing イベントオブジェクトの type プロパティの値を定義します。

注意:このイベントは "キャプチャ段階" を経由せず、ターゲットが表示リストにあるかどうかにかかわらず、ターゲットに直接送出されます。

このイベントには、次のプロパティがあります。

プロパティ
bubblesfalse
cancelablefalse
currentTargetこのイベントを送出したオブジェクトです。
targetこのイベントを送出したオブジェクトです。
    

select

イベント  
イベントオブジェクトの型: flash.events.Event
プロパティ Event.type = flash.events.Event.SELECT

言語バージョン: ActionScript 3.0
ランタイムバージョン: AIR 1.0

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

select イベントは、このアイテムからアイテムに含まれているメニューまで、親メニューのチェーンをルートメニューオブジェクトに向かって上方にバブルします。イベントオブジェクトの target プロパティは、この NativeMenuItem オブジェクトを参照します。currentTarget プロパティは、送出するオブジェクト(この NativeMenuItem オブジェクトまたはその上位の NativeMenu オブジェクト)を参照します。

注意:メニューを含むウィンドウがフルスクリーンモードである場合(stage.displayState == StageDisplayState.FULL_SCREEN)、NativeMenuItem オブジェクトは、ユーザーがメニューアイテムにキーボードショートカットを入力しても select イベントを送出しません。

Event.SELECT 定数は、type プロパティ(select イベントオブジェクト)の値を定義します。

このイベントには、次のプロパティがあります。

プロパティ
bubblesfalse
cancelablefalse は、キャンセルするデフォルトの動作がないことを示します。
currentTargetイベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
targetアイテムが選択されたオブジェクトです。




[ X ]英語で表示される理由
ActionScript 3.0 リファレンスガイドのコンテンツが英語で表示されます。

ActionScript 3.0 リファレンスガイドのすべての部分がすべての言語に翻訳されているわけではありません。言語エレメントが翻訳されていない場合、そのエレメントは英語で表示されます。例えば、ga.controls.HelpBox クラスはどの言語にも訳されていません。このため、リファレンスガイドの日本語バージョンでは、ga.controls.HelpBox クラスは英語で表示されます。