ZK Developer's Reference

ZK Developer's Reference is under construction.
If you cannot find material you want here, please refer to other references or ZK Developer's Guide, though it is archived.

If you are new to ZK, you might take a look at ZK Essentials first.

Overture

Architecture Overview

Technology Guidelines

Extensions

Example Project

UI Composing

Component-based UI

ID Space

ZUML

XML Background

Basic Rules

EL Expressions

Scripts in ZUML

Conditional Evaluation

Iterative Evaluation

On-demand Evaluation

Include a Page

Load ZUML in Java

XML Namespaces

Richlet

Macro Component

Inline Macros

Implement Custom Java Class

Composite Component

Client-side UI Composing

Shadow for MVC

Event Handling

Event Listening

Event Firing

Event Forwarding

Event Queues

Client-side Event Listening

MVC

Controller

Composer

Wire Components

Wire Variables

Wire Event Listeners

Subscribe to EventQueues

Model

List Model

Groups Model

Tree Model

Chart Model

Matrix Model

View

Template

Listbox Template

Grid Template

Tree Template

Combobox Template

Selectbox Template

Biglistbox Template

Chosenbox Template

Tabbox Template

Organigram Template

Searchbox Template

Renderer

Listbox Renderer

Grid Renderer

Tree Renderer

Combobox Renderer

Tabbox Renderer

Organigram Renderer

Biglistbox Renderer

Item Renderer

Stateless Components

Building Stateless UI

Annotations

Annotate in ZUML

Annotate in Java

Retrieve Annotations

Annotate Component Definitions

Responsive Design

Fluid Design

Adaptive Design

Responsive Templating

UI Patterns

Mobile And Touch Support

Message Box

Layouts and Containers

Hflex and Vflex

Grid's Columns and Hflex

Tooltips, Context Menus and Popups

Keystroke Handling

Drag and Drop

Page Initialization

Forward and Redirect

File Upload and Download

Browser Information and Control

Browser History Management

Session Timeout Management

Error Handling

Actions and Effects

Useful Java Utilities

HTML Tags

The html Component

The native Namespace

The XHTML Component Set

Long Operations

Use Echo Events

Use Event Queues

Use Piggyback

Communication

Inter-Page Communication

Inter-Desktop Communication

Inter-Application Communication

Templating

Composition

Templates

XML Output

Event Threads

Modal Windows

Message Box

File Upload

Theming and Styling

Molds

CSS Classes and Styles

ZK Official Themes

Switching Themes

Customizing Standard Themes

Creating Custom Themes

Theme Template

Archive-based Themes

Folder-based Themes

Understanding the Theming Subsystem

Information about a Theme

Registering your Theme

Providing Theme Resources

Resolving Theme URLs

Internationalization

Locale

Time Zone

Handling Server and User Time Zones

Labels

The Format of Properties Files

Date and Time Formatting

The First Day of the Week

Locale-Dependent Resources

Warning and Error Messages

Server Push

Event Queues

Synchronous Tasks

Asynchronous Tasks

Configuration

Clustering

ZK Configuration

Server Configuration

Programming Tips

Integration

Accessing Java EE Scope Objects

Presentation Layer

Bootstrap

Font Awesome

JSP

Struts

Portal

ZK Filter

Foreign Templating Framework

Middleware Layer

Spring

CDI

EJB

Persistence Layer

JDBC

Hibernate

JPA

Security

Spring Security

ZK Embedded

Embedded ZK Application

Embed ZK Component in Foreign Framework

Embedded ZK Application Troubleshooting

Miscellaneous

Google Analytics

Start Execution in Foreign Ajax Channel

Websocket Channel

Performance Tips

Use Compiled Java Codes

Use Native Namespace instead of XHTML Namespace

Use ZK JSP Tags instead of ZK Filter

Defer the Creation of Child Components

Defer the Rendering of Client Widgets

Client Render on Demand

Listbox, Grid and Tree for Huge Data

Use Live Data and Paging

Turn on Render on Demand

Implement ListModel and TreeModel

Minimize Number of JavaScript Files to Load

Load JavaScript and CSS from Server Nearby

Specify Stubonly for Client-only Components

Reuse Desktops

Control resource caching

Miscellaneous

Security Tips

Cross-site scripting

Block Request for Inaccessible Widgets

Denial Of Service

Cross-site Request Forgery

OWASP Top 10 Security Concerns

2021

2017

Content Security Policy

Enhancing Security with Strict-Dynamic

SSO Redirect Handling

Performance Monitoring

Performance Meters

Event Interceptors

Loading Monitors

Step by Step Trouble Shooting

Accessibility

Keyboard Support

High Contrast Theme

Testing

Testing Tips

ZATS

Upgrade Tips

Version Upgrade

Edition Upgrade

Customization

Packing Code

Component Properties

UI Factory

Life Cycle Listener

AU Services

AU Extensions

How to Build ZK Source Code

Handle AU Request Resend

Supporting Utilities

Logger

DSP

iDOM