public class Attributes extends java.lang.Object
|Modifier and Type||Field and Description|
A library property used with
A library property to specify the timeout (in milliseconds) to wait for the activation.
A component or page attribute to indicate if the client ROD (render-on-demand) shall be applied.
A library property to specify the class used to handle client script error
A special prefix that is used if you want to inject a special fragment into the URI of a class Web resource (CWR).
A request attribute to indicate whether "no-cache" header is generated for the current desktop.
The execution attribute used to control how to redraw a page (
The execution attribute used to control how to render a page.
An execution attribute to indicate that a page is rendering.
A library property to specify the class used to patch the rendering result of a portlet.
A session attribute used to denote that the invalidation of a native session (such as HttpSession and PortletSession) does not invalidate ZK session.
A component attribute used to indicate whether to enable the stubbing of the native components.
A library property to indicate whether UUID shall not be recycled.
A session attribute used to store the ZK session in the native session.
|Constructor and Description|
public static final java.lang.String CLIENT_ROD
Applicable: ZK EE
public static final java.lang.String PAGE_REDRAW_CONTROL
PageCtrl.redraw(java.io.Writer)). There are three different values:
Default: null (means auto). In other words,
desktop is assumed
if this is the top-level page and not being included (and other conditions).
Otherwise, it assumes
Application developers rarely need to set this attribute, unless ZK Loader cannot decide which control to use correctly.
This control can also be specified as a request parameter called
zk.redrawCtrl. For example, if you are using
other technology, say jQuery, and want to load a ZUL page dynamically; as shown below:
If you prefer to draw the desktop with the page, you can set the
desktop. By drawing the desktop, it means HTML and BODY
tags will be generated, too.
If you prefer to draw the page only (such as being included),
you can set the value to
If the page already contains everything that the client expects such
as the HTML and BODY tags, you can set the value to
The difference between
a bit subtle. They don't generate HTML and BODY tags. However,
page generates DIV to represents a page, while
complete generates only the root components.
complete is usually used for the situation that
HTML and BODY are being generated by other technology, while
page for a included ZK page.
Page.isComplete() is true, it has the same effect
ExecutionsCtrl.getPageRedrawControl(org.zkoss.zk.ui.Execution), Constant Field Values
public static final java.lang.String PAGE_RENDERER
Default: null (means auto). It is decided by
public static final java.lang.String NO_CACHE
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 memory.
Since 5.0.8, if the zk.redrawCtrl parameter is specified with page
(as described in
public static final java.lang.String RENEW_NATIVE_SESSION
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);
public static final java.lang.String UUID_RECYCLE_DISABLED
Default: false (i.e., not disabled).
public static final java.lang.String PORTLET_RENDER_PATCH_CLASS
Default: null (means no need of patch).
If specified, the class must implement
An example implementation is
that delays the rendering of a ZK portlet to avoid the conflicts when
public static final java.lang.String ACTIVATE_RETRY_DELAY
Notice that, after timeout, the activation will restart automatically. That is, the value won't really affect the result (no aborting or other). It is designed to avoid the annoying warning messages found in some JVM. For example, IBM JVM shows a warning if wait() exceeds 10 minutes. To prevent the warning, you can set the value to less than 10 minutes.
If you'd like to aborting the activation (and then stops the pending thread),
you can specify
ACTIVATE_RETRY_ABORT to "true". Then, after timeout,
the activation will be aborted.
Default: 120000 (unit: milliseconds)
public static final java.lang.String ACTIVATE_RETRY_ABORT
ACTIVATE_RETRY_DELAYto indicate if the time waiting for activation is longer than
ACTIVATE_RETRY_DELAY, the activation will be aborted and the thread will end.
It has no function if
ACTIVATE_RETRY_DELAY is not specified (with a positive value).
public static final java.lang.String INJECT_URI_PREFIX
is based on this prefix.
Notice that this prefix is currently supported only by the WCS files
public static final java.lang.String PAGE_RENDERING
public static final java.lang.String STUB_NATIVE
By default, the native component will be stub-ized, i.e., replaced
with a stateless component called
such that the memory footprint will be minimized.
To stub-ize non-native, please use
Default: true. Though rarely, you could disable the stubbing by setting this attribute to false. For example, if you have a component that has native children, and you'd like to detach it and re-attach later. Since the server does not maintain the states, it cannot be restored when attached back.
It shall be set to a component's attribute, and it affects all descendant components unless it was set explicitly.
Available in ZK EE only.
public static final java.lang.String ZK_SESSION
public static final java.lang.String CLIENT_SCRIPT_ERROR_LISTENER_CLASS
Copyright © 2005-2023 Potix Corporation. All Rights Reserved.