Class Index | File Index

Classes


Class zwt.animation.AnimationEventManager


Extends zwt.event.EventManager.

An Animation event manager is used by an animation to process animation events and dispatch them to the appropriate handlers.

Handlers are methods previously registered on the event manager to handle a specific type of event. A typical handler method has two input parameters: the object that triggered the event and the event. An optional object argument may also be passed to the handler if it was provided when dispatching the event to the event manager (see zwt.event.EventManager#onEvent).


Defined in: AnimationEventManager.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
zwt.animation.AnimationEventManager(zwt_animation_Animation_animation)
Construct an animation event manager and attach it to the specified animation.
Method Summary
Method Attributes Method Name and Description
 
addBeginHandler(function_handler)
Add an animation begin handler.
 
addEndHandler(function_handler)
Add an animation end handler.
 
onEvent(zwt_animation_AnimationEvent_event, zwt_animation_Animation_overrideAnim, object_arg)
Dispatch the specified animation event to the appropriate handlers.
 
removeBeginHandler(function_handler)
Remove an animation begin handler.
 
removeEndHandler(function_handler)
Remove an animation end handler.
Methods borrowed from class zwt.event.EventManager:
addHandler, addHandlers, removeHandler, removeHandlers
Class Detail
zwt.animation.AnimationEventManager(zwt_animation_Animation_animation)
Construct an animation event manager and attach it to the specified animation.
Author: Jeremy KUHN.
Parameters:
{zwt.animation.Animation} zwt_animation_Animation_animation
The animation to monitor.
See:
zwt.animation.AnimationEvent
Method Detail
addBeginHandler(function_handler)
Add an animation begin handler.
Parameters:
{Function} function_handler
The handler to add

addEndHandler(function_handler)
Add an animation end handler.
Parameters:
{Function} function_handler
The handler to add

onEvent(zwt_animation_AnimationEvent_event, zwt_animation_Animation_overrideAnim, object_arg)
Dispatch the specified animation event to the appropriate handlers.
Parameters:
{zwt.animation.AnimationEvent} zwt_animation_AnimationEvent_event
The event to dispatch
{zwt.animation.Animation} zwt_animation_Animation_overrideAnim
If set it overrides the animation object passed to the handlers which is the animation managed by the event manager by default
{zwt.Object} object_arg
An optional object to pass to the handler method

removeBeginHandler(function_handler)
Remove an animation begin handler.
Parameters:
{Function} function_handler
The handler to remove

removeEndHandler(function_handler)
Remove an animation end handler.
Parameters:
{Function} function_handler
The handler to add

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Jan 12 2012 02:07:52 GMT+0100 (CET)