org.zkoss.zk.au

Class AuWriters

java.lang.Object

org.zkoss.zk.au.AuWriters

public class AuWriters
extends Object

Utilities to instantiate an implementation of AuWriter.

Since:

3.0.1

Author:

tomyeh

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_TYPE The content type of the output.

Constructor Summary

Constructors

Constructor and Description
AuWriters()

Method Summary

Methods

Modifier and Type	Method and Description
static Class	getImplementationClass() Returns the implementation class of AuWriter that will be used to generate the output to the client.
static org.zkoss.json.JSONObject	getJSONOutput(org.zkoss.json.JSONArray rs) Returns a JSON object representing the output that will be sent to the client.
static AuWriter	newInstance() Creates an instance of AuWriter.
static void	setImplementationClass(Class cls) Sets the implementation class of AuWriter that will be used to generate the output to the client.
static org.zkoss.json.JSONArray	toJSON(AuResponse response) Converts a response to a JSON object.

Methods inherited from class java.lang.Object

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

Field Detail

CONTENT_TYPE

public static final String CONTENT_TYPE

The content type of the output.

Since:

3.5.0

See Also:

Constant Field Values

Constructor Detail

AuWriters

public AuWriters()

Method Detail

getImplementationClass

public static Class getImplementationClass()

Returns the implementation class of AuWriter that will be used to generate the output to the client.

Default: HttpAuWriter.

setImplementationClass

public static void setImplementationClass(Class cls)

Sets the implementation class of AuWriter that will be used to generate the output to the client.

newInstance

public static AuWriter newInstance()
                            throws UiException

Creates an instance of AuWriter.

Throws:

UiException

getJSONOutput

public static org.zkoss.json.JSONObject getJSONOutput(org.zkoss.json.JSONArray rs)

Returns a JSON object representing the output that will be sent to the client.

You could add the responses to the given array by invoking toJSON(org.zkoss.zk.au.AuResponse).

Parameters:

rs - the array to hold the responses. To output a response, invoke toJSON(org.zkoss.zk.au.AuResponse) as follows: rs.add(AuWriters.toJSON(response)).

Since:

5.0.5

toJSON

public static org.zkoss.json.JSONArray toJSON(AuResponse response)

Converts a response to a JSON object.

Since:

5.0.5