Create a New ZK Project

From Documentation
< User:Paowang
Revision as of 03:58, 17 October 2012 by Paowang (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
DocumentationPaowangZK StudioBegin Your First ZK Project
Begin Your First ZK Project

Video Guide

Create a New ZK Project

  1. Click [File]/[New]/[Other...]/[ZK Project] in Eclipse main menu.
    Zk studio 094 create proj 0.png
  2. Type the project name. Eclipse will automatically include the default ZK package configured in the ZK Package preferences, however, you can select any other installed ZK package by selecting it from the combo box. Then, click Next.
    Zk studio 094 create proj 1.png
  3. You can modify the Source folders and Default output folder if you like. Then, click Next.
    Zk studio 094 create proj 4 1.png
  4. You can modify Context root or Content directory if you like. Then, Click Finish.
    Zk studio 094 create proj 4.png
  5. After clicking Finish, the New Project Wizard will setup the ZK Project ready for development.


  1. The project's top right icon includes a ZK mark to show that the project has ZK Studio support:
  2. The ZK package source code will be automatically attached to the related jar files
    Zk studio 094 source attach.png

Creating a New ZUL File

Using the New File Command

You can create new ZUL file using the [File]/[New]/[File] command in Eclipse's main menu.


However, you have to write the ".zul" extension yourself and the newly create zul file will not contain any template code.


Using the New ZUL File Wizard

  1. There are two ways to open the New ZUL File Wizard:
    • Right click on the opened Dynamic Web Project in "Project Explorer" view or "Package Explorer" view and select [New]/[ZUL].
    • Click [File]/[New]/[Other] in Eclipse's main menu and then using the wizard to filter zul. Select zul from the listbox and then click Next.
      NewZULFileWizard 0.png
  2. Type the file name and optional page title name, click Finish.
  3. The newly created ZUL File will be opened in ZUL Editor.

Running the ZK Project

To run the ZK Project (that is, to run a ZK Web application in Eclipse), please follow the instructions below:

  1. Configuring Apache Tomcat for Eclipse
    • You are required to create a valid Apache Tomcat server configuration. Configuration of Apache with Eclipse is done in the Server/Runtime Environments preference page.
    • To create a server instance to run a web application the server needs to be defined. For tutorials on how to do this, please refer to the Choose a Server Runtime Environment section of the article Tutorials – Building and Running a Web Application.
  2. Creating a Server instance in Eclipse's Server View
    To create a server instance, please follow the Create a Server section of the article Tutorials – Building and Running a Web Application on Eclipse's website.
  3. To start the server and view the result
    To start the server and view the resulting zul file, please refer to the sections Start the Server and Running the Application of the article Tutorials – Building and Running a Web Application.


There's a detailed step-by-step tutorial on using Tomcat with Eclipse here:

Last Update : 2012/10/17

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.