AjaxDevice (zk 7.0.3 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.zkoss.zk.device
Class AjaxDevice

java.lang.Object
  org.zkoss.zk.device.GenericDevice
      org.zkoss.zk.device.AjaxDevice

All Implemented Interfaces:: Device

public class AjaxDevice
extends GenericDevice
extends GenericDevice

Represents a Web browser with the Ajax support.

Since:: 2.4.0
Author:: tomyeh

Constructor Summary
`AjaxDevice()`

Method Summary
`java.lang.String`	`getContentType()` Returns `text/html`
`java.lang.String`	`getDocType()` Returns `<!`
`boolean`	`isCacheable()` Return false to indicate it is not cacheable.
`java.lang.Boolean`	`isCompatible(java.lang.String userAgent)` Returns null to indicate unknown.
`java.lang.String`	`packageToPath(java.lang.String pkg)` Converts a package to a path that can be accessible by the class loader (classpath).
`void`	`reloadMessages(java.util.Locale locale)` Reloads the client-side messages in the specified locale.
`java.lang.String`	`toAbsolutePath(java.lang.String path)` Converts a relative path to an absolute path that can be accessible by the class loader (classpath).

Methods inherited from class org.zkoss.zk.device.GenericDevice
`addEmbedded, getEmbedded, getServerPushClass, getType, getUnavailableMessage, init, isSupported, matches, sessionDidActivate, sessionWillPassivate, setServerPushClass, setUnavailableMessage`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

AjaxDevice

public AjaxDevice()

Method Detail

isCacheable

public boolean isCacheable()

Return false to indicate it is not cacheable.

Specified by:: isCacheable in interface Device
Overrides:: isCacheable in class GenericDevice

isCompatible

public java.lang.Boolean isCompatible(java.lang.String userAgent)

Description copied from class: GenericDevice

Returns null to indicate unknown. Deriving should override it to provide more precise information.

Specified by:: isCompatible in interface Device
Overrides:: isCompatible in class GenericDevice

Parameters:: userAgent - represents a client. For HTTP clients, It is the user-agent header.
Returns:: Boolean.TRUE if this device supports the specified client, Boolean.FALSE if cannot, or null if unknown.
See Also:: Execution.getUserAgent(), Devices.getDeviceByClient(java.lang.String)

getContentType

public java.lang.String getContentType()

Returns text/html

getDocType

public java.lang.String getDocType()

Returns <!DOCTYPE html>. (since 7.0.0)

Specified by:: getDocType in interface Device
Overrides:: getDocType in class GenericDevice

packageToPath

public java.lang.String packageToPath(java.lang.String pkg)

Converts a package to a path that can be accessible by the class loader (classpath).

Default: "/js/" + pkg + ".wpd";

Specified by:: packageToPath in interface Device
Overrides:: packageToPath in class GenericDevice

Since:: 5.0.4

toAbsolutePath

public java.lang.String toAbsolutePath(java.lang.String path)

Converts a relative path to an absolute path that can be accessible by the class loader (classpath).

Default: "/js/" + path (if path doesn't start with '/' or '~').

Specified by:: toAbsolutePath in interface Device
Overrides:: toAbsolutePath in class GenericDevice

Parameters:: path - the path (never null). It is assumed to be a relative path if not starting with '/' or '~'.
Since:: 5.0.4

reloadMessages

public void reloadMessages(java.util.Locale locale)
                    throws java.io.IOException