ZK Developer's Guide

ZK Developer's Guide is archived.
Some of the material might be old and even obsolete.
For more updated information, please refer to ZK Essentials, ZK Developer's Reference and ZK Component Reference.

Preface

About the ZK Development Guide

Introduction

What's ZK

Getting Started

Environment setup

Online Resources

Fundamental ZK

Basic Concepts

Architecture Overview

Markup Language or Pure Java

UI Components

Page and Desktop

UI Component Forest

Events of UI Components

ZK User Interface Markup Language

XML

XML Format

Elements Must Be Well-formed

Special Character Must Be Replaced

Attribute Values Must Be Specified and Quoted

Comments

Character Encoding

zscript

Write Java code in ZUML

Hints to read zscript

Distinguish zscript from EL

Java Interpreter (BeanShell)

zscript other than Java

Implicit Objects

List of Implicit Objects

Information about Request and Execution

Life cycle of page, execution, desktop, session, application

About xxxScope

Expression Language (EL)

Access Java Bean

Access ZUML Component

Access Implicit Object

More EL Examples

Import Java Methods

ZK Processing Instructions

ZK Attributes

ZK Elements

Component Sets and XML Namespaces

Standard Namespaces

Mix With Another Markup Language

ZUL Components

Form and Inputs

Label

Buttons

Radio and Radio Group

Comboboxes

Bandboxes

Input Controls

Layout and Windows

Windows

Panel

Tab Boxes

The Box Model

The Layout Components

More Layout Components

Grids, Trees and Listbox

Paging

Tree Controls

Grids

List Boxes

Toolbar and Menus

Menu bars

Context Menus

Multimedia and Utilities

Image

Imagemap

Audio

Chart and Report

Chart

Jasper Report

Calendar

Progressmeter

Slider

Timer

Wrapped

Gmaps

Fckeditor

Timeline

Timeplot

Miscellaneous

ZK Applet Component

Supported Events

Events

Mouse Events

Keystroke Events

Input Events

List and Tree Events

Drag and Drop

Slider and Scroll Events

Other Events

How to know what events a component has

ZK in Depth

Data Binding

Adding a Data Source

Activates Data Binding Manager

Associate UI Components with Data Source

When to Load Data from Data Source to UI

When to Save Data from UI Components to the Data Source

Associate the Same Data Source with Multiple UI Components

Associate UI Components with a Collection

Customization of Conversion between the Data Source and UI Components

Define the Access Privilege of Data Binding Manager

Macro Component

Macro Components

Three Steps to Use Macro Components

Inline Macros

Regular Macros

Zscript, java, EL

Overview

Use zscript to initialize

access UI component by ID

define Variable in zscript and access by EL

Define class and methods in zscript

access implicit object

getVariable VS. getZScriptVariable

The Scripting Codes in a Separate File

foreach

Macro Component

event handler

GenericAutowireComposer

Component Path and Accesibility

Access UI Component

Most used api for Implicit Objects and Static Classes

Overview

self

spaceOwner

page

desktop

execution

session

application

event

Executions

Path

Clients

Inter Page, App Communication

Inter-Page Communication

Use cookies

Inter-Web-Application Communication

Event listening and processing

Add Event Listeners by Markup Languages

Add and Remove Event Listeners by Program

Send, Post and Echo Events from an Event Listener

Thread Model

Initialization and Cleanup of Event Processing Thread

Style Customization

CSS

firebug : edit, debug, and monitor CSS, HTML, and JavaScript lively

The Style Class (sclass)

The contentStyle Property

Mold

Theme

Line it up: hbox, vbox

Absolute position

What's wrong

Parsing of CSS files for image URLs

Live Data, Paging, setModel and Implement your own renderer

Overview

What's Live Data

What's Paging

What's Model

What's Renderer

Three Steps to Use Live Data

Examples

If extreme large data set, say 1,000,000

Data Binding

Servlet Thread vs Event Thread

Modal Window

Message Box

File Upload

Unit Test

Introduction

Prerequisites

Version Info

Environment Setup

Test Case

Running the Test Case

Reference

How to Initialise the Page

ZK Directive: init

The apply Attribute

Initialize by zscript

Initialize by Java Class

Advanced ZK

Internationalization

Locale

Time Zone

The First Day of the Week

Labels

Locale-Dependent Files

Messages

Themes

Performance Tips

Use Compiled Java Codes

Use the Native Namespace instead of the XHTML Namespace

Specify Stubonly for Client-only Components

Defer the Creation of Child Components

Defer the Rendering of Client Widgets

Use Live Data and Paging for Large List Boxes

Client Render on Demand

Render on Demand to Show Huge Data with Grid and Listbox

Minimizes the number of JavaScript Files to Load

Use ZK JSP Tags or ZK JSF Components instead of ZK Filter

Prolong the Period to Check Whether a File Is Modified

Reuse Desktops

Miscellaneous

Security Tips

Cross-site scripting

Block Request for Inaccessible Widgets

Cluster

Introduction

A Simple Case of Clustering

Procedure for Eclipse & Tomcat Configuration

Procedure for Apache & JK Configuration

Running our Clustering System

Little Trick

Container Management HttpSession Replication

ZK Session Object Serialization

Notice of developing serializable ZK Component

zkDemo in clustering

Summary

MVC in ZK

Introduction

Browser Management

Browser's Information and Controls

Browser's History Management

Cookie

redirect

login

Session Timeout Management

Zscript other than java

How to Select a Different Scripting Language

How to Support More Scripting Languages

Multi-Scope Interpreters

Single-Scope Interpreters

Multiple scripting Languages in One Page

Long Operations

Alternative 1: Server Push

Alternative 2: Thread Suspend and Resume

Alternative 3: Timer (No Suspend or Resume)

Alternative 4: Piggyback (No Suspend or Resume, No Timer)

Annotations

Overview

Annotate ZUML Pages

Annotate Components Created Manually

The classic way to annotate the component & property declarations

Retrieve Annotations

Integrate with Backend Frameworks

Database Connectivity (JDBC)

ZK Is Presentation-Tier Only

Simplest Way to Use JDBC (but not recommended)

Use with Connection Pooling

ZK Features Applicable to Database Access

Hibernate

What is Hibernate

Version Info

Installing Hibernate

Configuring the ZK Configuration File

Creating the Java Objects

Mapping the Java Objects

Creating the Hibernate Configuration File

Creating DAO Objects

Accessing Persistence Objects in ZUML Page

Spring

What is Spring

Prerequisites of Using Spring

Version Info

Configure web.xml

Create Spring Configuration File

Creating Spring Bean Class

Accessing Spring Bean in the ZUML page

Spring Security

ZK + Spring

ZK Spring 1.1.0 Release configuration details

Seam

Introduction

Demo Installation

A CRUD Example "Say Hello" of Seam

How to Integrate ZK with Seam

Using bean context of Seam only

Download

Migrate

Integrate Other UI frameworks

Work with HTML Tags

Work with HTML FORM and Java Servlets

The Goal

The Differences

The DOM Tree at the Browser

Events

Integrate with JSF, JSP and Others

Work with Existent Servlets

Enrich by Inclusion

Enrich Static HTML Pages

Use of ZK JSP Tags

Use of ZK JSF Components

Enrich a Dynamically Generated Page with ZK Filter

SWING

Richlets

ZK in Other Environments

Portal integration

Configuration

The Usage

Overview

The Mobile Component Set

XML Output

Three Steps to Generate XML Output with a ZUML Page

The XML Component Set

Beyond zk

Logger

DSP

iDOM

Appendix

Development methodology

Refactor to Java, not zscript

Debug tools

Component Life cycle

An Example

Table of Sequence

EL