ZK5: JavaScript API
From Documentation
ZK 5 is under development, so the documentation is not final. Please feel free to feedback to us.
DOM Level API
- jQuery - jQuery API. ZK 5 Client Engine is based on jQuery.
- jQuery Enhancement: ZK enhancement added to jQuery
- JQuery.event Enhancement: ZK Enhancement added to jQuery events
- jQuery.json: JSON extension to jQuery
- zk.canvas: The canvas support
Language API
- zk: Language enhancement utilities
- zk.Class: Represent a class, such as zk.Object
- zk.Object: The root of the class hierarch
- Array: JavaScript array
- String: JavaScript string
Common Utilities API
- zUtl: The common utilities
- zNumFormat: The number formatting utilities
- zMsgFormat: The message formatting utilities
System API
Event API
Animation API
- zEffect: The animation utilities for DOM elements
The zk.eff Package
The animation effect classes that zEffect are implemented upon.
- zk.eff.FullMask: A mask to cover the whole browser.
- zk.eff.Mask: Applies the indicator mask over the specified element.
- zk.eff.Move
- zk.eff.Parallel
- zk.eff.Opacity
- zk.eff.Scale
- zk.eff.ScrollTo
- zk.eff.Shadow
- zk.eff.Tooltip: Applies the tooltip effect
Debugger API
The zk.debug Package
- zk.debug.Debugger the debugger of Javascript
- zk.debug.DefaultHandler the default HTML handler for zk.debug.Debugger#outDomTree
Wiget API
The zk Package
- zk.Class: The class
- zk.Color: The color
- zk.Desktop: The desktop widget
- zk.Draggable: The draggable feature for widgets
- zk.Event: ZK Event API
- zk.Macro: The macro widget
- zk.Native: The native widget (org.zkoss.zk.ui.HtmlNativeComponent)
- zk.Object: The object
- zk.Page: The page widget
- zk.RefWidget: The reference widget
- zk.Skipper: The interface used to skip the rendering a portion of a widget
- zk.Widget: The root of the UI widget hierarchy
The zk.wgt Package
Widget Utilities
- zk.wgt.WidgetInfo: the information about widgets (not just loaded)
The zk.zuml Package
iZUML utilities
- zk.zuml.Parser: the iZUML parser
The zul Package
- zul.Widget: The root class for ZUL Widgets
- zul.LabelImageWidget: The skeletal class for ZUL widgets that support both label and image
The zul.utl Package
- zul.utl.Iframe: the iframe widget
- zul.utl.Script: the script widget but meaninless for client-side application developers.
- zul.utl.Style: the style widget
- zul.utl.Timer: the timer widget
The zul.mesh Package
- zul.mesh.MeshWidget: The skeletal class for mesh-type widgets, such as zul.grid.Grid and zul.sel.Listbox
- zul.mesh.HeadWidget: The skeletal class for the head row of a mesh-type widget.
- zul.mesh.HeaderWidget: The skeletal class for the header (cell) of a mesh-type widget.
- zul.mesh.Auxhead
- zul.mesh.Auxheader
- zul.mesh.Paging
The zul.wgt Package
- zul.wgt.Button
- zul.wgt.Caption
- zul.wgt.Checkbox
- zul.wgt.Div
- zul.wgt.Groupbox
- zul.wgt.Html
- zul.wgt.Include
- zul.wgt.Label
- zul.wgt.Popup
- zul.wgt.Radio
- zul.wgt.Radiogroup
- zul.wgt.Separator
- zul.wgt.Space
- zul.wgt.Toolbar
- zul.wgt.Toolbarbutton
- zul.wgt.Progressmeter
The zul.grid Package
- zul.grid.Column
- zul.grid.Columns
- zul.grid.Foot
- zul.grid.Footer
- zul.grid.Grid
- zul.grid.Paging
- zul.grid.Row
- zul.grid.Rows
The zul.sel Package
- zul.sel.Listbox
- zul.sel.Listcell
- zul.sel.Listhead
- zul.sel.Listheader
- zul.sel.Listitem
- zul.sel.Option
- zul.sel.Select
The zul.menu Package
The zul.panel Package
The zul.wnd Package
The zul.inp Package
- zul.inp.InputWidget - the superclass of all input widgets
- zul.inp.Textbox - textbox
- zul.inp.ComboWidget - the superclass of combo-type input widgets
- zul.inp.Bandbox - bandbox
- zul.inp.Combobox - combobox
- zul.inp.Datebox - datebox
- zul.inp.SimpleConstraint - the simple constraint
The zul.box Package
The zul.layout Package
- zul.layout.Borderlayout
- zul.layout.Center
- zul.layout.East
- zul.layout.LayoutRegion
- zul.layout.North
- zul.layout.South
- zul.layout.West
The zhtml Package
- zhtml.Widget - the generic widget to represent almost all XHTML components at client
- zhtml.Text - the widget for XHTML labels (org.zkoss.zhtml.Text)
The zkex Package
The zkmax Package
- zkmax.layout.Tablelayout
- zkmax.layout.Tablechildren
- zkmax.layout.Portallayout
- zkmax.layout.Portalchildren