|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.zkoss.zk.au.AuResponse
public class AuResponse
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)
.
Field Summary | |
---|---|
protected java.lang.String |
_cmd
|
protected java.lang.Object[] |
_data
Either String or DeferredValue. |
Constructor Summary | |
---|---|
AuResponse(java.lang.String cmd)
Constructs a component-independent response. |
|
AuResponse(java.lang.String cmd,
Component depends,
java.lang.Object data)
Constructs a response with one or zero data. |
|
AuResponse(java.lang.String cmd,
Component depends,
java.lang.Object[] data)
Constructs a response with multiple data. |
|
AuResponse(java.lang.String cmd,
java.lang.Object data)
Constructs a component-independent response. |
|
AuResponse(java.lang.String cmd,
java.lang.Object[] data)
Constructs a component-independent response. |
|
AuResponse(java.lang.String cmd,
Page depends,
java.lang.Object data)
Constructs a response with single data. |
|
AuResponse(java.lang.String cmd,
Page depends,
java.lang.Object[] data)
Constructs a response with multiple data. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object o)
|
java.lang.String |
getCommand()
Returns the command of this response (never null). |
java.lang.Object |
getDepends()
Returns the component or page that this response depends on. |
java.util.List |
getEncodedData()
Returns the evaluated result of the associated data of this response (might be null). |
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 |
---|
protected java.lang.String _cmd
protected java.lang.Object[] _data
Constructor Detail |
---|
public AuResponse(java.lang.String cmd)
public AuResponse(java.lang.String cmd, java.lang.Object data)
data
- the data. It can be null, String, Date,
and any kind of objects that
the client accepts (marshaled by JSON).public AuResponse(java.lang.String cmd, java.lang.Object[] data)
public AuResponse(java.lang.String cmd, Component depends, java.lang.Object data)
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.public AuResponse(java.lang.String cmd, Component depends, java.lang.Object[] data)
public AuResponse(java.lang.String cmd, Page depends, java.lang.Object data)
public AuResponse(java.lang.String cmd, Page depends, java.lang.Object[] data)
data
- an array of data (null to ignore).
Each element must be an instance of String, DeferredValue
or null.
java.lang.IllegalArgumentException
- if an element of data
is neither String nor DeferredValue.Method Detail |
---|
public java.lang.String getCommand()
public java.util.List getEncodedData()
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 copy, so any modification to it won't affect the data of this response.
getRawData()
public java.lang.Object[] getRawData()
Note: it is a readonly array. Don't change its value.
getEncodedData()
public final java.lang.Object getDepends()
Note: the returned object is either a Component
or a
Page
.
public final boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |