flash.ui.ContextMenuItem (Flex™ 2 リファレンスガイド)

パッケージ	flash.ui
	public final class ContextMenuItem
継承	ContextMenuItem EventDispatcher Object

ContextMenuItem クラスを使用して、Flash Player のコンテキストメニューに表示するカスタムメニューアイテムを作成します。各 ContextMenuItem オブジェクトには、コンテキストメニューに表示されるキャプション (テキスト) があります。コンテキストメニューに新しいアイテムを追加するには、ContextMenu オブジェクトの customItems 配列にアイテムを追加します。

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

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

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

制約 :

コンテキストメニューに追加できるカスタムアイテムは 15 アイテム以内です。
各キャプションには、少なくとも 1 つの表示可能な文字が含まれている必要があります。
制御文字、改行、その他の空白文字は無視されます。
キャプションの長さは 100 文字以内である必要があります。
ビルトインメニューアイテムまたは他のカスタムメニューアイテムと同じキャプションは、一致するアイテムが表示されているかどうかにかかわらず無視されます。メニューキャプションは、ビルトインキャプションまたは既存のカスタムキャプションと比較されます。大文字と小文字、カンマとピリオド、空白文字は無視されます。
以下のキャプションは許可されませんが、他の単語と組み合わせてカスタムキャプションを作成できます。たとえば、"ペースト" は許可されませんが、"ペーストはおいしい" は許可されます。
```
 Save
 Zoom In
 Zoom Out
 100%
 Show All
 Quality
 Play
 Loop
 Rewind
 Forward
 Back
 Movie not loaded
 About
 Print
 Show Redraw Regions
 Debugger
 Undo
 Cut
 Copy
 Paste
 Delete
 Select All
 Open
 Open in new window
 Copy link
 
```
以下の単語は、単独でも他の単語と組み合わせてもカスタムキャプションには使用できません。
```
 Adobe
 Macromedia
 Flash Player
 Settings
 
```

メモ : 英語以外のシステムで実行される場合、キャプションストリングは英語の一覧およびローカライズされた一覧の両方と比較されます。

	プロパティ	定義
		caption : String コンテキストメニューに表示するメニューアイテムのキャプション (テキスト) を指定します。	ContextMenuItem
		constructor : Object 指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。	Object
		enabled : Boolean 指定されたメニューアイテムが有効か無効かを示します。	ContextMenuItem
		prototype : Object [static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。	Object
		separatorBefore : Boolean 指定されたメニューアイテムの上にセパレータを表示するかどうかを示します。	ContextMenuItem
		visible : Boolean Flash Player のコンテキストメニューを表示するときに、指定されたメニューアイテムを表示するかどうかを示します。	ContextMenuItem

パブリック Methods

継承されるパブリックメソッドの非表示

継承されるパブリックメソッドの表示

	メソッド		定義
		ContextMenuItem(caption:String, separatorBefore:Boolean = false, enabled:Boolean = true, visible:Boolean = true) `ContextMenu.customItems` 配列に追加できる新しい ContextMenuItem オブジェクトを作成します。	ContextMenuItem
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void リスナーがイベントの通知を受け取るように、イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録します。	EventDispatcher
		clone():ContextMenuItem 指定された ContextMenuItem オブジェクトのコピーを作成して返します。	ContextMenuItem
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	EventDispatcher
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	EventDispatcher
		hasOwnProperty(name:String):Boolean 指定されたプロパティがオブジェクトに定義されているかどうかを示します。	Object
		isPrototypeOf(theClass:Object):Boolean Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。	Object
		propertyIsEnumerable(name:String):Boolean 指定されたプロパティが存在し、列挙できるかどうかを示します。	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher オブジェクトからリスナーを削除します。	EventDispatcher
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void ループ処理に対するダイナミックプロパティの可用性を設定します。	Object
		toString():String 指定されたオブジェクトのストリング表現を返します。	Object
		valueOf():Object 指定されたオブジェクトのプリミティブな値を返します。	Object
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	EventDispatcher

一覧	定義
activate	Flash Player がオペレーティングシステムのフォーカスを取得して、アクティブになったときに送出されます。	EventDispatcher
deactivate	Flash Player がオペレーティングシステムのフォーカスを失って、非アクティブになったときに送出されます。	EventDispatcher
menuItemSelect	ユーザーがコンテキストメニューからアイテムを選択したときに送出されます。	ContextMenuItem

プロパティの詳細

caption

プロパティ

caption:String [read-write]

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

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

enabled

プロパティ

enabled:Boolean [read-write]

指定されたメニューアイテムが有効か無効かを示します。

デフォルト値true.

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

separatorBefore

プロパティ

separatorBefore:Boolean [read-write]

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

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

デフォルト値false.

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

visible

プロパティ

visible:Boolean [read-write]

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

デフォルト値true.

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

コンストラクタの詳細

ContextMenuItem

()

コンストラクタ

public 関数 ContextMenuItem(caption:String, separatorBefore:Boolean = false, enabled:Boolean = true, visible:Boolean = true)

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

パラメータ

	`caption:String` — メニューアイテムに関連付けられるテキストを指定します。`caption` 値の制約については、ContextMenuItem クラスの概要を参照してください。

	`separatorBefore:Boolean` (default = `false`) — コンテキストメニューのメニューアイテムの上にセパレータを表示するかどうかを指定します。デフォルト値は `false` です。

	`enabled:Boolean` (default = `true`) — コンテキストメニューのメニューアイテムが有効か無効かを指定します。デフォルト値は `true` (有効) です。このパラメータはオプションです。

	`visible:Boolean` (default = `true`) — メニューアイテムを表示するか非表示にするかを指定します。デフォルト値は `true` (表示する) です。

メソッドの詳細

clone

()

メソッド

public function clone():ContextMenuItem

指定された ContextMenuItem オブジェクトのコピーを作成して返します。コピーには、元のオブジェクトのすべてのプロパティが含まれます。

戻り値

ContextMenuItem — 元のオブジェクトのすべてのプロパティを含む ContextMenuItem オブジェクトです。

イベントの詳細

menuItemSelect

event

イベントオブジェクトの型: flash.events.ContextMenuEvent
ContextMenuEvent.type property = flash.events.ContextMenuEvent.MENU_ITEM_SELECT

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

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

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

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

Adobe^® Flex™ 2 リファレンスガイド		すべてのパッケージ \| すべてのクラス \| \| 索引 \| 付録 \| 規則 \| フレーム内に表示フレームなしバージョン
Class ContextMenuItem	プロパティ \| メソッド \| イベント