Packageorg.libspark.utils
Classpublic class EventUtil

イベント系のユーティリティクラスです



Public Properties
 PropertyDefined by
  priority : int = 0
[static] EventUtil クラスのクラスメソッドを使用した場合の priority のデフォルト値になります.
EventUtil
  useCapture : Boolean = false
[static] EventUtil クラスのクラスメソッドを使用した場合の useCapture のデフォルト値になります.
EventUtil
  useWeakReference : Boolean = false
[static] EventUtil クラスのクラスメソッドを使用した場合の useWeakReference のデフォルト値になります.
EventUtil
Public Methods
 MethodDefined by
  
addCustomArgumentsEventListener(target:EventDispatcher, type:String, listener:Function, args:Array = null, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
[static] 任意の引数を設定したイベントリスナーを登録します。
EventUtil
  
addDelayEventListener(target:EventDispatcher, type:String, listener:Function, delay:uint = 0, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
[static] 指定時間の経過後にイベントリスナーが実行されます。 登録したイベントリスナーはイベントの通知を受けるたびに遅延実行します。
EventUtil
  
addNextFrameEventListener(target:EventDispatcher, type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
[static] タイムラインが次のフレームに移った時にイベントリスナーが実行されます。
EventUtil
  
addOneTimeEventListener(target:EventDispatcher, type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
[static] 1度だけ登録したイベントリスナーが実行されます。実行後は登録は解除されます。
EventUtil
  
addOnStageEventListener(eventTarget:EventDispatcher, type:String, listener:Function, displayTarget:DisplayObject, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
[static] DisplayObject オブジェクトがステージ上に配置されている時だけイベントリスナーが登録されます.
EventUtil
Property detail
priorityproperty
public static var priority:int = 0

EventUtil クラスのクラスメソッドを使用した場合の priority のデフォルト値になります. イベントリスナーの優先度レベルです。

useCaptureproperty 
public static var useCapture:Boolean = false

EventUtil クラスのクラスメソッドを使用した場合の useCapture のデフォルト値になります. リスナーが、キャプチャ段階、またはターゲットおよびバブリング段階で動作するかどうかを判断します。

useWeakReferenceproperty 
public static var useWeakReference:Boolean = false

EventUtil クラスのクラスメソッドを使用した場合の useWeakReference のデフォルト値になります. リスナーへの参照が強参照と弱参照のいずれであるかを判断します。

Method detail
addCustomArgumentsEventListener()method
public static function addCustomArgumentsEventListener(target:EventDispatcher, type:String, listener:Function, args:Array = null, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

任意の引数を設定したイベントリスナーを登録します。

Parameters
target:EventDispatcher — イベントリスナーオブジェクトを登録する EventDispatcher オブジェクトです。
 
type:String — イベントのタイプです。
 
listener:Function — イベントを処理するリスナー関数です。
 
args:Array (default = null) — 引数を指定した配列
 
useCapture:Boolean (default = false) — リスナーが、キャプチャ段階、またはターゲットおよびバブリング段階で動作するかどうかを判断します。
 
priority:int (default = 0) — イベントリスナーの優先度レベルです。
 
useWeakReference:Boolean (default = false) — リスナーへの参照が強参照と弱参照のいずれであるかを判断します。
addDelayEventListener()method 
public static function addDelayEventListener(target:EventDispatcher, type:String, listener:Function, delay:uint = 0, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

指定時間の経過後にイベントリスナーが実行されます。 登録したイベントリスナーはイベントの通知を受けるたびに遅延実行します。

Parameters
target:EventDispatcher — イベントリスナーオブジェクトを登録する EventDispatcher オブジェクトです。
 
type:String — イベントのタイプです。
 
listener:Function — イベントを処理するリスナー関数です。
 
delay:uint (default = 0) — 待機時間(ミリ秒単位)
 
useCapture:Boolean (default = false) — リスナーが、キャプチャ段階、またはターゲットおよびバブリング段階で動作するかどうかを判断します。
 
priority:int (default = 0) — イベントリスナーの優先度レベルです。
 
useWeakReference:Boolean (default = false) — リスナーへの参照が強参照と弱参照のいずれであるかを判断します。
addNextFrameEventListener()method 
public static function addNextFrameEventListener(target:EventDispatcher, type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

タイムラインが次のフレームに移った時にイベントリスナーが実行されます。

Parameters
target:EventDispatcher — イベントリスナーオブジェクトを登録する EventDispatcher オブジェクトです。
 
type:String — イベントのタイプです。
 
listener:Function — イベントを処理するリスナー関数です。
 
useCapture:Boolean (default = false) — リスナーが、キャプチャ段階、またはターゲットおよびバブリング段階で動作するかどうかを判断します。
 
priority:int (default = 0) — イベントリスナーの優先度レベルです。
 
useWeakReference:Boolean (default = false) — リスナーへの参照が強参照と弱参照のいずれであるかを判断します。
addOneTimeEventListener()method 
public static function addOneTimeEventListener(target:EventDispatcher, type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

1度だけ登録したイベントリスナーが実行されます。実行後は登録は解除されます。

Parameters
target:EventDispatcher — イベントリスナーオブジェクトを登録する EventDispatcher オブジェクトです。
 
type:String — イベントのタイプです。
 
listener:Function — イベントを処理するリスナー関数です。
 
useCapture:Boolean (default = false) — リスナーが、キャプチャ段階、またはターゲットおよびバブリング段階で動作するかどうかを判断します。
 
priority:int (default = 0) — イベントリスナーの優先度レベルです。
 
useWeakReference:Boolean (default = false) — リスナーへの参照が強参照と弱参照のいずれであるかを判断します。
addOnStageEventListener()method 
public static function addOnStageEventListener(eventTarget:EventDispatcher, type:String, listener:Function, displayTarget:DisplayObject, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

DisplayObject オブジェクトがステージ上に配置されている時だけイベントリスナーが登録されます. 指定の DisplayObject オブジェクトがステージ上から削除されると、イベントリスナーは解除されますが、再度ステージ上に配置されたときは再設定されます。

Parameters
eventTarget:EventDispatcher — イベントリスナーオブジェクトを登録する EventDispatcher オブジェクトです。
 
type:String — イベントのタイプです。
 
listener:Function — イベントを処理するリスナー関数です。
 
displayTarget:DisplayObject — イベントの登録・解除のタイミングを決定する DisplayObject インスタンス。
 
useCapture:Boolean (default = false) — リスナーが、キャプチャ段階、またはターゲットおよびバブリング段階で動作するかどうかを判断します。
 
priority:int (default = 0) — イベントリスナーの優先度レベルです。
 
useWeakReference:Boolean (default = false) — リスナーへの参照が強参照と弱参照のいずれであるかを判断します。