Package org.zkoss.zkmax.ui.event.impl

Class EventQueueProviderImpl

java.lang.Object

org.zkoss.zk.ui.event.impl.EventQueueProviderImpl

org.zkoss.zkmax.ui.event.impl.EventQueueProviderImpl

All Implemented Interfaces:

EventQueueProvider

public class EventQueueProviderImpl
extends EventQueueProviderImpl

Enhance the default implementation to support EventQueues.GROUP.

Since:

5.0.4

Author:

tomyeh

Field Summary

Fields inherited from class org.zkoss.zk.ui.event.impl.EventQueueProviderImpl

ATTR_EVENT_QUEUES

Constructor Summary

Constructors

Constructor	Description
EventQueueProviderImpl()

Method Summary

Modifier and Type	Method	Description
<T extends Event> EventQueue<T>	lookup(java.lang.String name, java.lang.String scope, boolean autoCreate)	Returns the event queue with the specified name in the specified scope.
boolean	remove(java.lang.String name, java.lang.String scope)	Removes the event queue.

Methods inherited from class org.zkoss.zk.ui.event.impl.EventQueueProviderImpl

lookup, lookup, remove, remove

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EventQueueProviderImpl

public EventQueueProviderImpl()

Method Detail

lookup

public <T extends Event> EventQueue<T> lookup(java.lang.String name,
                                              java.lang.String scope,
                                              boolean autoCreate)

Description copied from interface: EventQueueProvider

Returns the event queue with the specified name in the specified scope.

Note:

• This method can be called only in an activated execution, i.e., Executions.getCurrent() not null.
• By default, EventQueueProviderImpl is used. To customize it, refer to EventQueues.

Specified by:

lookup in interface EventQueueProvider

Overrides:

lookup in class EventQueueProviderImpl

Parameters:

name - the name of the event queue.

scope - the scope of the event queue. It must support EventQueues.DESKTOP and EventQueues.APPLICATION. Developers might extend it to support other types of event queues.

autoCreate - whether to create the event queue if not found.

Returns:

the event queue with the associated name, or null if not found and autoCreate is false

remove

public boolean remove(java.lang.String name,
                      java.lang.String scope)

Description copied from interface: EventQueueProvider

Removes the event queue.

Specified by:

remove in interface EventQueueProvider

Overrides:

remove in class EventQueueProviderImpl

Parameters:

name - the name of the event queue.

scope - the scope of the event queue. It must support EventQueues.DESKTOP and EventQueues.APPLICATION. Developers might extend it to support other types of event queues.

Returns:

true if it is removed successfully