Class Index | File Index

Classes


Class zwt.event.PartEventManager


Extends zwt.event.EventManager.

A part event manager is used by a part to process part 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: PartEventManager.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
zwt.event.PartEventManager(zwt_ui_Part_part)
Construct a part event manager and attach it to the specified part controller.
Method Summary
Method Attributes Method Name and Description
 
addAttachedHandler(function_handler)
Add a part attached handler.
 
addDetachedHandler(function_handler)
Add a part detached handler.
 
addRedrawHandler(function_handler)
Add a part redraw handler.
 
onEvent(zwt_control_PartControllerEvent_event, zwt_ui_Part_overridePart, object_arg)
Dispatch the specified part controller event to the appropriate handlers.
 
removeAttachedHandler(function_handler)
Remove a part attached handler.
 
removeDetachedHandler(function_handler)
Remove a part detached handler.
 
removeRedrawHandler(function_handler)
Remove a part redraw handler.
Methods borrowed from class zwt.event.EventManager:
addHandler, addHandlers, removeHandler, removeHandlers
Class Detail
zwt.event.PartEventManager(zwt_ui_Part_part)
Construct a part event manager and attach it to the specified part controller.
Author: Jeremy KUHN.
Parameters:
{zwt.ui.Part} zwt_ui_Part_part
The part to monitor
See:
zwt.event.PartEvent
Method Detail
addAttachedHandler(function_handler)
Add a part attached handler.
Parameters:
{Function} function_handler
The handler to add

addDetachedHandler(function_handler)
Add a part detached handler.
Parameters:
{Function} function_handler
The handler to add

addRedrawHandler(function_handler)
Add a part redraw handler.
Parameters:
{Function} function_handler
The handler to add

onEvent(zwt_control_PartControllerEvent_event, zwt_ui_Part_overridePart, object_arg)
Dispatch the specified part controller event to the appropriate handlers.
Parameters:
{zwt.event.PartEvent} zwt_control_PartControllerEvent_event
The event to dispatch
{zwt.ui.Part} zwt_ui_Part_overridePart
If set it overrides the part object passed to the handlers which is the part managed by the event manager by default
{zwt.Object} object_arg
An optional object to pass to the handler method

removeAttachedHandler(function_handler)
Remove a part attached handler.
Parameters:
{Function} function_handler
The handler to remove

removeDetachedHandler(function_handler)
Remove a part detached handler.
Parameters:
{Function} function_handler
The handler to remove

removeRedrawHandler(function_handler)
Remove a part redraw handler.
Parameters:
{Function} function_handler
The handler to remove

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