Client-side UI Composing

Overview

A UI object visible to a user at the client is hosted by a JavaScript object called a widget (Widget). On the other hand, a component is a Java object (Component) representing the UI object at the server that an application manipulates directly. Once a component is attached to a page, a widget is created at client automatically. Furthermore, any state change of the component at the server will be updated to the widget at the client.

Generally, you need not to know the existence of widgets. Ajax requests and the state synchronization are handled automatically by ZK and the components automatically. However, you are allowed to instantiate or alert any client-side widgets directly at the client (in JavaScript). It is the so-called Server+client fusion.

The rule of thumb is to compose and manipulate UI at the server first since it is easier. Then, you could reduce the load of the server by composing some UI at the client when it is appropriate. Notice that JavaScript is readable by any user, so be careful not to expose sensitive data or business logic when migrating some code from server to client.

Here we describe how to compose UI in JavaScript at the client. For client-side event handling, please refer to the Client-side Event Handling section. For XML-based UI composing at the client, please refer to the iZUML section.

---

Modify Widget's State at Client

While the states of a widget is maintained automatically if you update the corresponding component at the server, you could modify the widget state directly at the server. The modification is straightforward: call the correct method with the arguments you want. Notice that it is JavaScript for Ajax browsers.

var foo = zk.Widget.$('foo');
foo.setValue("What's Up?");

For a complete API available to the client-side fusion, please refer to JavaScript API.

Fusion with Server-side ZUML and Java

It is suggested that the client-side UI composing is better designed to minimize the network round-trip, provide effects and other enhancement, while the most, if not all, of the application is better to be done at the server. Thus, here we only discuss this kind of addon, aka., fusion. For pure-client approach, please refer to Small Talk: ZK 5.0 and Client-centric Approach.

Depending on your requirement, there are typically two situations we could fuse the client-side code:

1. Register a client-side event listener.
2. Override widget's default behavior

For example, suppose we want to open the drop down when a commbox gains the focus, then we register a client-side event listener for the onFocus event as follows.

<div>
  <combobox xmlns:w="client" w:onFocus="this.open()"/>
</div>

As shown, we have to use the native namespace to indicate the onFocus attribute is for the client-side event listener. It is done by apply XML namespace:

• Add the xmlns:w="client" attribute
• Prefix w: before onFocus

For more information about the client-side event listener, please refer to the Client-side Event Listening section.

The other typical situation to fuse the client-side code is to override the default behavior of a widget. We will discuss it later.

Identify Widget at Client

When the client event is invoked, you can reference the widget using this and the event using event. In the following example, this refers to the label.

<window xmlns:w="client">
  <label value="change me by click" w:onClick="this.setValue('clicked');"/> 
</window>

To retrieve a fellow, you could use Widget.$f(String). It works in a similar manner as Component.getFellow(String). For example,

this.$f('foo').setValue('found');
this.$().foo.setValue('found'); //equivalent to the above statement

If you don't have a widget as a reference, you could use Widget.$(Object, Map). Notice it assumes there is only one widget with the given ID in all ID spaces of the desktop. For example,

zk.Widget.$('foo').setValue('found');

In additions, you can use jQuery to select a DOM element of a widget. For example jq("@window") will select DOM elements of all window widget. And, jq("$win1") will select DOM elements of all widgets whose ID is win1. (see jq).

<window xmlns:w="http://www.zkoss.org/2005/zk/client">
	<vbox>
		<label id="labelone" value="click to change"
			w:onClick="this.setValue('changed by click label');" />

		<button label="button"
			w:onClick="this.$f('labelone').setValue('changed by button');" />

		<html><![CDATA[
  <a href="javascript:;" onclick="zk.Widget.$(jq('$labelone')[0]).setValue('changed with jq');">not widget</a>
		]]></html>		
	
	</vbox>
</window>

---

Instantiate Widget at Client

A widget has to be create to make a component visible at the client (once it has been attached to a page). However, you could instantiate a widget at client, without the corresponding component at the server. To extreme extent, you could create all widgets at client (of course, it is costly and less secure).

To instantiate a widget is similar to a widget, except we can pass all initial values into the constructor. For example,

new zul.wnd.Window({
    title: 'Hello, World',
    border: 'normal',
    children: [
        new zul.wgt.Label({value: 'Hi, '}),
        new zul.wgt.Button({
            label: 'Click Me!',
            listeners:  {
                onClick: function (evt) {
                    alert('Hi, you clicked me');
                }
            }
        })
    ]
});

As shown, the initial values can be passed as a map. In additions, the children property could be used to specify an array of child widgets, and the listeners property to specify a map of listeners.

In additions to instantiate widgets in JavaScript, you could use a markup language called iZUML. Please refer to the iZUML section for more information.

Version History

Last Update : 2010/11/10

Version	Date	Content