The Developer's Reference

Version 3.0.4


Table of Contents

1. Introduction
2. The ZK User Interface Markup Language
Implicit Objects
applicationScope - java.util.Map
arg - java.util.Map
componentScope - java.util.Map
desktop - org.zkoss.zk.ui.Desktop
desktopScope - java.util.Map
each - java.lang.Object
event - org.zkoss.zk.ui.event.Event or derived
forEachStatus – org.zkoss.zk.ui.util.ForEachStatus
page - org.zkoss.zk.ui.Page
pageContext – org.zkoss.web.servlet.xel.PageContext
pageScope - java.util.Map
requestScope – java.util.Map
self - org.zkoss.zk.ui.Component
session - org.zkoss.zk.ui.Session
sessionScope - java.util.Map
spaceOwner - org.zkoss.zk.ui.IdSpace
spaceScope - java.util.Map
Processing Instructions
The component Directive
The evaluator Directive
The forward Directive
The import Directive
The init Directive
The link and meta Directives
The page Directive
The root-attributes Directive
The taglib Directive
The variable-resolver Directive
The xel-method Directive
ZK Elements
The XML Namespace
The attribute Element
The custom-attributes Element
The variables Element
The zk Element
The zscript Element
ZK Attributes
The apply Attribute
The forEach Attribute
The forEachBegin Attribute
The forEachEnd Attribute
The forward Attribute
The fulfill Attribute
The if Attribute
The unless Attribute
The use Attribute
3. EL Expressions
Overview
Using EL Expressions
Variables
Implicit Objects
Literals
Operators
Functions
Standard Implicit Objects that ZK supports
applicationScope - java.util.Map
cookie - java.util.Map
header - java.util.Map
headerValues - java.util.Map
pageScope - java.util.Map
param - java.util.Map
paramValues - java.util.Map
requestScope - java.util.Map
sessionScope - java.util.Map
ZK Implicit Objects
4. The XUL Components
Overview
AbstractComponent
FormatInputElement
HeaderElement
HeadersElement
HtmlBasedComponent
InputElement
LabelElement
LabelImageElement
LayoutRegion
NumberInputElement
XulElement
Components
Audio
Auxhead
Auxheader
Bandbox
Bandpopup
Calendar
Borderlayout
Box
Button
Captcha
Caption
Center
Chart
Checkbox
Column
Columns
Combobox
Comboitem
Datebox
Doublebox
Div
East
Flash
Footer
Foot
Grid
Groupbox
Hbox
Html
Iframe
Image
Imagemap
Include
Intbox
Label
Listbox
Listcell
Listfoot
Listfooter
Listhead
Listheader
Listitem
Longbox
Menu
Menubar
Menuitem
Menupopup
Menuseparator
North
Paging
Popup
Progressmeter
Radio
Radiogroup
Row
Rows
Script
Slider
Space
South
Separator
Splitter
Style
Tab
Tabbox
Tabpanel
Tabpanels
Tabs
Textbox
Timebox
Timer
Toolbar
Toolbarbutton
Tree
Treecell
Treechildren
Treecol
Treecols
Treefoot
Treefooter
Treeitem
Treerow
Vbox
West
Window
Events
CheckEvent
ColSizeEvent
CreateEvent
DropEvent
ErrorEvent
Event
InputEvent
KeyEvent
MouseEvent
MoveEvent
OpenEvent
PageSizeEvent
PagingEvent
ScrollEvent
SelectEvent
SelectionEvent
SizeEvent
UploadEvent
ZIndexEvent
Supplemental Classes
AbstractListModel
Constraint
Constrained
Fileupload
ListitemRenderer
ListModel
Messagebox
RendererCtrl
SimpleConstraint
SimpleListModel
5. The XHTML Components
Overview
URL and encodeURL
AbstractTag
Raw
Components
A
Abbr
Acronym
Address
Area
B
Base
Big
Blockquote
Body
Br
Button
Caption
Cite
Code
Collection
Colgroup
Dd
Del
Dfn
Dir
Div
Dl
Dt
Em
Embed
Fieldset
Font
Form
H1
H2
H3
H4
Head
Hr
Html
I
Iframe
Img
Input
Ins
Isindex
Kbd
Label
Legend
Li
Link
Map
Menu
Meta
Nobr
Object
Ol
Optgroup
Option
P
Pre
Q
S
Sam
Script
Select
Small
Span
Strong
Style
Sub
Sup
Table
Tbody
Td
Text
Textarea
Tfoot
Th
Thead
Title
Tr
Tt
Ul
Var
Supplement Classes
Fileupload
Messagebox
Appendix A. WEB-INF/web.xml
ZK Loader
The Initial Parameters
ZK AU Engine
The Initial Parameters
ZK Session Cleaner
ZK Filter
The Initial Parameters
How to Specify in web.xml
DSP Loader
The Initial Parameters
How to Specify in web.xml
Sample of web.xml
Appendix B. WEB-INF/zk.xml
Overview
The richlet and richlet-mapping elements
The listener Element
The log Element
The client-config Element
The desktop-config Element
The xel-config Element
The language-config Element
The session-config Element
The system-config Element
The zscript-config Element
The device-config Element
The error-page Element
The preference Element
The system-property Element

SIMPLY RICH

ZKTM

March 2008

Potix Corporation

Revision 97

Copyright © Potix Corporation. All rights reserved.

The material in this document is for information only and is subject to change without notice. While reasonable efforts have been made to assure its accuracy, Potix Corporation assumes no liability resulting from errors or omissions in this document, or from the use of the information contained herein.

Potix Corporation may have patents, patent applications, copyright or other intellectual property rights covering the subject matter of this document. The furnishing of this document does not give you any license to these patents, copyrights or other intellectual property.

Potix Corporation reserves the right to make changes in the product design without reservation and without notification to its users.

The Potix logo and ZK are trademarks of Potix Corporation.

All other product names are trademarks, registered trademarks, or trade names of their respective owners.