org.zkoss.zk.au
Class AuResponse

java.lang.Object
  org.zkoss.zk.au.AuResponse

Direct Known Subclasses:

AuAlert, AuAppendChild, AuBookmark, AuClientInfo, AuCloseErrorBox, AuConfirmClose, AuDownload, AuEcho, AuFocus, AuInsertAfter, AuInsertBefore, AuInvoke, AuMoveBy, AuMoveTo, AuObsolete, AuPrint, AuRemove, AuRemoveAttribute, AuReplace, AuResizeBy, AuResizeTo, AuScript, AuScrollBy, AuScrollTo, AuSendRedirect, AuSetAttribute, AuSetTitle, AuSubmitForm, AuWrongValue

public class AuResponse
extends java.lang.Object

A response sent from the server to the client via UiEngine.

Application developers rarely need access this class and its derived directly. Rather, use Clients instead. If you prefer to use the derives directly, you can use them with Execution.addAuResponse(java.lang.String, org.zkoss.zk.au.AuResponse).

Author:

tomyeh

Constructor Summary

protected	AuResponse(java.lang.String cmd) Constructs a component-independent response.
protected	AuResponse(java.lang.String cmd, Component depends, java.lang.String data) Constructs a response with one or zero data.
protected	AuResponse(java.lang.String cmd, Component depends, java.lang.String[] data) Constructs a response with multiple data.
protected	AuResponse(java.lang.String cmd, Page depends, java.lang.String data) Constructs a response with multiple data.
protected	AuResponse(java.lang.String cmd, Page depends, java.lang.String[] data) Constructs a response with multiple data.
protected	AuResponse(java.lang.String cmd, java.lang.String data) Constructs a component-independent response.
protected	AuResponse(java.lang.String cmd, java.lang.String[] data) Constructs a component-independent response.

Method Summary

boolean	equals(java.lang.Object o)
java.lang.String	getCommand() Returns the command of this response (never null).
java.lang.String[]	getData() Returns the associated data of this response (might be null).
java.lang.Object	getDepends() Returns the component or page that this response depends on.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AuResponse

protected AuResponse(java.lang.String cmd)

Constructs a component-independent response.

AuResponse

protected AuResponse(java.lang.String cmd,
                     java.lang.String data)

Constructs a component-independent response.

AuResponse

protected AuResponse(java.lang.String cmd,
                     java.lang.String[] data)

Constructs a component-independent response.

AuResponse

protected AuResponse(java.lang.String cmd,
                     Component depends,
                     java.lang.String data)

Constructs a response with one or zero data.

Parameters:

depends - specifies whether this response depends on whether the depends component. If depends is not null, this response shall be purged if the depends component is removed. If null, this response is called component-independent, and always sent to the client.

Note: info of the depends component doesn't send to the client. It is used only to optimize what responses to send.

data - specifies the data to be sent. If null, no data at all.

AuResponse

protected AuResponse(java.lang.String cmd,
                     Component depends,
                     java.lang.String[] data)

Constructs a response with multiple data.

AuResponse

protected AuResponse(java.lang.String cmd,
                     Page depends,
                     java.lang.String data)

Constructs a response with multiple data.

AuResponse

protected AuResponse(java.lang.String cmd,
                     Page depends,
                     java.lang.String[] data)

Constructs a response with multiple data.

Method Detail

getCommand

public final java.lang.String getCommand()

Returns the command of this response (never null).

getData

public final java.lang.String[] getData()

Returns the associated data of this response (might be null).

getDepends

public final java.lang.Object getDepends()

Returns the component or page that this response depends on. If it is not null and the depends component/page is removed, this response shall be removed, too.

Note: the returned object is either a Component or a Page.

equals

public final boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object