ZK Developer's Guide

Creating Custom Components
languagename
The language of the addon. The possible languages are defined
in the lang.xml file which is provided from the ZK framework.
addon-name The name of the addon. The addon name is the identifier for the
addon. That name must be unique for one web application.
componentname
The name of the component. This name is used in the ZUL files
to integrate the component.
extends This is same as the extends in a Java class. Here, we define the
base component.
property Inside property, we define the predefined attributes for
the component.
To register a language-addon, we have two possibilities. The first one is to place the
file into the metainfo/zk directory, and name it language-addon.xml. Another way
is to register the file inside the optional configuration zk.xml file. This file has to be
located inside the WEB-INF directory. The zk.xml file to register a language-addon
is depicted.
/WEB-INF/my-addon.xml
Now we can use the component inside the pages.
A language-addon can do many more things for you. For example,
with the component-class attribute you can provide your own class
for the component. Just look into lang.xml file of the zul.jar file of the
ZK framework.
Macro Components
Beyond the possibility of customizing existing components with the help of CSS files,
it's also possible to create new components based on existing ones. In our sample
login page, we used a label followed by a textbox component. Now we will replace
that component with a component that has a label, and a textbox.
[ 142 ]