パッケージflash.ui
クラスpublic final class ContextMenuItem
継承ContextMenuItem Inheritance NativeMenuItem Inheritance EventDispatcher Inheritance Object

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

ContextMenuItem クラスは、コンテキストメニューのアイテムを表します。各 ContextMenuItem オブジェクトには、コンテキストメニューに表示されるキャプション (テキスト) を指定できます。コンテキストメニューに新しいアイテムを追加するには、ContextMenu オブジェクトの customItems 配列にアイテムを追加します。

ContextMenuItem クラスのプロパティを使用して、特定のメニューアイテムを有効または無効にして、アイテムを表示または非表示にすることができます。

menuItemSelect イベントのイベントハンドラを記述して、ユーザーがメニューアイテムを選択したときにメニューアイテムに機能を追加します。

カスタムメニューアイテムは、コンテキストメニューの一番上、つまり、どのビルトインアイテムよりも上に表示されます。カスタムメニューアイテムとビルトインアイテムとの間には常にセパレータが表示されます。 (AIR では、ビルトインアイテムはありません)。

例を表示

関連項目

ContextMenu クラス
ContextMenuBuiltInItems クラス


パブリックプロパティ
 プロパティ定義元
  caption : String
コンテキストメニューに表示するメニューアイテムのキャプション(テキスト)を指定します。
ContextMenuItem
 InheritedAIR-only checked : Boolean
このメニューにチェックマークを表示するかどうかを制御します。
NativeMenuItem
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
 InheritedAIR-only data : Object
このメニューアイテムに関連付けられた任意のデータオブジェクトです。
NativeMenuItem
 InheritedAIR-only enabled : Boolean
このメニューを有効にするかどうかを制御します。
NativeMenuItem
 InheritedAIR-only isSeparator : Boolean
[読み取り専用] このアイテムがメニューセパレータ線かどうかを報告します。
NativeMenuItem
 InheritedAIR-only keyEquivalent : String
このメニューアイテムのキーボードショートカットです。
NativeMenuItem
 InheritedAIR-only keyEquivalentModifiers : Array
キーボードショートカットのモディファイアに対応するキーコードの配列です。
NativeMenuItem
 InheritedAIR-only label : String
このメニューアイテムの表示ストリングです。
NativeMenuItem
 InheritedAIR-only menu : NativeMenu
[読み取り専用] このアイテムを含むメニューです。
NativeMenuItem
 InheritedAIR-only mnemonicIndex : int
メニューアイテムでのニーモニック文字の位置です。
NativeMenuItem
 InheritedAIR-only name : String
このメニューアイテムの名前です。
NativeMenuItem
 Inheritedprototype : Object
[静的] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
  separatorBefore : Boolean
指定されたメニューアイテムの上にセパレータを表示するかどうかを示します。
ContextMenuItem
 InheritedAIR-only submenu : NativeMenu
このメニューアイテムに関連付けられたサブメニューです。
NativeMenuItem
  visible : Boolean
Flash Player のコンテキストメニューを表示するときに、指定されたメニューアイテムを表示するかどうかを示します。
ContextMenuItem
パブリックメソッド
 メソッド定義元
  
ContextMenuItem(caption:String, separatorBefore:Boolean = false, enabled:Boolean = true, visible:Boolean = true)
ContextMenu.customItems 配列に追加できる新しい ContextMenuItem オブジェクトを作成します。
ContextMenuItem
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
EventDispatcher
  
[override] NativeMenuItem オブジェクトのコピーを作成します。
ContextMenuItem
 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
  
[静的]
ContextMenuItem
  
[静的]
ContextMenuItem
  
[静的]
ContextMenuItem
  
[静的]
ContextMenuItem
  
[静的]
ContextMenuItem
  
[静的]
ContextMenuItem
  
[静的]
ContextMenuItem
 Inherited
[override] NativeMenuItem オブジェクトのすべてのプロパティを含むストリングを返します。
NativeMenuItem
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
 Inherited
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
イベント
 イベント 概要 定義元
 Inherited[ブロードキャスト イベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。EventDispatcher
 Inherited[ブロードキャスト イベント] Flash Player または AIR アプリケーションがオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。EventDispatcher
 Inheritedアイテムを含むメニューが表示される直前に、この NativeMenuItem から送出されます。NativeMenuItem
  ユーザーがコンテキストメニューからアイテムを選択したときに送出されます。ContextMenuItem
 Inheritedユーザーがメニューアイテムを選択したときに送出されます。NativeMenuItem
プロパティの詳細
captionプロパティ
caption:String

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

コンテキストメニューに表示するメニューアイテムのキャプション (テキスト) を指定します。caption 値の制約については、ContextMenuItem クラスの概要を参照してください。



実装
    public function get caption():String
    public function set caption(value:String):void
separatorBeforeプロパティ 
separatorBefore:Boolean

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

指定されたメニューアイテムの上にセパレータを表示するかどうかを示します。

メモ : カスタムメニューアイテムとビルトインメニューアイテムの間には常にセパレータが表示されます。

デフォルト値 : false.



実装
    public function get separatorBefore():Boolean
    public function set separatorBefore(value:Boolean):void
visibleプロパティ 
visible:Boolean

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

Flash Player のコンテキストメニューを表示するときに、指定されたメニューアイテムを表示するかどうかを示します。

デフォルト値 : true.



実装
    public function get visible():Boolean
    public function set visible(value:Boolean):void
コンストラクタの詳細
ContextMenuItem()コンストラクタ
public function ContextMenuItem(caption:String, separatorBefore:Boolean = false, enabled:Boolean = true, visible:Boolean = true)

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

ContextMenu.customItems 配列に追加できる新しい ContextMenuItem オブジェクトを作成します。

パラメータ
caption:String — メニューアイテムに関連付けられるテキストを指定します。caption 値の制約については、ContextMenuItem クラスの概要を参照してください。
 
separatorBefore:Boolean (default = false) — コンテキストメニューのメニューアイテムの上にセパレータを表示するかどうかを指定します。デフォルト値は false です。
 
enabled:Boolean (default = true) — コンテキストメニューのメニューアイテムが有効か無効かを指定します。デフォルト値は true (有効) です。このパラメータはオプションです。
 
visible:Boolean (default = true) — メニューアイテムを表示するか非表示にするかを指定します。デフォルト値は true (表示) です。
メソッドの詳細
clone()メソッド
override public function clone():NativeMenuItem

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

戻り値
NativeMenuItem
systemClearMenuItem()メソッド 
public static function systemClearMenuItem():ContextMenuItem

戻り値
ContextMenuItem
systemCopyLinkMenuItem()メソッド 
public static function systemCopyLinkMenuItem():ContextMenuItem

戻り値
ContextMenuItem
systemCopyMenuItem()メソッド 
public static function systemCopyMenuItem():ContextMenuItem

戻り値
ContextMenuItem
systemCutMenuItem()メソッド 
public static function systemCutMenuItem():ContextMenuItem

戻り値
ContextMenuItem
systemOpenLinkMenuItem()メソッド 
public static function systemOpenLinkMenuItem():ContextMenuItem

戻り値
ContextMenuItem
systemPasteMenuItem()メソッド 
public static function systemPasteMenuItem():ContextMenuItem

戻り値
ContextMenuItem
systemSelectAllMenuItem()メソッド 
public static function systemSelectAllMenuItem():ContextMenuItem

戻り値
ContextMenuItem
イベントの詳細
menuItemSelect イベント
イベントオブジェクトの型: flash.events.ContextMenuEvent
プロパティ ContextMenuEvent.type = flash.events.ContextMenuEvent.MENU_ITEM_SELECT

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

ユーザーがコンテキストメニューからアイテムを選択したときに送出されます。ユーザーは、ポインティングデバイスの第 2 ボタンをクリックすることにより、コンテキストメニューを生成します。

type プロパティ (menuItemSelect イベントオブジェクト) の値を定義します。

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

プロパティ
bubblesfalse
cancelablefalse は、キャンセルするデフォルトの動作がないことを示します。
contextMenuOwnerメニューが関連付けられている表示リストオブジェクトです。
currentTargetイベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
mouseTargetユーザーがコンテキストメニューを表示するために右クリックした表示リストオブジェクトです。
target選択された ContextMenuItem オブジェクトです。target は、必ずしもイベントリスナーを登録した表示リスト内のオブジェクトとは限りません。現在イベントを処理している表示リスト内のオブジェクトにアクセスするには、currentTarget プロパティを使用します。
例の使用法
ContextMenuItemExample.as

次の例では、ContextMenuBuiltInItemsExample クラスを使用して、デフォルトのコンテキストメニューアイテムをステージから削除し、新しいメニューアイテムを追加します。これを行うには、以下の手順を実行します。
  1. myContextMenu プロパティが宣言され、新しい ContextMenu オブジェクトに割り当てられます。
  2. removeDefaultItems() メソッドが呼び出されます。このメソッドによって、すべてのビルトインコンテキストメニューアイテムが削除されます。ただし、「プリント」を除きます。
  3. addCustomMenuItems() メソッドが呼び出され、Hello World というメニューアイテムを customItems 配列に配置します。このとき、配列の push() メソッドが使用されます。
  4. Hello World コンテキストメニューアイテムは、ステージのコンテキストメニューアイテム一覧に追加されます。
  5. テキスト「ここを右クリック」が指定されている TextField オブジェクトがステージに追加されます。
package {
    import flash.ui.ContextMenu;
    import flash.ui.ContextMenuItem;
    import flash.ui.ContextMenuBuiltInItems;
    import flash.display.Sprite;
    import flash.text.TextField;

    public class ContextMenuItemExample extends Sprite {
        private var myContextMenu:ContextMenu;

        public function ContextMenuItemExample() {
            myContextMenu = new ContextMenu();
            removeDefaultItems();
            addCustomMenuItems();
            this.contextMenu = myContextMenu;
            addChild(createLabel());
        }

        private function removeDefaultItems():void {
            myContextMenu.hideBuiltInItems();

            var defaultItems:ContextMenuBuiltInItems = myContextMenu.builtInItems;
            defaultItems.print = true;
        }

        private function addCustomMenuItems():void {
            var item:ContextMenuItem = new ContextMenuItem("Hello World");
            myContextMenu.customItems.push(item);
        }
        
        private function createLabel():TextField {
            var txtField:TextField = new TextField();
            txtField.text = "Right Click Here";
            return txtField;
        }
    }
}




 

 

このページに新しいコメントが追加された場合に、電子メールでの通知を希望する。 | コメントレポート

現在のページ: http://livedocs.adobe.com/flex/3_jp/langref/flash/ui/ContextMenuItem.html