org.zkoss.zk.ui.event.impl
Interface EventQueueProvider

All Known Implementing Classes:
EventQueueProviderImpl

public interface EventQueueProvider

Used to instantiate an event queue.

Since:
5.0.0
Author:
tomyeh

Method Summary
 EventQueue 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 qeueue.
 

Method Detail

lookup

EventQueue lookup(java.lang.String name,
                  java.lang.String scope,
                  boolean autoCreate)
Returns the event queue with the specified name in the specified scope.

Note:

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
Throws:
java.lang.IllegalStateException - if not in an activated execution
java.lang.UnsupportedOperationException - if the scope is not supported

remove

boolean remove(java.lang.String name,
               java.lang.String scope)
Removes the event qeueue.

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


Copyright © 2005-2009 Potix Corporation. All Rights Reserved. SourceForge.net Logo