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, AuPopup, AuPrint, AuRemove, AuRemoveAttribute, AuReplace, AuResizeBy, AuResizeTo, AuScript, AuScrollBy, AuScrollIntoView, AuScrollTo, AuSendRedirect, AuSetAttribute, AuSetTitle, AuShowBusy, 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

Field Summary

protected java.lang.String	_cmd
protected java.lang.Object[]	_data Either String or DeferredValue.

Constructor Summary

protected	AuResponse(java.lang.String cmd) Constructs a component-independent response.
protected	AuResponse(java.lang.String cmd, Component depends, DeferredValue data) Constructs a response with one or zero deferred data.
protected	AuResponse(java.lang.String cmd, Component depends, java.lang.Object[] data) Constructs a response with multiple data.
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, DeferredValue data) Constructs a component-independent deferred response.
protected	AuResponse(java.lang.String cmd, java.lang.Object[] data) Constructs a component-independent response.
protected	AuResponse(java.lang.String cmd, Page depends, DeferredValue data) Constructs a response with single deferred data.
protected	AuResponse(java.lang.String cmd, Page depends, java.lang.Object[] data) Constructs a response with multiple data.
protected	AuResponse(java.lang.String cmd, Page depends, java.lang.String data) Constructs a response with single 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 evaluated result of 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.Object[]	getRawData() Returns the associated data of this response in the original format (might be null).
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

_cmd

protected java.lang.String _cmd

_data

protected java.lang.Object[] _data

Either String or DeferredValue.

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 single 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,
                     DeferredValue data)

Constructs a component-independent deferred response.

Since:

3.0.5

AuResponse

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

Constructs a component-independent response.

Since:

3.0.5

AuResponse

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

Constructs a response with one or zero deferred data.

Since:

3.0.5

AuResponse

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

Constructs a response with multiple data.

Parameters:

data - an array of data (null to ignore). Each element must be an instance of String, DeferredValue or null.

Throws:

java.lang.IllegalArgumentException - if an element of data is neither String nor DeferredValue.

Since:

3.0.5

AuResponse

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

Constructs a response with single deferred data.

Since:

3.0.5

AuResponse

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

Constructs a response with multiple data.

Parameters:

data - an array of data (null to ignore). Each element must be an instance of String, DeferredValue or null.

Throws:

java.lang.IllegalArgumentException - if an element of data is neither String nor DeferredValue.

Since:

3.0.5

Method Detail

getCommand

public java.lang.String getCommand()

Returns the command of this response (never null).

getData

public java.lang.String[] getData()

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

Note: when this method is called, DeferredValue will be evaluated. Thus, don't call it until the rendering phase. If you want to access it other than the render phase, use getRawData() instead.

Note: it is a readonly array. Don't change its value.

See Also:

getRawData()

getRawData

public java.lang.Object[] getRawData()

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

Note: it is a readonly array. Don't change its value.

Since:

3.0.5

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