Skip navigation links

Package org.zkoss.zul

ZUL component set that are used for HTML-based clients.

See: Description

Package org.zkoss.zul Description

ZUL component set that are used for HTML-based clients.

Table of Contents

Components of XUL in HTML

Introduction

The implementation of XUL components for ZK.

Directive Elements

page

<?page [id="..."] [title="..."] [language="xul/html"]?>

Special Elements

zk

Due to XML's syntax limitation, we can only specify one document root. Thus, if you have multiple root components, you must use <zk> as the document root to group these root components. In other words, <zk> is not a component and it, if used, must be the document root.

zscript

<zscript>...</zscript>
<zscript src="/WEB-INF/xx/yy.bs">

Simple Elements

Common Attributes

<xxx [id="..."] [class="..."] [style="...] [use="..."]/>

textbox

<textbox [id="..."] [class="..."] [style="...] [use="..."]
[onChange="script"] [onChanging="script"] [value="value"] [type="|password"]
[maxlength="0|num"] [rows="3|num"] [cols="0|num"]
[disabled="false|true"] [readonly="false|true"] [multiline="false|true"] />

window

<window [id="..."] [class="..."] [style="...] [use="..."] [title="..."] [border="normal|none"]/>

Implicit Objects

Depending on invoking from a script or from an EL expression, different implicit objects might be used.

NameDescriptionFrom ScriptFrom EL
self The current component that script/EL is interpreted upon.
It is the same as this in Java.
YesYes
spaceOwner The owner of the ID space that the current component belongs to (See What is an ID space"). It is null, if the current component doesn't belong to any space.
It is the same as self.getSpaceOwner() in script, self.root in EL and this.getSpaceOwner() in Java.
YesYes
desktopScope The attributes defined in the current desktop.
It is the same as this.getPage().getAttributes(name,DESKTOP_SCOPE) in Java.
YesYes
pageScope The attributes defined in the current page.
It is the same as this.getPage().getAttributes() in Java.
YesYes
spaceScope The attributes defined in the ID space that the current component belongs to (See What is an ID space"). It is the same as this.getAttributes() with SPACE_SCOPE in Java. YesYes
componentScope The attributes defined in the current component. It is the same as this.getAttributes() with COMPONENT_SCOPE in Java. YesYes
arg A map of parameters that are passed to Execution.createComponents(...).
It is the same as desktop.getExecution().getArg() in Java.
YesYes

How to browse components

In Java

Each window forms an independent ID space. To get a component from an ID space, use Component.getFellow against any component in the same ID space. If a window, say C, is a child of another window, say P, then C belongs the ID space of P, but descendants of C don't. Rather, descendants of C belong to the ID space of C. Notice: C belongs to the ID spaces of both C and P.

A page is also an independent ID space, Page.getFellow is used to retrieve a fellow in it.

In Script and EL

Components that are specified with the id attribute (i.e., you have assign an ID) can be accessed directly by the value of the id attribute.

For example,

<label id="label" value="Not good enough?"/>
<button label="Change label" onClick="label.value = label.value + 'A'"/>
The scope of visibility, same as in Java, is controlled by the ID space. In other words, each window has an independent ID space. When you specified an ID, only the current ID space is searched.

Events

onOK and onCancel

When window intercepts whether ENTER or ESC is pressed, the onOK or onCancel event is sent, resprectively.

onCtrlKey

Window intercepts whether control or function keys is pressed if you specify what to intercept by use of the ctrlKeys attribute. For example, If ctrlKeys="GW2" is specified, it means Ctrl+G, Ctrl+W and F2 are all intercepted. Once user press one of them, the onCtrlKey event is sent.

Skip navigation links

Copyright © 2005-2019 Potix Corporation. All Rights Reserved. SourceForge.net Logo