Packagecom.threerings.util
Classpublic class EventHandlers

A class for keeping track of event listeners and freeing them all at a given time. This is useful for keeping track of your ENTER_FRAME listeners, and releasing them all on UNLOAD to make sure your game/furni/avatar fully unloads at the proper time. See {


Protected Properties
 PropertyDefined by
  _mgr : EventHandlerManager
[static]
EventHandlers
Public Methods
 MethodDefined by
  
callWhenTrue(callback:Function, callNow:Boolean, dispatcher:IEventDispatcher, event:String, useCapture:Boolean = false, priority:int = 0):void
[static] Will either call a given function now, or defer it based on the boolean parameter.
EventHandlers
  
freeAllHandlers(... ignored):void
[static] Free all handlers that have been added via this registerListener() and have not been freed already via unregisterListener()
EventHandlers
  
getGlobalManager():EventHandlerManager
[static] Returns the global manager that is accessed by all of the static members of this class.
EventHandlers
  
registerListener(dispatcher:IEventDispatcher, event:String, listener:Function, useCapture:Boolean = false, priority:int = 0):void
[static] Adds the specified listener to the specified dispatcher for the specified event.
EventHandlers
  
registerListenerUntil(triggerDispatcher:IEventDispatcher, triggerEvent:String, dispatcher:IEventDispatcher, event:String, listener:Function):void
[static] Will register a listener on a dispatcher for an event until the trigger event has been dispatched on the trigger dispatcher.
EventHandlers
  
registerOneShotCallback(dispatcher:IEventDispatcher, event:String, callback:Function, useCapture:Boolean = false, priority:int = 0):void
[static] Registers a zero-arg callback function that should be called once when the event fires.
EventHandlers
  
registerUnload(dispatcher:IEventDispatcher):void
[static] Registers the freeAllHandlers() method to be called upon Event.UNLOAD on the supplied event dispatcher.
EventHandlers
  
unregisterListener(dispatcher:IEventDispatcher, event:String, listener:Function, useCapture:Boolean = false):void
[static] Removes the specified listener from the specified dispatcher for the specified event.
EventHandlers
Property detail
_mgrproperty
protected static var _mgr:EventHandlerManager
Method detail
callWhenTrue()method
public static function callWhenTrue(callback:Function, callNow:Boolean, dispatcher:IEventDispatcher, event:String, useCapture:Boolean = false, priority:int = 0):void

Will either call a given function now, or defer it based on the boolean parameter. If the parameter is false, the function will be registered as a one-shot callback on the dispatcher

Parameters
callback:Function
 
callNow:Boolean
 
dispatcher:IEventDispatcher
 
event:String
 
useCapture:Boolean (default = false)
 
priority:int (default = 0)
freeAllHandlers()method 
public static function freeAllHandlers(... ignored):void

Free all handlers that have been added via this registerListener() and have not been freed already via unregisterListener()

Parameters
... ignored
getGlobalManager()method 
public static function getGlobalManager():EventHandlerManager

Returns the global manager that is accessed by all of the static members of this class.

Returns
EventHandlerManager
registerListener()method 
public static function registerListener(dispatcher:IEventDispatcher, event:String, listener:Function, useCapture:Boolean = false, priority:int = 0):void

Adds the specified listener to the specified dispatcher for the specified event.

Parameters
dispatcher:IEventDispatcher
 
event:String
 
listener:Function
 
useCapture:Boolean (default = false)
 
priority:int (default = 0)
registerListenerUntil()method 
public static function registerListenerUntil(triggerDispatcher:IEventDispatcher, triggerEvent:String, dispatcher:IEventDispatcher, event:String, listener:Function):void

Will register a listener on a dispatcher for an event until the trigger event has been dispatched on the trigger dispatcher. Useful for attaching listeners until an object has been REMOVED_FROM_STAGE or UNLOADed. All associated event listeners use the default useCapture and priority settings.

Parameters
triggerDispatcher:IEventDispatcher
 
triggerEvent:String
 
dispatcher:IEventDispatcher
 
event:String
 
listener:Function
registerOneShotCallback()method 
public static function registerOneShotCallback(dispatcher:IEventDispatcher, event:String, callback:Function, useCapture:Boolean = false, priority:int = 0):void

Registers a zero-arg callback function that should be called once when the event fires.

Parameters
dispatcher:IEventDispatcher
 
event:String
 
callback:Function
 
useCapture:Boolean (default = false)
 
priority:int (default = 0)
registerUnload()method 
public static function registerUnload(dispatcher:IEventDispatcher):void

Registers the freeAllHandlers() method to be called upon Event.UNLOAD on the supplied event dispatcher.

Parameters
dispatcher:IEventDispatcher
unregisterListener()method 
public static function unregisterListener(dispatcher:IEventDispatcher, event:String, listener:Function, useCapture:Boolean = false):void

Removes the specified listener from the specified dispatcher for the specified event.

Parameters
dispatcher:IEventDispatcher
 
event:String
 
listener:Function
 
useCapture:Boolean (default = false)



Copyright © 2007-2009 Three Rings Design, Inc.