Class zwt.ui.stack.StackEventManager

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

Class Summary
Constructor Attributes	Constructor Name and Description
	zwt.ui.stack.StackEventManager(zwt_ui_stack_StackPanel_panel) Construct a stack event manager and attach it to the specified stack panel.

Method Summary
Method Attributes	Method Name and Description
	addStackDeselectedHandler(function_handler) Add a stack deselected handler.
	addStackInsertedHandler(function_handler) Add a stack inserted handler.
	addStackRemovedHandler(function_handler) Add a stack removed handler.
	addStackSelectedHandler(function_handler) Add a stack selected handler.
	onEvent(zwt_ui_stack_StackEvent_event, zwt_ui_stack_StackPanel_overridePanel, object_arg) Dispatch the specified stack event to the appropriate handlers.
	registerItem(zwt_ui_stack_StackItem_item) Register the specified stack item into the event manager.
	removeStackDeselectedHandler(function_handler) Remove a stack deselected handler.
	removeStackInsertedHandler(function_handler) Remove a stack inserted handler.
	removeStackRemovedHandler(function_handler) Remove a stack removed handler.
	removeStackSelectedHandler(function_handler) Remove a stack selected handler.
	unregisterItem(zwt_ui_stack_StackItem_item) Unregister the specified stack item from the event manager.

Methods borrowed from class zwt.event.UIEventManager:: finalizeEventHandling, registerElement
Methods borrowed from class zwt.event.EventManager:: addHandler, addHandlers, removeHandler, removeHandlers

Class Detail

zwt.ui.stack.StackEventManager(zwt_ui_stack_StackPanel_panel)

Construct a stack event manager and attach it to the specified stack panel.
Author: Jeremy KUHN.

Parameters:
{zwt.ui.stack.StackPanel} zwt_ui_stack_StackPanel_panel: The stack panel to monitor

See:: zwt.ui.stack.StackEvent; zwt.ui.stack.StackPanel

Method Detail

addStackDeselectedHandler(function_handler)

Add a stack deselected handler.

Parameters:
{Function} function_handler: The handler to add

addStackInsertedHandler(function_handler)

Add a stack inserted handler.

Parameters:
{Function} function_handler: The handler to add

addStackRemovedHandler(function_handler)

Add a stack removed handler.

Parameters:
{Function} function_handler: The handler to add

addStackSelectedHandler(function_handler)

Add a stack selected handler.

Parameters:
{Function} function_handler: The handler to add

onEvent(zwt_ui_stack_StackEvent_event, zwt_ui_stack_StackPanel_overridePanel, object_arg)

Dispatch the specified stack event to the appropriate handlers.

Parameters:
{zwt.ui.stack.StackEvent} zwt_ui_stack_StackEvent_event: The event to dispatch
{zwt.ui.stack.StackPanel} zwt_ui_stack_StackPanel_overridePanel: If set it overrides the stack panel object passed to the handlers which is the stack panel managed by the event manager by default
{zwt.Object} object_arg: An optional object to pass to the handler method

registerItem(zwt_ui_stack_StackItem_item)

Register the specified stack item into the event manager. This method is basically called when a stack item is added to the stack panel.

The event manager will catch the UI event emitted by the item and dispatch them to the handlers.

Parameters:
{zwt.ui.stack.StackItem} zwt_ui_stack_StackItem_item: The item to register.

removeStackDeselectedHandler(function_handler)

Remove a stack deselected handler.

Parameters:
{Function} function_handler: The handler to remove

removeStackInsertedHandler(function_handler)

Remove a stack inserted handler.

Parameters:
{Function} function_handler: The handler to remove

removeStackRemovedHandler(function_handler)

Remove a stack removed handler.

Parameters:
{Function} function_handler: The handler to remove

removeStackSelectedHandler(function_handler)

Remove a stack selected handler.

Parameters:
{Function} function_handler: The handler to remove

unregisterItem(zwt_ui_stack_StackItem_item)

Unregister the specified stack item from the event manager. This method is basically called when a stack item is removed from the stack panel.

Parameters:
{zwt.ui.stack.StackItem} zwt_ui_stack_StackItem_item: The item to unregister.

Classes

Class zwt.ui.stack.StackEventManager