|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.zkoss.zk.ui.sys.Attributes
public class Attributes
Attributes or library properties to customize the behaviors of ZK, such as page rending, fileupload and so on.
Field Summary | |
---|---|
static java.lang.String |
CLIENT_ROD
A component or page attribute to indicate if the client ROD (render-on-demand) shall be applied. |
static java.lang.String |
GAE_FIX
A special attribute set to the session to cause Google App Engine to update attributes to the storage. |
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 |
INJECT_URI_PREFIX
A special prefix that is used if you want to inject a special fragment into the URI of a clss Web resource (CWR). |
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 |
PAGE_REDRAW_CONTROL
The execution attribute used to control how to PageCtrl.redraw(java.io.Writer)
a page. |
static java.lang.String |
PAGE_RENDERER
The execution attribute used to control how to render a page. |
static java.lang.String |
PORTLET_RENDER_PATCH_CLASS
A library property to specify the class used to patch the rendering result of a portlet. |
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 |
---|
public static final java.lang.String UPLOAD_PERCENT
public static final java.lang.String UPLOAD_SIZE
public static final java.lang.String CLIENT_ROD
Default: true.
Applicable: ZK EE
public static final java.lang.String PAGE_REDRAW_CONTROL
PageCtrl.redraw(java.io.Writer)
a page. There are three different values: destkop
,
page
, and complete
.
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 page
.
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:
jQuery.ajax({
url: "z5-load-1.zul?zk.redrawCtrl=page",
success: function (html) {
jQuery("#myDiv").append(html);
}
});
If you prefer to draw the desktop with the page, you can set the
vallue to 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 page
.
If the page already contains everything that the client expects such
as the HTML and BODY tags, you can set the value to complete
.
The difference between page
and complete
is
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.
Thus, complete
is usually used for the situation that
HTML and BODY are being generated by other technology, while
page
for a included ZK page.
Note: if Page.isComplete()
is true, it has the same effect
of setting PAGE_REDRAW_CONTROL
to complete
.
ExecutionsCtrl.getPageRedrawControl(org.zkoss.zk.ui.Execution)
,
Constant Field Valuespublic static final java.lang.String PAGE_RENDERER
PageRenderer
.
Default: null (means auto). It is decided by
LanguageDefinition.getPageRenderer()
.
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 memroy.
request.setAttribute(Attributes.NO_CACHE, Boolean.TRUE);
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 GAE_FIX
public static final java.lang.String RESEND_DELAY
Configuration.getResendDelay()
will use it as the default. Otherwise, -1 is assumed.
Notice that this property is ignored after ZK is booted
since ZK depends on Configuration.getResendDelay()
.
public static final java.lang.String ID_TO_UUID_PREFIX
Note: An empty string means no prefix, while null means UUID is independent of ID (which is the default).
public static final java.lang.String PORTLET_RENDER_PATCH_CLASS
Default: null (means no need of patch).
If specified, the class must implement PageRenderPatch
.
An example implementation is JQueryRenderPatch
that delays the rendering of a ZK portlet to avoid the conflicts when
using IE.
public static final java.lang.String INJECT_URI_PREFIX
For example, ThemeProvider.Aide
is based on this prefix.
Notice that this prefix is currently supported only by the WCS files
(WcsExtendlet
).
Constructor Detail |
---|
public Attributes()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |