org.zkoss.zk.au.out

Class AuShowBusy

java.lang.Object

org.zkoss.zk.au.AuResponse

org.zkoss.zk.au.out.AuShowBusy

public class AuShowBusy
extends AuResponse

A response to ask the client to show the busy message such that the user knows the system is busy.

Since:

3.0.2

Author:

jumperchen

See Also:

AuClearBusy

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zk.au.AuResponse

AuResponse.JSONComponent, AuResponse.JSONDate

Field Summary

Fields inherited from class org.zkoss.zk.au.AuResponse

_cmd, _data, SC_ACTIVATION_TIMEOUT, SC_OUT_OF_SEQUENCE

Constructor Summary

Constructors

Constructor and Description
AuShowBusy(Component comp, java.lang.String mesg) Constructs a busy message covering only the specified component.
AuShowBusy(java.lang.String mesg) Constructs a busy message covering the whole browser.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getOverrideKey() Default: zk.busy (i.e., only one response of this class and AuClearBusy will be sent to the client in an execution for the same component, if any)

Methods inherited from class org.zkoss.zk.au.AuResponse

equals, getCommand, getDepends, getEncodedData, getRawData, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AuShowBusy

public AuShowBusy(java.lang.String mesg)

Constructs a busy message covering the whole browser. To close, use AuClearBusy().

Parameters:

mesg - the message to show. Ignored if open is false.

Since:

5.0.0

AuShowBusy

public AuShowBusy(Component comp,
                  java.lang.String mesg)

Constructs a busy message covering only the specified component. To close, use AuClearBusy(Component).

Parameters:

comp - the component that the busy message to cover.

mesg - the message to show.

Since:

5.0.0

Method Detail

getOverrideKey

public final java.lang.String getOverrideKey()

Default: zk.busy (i.e., only one response of this class and AuClearBusy will be sent to the client in an execution for the same component, if any)

Overrides:

getOverrideKey in class AuResponse

Since:

5.0.2