org.zkoss.zk.ui.impl
Class Attributes

java.lang.Object
  org.zkoss.zk.ui.impl.Attributes

public class Attributes
extends java.lang.Object

Attributes of desktops, pages and components that are used internally.

Author:

tomyeh

Field Summary

static java.lang.String	ID_TO_UUID_PREFIX A library property to indicate that UUID shall be generated by prefixing ID with the value stored in this property.
static java.lang.String	NO_CACHE A request attribute to indicate whether "no-cache" header is generated for the current desktop.
static java.lang.String	RENEW_NATIVE_SESSION A session attribute used to denote that the invalidation of a native session (such as HttpSession and PortletSession) does not invalidate ZK session.
static java.lang.String	RESEND_DELAY A library property to indicate the default resend delay (an integer in milliseconds).
static java.lang.String	UPLOAD_PERCENT A desktop attribute to indicate the completeness percentage of the current file upload.
static java.lang.String	UPLOAD_SIZE A desktop attribute to indicate the number of bytes of the current file upload.

Constructor Summary

Attributes()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

UPLOAD_PERCENT

public static final java.lang.String UPLOAD_PERCENT

A desktop attribute to indicate the completeness percentage of the current file upload. It is an integer ranging from 0 to 99.

See Also:

Constant Field Values

UPLOAD_SIZE

public static final java.lang.String UPLOAD_SIZE

A desktop attribute to indicate the number of bytes of the current file upload. It is a non-negative long.

See Also:

Constant Field Values

NO_CACHE

public static final java.lang.String NO_CACHE

A request attribute to indicate whether "no-cache" header is generated for the current desktop. If no-cache is generated, ZK will remove a desktop as soon as possible to save the use of memory.

This attribute is set if ZK loader sets Cache-Control=no-cache. However, if a ZUML page is included by other servlet (such as JSP and DSP), this attribute won't be set. If you set Cache-Control manually, you might also set this attribute to save the use of memroy.

request.setAttribute(Attributes.NO_CACHE, Boolean.TRUE);

Since:

3.0.1

See Also:

Constant Field Values

RESEND_DELAY

public static final java.lang.String RESEND_DELAY

A library property to indicate the default resend delay (an integer in milliseconds). If specified, Configuration.getResendDelay() will use it as the default. Otherwise, -1 is assumed.

Since:

3.0.3

See Also:

Constant Field Values

RENEW_NATIVE_SESSION

public static final java.lang.String RENEW_NATIVE_SESSION

A session attribute used to denote that the invalidation of a native session (such as HttpSession and PortletSession) does not invalidate ZK session. Rather it is intended to renew a session (and the ZK session still alive).

A typical case is so-called Session Fixation Protection.

hsess.setAttribute(Attributes.RENEW_NATIVE_SESSION, Boolean.True);
 hsess.invalidate();
 hsess.removeAttribute(Attributes.RENEW_NATIVE_SESSION);
 

Since:

3.5.1

See Also:

Constant Field Values

ID_TO_UUID_PREFIX

public static final java.lang.String ID_TO_UUID_PREFIX

A library property to indicate that UUID shall be generated by prefixing ID with the value stored in this property. This property is used for unit-test purpose.

Note: An empty string means no prefix, while null means UUID is independent of ID (which is the default).

Since:

3.6.1

See Also:

Constant Field Values

Constructor Detail

Attributes

public Attributes()