Create a New ZK Project"

From Documentation
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{ZKStudioEssentialsPageHeader}}
 
{{ZKStudioEssentialsPageHeader}}
 +
  
 
== Video Guide ==
 
== Video Guide ==
  
 +
http://www.youtube.com/watch?v=Gm0IfIYa2PU&NR=1
  
http://www.youtube.com/watch?v=Gm0IfIYa2PU&NR=1
 
 
== Create a New ZK Project ==
 
== Create a New ZK Project ==
  
Line 18: Line 19:
  
  
=== '''TIPS''' ===
+
'''Tips:'''
 
# The project's top right icon includes a ZK mark to show that the project has ZK Studio support:
 
# The project's top right icon includes a ZK mark to show that the project has ZK Studio support:
 
#: [[Image:hasZKLibrary.png]]
 
#: [[Image:hasZKLibrary.png]]
Line 25: Line 26:
  
 
== Creating a New ZUL File ==
 
== Creating a New ZUL File ==
 +
 
=== Using the New File Command ===
 
=== Using the New File Command ===
 +
 
You can create new ZUL file using the '''<nowiki>[File]/[New]/[File]</nowiki>''' command in Eclipse's main menu.
 
You can create new ZUL file using the '''<nowiki>[File]/[New]/[File]</nowiki>''' command in Eclipse's main menu.
 
: [[Image:NewZULFileMethod1-1.png]]
 
: [[Image:NewZULFileMethod1-1.png]]
Line 33: Line 36:
  
 
=== Using the New ZUL File Wizard ===
 
=== Using the New ZUL File Wizard ===
:1. There are two ways to open the New ZUL File Wizard:
 
::1.1. Right click on the opened Dynamic Web Project in "Project Explorer" view or "Package Explorer" view and select '''<nowiki>[New]/[ZUL]</nowiki>'''.
 
[[Image:NewZULFileRightClick.png]]
 
 
::1.2. Click '''<nowiki>[File]/[New]/[Other]</nowiki>''' in Eclipse's main menu and then using the wizard to filter zul. Select zul from the listbox and then click '''Next'''.
 
[[Image:NewZULFileWizard_0.png]]
 
 
:2. Type the file name and optional page title name, click '''Finish'''.
 
[[Image:NewZULFileWizard.png]]
 
 
 
:3. The newly created ZUL File will be opened in ZUL Editor.
 
 
=== Running the ZUL File ===
 
To run the ZUL File (that is, to run a ZK Web application in Eclipse), please follow the instructions below:
 
 
# Configuring Apache Tomcat for Eclipse:<br/>
 
You are required to create a valid [[ZK_Installation_Guide/Before_You_Start/New_to_Java_Servlet| Apache Tomcat server]] configuration.
 
Configuration of Apache with Eclipse is done in the '''Server/Runtime Environments''' preference page. The screenshot and instruction links below will enable you to setup your server instance with Eclipse.
 
 
[[Image:ServerRuntimePreference1.png]]
 
 
 
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 [http://www.eclipse.org/webtools/community/tutorials/BuildJ2EEWebApp/BuildJ2EEWebApp.html "'''''WTP Tutorials – Building and Running a Web Application'''''"].
 
 
 
'''Creating a Server instance in Eclipse's Server View:'''
 
<br/>
 
To create a server instance please follow the "'''Create a Server'''" section of the [http://www.eclipse.org/webtools/community/tutorials/BuildJ2EEWebApp/BuildJ2EEWebApp.html "'''''WTP Tutorials – Building and Running a Web Application'''''"] article on Eclipse's website.
 
  
 +
# 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 '''<nowiki>[New]/[ZUL]</nowiki>'''.
 +
#*: [[Image:NewZULFileRightClick.png]]
 +
#* Click '''<nowiki>[File]/[New]/[Other]</nowiki>''' in Eclipse's main menu and then using the wizard to filter zul. Select zul from the listbox and then click '''Next'''.
 +
#*: [[Image:NewZULFileWizard_0.png]]
 +
# Type the file name and optional page title name, click '''Finish'''.
 +
#: [[Image:NewZULFileWizard.png]]
 +
# The newly created ZUL File will be opened in ZUL Editor.
  
'''To start the server and view the result:'''
+
== Running the ZK Project ==
<br/>
 
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 [http://www.eclipse.org/webtools/community/tutorials/BuildJ2EEWebApp/BuildJ2EEWebApp.html "'''''WTP Tutorials – Building and Running a Web Application'''''"].
 
  
 +
To run the ZK Project (that is, to run a ZK Web application in Eclipse), please follow the instructions below:
 +
# '''Configuring Apache Tomcat for Eclipse'''
 +
#* You are required to create a valid [[ZK_Installation_Guide/Before_You_Start/New_to_Java_Servlet| Apache Tomcat server]] configuration. Configuration of Apache with Eclipse is done in the '''Server/Runtime Environments''' preference page.
 +
#*: [[Image:ServerRuntimePreference1.png|800px]]
 +
#* 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 [http://www.eclipse.org/webtools/community/tutorials/BuildJ2EEWebApp/BuildJ2EEWebApp.html|WTP Tutorials – Building and Running a Web Application].
 +
# '''Creating a Server instance in Eclipse's Server View'''
 +
#: To create a server instance, please follow the '''''Create a Server''''' section of the article [http://www.eclipse.org/webtools/community/tutorials/BuildJ2EEWebApp/BuildJ2EEWebApp.html|WTP Tutorials – Building and Running a Web Application] on Eclipse's website.
 +
# '''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 [http://www.eclipse.org/webtools/community/tutorials/BuildJ2EEWebApp/BuildJ2EEWebApp.html|WTP Tutorials – Building and Running a Web Application].
  
 
'''Tips:'''
 
'''Tips:'''
 +
: There's a detailed step-by-step tutorial on using Tomcat with Eclipse here: http://www.coreservlets.com/Apache-Tomcat-Tutorial/eclipse.html
  
There's a detailed step-by-step tutorial on using Tomcat with Eclipse at coreservlets.com: [http://www.coreservlets.com/Apache-Tomcat-Tutorial/eclipse.html http://www.coreservlets.com/Apache-Tomcat-Tutorial/eclipse.html]
 
  
 
{{ZKStudioEssentialsPageFooter}}
 
{{ZKStudioEssentialsPageFooter}}

Latest revision as of 03:58, 17 October 2012

DocumentationPaowangZK StudioBegin Your First ZK Project
Begin Your First ZK Project




Video Guide

http://www.youtube.com/watch?v=Gm0IfIYa2PU&NR=1

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.


Tips:

  1. The project's top right icon includes a ZK mark to show that the project has ZK Studio support:
    HasZKLibrary.png
  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.

NewZULFileMethod1-1.png

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

NewZULFileMethod1-2.png

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].
      NewZULFileRightClick.png
    • 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.
    NewZULFileWizard.png
  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.
      ServerRuntimePreference1.png
    • 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.

Tips:

There's a detailed step-by-step tutorial on using Tomcat with Eclipse here: http://www.coreservlets.com/Apache-Tomcat-Tutorial/eclipse.html



Last Update : 2012/10/17

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