org.zkoss.zkmax.ui.eq
Class EventQueues

java.lang.Object
  org.zkoss.zkmax.ui.eq.EventQueues

public class EventQueues
extends java.lang.Object

Utilities to access the event queue.

Since:

3.5.0

Author:

tomyeh

Constructor Summary

EventQueues()

Method Summary

static EventQueue	lookup(java.lang.String name) Returns the event queue with the specified name in the current desktop, or if no such event queue, create one.
static EventQueue	lookup(java.lang.String name, boolean autoCreate) Returns the event queue with the specified name in the current desktop.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventQueues

public EventQueues()

Method Detail

lookup

public static final EventQueue lookup(java.lang.String name,
                                      boolean autoCreate)

Returns the event queue with the specified name in the current desktop.

Note:

• This method can be called only in an activated execution, i.e., Executions.getCurrent() not null.
• The event queue is associated with the desktop the current execution.
• The event queue is gone if the desktop is removed.

Parameters:

name - the queue name.

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

lookup

public static final EventQueue lookup(java.lang.String name)

Returns the event queue with the specified name in the current desktop, or if no such event queue, create one. It is a shortcut of lookup(name, true).