パッケージmx.states
public class SetEventHandler
継承SetEventHandler Inheritance EventDispatcher Inheritance Object
実装IOverride

SetEventHandler クラスは、特定のビューステートでのみアクティブになるイベントハンドラを指定します。たとえば、基本ビューステートではあるイベントハンドラを使用し、ビューステートを変更するときには別のイベントハンドラを使用する Button コントロールを定義できます。

このクラスは、State クラスの overrides プロパティで使用します。

MXML シンタックスexpandedMXML シンタックスの非表示

<mx:SetEventHanlder> タグには、以下の属性があります。

 <mx:SetEventHandler プロパティ name="null" handlerFunction="null" target="null"
  
Events handler=デフォルト値なし /> 

関連項目

mx.states.State
mx.states.SetProperty
mx.states.SetStyle


パブリックプロパティ
 プロパティ定義
 Inheritedconstructor : Object
特定のオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
  handlerFunction : Function
イベントのハンドラ関数です。
SetEventHandler
  name : String
ハンドラを設定する対象となるイベントの名前です。
SetEventHandler
 Inheritedprototype : Object
[static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
  target : EventDispatcher
イベントを送出するコンポーネントです。
SetEventHandler
パブリックメソッド
 メソッド定義
  SetEventHandler(target:EventDispatcher = null, name:String = null)
コンストラクタ。
SetEventHandler
 InheritedaddEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。
EventDispatcher
  apply(parent:UIComponent):void
オーバーライドを適用します。
SetEventHandler
 InheriteddispatchEvent(event:Event):Boolean
イベントをイベントフローに送出します。
EventDispatcher
 InheritedhasEventListener(type:String):Boolean
EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。
EventDispatcher
 InheritedhasOwnProperty(name:String):Boolean
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
  initialize():void
IOverride インターフェイスのメソッド。このクラスは、このインターフェイスのメソッドを空のメソッドとして実装します。
SetEventHandler
 InheritedisPrototypeOf(theClass:Object):Boolean
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 InheritedpropertyIsEnumerable(name:String):Boolean
指定されたプロパティが存在し、列挙可能かどうかを示します。
Object
  remove(parent:UIComponent):void
オーバーライドを削除します。
SetEventHandler
 InheritedremoveEventListener(type:String, listener:Function, useCapture:Boolean = false):void
EventDispatcher オブジェクトからリスナーを削除します。
EventDispatcher
 InheritedsetPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 InheritedtoString():String
指定されたオブジェクトのストリング表現を返します。
Object
 InheritedvalueOf():Object
指定されたオブジェクトのプリミティブ値を返します。
Object
 InheritedwillTrigger(type:String):Boolean
指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。
EventDispatcher
イベント
 イベント一覧定義
  handler name プロパティで指定されたイベントに応じて実行するイベントハンドラ関数です。SetEventHandler
プロパティの詳細
handlerFunctionプロパティ
public var handlerFunction:Function

イベントのハンドラ関数です。このプロパティは、ActionScript を使用してビューステートを作成し、それにアクセスする開発者を対象としています。MXML では、同等の handler イベント属性も使用できますが、単一の MXML タグに両方の属性を使用しないでください。

デフォルト値null.

nameプロパティ 
public var name:String

ハンドラを設定する対象となるイベントの名前です。SetEventHandler コンストラクタでこのプロパティを設定するか、プロパティ値を直接設定する必要があります。

targetプロパティ 
public var target:EventDispatcher

イベントを送出するコンポーネントです。プロパティ値が null の場合、Flex では <mx:states> タグの直接の親が使用されます。

デフォルト値null.

コンストラクタの詳細
SetEventHandler()コンストラクタ
public 関数 SetEventHandler(target:EventDispatcher = null, name:String = null)

コンストラクタ。

パラメータ
target:EventDispatcher (default = null) — 処理対象のイベントを送出するオブジェクトです。デフォルトでは、Flex は State オブジェクトの直接の親を使用します。
 
name:String (default = null) — ハンドラを設定するイベントタイプです。
メソッドの詳細
apply()メソッド
public function apply(parent:UIComponent):void

オーバーライドを適用します。Flex では元の値が保持されるため、後で remove() メソッドに元の値を復元できます。

そのビューステートに移行すると、自動的にこのメソッドが呼び出されます。このメソッドは直接呼び出さないでください。

パラメータ
parent:UIComponent — このオーバーライドを含む状態オブジェクトの親です。ターゲットが明示的に指定されていない場合、オーバーライドのターゲットとして使用されます。
initialize()メソッド 
public function initialize():void

IOverride インターフェイスのメソッド。このクラスは、このインターフェイスのメソッドを空のメソッドとして実装します。

オーバーライドを初期化します。Flex では apply() メソッドを最初に呼び出す前にこのメソッドを呼び出すため、このメソッドのオーバーライドには、1 回だけ実行する初期化コードを配置します。

そのビューステートに移行すると、Flex が自動的にこのメソッドを呼び出します。このメソッドは直接呼び出さないでください。

remove()メソッド 
public function remove(parent:UIComponent):void

オーバーライドを削除します。apply() メソッドに記憶されている値が復元されます。

そのビューステートに移行すると、自動的にこのメソッドが呼び出されます。このメソッドは直接呼び出さないでください。

パラメータ
parent:UIComponent — このオーバーライドを含む状態オブジェクトの親です。ターゲットが明示的に指定されていない場合、オーバーライドのターゲットとして使用されます。
イベントの詳細
handlerevent 
イベントオブジェクトの型: Object

name プロパティで指定されたイベントに応じて実行するイベントハンドラ関数です。

単一の <mx:SetEventHandler> タグに handler プロパティと handlerFunction プロパティの両方を指定しないでください。

そのようにすると、Flex は handler イベントを送出しません。MXML 属性には handler キーワードのみを使用します。handler ハンドラ属性を使用すると、Event オブジェクトだけではなく、複数のパラメータを使用するメソッドを指定できます。また、MXML タグにイベントハンドラのコードをインラインで指定できます。