|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Device
Represents a client device.
For example, the HTML browsers with Ajax are called AjaxDevice
,
the XML output called org.zkoss.zml.device.XmlDevice,
and the MIL device called org.zkoss.mil.device.MilDevice.
Note: the same device is shared by all desktops of the same device type.
Field Summary | |
---|---|
static int |
RESEND
Used with isSupported(int) to know whether the device supports
the resend mechanism. |
Method Summary | |
---|---|
void |
addEmbedded(java.lang.String content)
Adds the content that shall be added to the output generated and sent to the client, when rending a desktop. |
java.lang.String |
getContentType()
Returns the default content type (never null). |
java.lang.String |
getDocType()
Returns the default doc type, or null if no doc type at all. |
java.lang.String |
getEmbedded()
Returns the content that shall be embedded to the output being generated to the client, or null if no embedded content. |
java.lang.Class |
getServerPushClass()
Returns the class that implements the server-push feature ( ServerPush ) for this device, or null if the default is used. |
java.lang.String |
getTimeoutURI()
Deprecated. As of release 3.6.3, use Configuration.getTimeoutURI(java.lang.String)
instead. |
java.lang.String |
getType()
Returns the device type. |
java.lang.String |
getUnavailableMessage()
Returns the unavailable message that is shown to the client if the client doesn't support this device. |
void |
init(java.lang.String deviceType,
DeviceConfig config)
Initializes the device. |
boolean |
isCacheable()
Returns whether the output can be cached by the client. |
boolean |
isClient(java.lang.String userAgent,
java.lang.String type)
Tests if a client is the givent type. |
java.lang.Boolean |
isCompatible(java.lang.String userAgent)
Returns whether this device supports the specified client. |
boolean |
isSupported(int func)
Returns whether the specified function is supported. |
void |
sessionDidActivate(Desktop desktop)
Notification that the desktop, which owns this device, has just been activated (aka., deserialized) by the Web container. |
void |
sessionWillPassivate(Desktop desktop)
Notification that the desktop, which owns this device, is about to be passivated (aka., serialized) by the Web container. |
java.lang.Class |
setServerPushClass(java.lang.Class cls)
Sets the class that implements the server-push feature ( ServerPush ) for this device, or null to use the default. |
java.lang.String |
setTimeoutURI(java.lang.String timeoutURI)
Deprecated. As of release 3.6.3, use Configuration.setTimeoutURI(java.lang.String, java.lang.String, int)
instead. |
java.lang.String |
setUnavailableMessage(java.lang.String unavailmsg)
Sets the unavailable message that is shown to the client if the client doesn't support this device. |
Field Detail |
---|
static final int RESEND
isSupported(int)
to know whether the device supports
the resend mechanism.
In other words, whether the client will resend the request if
the time specified in Configuration.getResendDelay()
expires.
Method Detail |
---|
boolean isSupported(int func)
func
- the function. It can be one of RESEND
.java.lang.String getType()
boolean isCacheable()
java.lang.String getUnavailableMessage()
java.lang.String setUnavailableMessage(java.lang.String unavailmsg)
unavailmsg
- the unavailable message.
java.lang.String getTimeoutURI()
Configuration.getTimeoutURI(java.lang.String)
instead.
java.lang.String setTimeoutURI(java.lang.String timeoutURI)
Configuration.setTimeoutURI(java.lang.String, java.lang.String, int)
instead.
java.lang.Boolean isCompatible(java.lang.String userAgent)
userAgent
- represents a client.
For HTTP clients, It is the user-agent header.
Execution.getUserAgent()
,
Devices.getDeviceByClient(java.lang.String)
java.lang.Class getServerPushClass()
ServerPush
) for this device, or null if the default is used.
java.lang.Class setServerPushClass(java.lang.Class cls)
ServerPush
) for this device, or null to use the default.
Default: PollingServerPush
.
If ZK EE (with zkmax.jar) is loaded,
the COMET-based server push (CometServerPush
)
is the default.
java.lang.String getContentType()
java.lang.String getDocType()
void addEmbedded(java.lang.String content)
As the method name suggests, the embedded contents are accumulated and all generated to the output.
java.lang.String getEmbedded()
void init(java.lang.String deviceType, DeviceConfig config)
deviceType
- the device type (never null)config
- the configuration to initialize the device (never null)void sessionWillPassivate(Desktop desktop)
void sessionDidActivate(Desktop desktop)
boolean isClient(java.lang.String userAgent, java.lang.String type)
userAgent
- represents a client.type
- the type of the browser.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |