Author: smukhina Date: 2009-03-06 13:46:29 -0500 (Fri, 06 Mar 2009) New Revision: 14086 Added: branches/jbosstools-3.0.x/as/docs/reference/en/master_output.xml branches/jbosstools-3.0.x/documentation/guides/Exadel-migration/en/master_output.xml branches/jbosstools-3.0.x/documentation/guides/GettingStartedGuide/en/master_output.xml branches/jbosstools-3.0.x/documentation/jbds-docs/ branches/jbosstools-3.0.x/documentation/jbds-docs/all-guides.xml branches/jbosstools-3.0.x/documentation/jbds-docs/clean.sh branches/jbosstools-3.0.x/documentation/jbds-docs/index/ branches/jbosstools-3.0.x/documentation/jbds-docs/index/en/ branches/jbosstools-3.0.x/documentation/jbds-docs/index/en/images/ branches/jbosstools-3.0.x/documentation/jbds-docs/index/en/images/favicon.ico branches/jbosstools-3.0.x/documentation/jbds-docs/index/en/master.xml branches/jbosstools-3.0.x/documentation/jbds-docs/index/pom.xml branches/jbosstools-3.0.x/documentation/jbds-docs/pom.xml branches/jbosstools-3.0.x/documentation/jbds-docs/settings.xml branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/master_output.xml branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/master_output.xml branches/jbosstools-3.0.x/jbpm/docs/reference/en/master_output.xml branches/jbosstools-3.0.x/jsf/docs/jsf_tools_ref_guide/en/master_output.xml branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/master_output.xml branches/jbosstools-3.0.x/jsf/docs/userguide/en/master_output.xml Log: JBDS doc build for 2.0.0.GA Added: branches/jbosstools-3.0.x/as/docs/reference/en/master_output.xml =================================================================== --- branches/jbosstools-3.0.x/as/docs/reference/en/master_output.xml (rev 0) +++ branches/jbosstools-3.0.x/as/docs/reference/en/master_output.xml 2009-03-06 18:46:29 UTC (rev 14086) @@ -0,0 +1,2060 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + +[<!ENTITY quick_start SYSTEM "modules/quick_start.xml"> +<!ENTITY runtimes_servers SYSTEM "modules/runtimes_servers.xml"> +<!ENTITY perspective SYSTEM "modules/perspective.xml"> +<!ENTITY webtools SYSTEM "modules/webtools.xml"> +<!ENTITY modules SYSTEM "modules/modules.xml"> +<!ENTITY tptp_support SYSTEM "modules/tptp_support.xml"> + +<!ENTITY seamlink "../../seam/html_single/index.html"> +<!ENTITY aslink "../../as/html_single/index.html"> +<!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> +<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html"> +<!ENTITY jbpmlink "../../jbpm/html_single/index.html"> +<!ENTITY jsflink "../../jsf/html_single/index.html"> +<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html"> +<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html"> +<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html"> +<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> + + +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + + <bookinfo> + <title>JBoss Server Manager Reference Guide</title> + + <author><firstname>Anatoly</firstname><surname>Fedosik</surname></author> + <author><firstname>Olga</firstname><surname>Chikvina</surname></author> + <author&gt;&lt;firstname&gt;Rob&lt;/firstname&gt;&lt;surname&gt;Stryker&lt;/surname&gt;&lt;email&gt;rob.stryker(a)jboss.com&lt;/email&gt;&lt;/author&gt; + <author&gt;&lt;firstname&gt;Svetlana&lt;/firstname&gt;&lt;surname&gt;Mukhina&lt;/surname&gt;&lt;email&gt;smukhina(a)exadel.com&lt;/email&gt;&lt;/author&gt; + + <pubdate>April 2008</pubdate> + <copyright> + <year>2007</year> + <year>2009</year> + <holder>JBoss, a division of Red Hat</holder> + </copyright> + <releaseinfo> + Version: 2.0.0.GA + </releaseinfo> +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/as/pdf/AS_... version</ulink> + </para> +</abstract> + + </bookinfo> + + + <toc></toc> + +<chapter id="quick_start" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/as/docs/reference/en/modules/quick_start.xml"> + <title>Quick Start with JBoss Server</title> + + <para>This chapter covers the basics of working with the <property moreinfo="none">JBoss Server</property>. If you + already have installed JBoss server and runtime you can quickly learn how to configure, start, + stop the server, to know deployment and archiving processes. How to install runtimes and servers + read in the <link linkend="runtimes_servers">Runtimes and Servers in the JBoss AS plugin</link> + chapter.</para> + + <para>To start working with JBoss AS, select a <property moreinfo="none">JBoss AS Perspective</property> via + <emphasis><property moreinfo="none">Window &gt; Open Perspective &gt; Other &gt; JBoss + AS</property>.</emphasis></para> + + <section id="starting"> + <title>Starting JBoss Server</title> + + <para>Starting <property moreinfo="none">JBoss Server</property> is quite simple. You can control the server + behaviour with the help of a special toolbar in the <property moreinfo="none">JBoss Server View</property> + where you could <emphasis> + <property moreinfo="none">start</property> + </emphasis> it in a regular or debug mode, <emphasis> + <property moreinfo="none">stop</property> + </emphasis> it or <emphasis> + <property moreinfo="none">restart</property> + </emphasis> it, <emphasis> + <property moreinfo="none">publish</property> + </emphasis> to the server, <emphasis> + <property moreinfo="none">clean</property> + </emphasis> the server.</para> + + <figure float="0"> + <title>JBoss Server Toolbar</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>To launch the server click the green-with-white-arrow icon on the <property moreinfo="none">JBoss Server + View </property>or right click server name in this view and select <emphasis> + <property moreinfo="none">Start</property>. </emphasis> If this view is not open, select + <emphasis><property moreinfo="none">Window &gt; Show View &gt; Other &gt; Server &gt; + JBoss Server View</property>.</emphasis></para> + + <figure float="0"> + <title>Start JBoss Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="stopping"> + <title>Stopping JBoss Server</title> + + <para>To stop the server, click the <emphasis> + <property moreinfo="none">Stop</property> + </emphasis> icon in the <property moreinfo="none">JBoss Server View</property> or right click the server name + and press <emphasis><property moreinfo="none">Stop</property>.</emphasis></para> + + <figure float="0"> + <title>Stop JBoss Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>When the server is stopped you will see <emphasis> + <property moreinfo="none">Stopped</property> + </emphasis> state next to its name in the square brackets.</para> + <para>Learn more about the <property moreinfo="none">JBoss Server View</property> + <link linkend="JBossServerView">here</link>.</para> + </section> + + <section id="archiving"> + + <title>Project Archiving</title> + + <para><property moreinfo="none">JBoss Tools</property> comes with our own archives tool. The Project Archives + plugin consists primarily of a view to set up each packaging configuration <emphasis>( + <property moreinfo="none">Window &gt; Show View &gt; Other &gt; JBoss Tools &gt; Project archives</property>). + </emphasis></para> + <para>Right clicking in the <property moreinfo="none">Project archives view</property> you can create War, + EJB War, EAR or JAR archive.</para> + + <figure float="0"> + <title>Archive Creating</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Using the context menu on the item you can initiate a <emphasis><property moreinfo="none">full build</property></emphasis> on + archive, <emphasis><property moreinfo="none">edit</property>,</emphasis> <emphasis><property moreinfo="none">delete</property></emphasis> or + <emphasis><property moreinfo="none">publish</property></emphasis> it.</para> + + <figure float="0"> + <title>Context Menu on the Item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Learn more about the <property moreinfo="none">Project Archives View</property> + <link linkend="Project_archivesView">here</link>.</para> + + </section> + <section id="deployment"> + <title>Deploying an Application to a Server</title> + + <para>There are two times to deploy your application:</para> + <itemizedlist> + <listitem> + <para>While creating it</para> + </listitem> + <listitem> + <para>After it already exists</para> + </listitem> + </itemizedlist> + + <para>When you create a new project (Seam, JSF or Struts) with the New Project or Import Project + wizards, the one of wizards steps has a <emphasis> + <property moreinfo="none">Target Runtime</property> + </emphasis> and <emphasis> + <property moreinfo="none">Target Server</property> + </emphasis> sections. You can deploy the application through the appropriate selection in + these sections.</para> + + <figure float="0"> + <title>Runtime and Server Sections in the New Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_4a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <figure float="0"> + <title>Runtime and Server Sections in the Import Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_4b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>You can deploy an existing application to a server by right-clicking the target defined + server in the <property moreinfo="none">JBoss Servers View</property> and then selecting <emphasis><property moreinfo="none">Add and + Remove Projects</property></emphasis> from the context menu.</para> + + <figure float="0"> + <title>Add and Remove Projects From the Context Menu.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>If this application is not assigned to a server, it will be in the left-hand available + projects list. Clicking on the <property moreinfo="none">Add &gt;</property> button will add it to the right-hand + configured projects list and deploy the application to this server.</para> + + <figure float="0"> + <title>Modifying The Projects that are Configured on the Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Here, we have just performed the basic steps you should know to quick start with JBoss + server. In fact, there are more functionalities which you can make use of. Further we will + talk about them in detail.</para> + </section> + + + <section> + <title>Other relevant resources on the topic</title> + + <para>All JBoss Developer Studio/JBoss Tools documentation you can find <ulink url="http://docs.jboss.org/tools/2.1.0.GA">here</ulink>... + <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">her... + + </section> + +</chapter> + + +<chapter id="runtimes_servers" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/as/docs/reference/en/modules/runtimes_servers.xml" xreflabel="runtimes_servers"> + <?dbhtml filename="runtimes_servers.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Deploy</keyword> + <keyword>Deployment</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + <title>Runtimes and Servers in the JBoss AS plugin</title> + + <para>In this chapter we will discuss how to install runtimes and servers.</para> + + <para>First of all it's necessary to mention that the JBoss AS plugin makes use of WTP. + This includes starting and stopping servers in run or debug mode. It also includes targeting WTP + projects, such as Dynamic Web Projects, to certain server runtimes in order to ensure that the + proper jars from a specific server are added to the project's classpath + properly.</para> + <para>In order to get started creating, running, and debugging J2EE applications, we should create + our <property moreinfo="none">runtime</property> and <property moreinfo="none">server</property> instances.</para> + + <section> + <title>Runtimes</title> + <para>In <property moreinfo="none">JBoss Tools</property>, the main purpose of Server Runtimes is to point to a + server installation somewhere on disk. In our case, this will be a JBoss installation, and it + can then be used for two primary purposes:</para> + <itemizedlist> + <listitem> + <para>it provides classpath additions to WTP projects that require them.</para> + </listitem> + <listitem> + <para>for <property moreinfo="none">JBoss server</property> at least, it provides information necessary for + the starting and stopping of the server, it tells which jars to run and which + configuration to use.</para> + </listitem> + </itemizedlist> + + <section id="InstNewRuntime"> + <title>Installing a New Runtime</title> + <para>You can install runtimes into eclipse from the <emphasis> + <property moreinfo="none">Window &gt; Preferences </property> + </emphasis> menu, and then select <emphasis> + <property moreinfo="none">Server &gt; Runtime Environments</property> + </emphasis> from the categories available on the left.</para> + <figure float="0"> + <title>Installed Runtimes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>From this preference page you can see all declared runtimes and their types as well. + Here, it's possible to edit or remove existing runtimes as well as add a new + one.</para> + + <para>To create a JBoss runtime click <emphasis> + <property moreinfo="none">Add</property> + </emphasis> button and choose a necessary type of runtime from the <emphasis> + <property moreinfo="none">JBoss Community</property> + </emphasis> category.</para> + + <figure float="0"> + <title>Adding a Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + + <para>Now there is a separation between .org servers (the <emphasis> + <property moreinfo="none">JBoss Community</property> + </emphasis> category) and product server that comes with JBoss EAP in JBDS ( the <emphasis> + <property moreinfo="none">JBoss Enterprise Middleware</property> + </emphasis> category).</para> + </note> + + <para>As you can see, <property moreinfo="none">JBoss Tools</property> provide its own adapters such as JBoss + 3.2, 4.0, 4.2 and 5.0 as well. The last one comes with its own new feature, that is a safer + incremental deployment, which prevents partial deployments to be picked up by the server. It + means that scanning for auto-deployment is suspended while files are being copied to the + deployment location and resumed when the copy is completed.</para> + + <note> + <title>Note:</title> + <para>Currently we recommend you to use a fully supported JBoss 4.2 server adapter.</para> + </note> + + <para>You'll also note a Deploy-Only Runtime type. This type provides no classpath + for WTP projects. It is used solely by its server type for the purpose of setting up a + deploy directory for users who don't wish to make use of starting, stopping, or + debugging their projects inside eclipse.</para> + + <figure float="0" id="add_runtime_figure"> + <title>Adding a JBoss 4.2 Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The following table describes all the available options of the currant wizard + page.</para> + <table> + <title>Server Runtime Wizard Parameters</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec colnum="2" colwidth="3*"></colspec> + + <thead> + <row> + <entry align="center"> + <para>Name</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para>Name</para> + </entry> + <entry> + <para>The name of a new Runtime for a chosen server. We suggest that you + don't leave a default value. It's better to give descriptive + names that will help to distinguish one runtime from another.</para> + </entry> + </row> + + <row> + <entry> + <para>Home directory</para> + </entry> + <entry> + <para>The path to a directory where the runtime is installed.</para> + </entry> + </row> + + <row> + <entry> + <para>jRE</para> + </entry> + <entry> + <para>The proper Java Runtime Environment. Because of the open-source nature of + JBoss, a user is likely to want to modify and repackage some of the + configuration-specific jboss jars and create their own configuration. Thus, rather + than forcing you to copy his entire JBoss installation, the structure of the + wizard allows to create only a new configuration instead.</para> + </entry> + </row> + + <row> + <entry> + <para>Configuration</para> + </entry> + <entry> + <para>The list of configurations (all, default, minimal) that is updated as soon as + you browse to a valid runtime installation folder. After the runtime is created + the configuration becomes an unchanging property of that runtime. To compile + against a different configuration's jars, you will need to create a new runtime + from that configuration.</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + + <para>As a result of having each runtime represent a specific configuration rather than the + server installation as a whole, it is very likely you'll create several different + runtimes to test each of your configurations. It becomes important to ensure your runtimes, + and later your servers, are given descriptive names that help you remember which is + which.</para> + + <para>Press <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> to see your new runtime in the list.</para> + </section> + + </section> + + <section> + <title>Servers</title> + <para>WTP servers are eclipse-representations of a backing server installation. They are used to + start or stop servers, deploy to servers, or debug code that will run on the server. They keep + track of the modules (jars, wars, etc) you deploy to the server and also allow you to undeploy + those modules (see <link linkend="run_on_server_wizard">Deploying with Run On Server + Wizard</link> section). </para> + <para>Servers can be started or stopped with different <link linkend="com_line_arg">command-line + arguments</link>. They are often backed by a runtime object representing that server's + location.</para> + + <section> + <title>Creating a New Server</title> + + <para>There are many ways to get to the new server wizard. One way is to use the old standard <emphasis> + <property moreinfo="none">File &gt; New &gt; Other... </property> + </emphasis> and then <emphasis> + <property moreinfo="none">Server</property> + </emphasis>. This should show the wizard like below.</para> + <figure float="0"> + <title>Adding a JBoss Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>A server object is that keeps track of things like command line arguments when starting + or stopping, and runtimes keep track of the location of the installation. Thus, each server + instance must be backed by an appropriate runtime. </para> + + <para>From the list of already declared runtimes in the combo box below the view it's + possible to select which runtime you want your server to be backed by. If there is no + runtime that matches your needs just press the <emphasis> + <property moreinfo="none">Add...</property> + </emphasis> link nearby to bring up the wizard for creating a new runtime (see the <link linkend="add_runtime_figure">previous section</link>). To configure the already installed + runtimes you should go to server preferences that you can easily do by pressing the <emphasis> + <property moreinfo="none">Configure runtime environments...</property></emphasis> link.</para> + + <para>If the server you want to create doesn't have any installed runtime yet, the combo box + and the links are absent.</para> + + <figure float="0"> + <title>Installed Server Runtime Environments</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In this case the next page in the wizard which has the same form as in <link linkend="add_runtime_figure">the previous section</link> will ask you to create the + associated runtime.</para> + <para>Either way, after targeting your server to a runtime, the final screen in this wizard is + largely confirmational, giving you a chance to verify that you've selected the + appropriate runtime. It also allows to name the server appropriately. </para> + + <figure float="0"> + <title>Installed Server Runtime Environments</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Press <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> to complete the process of the server creation.</para> + <para>Now that we've created our runtimes and servers, we can dwell on all services + and tools that JBoss Server Manager provides.</para> + </section> + + </section> + +</chapter> + + +<chapter id="perspective" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/as/docs/reference/en/modules/perspective.xml" xreflabel="perspective"> + <?dbhtml filename="perspective.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Deploy</keyword> + <keyword>Deployment</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>JBoss AS Perspective</title> + + <para>This chapter tells how to manage installed <property moreinfo="none">JBoss Server</property> via + <property moreinfo="none">JBoss AS perspective</property>.</para> + + <para>The <property moreinfo="none">JBoss AS perspective</property> is similar to the <property moreinfo="none">Java + perspective</property>, but it contains a few additional views. Two of the additional + views are standard views, specifically the <property moreinfo="none">Console view</property> and the + <property moreinfo="none">Properties view</property>. The other two views that are added are the + <property moreinfo="none">Project archives view</property> and the <property moreinfo="none">JBoss Server + View</property>.</para> + + <section id="JBossServerView" > + <?dbhtml filename="JBossServerView.html"?> + <title>The JBoss Server View</title> + + <para>The <property moreinfo="none">JBoss Server View</property> is built on Common Navigator Framework + allowing extensions and is using label decorators what makes the UI enough compact + without loosing the vital information.</para> + + <para>Let's have a look at the <property moreinfo="none">JBoss Server View</property> and inspect + in detail all parts it consists of. </para> + <figure float="0"> + <title>The JBoss Server View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <section id="jbossserver_view_toolbar"> + <title>JBoss Server View Toolbar</title> + <para>In the right top corner of the <property moreinfo="none">JBoss Server View</property> there is a + special toolbar which provides a quick access to starting a server (in debug mode, + run mode, or profile mode), restarting a server, stopping a server, publishing to a + server and a possibility to clean a server.</para> + + <figure float="0"> + <title>The JBoss Server View Toolbar</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In order to debug your applications or EJB's that are deployed to the server, you + must start the server in debug mode. By starting the server in debug mode, eclipse + will allow you to set breakpoints on code in your workspace and step through the + code.</para> + + <para><emphasis> + <property moreinfo="none">Start the server in profiling mode</property> + </emphasis> button allows to enable profiling actions for your application. For more + details on how to start using TPTP profiling with <property moreinfo="none">JBoss Tools</property> + refer to <link linkend="tptp_support">TPTP Support</link> chapter.</para> + + <para><emphasis> + <property moreinfo="none">Publish to the server</property> + </emphasis> button will republish any modules where it has determined the workspace + is out of sync with the server. It will attempt to do an incremental publish if it + turns out that the module in question is capable of doing one.</para> + + + <para>Press <emphasis> + <property moreinfo="none">Clean</property> + </emphasis> if you need to clean projects published on the server, i.e. remove + invalid resources from the server.</para> + </section> + + <section id="jbossserver_view_structure"> + <title>JBoss Server View Structure</title> + <para>The <property moreinfo="none">JBoss Server View</property> displays all declared servers as well + as their current states (that is whether they are started or stopped) and statuses + in the square brackets next to a server name.</para> + + <figure float="0"> + <title>The JBoss Server View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The following table lists possible server statuses.</para> + + <table> + <title>Server Publish Status</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec colnum="2" colwidth="3*"></colspec> + + + <thead> + <row> + <entry align="center">Status</entry> + + <entry align="center">Description</entry> + </row> + </thead> + + <tbody> + <row> + <entry align="center"> + <para>Republish</para> + </entry> + + <entry align="center"> + <para>The status which allows you to see if changes are + awaiting</para> + </entry> + </row> + <row> + <entry align="center"> + <para>Publishing...</para> + </entry> + + <entry align="center"> + <para>The status which shows if changes are being updated</para> + </entry> + </row> + <row> + <entry align="center"> + <para>Synchronized</para> + </entry> + + <entry align="center"> + <para>The status which allows you to see if changes are + in-sync</para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para>You can control a server behavior as well as adjust some server preferences with + the help of the context menu commands.</para> + + <figure float="0"> + <title>Context Menu Commands</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>All available context menu commands are described in the following table.</para> + <table> + <title>Server Properties through the Context Menu</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec colnum="2" colwidth="3*"></colspec> + + <thead> + <row> + <entry align="center"> + <para>Name</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para>New Server</para> + </entry> + <entry> + <para>The option allows to define a new server</para> + </entry> + </row> + + <row> + <entry> + <para>Open</para> + </entry> + <entry> + <para>The option opens the Server editor</para> + </entry> + </row> + + <row> + <entry> + <para>Show in</para> + </entry> + <entry> + <para>This option gives an easy access to the next views: Console, + Debug view, Server Log or MBean Explorer</para> + </entry> + </row> + + <row> + <entry> + <para>Delete</para> + </entry> + <entry> + <para>Standard option that allows to delete the chosen server</para> + </entry> + </row> + + <row> + <entry> + <para>Start</para> + </entry> + <entry> + <para>The action for stating a server in a run mode</para> + </entry> + </row> + + <row> + <entry> + <para>Debug</para> + </entry> + <entry> + <para>The action for stating a server in a debug mode</para> + </entry> + </row> + + <row> + <entry> + <para>Stop</para> + </entry> + <entry> + <para>The action for stopping a declared server</para> + </entry> + </row> + + <row> + <entry> + <para>Publish</para> + </entry> + <entry> + <para>The action for synching the publish information between the + server and workspace</para> + </entry> + </row> + + <row> + <entry> + <para>Clean</para> + </entry> + <entry> + <para>The option for complete redeploying the resources</para> + </entry> + </row> + + <row> + <entry> + <para>Explore</para> + </entry> + <entry> + <para>This action uses the native OS file explorer to browse the + deploy destination. Note: The option is also available for + deployed resources/projects (see the figure below).</para> + </entry> + </row> + + <row> + <entry> + <para>Add and Remove Projects</para> + </entry> + <entry> + <para>The option allows to publish a new project to the server (if + its type is supported)</para> + </entry> + </row> + + <row> + <entry> + <para>Monitoring</para> + </entry> + <entry> + <para>Possibility to add ports to be monitored on the current + server</para> + </entry> + </row> + + <row> + <entry> + <para>Properties</para> + </entry> + <entry> + <para>Opens the window to adjust the current server + preferences</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + + <para>Under the server element in the <property moreinfo="none">JBoss Server View</property>, you can + see currently deployed to the server modules and some server extensions which + provide the additional information on the server.</para> + + <para>The context menu for any module allows you to remove it from the server, force a + full or incremental republish upon it.</para> + + <figure float="0"> + <title>Modules Action</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_11.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <section id="filesets"> + <title>Filesets</title> + + <para>The <emphasis> + <property moreinfo="none">Filesets</property> + </emphasis> category in the <property moreinfo="none">JBoss Server View</property> is intended + for files filtering.</para> + + <para>To add a new file filter, right-click the <emphasis> + <property moreinfo="none">Filesets</property> + </emphasis> category and select <emphasis> + <property moreinfo="none">Create File Filter</property>.</emphasis>The <property moreinfo="none">New File + Filter wizard</property> should appear.</para> + + <figure float="0"> + <title>Creating a New File Filter</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The wizard asks you to enter the filter name and add includes and excludes + patterns. The preview box underneath gives a list of files matched to the + defined patterns.</para> + + <figure float="0"> + <title>New File Filter Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>After the filter is created, you can observe it by expanding the <emphasis> + <property moreinfo="none">Filesets</property> + </emphasis> category in the <property moreinfo="none">JBoss Server View</property>.</para> + + <para>It's possible now to edit files directly from the <emphasis> + <property moreinfo="none">Filesets</property> + </emphasis> category. Double clicking on a file from <emphasis> + <property moreinfo="none">Filesets</property> + </emphasis> opens up the editor automatically or you can use the <emphasis> + <property moreinfo="none">Edit File</property> + </emphasis> context menu command.</para> + + <figure float="0"> + <title>Direct Editing from the Filesets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>To delete a file filter (or just a file) from the <emphasis> + <property moreinfo="none">Filesets</property>,</emphasis> right-click a file filter (or the + unnecessary file) and select the <emphasis> + <property moreinfo="none">Delete File Filter</property> + </emphasis> + <emphasis>(<property moreinfo="none">Delete File</property>)</emphasis> command.</para> + + <figure float="0"> + <title>Deleting the File from the Filesets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="xml_configuration"> + <title>XML Configuration</title> + <para>The <emphasis> + <property moreinfo="none">XML Configuration</property> + </emphasis> category allows you to quickly browse to descriptor files in your + server's deploy directory and check or change the values. Basically, <emphasis> + <property moreinfo="none">XML Configuration</property> + </emphasis> includes XML XPaths where a xpath is a path used to access some + specific part of an xml document. </para> + + <note> + <title>Note:</title> + <para>You are assumed to be familiar with XPath. If not, we highly suggested + that you look through an appropriate manual or tutorial on the topic.</para> + </note> + + <para>The <emphasis> + <property moreinfo="none">XML Configuration</property> + </emphasis> category itself contains only a list of categories. <emphasis> + <property moreinfo="none">Ports</property> + </emphasis> are provided by default and is filled with many of the most commonly + used ports in the <property moreinfo="none">JBoss Server</property>.</para> + + <figure float="0"> + <title>XML Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_14.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <!--para>In the <property>Properties + view</property> you can see an identifier and nested files underneath in which + that xpath can be found as well as its current value. The details of the xpath are + hidden as all you need to see is only which file you&apos;re referring to and + what its current value is.</para--> + + <para>By right-clicking on <emphasis> + <property moreinfo="none">XML Configuration</property>, </emphasis> you can create a new + category. Besides, context menu for <emphasis> + <property moreinfo="none">XML Configuration</property> + </emphasis> category makes possible to disable it. You can disable any category + in the bottom part of the <emphasis> + <property moreinfo="none">JBoss Server View</property>.</emphasis> Look for them in the <emphasis> + <property moreinfo="none">Inactive Categories</property> + </emphasis> afterwards to re-enable.</para> + + <figure float="0"> + <title>Adding New Category</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_15.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>By right-clicking on <emphasis> + <property moreinfo="none">Ports</property> + </emphasis> or any other category in <emphasis> + <property moreinfo="none">XML Configuration</property> + </emphasis>, you can create a new xpath.</para> + + <figure float="0"> + <title>Adding New XPath</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_16.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>After that, the dialog shown below will appear.</para> + + <figure float="0"> + <title>Adding New XPath</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_17.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The goal here is to get an end result where the XPath matches up with a + necessary property. With that in mind, let's look how it works. If the + property you want to reach is the value of the <emphasis>name</emphasis> + attribute in the element <emphasis>&lt;mbean&gt;</emphasis>, then your <emphasis> + <property moreinfo="none">XPath Patten</property> + </emphasis>should end with <emphasis>mbean</emphasis> and your <emphasis> + <property moreinfo="none">Attribute Name</property> + </emphasis> should be <emphasis>name</emphasis> like on the next figure.</para> + + <programlisting format="linespecific" role="XML"><![CDATA[... +<server> +... + <mbean code="org.jboss.ejb.EJBDeployer" + name="jboss.ejb:service=EJBDeployer" xmbean-dd=""> + + <!-- Inline XMBean Descriptor BEGIN --> + <xmbean> + <description> + The EJBDeployer responsible for ejb jar deployment</description> + ... + </xmbean> + </mbean> +</server> +]]></programlisting> + + <figure float="0"> + <title>XPath Preview</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_18.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>Notice, when you type the fields autocomplete to help you locate exactly + what xpath you're looking for.</para> + </tip> + + <para>Then, on the other hand, if your desired field is the text of an element + <emphasis>&lt;description&gt;</emphasis>, your <emphasis> + <property moreinfo="none">XPath Patten</property> + </emphasis> should end with <emphasis>description</emphasis> and <emphasis> + <property moreinfo="none">Attribute Name</property> + </emphasis> field should be left blank. When finished, click <emphasis> + <property moreinfo="none">Preview</property> + </emphasis> to see how many matches you have for that particular XPath.</para> + + <figure float="0"> + <title>XPath Preview</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_19.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + </section> + + <section id="dragndrop_to_jboss_server_view"> + <title>Drag-n-Drop to JBoss Server View</title> + + <para>Starting from 2.0.0.CR2 version of <property moreinfo="none">JBoss AS Tools</property> the + <property moreinfo="none">JBoss Server View</property> supports drag-n-drop of deployable and + runnable projects/resources.</para> + + <figure float="0"> + <title>Dragging to the JBoss Server View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/dnd_toJBossServerView.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>With drag-n-drop the following actions can be performed:</para> + + <itemizedlist> + <listitem> + <para>dragging a project to a server will deploy it to the server and run it by + showing the main page in a browser</para> + </listitem> + + <listitem> + <para>dragging an <emphasis> + <property moreinfo="none">.xhtml</property> + </emphasis> file from <emphasis> + <property moreinfo="none">WebContent</property> + </emphasis> will do the same and show the corresponding page in a + browser</para> + </listitem> + + <listitem> + <para>dragging a deployable resource (i.e. a datasource (<emphasis> + <property moreinfo="none">-ds.xml</property></emphasis>) file that has + been made deployable) will simply deploy that resource directly to the + server</para> + </listitem> + </itemizedlist> + + <para>In short, the feature does the same thing as if you used the <emphasis> + <property moreinfo="none">Run On Server</property> + </emphasis> option or <emphasis> + <property moreinfo="none">Add and Remove Projects</property> + </emphasis> option in the context menu of the server.</para> + </section> + + <section id="server_log"> + <title>Server Log View</title> + + <para>You can monitor the current server behavior with the help of the <property moreinfo="none">Server + Log</property>. To open a server in the <property moreinfo="none">Server Log view</property> you + should right-click on the server and follow to <emphasis> + <property moreinfo="none">Open in &gt; Server Log</property>.</emphasis></para> + + <para>The <emphasis> + <property moreinfo="none">Server Log</property> + </emphasis> shows relevant information to your server's startup, shutdown, + and publish processes. This allows you to keep an eye on what's going on + (such as automatic incremental deployment if you have it enabled).</para> + + <figure float="0"> + <title>Event Log Actions</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_12.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The <property moreinfo="none">Server Log</property> toolbar contains several icons that perform + the following actions:</para> + + <table> + <title>Server Log Toolbar Icons</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec colnum="2" colwidth="3*"></colspec> + + <thead> + <row> + <entry align="center"> + <para>Name</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para>Export Log</para> + </entry> + <entry> + <para>Possibility to export the log into a text file</para> + </entry> + </row> + + <row> + <entry> + <para>Clear Log Viewer</para> + </entry> + <entry> + <para>The option clears the current server log</para> + </entry> + </row> + + <row> + <entry> + <para>Delete Log</para> + </entry> + <entry> + <para>Click to delete the server log</para> + </entry> + </row> + + <row> + <entry> + <para>Open Log</para> + </entry> + <entry> + <para>Click to open the server log text file</para> + </entry> + </row> + + <row> + <entry> + <para>Restore Log</para> + </entry> + <entry> + <para>Click to restore the server log</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + + </section> + + <section id="server_editor"> + <title>Server Editor</title> + <para>By double-clicking on any server, an editor window will appear allowing you to + edit parts of that server.</para> + + <figure float="0"> + <title>Preferences Page for the Chosen Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>On the figure you can see that a username/password is available in the UI when + configuring the server. If you get an SecurityException when trying to launch + the server, it is most likely because your server is protected and hence you + need to fill the username/password fields with appropriate values.</para> + </tip> + + <para>It should be pointed out that our server adapter by default tries to automatically + detect the ports it needs for integrating with a <property moreinfo="none">JBoss Server</property>. + Sometimes it can though be relevant to override this automatic detection if you are + using some custom configuration. For this purposes the <emphasis> + <property moreinfo="none">Server Ports</property> + </emphasis> section in the <property moreinfo="none">Server editor</property> is provided where the + port settings are configurable. Click the <emphasis> + <property moreinfo="none">Configure...</property> + </emphasis> link to bring up the wizard for adjusting the settings for the + ports.</para> + + <figure float="0"> + <title>Server Ports Preferences</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Press <emphasis> + <property moreinfo="none">Edit XPath</property> + </emphasis> button for the chosen port to configure its XPath's values.</para> + + <figure float="0"> + <title>XPath Pattern for a Server Port</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The settings related to <emphasis> + <property moreinfo="none">Publishing</property> + </emphasis>, <emphasis> + <property moreinfo="none">Timeouts</property> + </emphasis> or <emphasis> + <property moreinfo="none">Server Polling</property> + </emphasis> can be also adjusted in the <property moreinfo="none">Server editor</property>.</para> + + <para id="com_line_arg"><property moreinfo="none">Server editor</property> makes it also possible to + modify the server's launch configuration. It's just after clicking <emphasis> + <property moreinfo="none">Open launch configuration</property> + </emphasis> link. In the open window there are the tabs for setting command line + arguments and other things that are relevant to launching the server.</para> + + <figure float="0"> + <title>Launch Configuration Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Look up <ulink url="http://docs.jboss.org/jbossas/guides/installguide/r1/en/html/st... to find parameters which can be specified for <property moreinfo="none">JBoss + Server</property>.</para> + </section> + + <section> + <title>Relevant Resources Links</title> + <para>Find more about XPath in the <ulink url="http://www.w3.org/TR/xpath20/">XPath + Documentation</ulink>.</para> + </section> + </section> + + <section id="Project_archivesView" > + <title>Project Archives View</title> + <para>Every application, whether Plain Old Java, J2EE, or some other language altogether, + needs to be packaged in some way. In Java-related projects, many people use ANT. </para> + <note> + <title>Note:</title> + <para>Those who use ANT will appreciate how the Project Archives Ant task is now + improved: it supports variables and gives more informative error/logging messages + when something goes wrong.</para> + </note> + + <para>But <property moreinfo="none">JBoss Tools</property> come with our own Archives tool with a bit easier + and less-verbose XML and a handy user interface. The Project Archives plugin consists + primarily of a view, that is <property moreinfo="none">Project Archives view</property>, to set up each + packaging configuration.</para> + <para>So far, let's look through all functionality that the <property moreinfo="none">Project + Archives view</property> provides.</para> + + <section id="archives_overview"> + <title>Overview</title> + + <para>The packaging configuration for each project is stored in the project's root + folder, and is in a file named <emphasis> + <property moreinfo="none">.packages</property> + </emphasis>, which has a fairly simple XML structure. Modifying the file by hand is + neither required nor recommended, and using the UI is the official way of modifying + your packaging structure.</para> + + <figure float="0"> + <title>Archives View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_21.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>A project's configuration contains archives. As you can see on the image + above a project can contain more than one archive. Internal archives and filesets + can be directly inside of an archive, or in some sub-folder of that archive.</para> + + <para>In the upper right corner of the view you can see an icon which, when clicked, + will build the selected top-level archive. Additionally, you can select <emphasis> + <property moreinfo="none">Project &gt; Build Packages</property> + </emphasis> when a project is selected in the <property moreinfo="none">Packages View</property> to + build all declared packages in that project's <emphasis> + <property moreinfo="none">.packages</property> + </emphasis> file. This will execute a full build on all declared archives.</para> + </section> + + <section id="Creating_Archive"> + <title>Creating an Archive</title> + + <para>When you open the <property moreinfo="none">Project archives view</property> for the first time, + it asks you to select the project for what you want to create an archive.</para> + + <figure float="0"> + <title>Archives View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_21a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>When creating a new archive for selected project, you have some different options + at your disposal. You need right-click inside the view and select <emphasis> + <property moreinfo="none">New Archive</property> + </emphasis> to see your archive type options.</para> + + <figure float="0"> + <title>Create an Archive</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_22.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para>If you see only JAR from the list of available archive types, you should + verify whether AS Tools plugins/features are in place. EAR, EJB JAR and WAR + options are contributed by the AS Tools independently from webtools and the + virtual project model. Thus, without them only JAR will show up.</para> + </note> + + <para><property moreinfo="none">JAR</property> is the standard archive type, and does very little + configuration, leaving most of the work up to you. You can customize the name, add + folders, filesets, and inner jars to it.</para> + + <para>The other types, for the most part, simply start off with a default setting, + usually the jar with some specific children based on an expected structure of the + project. For example, if the project is a Dynamic Web Project, and you create a + <property moreinfo="none">WAR</property> archive, the archive will be created with a few + filesets relevant to the known structure of the project.</para> + + <para>Here is the first page of all New archive wizards. It is the same for any archive + type and the only page in the <property moreinfo="none">New Jar wizard</property>.</para> + <figure float="0"> + <title>New WAR Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_23.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The page is pretty simple. First it asks to set the name of your new archive and a + destination.</para> + + <para>The destination of an archive can be anywhere on the file system, anywhere in the + workspace, inside some other archive, or inside a folder declared inside an archive. + Select the necessary checkbox (either <emphasis> + <property moreinfo="none">workspace</property> + </emphasis> or <emphasis> + <property moreinfo="none"> file system</property> + </emphasis>) for marking the destination as related to either workspace or file + system. You can browse to workspace or filesystem destinations by clicking on their + respective buttons. To select a destination inside some other archive, you'll need + to press the <emphasis> + <property moreinfo="none">Workspace</property> + </emphasis> button. At the bottom of the list, you'll see archives that + have been declared in the workspace.</para> + + <figure float="0"> + <title>Selecting the destination in the workspace</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_23a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Also in the wizard for creating a new archive you can choose whether an archive to + be compressed or exploded into a folder (without compression). You need just select + proper chechbox in the <emphasis> + <property moreinfo="none">Archive type</property> + </emphasis> section.</para> + <para>If a build or incremental update fails Project Archives will show an error + dialog:</para> + <figure float="0"> + <title>Selecting the destination in the workspace</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/projectarchives_error.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click in <emphasis> + <property moreinfo="none">Details</property> + </emphasis> to see detailed information about what caused the error.</para> + + <para>In the <property moreinfo="none">Package Explorer</property> you can observe the created + archive.</para> + <figure float="0"> + <title>The Archive in the Package Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_23b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>If you use the exploded type of archiving, instead of a single file archive the + result put into a folder is displayed in the <property moreinfo="none">Package + Explorer</property>.</para> + <figure float="0"> + <title>The Exploded Archive in the Package Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_23c.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <section id="CreatingaFolder"> + <title>Creating a Folder</title> + <para>Creating a folder is much easier. You simply right-click on an archive or + folder you want your new folder to be a child under. The only piece of required + information is naming the file.</para> + </section> + <section id="CreatingaFileSet"> + <title>Creating a FileSet</title> + <para>To create a new fileset, you click on an available target location such as an + archive, a nested archive, or a folder within an archive, and select <emphasis> + <property moreinfo="none">New Fileset</property>. </emphasis></para> + <para>The <property moreinfo="none">New Fileset wizard</property> requires a destination (where the + files will go), and a root directory (or where the files are coming from). The + source can be anywhere in the workspace or from the filesystem at large.</para> + + <figure float="0"> + <title>Adding a New FileSet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_24.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Below that, the fileset requires only an includes pattern and an excludes + pattern. As you type in either of these fields, the preview viewer should update + itself with which files are matched.</para> + + <para>You can create a Fileset with flattenning or without it. Look at the + difference on the figure below.</para> + + <figure float="0"> + <title>The FileSet with flattenning and without it</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_24a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + </section> + + <section id="View_Actions"> + <title>Archive Actions</title> + <figure float="0"> + <title>Context Menu on the Item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_25.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The context menu on the items in the view is extendable, but there are several + that come standard.</para> + + <table> + <title>Context Menu on the Item</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec colnum="2" colwidth="3*"></colspec> + + + <thead> + <row> + <entry align="center"> + <para>Name</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + + <tbody> + + <row> + <entry> + <para>Build Archive (Full)</para> + </entry> + + <entry> + <para>The action enabled only on top-level archives, which initiates + a full build on that archive</para> + </entry> + </row> + + <row> + <entry> + <para>Edit Archive</para> + </entry> + + <entry> + <para>Standard action that brings up the wizard associated with that + particular node type and allows the details to be changed</para> + </entry> + </row> + + <row> + <entry> + <para>Delete Archive</para> + </entry> + + <entry> + <para>Deleting node is standard action with deletion not needing an + explanation</para> + </entry> + </row> + + <row> + <entry> + <para>Publish To Server</para> + </entry> + + <entry> + <para>The action means the ability to publish to a declared + server</para> + </entry> + </row> + + <row> + <entry> + <para>Edit publish settings</para> + </entry> + + <entry> + <para>Gives possibility to edit an archive publish settings</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + </section> + + <section id="PublishToServer"> + <title>Publishing to Server</title> + <para>Finally, you'll need to publish your application to a server. Here, we + show you how to do it with the help of <emphasis> + <property moreinfo="none">Archives View</property>. </emphasis></para> + + <figure float="0"> + <title>Context Menu on the Item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_26.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The dialog above appears after selecting <emphasis> + <property moreinfo="none">Publish To Server</property>. </emphasis> To simply publish once, you + just select the server(s) that you want, and finish. If you want the <emphasis> + <property moreinfo="none">Publish to Server</property> + </emphasis> action on that particular Archive to publish always to that set of + servers, then check the appropriate checkbox. And finally, to enable automatic + publishing upon build events, check the last checkbox.</para> + <para>The automatic publishing feature is nice if, for example, your package's + destination (where it is built) is a temporary folder and you want the archive + published to several servers. If you only really want your archive published to one + server, it might be easier to have the archive's destination folder be the deploy + folder of the server.</para> + </section> + <section id="rel_res_links_archiving"> + <title>Relevant Resources Links</title> + <para>Refer to <ulink url="http://ant.apache.org/manual/index.html">Ant manual</ulink> + to find more on how to build your applications with help of Ant.</para> + + <para>We also recommend you to watch the <ulink url="http://docs.jboss.org/tools/movies/demos/archiving/archiving.ht... which demonstrates a powerful archiving functionality in + <property moreinfo="none">JBoss Tools</property>.</para> + + <para>At this point, you are guessed to be familiar with <property moreinfo="none">JBoss AS + perspective</property> and your next step now is to explore how to work with + different kinds of projects.</para> + </section> + + </section> + + +</chapter> + + +<chapter id="webtools" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/as/docs/reference/en/modules/webtools.xml"> + <title>Projects</title> + <para>The most popular of the projects we deal with are the J2EE ones, such as Dynamic Web + Project, EJB Project, or EAR project. Web projects of <property moreinfo="none">JBoss Tools</property> are + Struts, JSF and Seam projects. All of them are called faceted projects. Thus, in this + chapter we are going to tell you about facets the main benefit of which to provide proper + structuring and packaging for any type of project.</para> + + <section> + <title>Faceted Projects Overview</title> + <para>The idea behind faceted projects is that each project can accept units of + functionality, or facets, which can be added or removed by the user. Most often, these + facets either add to the project's classpath, enable a builder, or watch the project in + some other fashion. Generally, every project concerned has at least one facet when + it's created. As an example, a Web project has a WebDoclet facet, or an EJB + Project has an EJB Module facet as prerequisites.</para> + + <para> WTP projects have undergone some criticism as being + <emphasis>over-engineered</emphasis> or too restrictive in their design. WTP projects + are set up in a tree-relationship to each other, where one project can be a child of + another. For example, an EAR project may have a Web Project child, an EJB project child, + or other types.</para> + + <para> However, the benefit of this is that the structure of your projects is then known, + and packaging it up *should* be trivial. Apparently, if your project is non-standard, or + you feel too confined by such rigid structural requirements, you can still choose to + package your project using the <link linkend="Project_archivesView">Archives + plugin</link>.</para> + </section> + + + <section> + <title>Adding Facets to a Project</title> + + <para>In this section we're going to consider the facets added by <property moreinfo="none">JBoss + Tools</property> and show how you can configure them in a project: add new ones or + modify already existing configuration of the facets.</para> + + <para>One way to configure the facets is doing it while organizing a new project. To + demonstrate this let's create a new <property moreinfo="none">Dynamic Web Project</property> by + selecting <emphasis> + <property moreinfo="none">File &gt; New &gt; Other...</property> + </emphasis> and then <emphasis> + <property moreinfo="none">Web &gt; Dynamic Web Project</property>. </emphasis></para> + <figure float="0"> + <title>New Dynamic Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/webtools/webtools_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click <emphasis> + <property moreinfo="none">Next</property> + </emphasis> and you will see Dynamic Web Project page like on the figure below.</para> + + <para> The first page of most WTP projects allows you to target a specific runtime, + representing a server's library location. It will also provide you the ability to add + this project to an EAR project, and select a pre-selected default set of facets, called + a configuration, rather than manually select each facet you might want.</para> + <para> Selecting the runtime, again, allows the project to install the proper classpaths to + the project so it knows what code to compile against.</para> + + <figure float="0" id="dyn_web_project"> + <title>New Dynamic Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/webtools/webtools_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click on the <emphasis> + <property moreinfo="none">Modify</property> + </emphasis> button next to <property moreinfo="none">Configuration</property> section in order to open + the wizard which allows you to modify a chosen configuration. The wizard looks as + follows.</para> + + <figure float="0" id="project_facets"> + <title>Project Facets Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/webtools/webtools_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Here part of the listed facets are those which are provided by WTP. Some of them are + added by <property moreinfo="none">JBoss Tools</property>. They are:</para> + <itemizedlist> + <listitem> + <para>BIRT Charting Runtime Component</para> + </listitem> + <listitem> + <para>BIRT Reporting Runtime Component</para> + </listitem> + <listitem> + <para>JBoss ESB</para> + </listitem> + <listitem> + <para>JBoss Portlets</para> + </listitem> + <listitem> + <para>JBoss Web Services</para> + </listitem> + <listitem> + <para>Seam</para> + </listitem> + </itemizedlist> + + <para>On this wizard page you can enable or disable any facet as well as change it version. + What you should note here is that some facets or facets versions may conflict with each + other. In case of incompatibility you'll be prompted about this in the combo + box underneath.</para> + <figure float="0"> + <title>Facet Constraints</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/webtools/webtools_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>When switching on the <emphasis> + <property moreinfo="none">Runtimes</property> + </emphasis> tab on the right you'll see the current server Runtime.</para> + <figure float="0"> + <title>Runtimes on the Project Facets Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/webtools/webtools_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>On this tab you can also create a new Server Runtime and make it primary by pressing <emphasis> + <property moreinfo="none">Make Primary</property> + </emphasis> button after enabling it.</para> + + <para>Clicking on <emphasis> + <property moreinfo="none">OK</property> + </emphasis> will save the chosen configuration of the facets and return you to the <link linkend="dyn_web_project">Dynamic Web Project wizard</link>. Further pages in the + wizard are specific to either the project type or the facets selected.</para> + + + <para>If you need to configure the facets for the existing project, you should bring up the + context menu for selected project and click <emphasis> + <property moreinfo="none">Properties</property> + </emphasis> and then <emphasis> + <property moreinfo="none">Project Facets</property>. </emphasis> This will bring up the familiar + <link linkend="project_facets">Project Facets wizard</link>, where you can create + your own custom facets configuration.</para> + + <para></para> + + </section> + <section id="rel_resources_links"> + <title>Relevant Resources Links</title> + + <para>More on the WTP facets you can read in the <ulink url="http://help.eclipse.org/ganymede/index.jsp?topic=/org.eclipse.j... help</ulink>.</para> + </section> +</chapter> + + +<chapter id="modules" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/as/docs/reference/en/modules/modules.xml"> + <title>Deploying Modules</title> + + <para>In this chapter it will be described how to deploy modules onto the server.</para> + <para> First of all it is necessary to say that deploying to a server is mostly painless. There + are several ways to do it provided by WTP, and some additional methods provided by JBoss + Tools. These methods are described further in this chapter.</para> + + <section> + <title>Deploying on the Package Explorer</title> + + <para>On the package explorer it is possible to publish either a project to a server or just + a signal file. Let's look at how to do this.</para> + <section id="run_on_server_wizard"> + <title>Deploying with Run On Server Wizard</title> + <para> The first WTP method is to right-click on a project, such as a Dynamic Web + project, EJB project, or EAR project and then select <emphasis> + <property moreinfo="none">Run As &gt; Run on Server</property> + </emphasis>. The resulting dialog allows you to select which supporting server the + project can be published to.</para> + <figure float="0"> + <title>Define a New Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click <emphasis> + <property moreinfo="none">Next</property> + </emphasis> button to see add or remove projects page where you can choose projects + to configure them on server.</para> + <figure float="0" id="add_rem_proj"> + <title>Add or Remove Projects</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>This page of the wizard also allows to undeploy modules from the server. For that + choose proper module(s) from the right and click <emphasis> + <property moreinfo="none"> &lt; Remove</property> + </emphasis>. The modules will be completely undeployed after restarting your server + or republishing.</para> + <para>Generally, for the JBoss AS Server Adapters, publishing using this method will + force a default, best-guess, packaging configuration for your project. This + best-guess does not publish incrementally, but instead repackages your entire + project into a <emphasis> + <property moreinfo="none">.war</property> + </emphasis>, <emphasis> + <property moreinfo="none">.jar</property> + </emphasis>, or <emphasis> + <property moreinfo="none">.ear</property> + </emphasis> as appropriate, and then copies that file into the proper deploy + directory. For quicker smarter deployment, you will need to create archives using + the <link linkend="Project_archivesView">Project Archives view</link> and customize + packaging yourself.</para> + </section> + + <section id="single_file_deployment"> + <?dbhtml filename="DeployToServer.html"?> + <title>Deploying single files</title> + + <para>Sometimes it becomes necessary to deploy one or more files to a server. For + that in order not to do a full republish in the context menu of files a <emphasis><property moreinfo="none">Deploy To Server</property></emphasis> + option is provided that allows a single file deployment. To deploy these non-WTP files/projects + right click on the file (<emphasis> + <property moreinfo="none">-ds.xml</property></emphasis>, <emphasis> + <property moreinfo="none">.ear</property></emphasis>, <emphasis> + <property moreinfo="none">.jar</property></emphasis> etc.) and select <emphasis> + <property moreinfo="none">Deploy To Server</property> + </emphasis> and it will be automatically deployed.</para> + <figure float="0"> + <title>Deploy to Sever</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The deployed files are listed side-by-side with other modules that are deployed to + the server.</para> + + <figure float="0"> + <title>Deployed files on the Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + </section> + <section> + <title>Deploying with JBoss Server View</title> + <para>As it has been already mentioned <property moreinfo="none">JBoss Server View</property> contains two + parts: the top part that displays all defined servers and the bottom part which provides + categories with additional information. Thus, in this section we suggest two more ways + to deploy resources onto the server.</para> + <section> + <title>Top part of JBoss Server View</title> + <para>In the top part of the <property moreinfo="none">JBoss Servers View</property> like in the Servers + View you should right click on a server and select the <emphasis> + <property moreinfo="none">Add and Remove Projects</property> + </emphasis> menu item.</para> + <figure float="0"> + <title>Add and Remove Projects</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>This will bring up a <link linkend="add_rem_proj">familiar dialog</link> allowing + you to either publish projects or modules to a server, or remove them from the + server. If the selected module is a project like a Dynamic Web project, EJB project, + or EAR project, it will be published as through <emphasis> + <property moreinfo="none">Run on Server</property> + </emphasis> wizard, with a best-guess full package. If, however, the selected + element is an archive from the <link linkend="Project_archivesView">Project Archives + view</link>, it will be published according to the rules of that module + type.</para> + </section> + + <section> + <title>Bottom part of JBoss Server View</title> + <para>In the bottom part of <emphasis> + <property moreinfo="none">JBoss Server View</property> + </emphasis> there is a category called <emphasis> + <property moreinfo="none">Modules</property> + </emphasis> which should display all currently-published modules on the server. + Right-clicking on the desired module and selecting <emphasis> + <property moreinfo="none">Full Publish</property> + </emphasis> will force a full rebuild of the entire module.</para> + <figure float="0"> + <title>Full Publish</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Here, <emphasis> + <property moreinfo="none">Incremental Publish</property> + </emphasis> is meant to enable publishing of only those parts where changes have + been made.</para> + </section> + </section> + <section> + <title>Deploying with Project Archives View</title> + <para>In the <property moreinfo="none">Project Archives View</property> you can right-click on any declared + archive and select the <emphasis> + <property moreinfo="none">Publish To Server</property> + </emphasis> element. For more on this subject, see <link linkend="PublishToServer">Publishing to Server</link> in the Project Archives View section.</para> + <figure float="0"> + <title>Publish to Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para> The only way to ensure an <emphasis> + <property moreinfo="none">Incremental Build</property> + </emphasis>, such as changes to one <emphasis> + <property moreinfo="none">.jsp</property>, </emphasis> + <emphasis> + <property moreinfo="none">.html</property>, </emphasis> or <emphasis> + <property moreinfo="none">.class</property> + </emphasis> file, is to enable the builder for that project. This is done by either + changing the global preferences for the <property moreinfo="none">Archives View</property>, or by + enabling project-specific preferences and ensuring the builder is on.</para> + <para>The last chapter covers a variety of methods on how you can deploy needed modules onto a + server.</para> + </section> +</chapter> + + +<chapter id="tptp_support" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/as/docs/reference/en/modules/tptp_support.xml"> + <title>TPTP Support</title> + <para>This chapter provides an overview on how to enable TPTP Profiling for <property moreinfo="none">JBoss + AS</property> adapters in <property moreinfo="none">JBoss Tools</property>.</para> + + <section> + <title>TPTP Profiling</title> + + <para>To get TPTP profiling work on <property moreinfo="none">JBoss Application Server</property> you should + first download <ulink url="http://www.eclipse.org/downloads/download.php?file=/tptp/4.5.0/... 4.5.0 Runtime</ulink> and install it, i. e. just add the content of <emphasis> + <property moreinfo="none">plugins/features</property> + </emphasis> folders from downloaded directory to the same folders in your eclipse + installation directory.</para> + + <para>And now all profile actions should work for you. To start <property moreinfo="none">JBoss + AS</property> in profiling mode use <emphasis> + <property moreinfo="none">Start the server in profiling mode</property> + </emphasis> button or <emphasis> + <property moreinfo="none">Profile As &gt; Profile on Server</property> + </emphasis> option in the context menu of the project.</para> + + <figure float="0"> + <title>Start the Server in Profiling mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/tptp_support/tptp_support_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>To enable TPTP features in your workbench use <property moreinfo="none">Profiling and Logging + Perspective</property> that you can find in the list of proposed perspectives: <emphasis> + <property moreinfo="none">Window &gt; Open Perspective &gt; Other…</property> + </emphasis> + </para> + + <figure float="0"> + <title>Profiling and Logging Perspective</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/tptp_support/tptp_support_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section> + <title>Relevant Resources Links</title> + <para>All additional information on TPTP(Test and Performance Tools Platform) you can find + in <ulink url="http://www.eclipse.org/tptp/home/downloads/4.5.0/documents/quic... documentation</ulink>.</para> + <para>In summary, this reference should help you to start with <ulink url="http://www.jboss.org/jbossas">JBoss AS</ulink> and get to know with functionality + for work with it.</para> + </section> +</chapter> + + +</book> Added: branches/jbosstools-3.0.x/documentation/guides/Exadel-migration/en/master_output.xml =================================================================== --- branches/jbosstools-3.0.x/documentation/guides/Exadel-migration/en/master_output.xml (rev 0) +++ branches/jbosstools-3.0.x/documentation/guides/Exadel-migration/en/master_output.xml 2009-03-06 18:46:29 UTC (rev 14086) @@ -0,0 +1,422 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + +[<!ENTITY jsf_struts SYSTEM "modules/jsf_struts.xml"> +<!ENTITY jsf_struts_war SYSTEM "modules/jsf_struts_war.xml"> +<!ENTITY introduction SYSTEM "modules/introduction.xml"> +<!ENTITY workspace SYSTEM "modules/workspace.xml"> + +<!ENTITY seamlink "../../seam/html_single/index.html"> +<!ENTITY aslink "../../as/html_single/index.html"> +<!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> +<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html"> +<!ENTITY jbpmlink "../../jbpm/html_single/index.html"> +<!ENTITY jsflink "../../jsf/html_single/index.html"> +<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html"> +<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html"> +<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html"> +<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> +<!ENTITY migrationlink "../../Exadel-migration/html_single/index.html"> + +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + <bookinfo> + <title>Exadel Studio Migration Guide</title> + + <pubdate>April 2008</pubdate> + <copyright> + <year>2007</year> + <year>2009</year> + <holder>JBoss, a division of Red Hat</holder> + </copyright> + <releaseinfo> +Version: 2.0.0.GA +</releaseinfo> + +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/Exadel-mig... version</ulink> + </para> +</abstract> + + + </bookinfo> + + <toc></toc> + +<chapter id="introduction" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/documentation/guides/Exadel-migration/en/modules/introduction.xml" xreflabel="introduction"> + <?dbhtml filename="introduction.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>JBDS</keyword> + <keyword>Exadel Studio Pro</keyword> + </keywordset> + </chapterinfo> + + <title>Introduction </title> + <para>This document is intended to help you to migrate an existing Exadel JSF or Struts projects + into <property moreinfo="none">JBoss Developer Studio</property>. Preferences can be exported from Eclipse 3.2.0 (3.2.1 or 3.2.2) and imported in Eclipse 3.3 by the standard Eclipse means. + </para> +<section> + <title>Other relevant resources on the topic</title> + <para>All JBoss Developer Studio/JBoss Tools documentation you can find <ulink url="http://docs.jboss.org/tools">here</ulink>.</pa... + <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">her... + +</section> + + </chapter> + + +<chapter id="workspace" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/documentation/guides/Exadel-migration/en/modules/workspace.xml" xreflabel="workspace"> + <?dbhtml filename="workspace.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>JBDS</keyword> + <keyword>Exadel Studio Pro</keyword> + </keywordset> + </chapterinfo> + + <title>Migrate workspace</title> + <para>You will not be able to run projects in JBoss Developer Studio + using <property moreinfo="none">Exadel Studio workspace</property>. In this case, project capabilities and settings specified in Exadel Studio will be lost. The simplest way to avoid this, is to copy your projects in <property moreinfo="none">JBoss Developer Studio workspace</property> and make an import as it is described in the following chapters.</para> +</chapter> + + +<chapter id="jsf_struts" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/documentation/guides/Exadel-migration/en/modules/jsf_struts.xml" xreflabel="jsf_struts"> + <?dbhtml filename="jsf_struts.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>JBDS</keyword> + <keyword>Exadel Studio Pro</keyword> + <keyword>Migration</keyword> + </keywordset> + </chapterinfo> + + <title>Migration of JSF and Struts Projects</title> + <para>In this chapter you can find concise description of migration of JSF and Struts Projects.</para> + <section id="import_jsf"> + <title>JSF</title> + <para>JBoss Developer Studio includes an Import <property moreinfo="none">JSF Project</property> Wizard that radically simplifies the process of bringing your existing JSF applications + into your JBoss Developer Studio workspace as JSF projects. You just need to follow these four steps:</para> + <itemizedlist> + <listitem><para><emphasis><property moreinfo="none">Select File &gt; Import...</property></emphasis> from the menu bar, and then select <emphasis><property moreinfo="none">Other &gt; JSF Project </property></emphasis>from the Import dialog box that appears.</para></listitem> + </itemizedlist> + + <figure float="0"> + <title>Selecting the Import Menu Item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts/migration_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <figure float="0"> + <title>Selecting the Import JSF Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts/migration_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem><para>In the first screen of the wizard, select the <emphasis><property moreinfo="none">Change...</property></emphasis> button next to the <emphasis><property moreinfo="none">web.xml Location</property></emphasis> field. Browse to the location of the web.xml file for the application you + want to import as a <property moreinfo="none">JSF project</property>. Once you select it, you'll be returned to the dialog box to see a project name derived from the web.xml file you selected. + You can edit this project name, if you wish.</para></listitem> + </itemizedlist> + + <figure float="0"> + <title>Selecting the Web.xml File in the Project Location Screen</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts/migration_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist id="import_jsf_screen"> + <listitem><para>In the <emphasis><property moreinfo="none">Project Folders</property></emphasis> screen, you can configure the rest of your project. Afterwards click on the <emphasis><property moreinfo="none">Finish</property></emphasis> button.</para></listitem> + </itemizedlist> + <para>On this step JBoss Developer Studio will try to determine your project + structure and set the values for: <emphasis><property moreinfo="none">Web Root</property></emphasis>, <emphasis><property moreinfo="none">Source Folder</property></emphasis>, <emphasis><property moreinfo="none">Classes Folder</property></emphasis>, <emphasis><property moreinfo="none">Lib Folder</property></emphasis>. If your project has a custom structure, some values might not be + set. If this is the case, you can manually set those values by clicking the <emphasis><property moreinfo="none">Change...</property></emphasis> button.</para> + <para>After dealing with these settings, you have to work through a few more configuration settings. These settings deal primarily with how the project will be deployed within JBoss Developer Studio.</para> + <para>First, if the project you are importing is not already a JSF project, select the <emphasis><property moreinfo="none">Add Libraries</property></emphasis> check box to add all the JSF-related libraries to your project. </para> + <para>Then, you may select the JavaServer Faces implementation (<emphasis><property moreinfo="none">Environment</property></emphasis>) and <emphasis><property moreinfo="none">Servlet Version</property></emphasis>.</para> + <para>The <emphasis><property moreinfo="none">Context Path</property></emphasis> is the name under which the application will be deployed. </para> + <para>The <emphasis><property moreinfo="none">Runtime</property></emphasis> value tells Eclipse where to find Web libraries in order to build the project. It is not possible to finish the importing of a project without selecting a Runtime. If you don't have any choices displayed for this, select <emphasis><property moreinfo="none">New...</property></emphasis> to add a new Runtime.</para> + <para>Finally, <emphasis><property moreinfo="none">Target Server</property></emphasis> sets the server to deploy the application under. The Target Server corresponds to the Runtime value selected above. If you don't want to deploy the application, uncheck this value.</para> + + + <figure float="0"> + <title>The Project Folders Screen</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts/migration_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem><para>Once the project is imported, it will appear in the Package Explorer view.</para></listitem> + </itemizedlist> + + <figure float="0"> + <title>Imported Project in the Package Explorer View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts/migration_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + <section> + <title>Struts</title> + <itemizedlist> + <listitem><para><emphasis><property moreinfo="none">Select File &gt; Import...</property></emphasis> from the menu bar, and then select <emphasis><property moreinfo="none">Other &gt; Struts Project</property></emphasis> from the Import dialog box that appears.</para></listitem> + </itemizedlist> + + <figure float="0"> + <title>Selecting the Import Menu Item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts/migration_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <figure float="0"> + <title>Selecting the Import Struts Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts/migration_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem><para>In the Project Location screen of the wizard, select the <emphasis><property moreinfo="none">Change... </property></emphasis>button next to the <emphasis><property moreinfo="none">web.xml Location</property></emphasis> field. Browse the location of the web.xml file for the application you + want to import as a <property moreinfo="none">Struts project</property>. Once you select it, you'll be returned to the dialog box to see a project name derived from the web.xml file you selected. + You can edit this project name, if you wish.</para></listitem> + </itemizedlist> + + <figure float="0"> + <title>The Project Location Screen</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts/migration_10.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem><para>In the next screen, JBoss Developer Studio will try to determine your project structure. The upper pane shows the modules in this project. + The lower pane allows you to edit the details of the select module. If the project structure is non-standard, some values might be left blank. + You can edit any values by hand or by using the <emphasis><property moreinfo="none">Change...</property></emphasis> button.</para></listitem> + </itemizedlist> + + <figure float="0"> + <title>The Project Modules Screen</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts/migration_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem><para>In the <emphasis><property moreinfo="none">Project Folders</property></emphasis> screen, you can configure the rest of your project. Afterwards click on the <emphasis><property moreinfo="none">Finish</property></emphasis> button.</para> + </listitem> + </itemizedlist> + <para>On this step JBoss Developer Studio will try to determine your project structure and set the values for: <emphasis><property moreinfo="none">Classes Folder</property></emphasis>, <emphasis><property moreinfo="none">Lib Folder</property></emphasis>, and <emphasis><property moreinfo="none">Ant Build File</property></emphasis>. If your project has a custom structure, some values might not be set. If this is the case, you can manually set those values by clicking <emphasis><property moreinfo="none">Change</property></emphasis>.</para> + <para>After dealing with these settings, you have to work through a few more configuration settings. These settings deal primarily with how the project will be deployed within JBoss Developer Studio.</para> + <para>First, if the project you are importing is not already a Struts project, select the <emphasis><property moreinfo="none">Add Libraries</property></emphasis> check box to add all the Struts-related libraries to your project. </para> + <para>Then, you may select the Struts <emphasis><property moreinfo="none">Environment</property></emphasis> and <emphasis><property moreinfo="none">Servlet Version</property></emphasis>.</para> + <para>The <emphasis><property moreinfo="none">Context Path</property></emphasis> is the name under which the application will be deployed. </para> + <para>The <emphasis><property moreinfo="none">Runtime</property></emphasis> value tells Eclipse where to find Web libraries in order to build the project. It is not possible to finish the importing of a project without selecting a Runtime. If you don't have any choices displayed for this, select<emphasis><property moreinfo="none"> New...</property></emphasis> to add a new Runtime.</para> + <para>Finally, <emphasis><property moreinfo="none">Target Server</property></emphasis> sets the server to deploy the application under. The Target Server corresponds to the Runtime value selected above. If you don't want to deploy the application, uncheck this value.</para> + + + <figure float="0"> + <title>The Project Folders Screen</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts/migration_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem><para>Once the project is imported, it will appear in the Package Explorer view.</para></listitem> + </itemizedlist> + + <figure float="0"> + <title>Imported Project in the Package Explorer View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts/migration_9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> +</chapter> + + +<chapter id="jsf_struts_war" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/documentation/guides/Exadel-migration/en/modules/jsf_struts_war.xml" xreflabel="jsf_struts_war"> + <?dbhtml filename="jsf_struts_war.html"?> + + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + + <keyword>JBDS</keyword> + + <keyword>Exadel Studio Pro</keyword> + </keywordset> + </chapterinfo> + + <title>Migrate JSF and Struts projects from *.war file</title> + <para>After you familiarized oneself with last chapter you can read this chapter. It looks as if you read in last chapter.</para> + <section> + <title>JSF</title> + + <itemizedlist> + <listitem> + <para>Select <emphasis><property moreinfo="none">File &gt; Import...</property></emphasis> from the menu bar, and then select + <emphasis><property moreinfo="none">Other &gt; JSF Project From *.war</property></emphasis> from the Import dialog box that + appears.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Selecting the Import Menu Item</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts_war/migration_war_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <figure float="0"> + <title>Selecting the JSF Project From *.war Import Wizard</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts_war/migration_war_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>In the wizard screen, select the <emphasis><property moreinfo="none">Change...</property></emphasis> button next to + the <emphasis><property moreinfo="none">*.war Location</property></emphasis> field. Browse to the location of the *.war file for + the application you want to import as a JSF project. Once you select + it, you'll be returned to the dialog box to see a project name + derived from the *.war file you selected. You can edit this name, if + you wish.</para> + + <para>Uncheck the <emphasis><property moreinfo="none">Use Default Path</property></emphasis> check box if you want to import + your project outside of the Eclipse workspace. In this case, you would + use <emphasis><property moreinfo="none"> Change... </property></emphasis> button next to the <emphasis><property moreinfo="none">Location</property></emphasis> field to choose a + location.</para> + + <para><emphasis><property moreinfo="none">Context Path</property></emphasis> is the name under which the application will be + deployed.</para> + + <para>The <emphasis><property moreinfo="none">Runtime</property></emphasis> value tells Eclipse where to find Web libraries in + order to build the project. It is not possible to finish project + import without selecting Runtime. If you don't have any options + here, select <emphasis><property moreinfo="none">New...</property></emphasis> to add a new Runtime.</para> + + <para>Finally, <emphasis><property moreinfo="none">Target Server</property></emphasis> sets the server to deploy the application + under. The Target Server corresponds to the Runtime value selected + above. If you don't want to deploy the application, uncheck this + value.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>The JSF Project From *.war Import Wizard</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts_war/migration_war_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Click on the <emphasis><property moreinfo="none">Finish</property></emphasis> button.</para> + </listitem> + </itemizedlist> + </section> + + <section> + <title>Struts</title> + + <itemizedlist> + <listitem> + <para>Select <emphasis><property moreinfo="none">File &gt; Import...</property></emphasis> from the menu bar, and then select + <emphasis><property moreinfo="none">Other &gt; Struts Project From *.war</property></emphasis> from the Import dialog box that + appears.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Selecting the Import Menu Item</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts_war/migration_war_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <figure float="0"> + <title>Selecting the Struts Project From *.war Import Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts_war/migration_war_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Follow the same steps as with the JSF Project From <property moreinfo="none">*.war</property> import + wizard.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>The Struts Project From *.war Import Wizard</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_struts_war/migration_war_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Click on the <emphasis><property moreinfo="none">Finish</property></emphasis> button.</para> + </listitem> + </itemizedlist> + <para>The migration process is completed</para> + </section> +</chapter> + + +</book> Added: branches/jbosstools-3.0.x/documentation/guides/GettingStartedGuide/en/master_output.xml =================================================================== --- branches/jbosstools-3.0.x/documentation/guides/GettingStartedGuide/en/master_output.xml (rev 0) +++ branches/jbosstools-3.0.x/documentation/guides/GettingStartedGuide/en/master_output.xml 2009-03-06 18:46:29 UTC (rev 14086) @@ -0,0 +1,3987 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" +[ +<!ENTITY getting_started SYSTEM "modules/getting_started.xml"> +<!ENTITY manage SYSTEM "modules/manage.xml"> +<!ENTITY first_seam SYSTEM "modules/first_seam.xml"> +<!ENTITY jsp_application SYSTEM "modules/jsp_application.xml"> +<!ENTITY rad_jsf_application SYSTEM "modules/rad_jsf_application.xml"> +<!ENTITY gsg_faq SYSTEM "modules/gsg_faq.xml"> +<!ENTITY further_reading SYSTEM "modules/further_reading.xml"> +<!ENTITY project_examples SYSTEM "modules/project_examples.xml"> + + +<!ENTITY seamlink "../../seam/html_single/index.html"> +<!ENTITY aslink "../../as/html_single/index.html"> +<!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> +<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html"> +<!ENTITY jbpmlink "../../jbpm/html_single/index.html"> +<!ENTITY jsflink "../../jsf/html_single/index.html"> +<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html"> +<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html"> +<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html"> +<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> +<!ENTITY jbossportallink "../../jboss_portal_tools_ref_guide/html_single/index.html"> +<!ENTITY migrationlink "../../Exadel-migration/html_single/index.html"> +<!ENTITY wslink "../../ws_ref_guide/html_single/index.html"> +]> +<book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + <bookinfo> + <title>Getting Started with JBoss Developer Studio</title> + <pubdate>April 2008</pubdate> + <copyright> + <year>2007</year> + <year>2009</year> + <holder>JBoss, a division of Red Hat</holder> + </copyright> + <releaseinfo>Version: 2.0.0.GA</releaseinfo> + <abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/GettingSta... version</ulink> + </para> +</abstract> + + +</bookinfo> + <toc></toc> + + + + +<chapter id="getting_started" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/documentation/guides/GettingStartedGuide/en/modules/getting_started.xml" xreflabel="getting_started"> + <?dbhtml filename="getting_started.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + <title>Getting Started with JBoss Developer Studio</title> + + <section id="intro1"> + <title>What is JBDS?</title> + <para><property moreinfo="none">JBoss Developer Studio</property> is a set of eclipse-based development tools that + are pre-configured for JBoss Enterprise Middleware Platforms and Red Hat Enterprise Linux. + Developers are not required to use <property moreinfo="none">JBoss Developer Studio</property> to develop on + JBoss Enterprise Middleware and/or Red Hat Linux. But, many find these pre-configured tools offer + significant time-savings and value, making them more productive and speeding time to deployment.</para> + <para>This guide covers the first steps to get started working with <property moreinfo="none">JBoss Developer + Studio</property>. You will learn how to install and configure necessary software for your OS + (currently Linux, Microsoft Windows or Mac OSX).</para> + <para>Thus this guide will provide you with detailed info on how to start JDK, JBDS and JBoss + Tools.</para> + </section> + + <section id="ConfigJavaEnvironment"> + <?dbhtml filename="ConfigJavaEnvironment.html"?> + <title>Configuring Your Java Environment</title> + <para>You must have a working installation of JDK 5 before you install <property moreinfo="none">JBoss Developer + Studio</property>. Currently it will only fully work with a 32-bit JVM, not a 64-bit JVM. On a + 64-bit JVM the visual editor fails to launch because of feature of OS architecture. Thus in this + guide we will show you how to install a 32-bit Sun JDK 5.0 on a Linux Platform and Microsoft + Windows Platform.</para> + + <section id="InstallJDK50onLinux"> + <title>Installing and Configuring 32-bit Sun JDK 5.0 on Linux</title> + <para>To install 32-bit Sun JDK 5.0 on Linux and configure it, you should follow the next steps:</para> + <itemizedlist> + <listitem> + <para>Download the <ulink url="http://java.sun.com/javase/downloads/index_jdk5.jsp">Sun JDK 5.0 + (Java 2 Development Kit)</ulink> from Sun's website. Choose "JDK 5.0 Update + &lt;x&gt;" (where "x" is the latest update number) for + download and then select "Red Hat Package Manager in self-extracting" file + for Linux. Read the instructions on Sun's website for installing the JDK.</para> + </listitem> + <listitem> + <para>If you don't want to use SysV service scripts you can install the + "self-extracting file" for Linux instead of choosing the "RPM in + self-extracting" file. In that case you can skip the next step mentioned here. But it + is recommended to use the SysV service scripts for production servers.</para> + </listitem> + <listitem> + <para>Download and install the appropriate -compat RPM from JPackage <ulink url="ftp://jpackage.hmdc.harvard.edu/JPackage/1.7/generic/RPMS.non-f...;. + Please ensure you choose a matching version of the -compat package to the JDK you've + installed.</para> + </listitem> + <listitem> + <para>Create an environment variable that points to the JDK installation directory and call it + JAVA_HOME. Add <emphasis> + <property moreinfo="none">$JAVA_HOME/bin</property> + </emphasis> to the system path to be able to run java from the command line. You can do this + by adding the following lines to the .bashrc file in your home directory.</para> + <programlisting format="linespecific"><![CDATA[#In this example /usr/java/jdk1.5.0_11 is the JDK installation directory. +export JAVA_HOME=/usr/java/jdk1.5.0_11 +export PATH=$PATH:$JAVA_HOME/bin]]></programlisting> + </listitem> + </itemizedlist> + + <note> + <title>Note:</title> + + <para>If you have JDK already installed and added in your system path, you should add + <emphasis>$JAVA_HOME/bin</emphasis> before the old <emphasis>$PATH</emphasis> (not after it) + so that the new version of JDK can be found first, i. e. <emphasis> + <emphasis>export PATH=$JAVA_HOME/bin:$PATH</emphasis> + </emphasis> This way, the machine will pick up the new JVM first. You only need to run + "alternative" as a safe guard for the right JVM. </para> + </note> + + <para>Set this variable for your account doing the installation and also for the user account + that will run the server.</para> + <itemizedlist> + <listitem> + <para>If you have more than one version of JVM installed on your machine, make sure you are + using the JDK 1.5 installation as the default java and javac. You can do this using the + alternatives system. The alternatives system allows different versions of Java from different + sources to co-exist on your system.</para> + </listitem> + </itemizedlist> + <section id="SelectAlternativesforJava"> + <title>Select alternatives for java, javac and java_sdk_1.5.0</title> + <itemizedlist> + <listitem> + <para>As a root user, type the following command at the shell prompt and you should see + something like this:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific"><![CDATA[[root@vsr ~]$ /usr/sbin/alternatives --config java +There are 2 programs that provide 'java'. +Selection Command +----------------------------------------------- + 1 /usr/lib/jvm/jre-1.4.2-gcj/bin/java +*+ 2 /usr/lib/jvm/jre-1.5.0-sun/bin/java +Enter to keep the current selection[+], or type selection number:]]></programlisting> + <para>Make sure the Sun version [jre-1.5.0-sun in this case] is selected (marked with a + '+' in the output), or select it by entering its number as prompted.</para> + <itemizedlist> + <listitem> + <para>Repeat the same for javac and java_sdk_1.5.0.</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific"><![CDATA[[root@vsr ~]$ /usr/sbin/alternatives --config javac +There is 1 program that provides 'javac'. + Selection Command +----------------------------------------------- +*+ 1 /usr/lib/jvm/java-1.5.0-sun/bin/javac +Enter to keep the current selection[+], or type selection number: + +[root@vsr ~]$ /usr/sbin/alternatives --config java_sdk_1.5.0 +There is 1 program that provide 'java_sdk_1.5.0'. + Selection Command +----------------------------------------------- +*+ 1 /usr/lib/jvm/java-1.5.0-sun +Enter to keep the current selection[+], or type selection number:]]></programlisting> + <para>You should verify that java, javac and java_sdk_1.5.0 all point to the same manufacturer + and version.</para> + <note> + <title>Note:</title> + <para>You can always override this step by setting the JAVA_HOME environment variable as + explained in the previous step.</para> + </note> + <itemizedlist> + <listitem> + <para>Make sure that the java executable is in your path and that you are using an appropriate + version. To verify your Java environment, type "java -version" at the shell + prompt and you should see something like this:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific"><![CDATA[[root@vsr ~]$ java -version +java version "1.5.0_11" +Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_11-b03) +Java HotSpot(TM) Client VM (build 1.5.0_11-b03, mixed mode, sharing)]]></programlisting> + </section> + + </section> + <section id="InstallJDK50onWindows"> + <title>Installing and Configuring 32-bit Sun JDK 5.0 on Microsoft Windows</title> + + <para>To install and configure 32-bit Sun JDK 5.0 on Microsoft Windows, follow these steps:</para> + <itemizedlist> + <listitem> + <para>Download the <ulink url="http://java.sun.com/javase/downloads/index_jdk5.jsp">Sun JDK 5.0 + (Java 2 Development Kit)</ulink> from Sun's website. Choose "JDK 5.0 Update + &lt;x&gt;" (where "x" is the latest update number) for + download and then select your Windows Platform options to perform the installation.</para> + </listitem> + <listitem> + <para>Create an environment variable called JAVA_HOME that points to the JDK installation + directory, for example: + <literallayout class="normal" format="linespecific"> + <emphasis>C:\Program Files\Java\jdk1.5.0_11\</emphasis> + </literallayout></para> + </listitem> + </itemizedlist> + + <para>In order to run java from the command line, add the <emphasis>jre\bin</emphasis> directory + to your path, for example:</para> + <para> + <emphasis>C:\Program Files\Java\jdk1.5.0_11\jre\bin</emphasis> + </para> + <para>To do this, open the <emphasis> + <property moreinfo="none">Control Panel</property> + </emphasis> from the <emphasis> + <property moreinfo="none">Start</property> + </emphasis> menu, switch to Classic View if necessary, open the System Control Panel applet (<emphasis> + <property moreinfo="none">System</property> + </emphasis>), select the <emphasis> + <property moreinfo="none">Advanced</property> + </emphasis> Tab, and click on the <emphasis> + <property moreinfo="none">Environment Variables</property> + </emphasis> button.</para> + <para>Now, when 32-bit Sun JDK 5.0 has been successfully installed, we can pass on to the next + step.</para> + </section> + + </section> + + <section id="InstallingJBDS"> + <?dbhtml filename="InstallingRHDS.html"?> + <title>JBoss Developer Studio Installation</title> + + <para>This chapter will provide you with detailed information on how to install <property moreinfo="none">JBoss + Developer Studio</property>.</para> + + <para>JBDS comes with a simple installer, bundled with tested/pre-configured versions of Eclipse, + WTP, JBossEAP, Seam, and SpringIDE. Thus, to start perform the next steps:</para> + + <itemizedlist> + <listitem> + <para>First of all you need the appropriate installation file for your platform from + <ulink url="https://www.redhat.com/apps/store/developers/jboss_developer_st... Hat + website</ulink>.</para> + </listitem> + <listitem> + <para>Then run in console:</para> + <programlisting format="linespecific" role="JAVA"><![CDATA[java -jar jbdevstudio-linux-gtk-2.0.0.GA.jar +]]></programlisting> + </listitem> + <listitem> + <para>Follow the instructions presented by the installation wizard:</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>JBoss Developer Studio Installation Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Provide the installation path</para> + </listitem> + <listitem> + <para>Select Java VM</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Select Java VM</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>By selecting <emphasis> + <property moreinfo="none">Default Java VM</property> + </emphasis> you set default Java VM of your system (to verify your Java environment, type + "java -version" in console).</para> + </tip> + + <para>Selecting <emphasis> + <property moreinfo="none">Specific Java VM</property> + </emphasis> you can provide the path to non-default Java VM.</para> + + <note> + <title>Note:</title> + <para>JBoss Developer Studio needs Java 5 and "gij" isn't available on + every platform.</para> + </note> + + <itemizedlist> + <listitem> + <para>Installation process includes <ulink url="http://www.jboss.com/products/platforms/application">JBoss Enterprise Application + Platform</ulink>. Select <emphasis> + <property moreinfo="none">Yes</property> + </emphasis> to use it in JBoss Developer Studio. This step lets you configure locally available JBoss Application Servers: </para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>JBoss Enterprise Application Platform Installing</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + +<itemizedlist> + <listitem><para>You can fill the list automatically using the <emphasis><property moreinfo="none">Find</property></emphasis> button: click <emphasis><property moreinfo="none">Find</property></emphasis>, select a folder where search of available JBoss Application Servers should be started and click on <emphasis><property moreinfo="none">Ok</property></emphasis>: </para> </listitem> +</itemizedlist> + + <figure float="0"> + <title>Finding Servers in the Selected Directory</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_3_3_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para></para> + + <itemizedlist> + <listitem><para> All available servers in the selected directory will be added to the list with the following information specified: Name, Type, Version and Location. + </para></listitem> + </itemizedlist> + + + <figure float="0"> + <title>List of Servers Added</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_3_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para></para> + + <itemizedlist> + <listitem> <para>You can also add servers one by one using the <emphasis><property moreinfo="none">Add</property></emphasis> button:</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Add Server to be Configured</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_3_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para></para> + +<para>Click on <emphasis><property moreinfo="none">Browse</property></emphasis> and select the server location. Fields Name, Type and Version will be filled in automatically:</para> + + <figure float="0"> + <title>Specify Server Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_3_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para></para> + + + <para>Click on <emphasis><property moreinfo="none">Ok</property></emphasis>. The server is added to the list with the details on its type, version and location.</para> + + + + <para>The <emphasis><property moreinfo="none">Remove</property></emphasis> button will the remove the selected server from the list. If necessary, you can edit the server details clicking on the <emphasis><property moreinfo="none">Edit</property></emphasis> button:</para> + + <figure float="0"> + <title>Edit Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_3_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para></para> + + + + <!-- <note> + <title>Note:</title> + <para>The installer installs JBoss Enterprise Application Platform for running your applications + if you select this option during the installation process. If you want to use a different server + than ours, you can change the setting in JBoss Developer Studio.</para> + </note>--> + + <itemizedlist> + <listitem> + <para>Click <emphasis><property moreinfo="none">Next</property></emphasis>. Check your installation paths and see the components to install. If you'd like to change + something, press the <emphasis> + <property moreinfo="none">Previous</property> + </emphasis> button. Click <emphasis> + <property moreinfo="none">Next</property> + </emphasis> to start installation. </para> + </listitem> + </itemizedlist> + + <para></para> + + <figure float="0"> + <title>Summary Information</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="jbds_jbosstools"> + + <title>JBoss Developer Studio and JBoss Tools</title> + + <para>This section uncovers the points on the differences between <property moreinfo="none">JBoss Developer + Studio</property> and <property moreinfo="none">JBoss Tools</property> and provides the steps on <property moreinfo="none">JBoss + Tools</property> installation as well.</para> + + <section id="WhatDifferenceBetweenJBDSAndJBossTools"> + <title>What is the difference?</title> + + <para><property moreinfo="none">JBoss Tools</property> is what went into our <property moreinfo="none">JBoss Developer + Studio</property> which comes as an easy-to-install Eclipse based IDE fully configured and ready + to run with the bundled <property moreinfo="none">JBoss Enterprise Application Platform</property>.</para> + + <para>In short <property moreinfo="none">JBoss Tools</property> are just a set of Eclipse plugins and + <property moreinfo="none">JBoss Developer Studio</property> adds:</para> + <itemizedlist> + <listitem> + <para>An installer</para> + </listitem> + <listitem> + <para>Eclipse and Web Tools preconfigured</para> + </listitem> + <listitem> + <para>JBoss EAP with JBoss AS and Seam preconfigured</para> + </listitem> + <listitem> + <para>3rd party plugins bundled and configured</para> + </listitem> + <listitem> + <para>Access to RHEL and Red Hat Network</para> + </listitem> + <listitem> + <para>Access to the JBoss/Red Hat supported software</para> + </listitem> + </itemizedlist> + <para> For additional information see <ulink url="http://www.jboss.com/products/devstudio">JBoss.com</... + </section> + + <section id="JBossToolsInstall"> + <title>JBoss Tools Installation</title> + <para>Here, let's consider the installation of the <property moreinfo="none">JBoss Tools</property> + modules.</para> + <para><property moreinfo="none">JBoss Tools</property> is an umbrella project for the JBoss developed plugins + that will make it into <property moreinfo="none">JBoss Developer Studio</property>. The JBoss Tools modules are:</para> + <itemizedlist> + <listitem> + <para>JBoss AS Tools</para> + </listitem> + <listitem> + <para>Seam Tools</para> + </listitem> + <listitem> + <para>Hibernate Tools</para> + </listitem> + <listitem> + <para>Visual Page Editor</para> + </listitem> + <listitem> + <para>JST Tools</para> + </listitem> + <listitem> + <para>JBPM Tools</para> + </listitem> + </itemizedlist> + + <para>To install the JBoss Tools plugins for Eclipse, you need the following:</para> + + <itemizedlist> + <listitem> + <para>Get Eclipse and Web Tools</para> + </listitem> + </itemizedlist> + <para>The current version of JBoss Tools (3.0.0.GA) targets at Eclipse 3.4.2/Ganymede SR2 and WTP + 3.0.3+</para> + + <tip> + <title>Tip:</title> + <para>We recommend you do not use Eclipse.org update site to go from Eclipse 3.3 to Eclipse 3.4. + Instead we suggest that you download the full binary from <ulink url="http://www.eclipse.org/downloads/">here</ulink>.&... + </tip> + + <para>If you can only use Eclipse 3.3 use <ulink url="http://www.jboss.org/tools/download/index.html#stable">... Tools 2.1.2</ulink>, but + JBoss Tools 2.x will not have any of the new features.</para> + + <note> + <title>Note:</title> + <para>Remember to choose the download that matches your OS and use Java 5 when you run + it.</para> + </note> + + <itemizedlist> + <listitem> + <para>Get the <ulink url="http://download.jboss.org/jbosstools/builds/nightly/latestBuild... JBoss Tools build</ulink></para> + </listitem> + </itemizedlist> + + <para>Some of our newer plugins, like TPTP and BIRT, need additional drivers. On the left side of + the download page you can find all of the required drivers for chosen build and their versions.</para> + <para>Instead of downloading the nightly build version manually, it's also possible to + get the latest release of <property moreinfo="none">JBoss Tools</property> from one of our update sites: <itemizedlist> + <listitem> + <para>Stable Updates: <ulink url="http://download.jboss.org/jbosstools/updates/stable">ht... + </listitem> + <listitem> + <para> Development Updates: <ulink url="http://download.jboss.org/jbosstools/updates/development"&... + </listitem> + </itemizedlist> + </para> + + <itemizedlist> + <listitem> + <para>Finally, install the build</para> + </listitem> + </itemizedlist> + + <para>Unzip the file(s) directly into your Eclipse <emphasis> + <property moreinfo="none">plugins/features</property> + </emphasis> directory and it will be readily available. It might be necessary to start Eclipse + with eclipse -clean to make sure it starts clean and rereads the new list of plugins.</para> + + <para>If you need to install any standalone plug-in from JBoss Tools visit a <ulink url="http://labs.jboss.com/wiki/InstallingJBossTools">JBoss Tools Wiki</ulink> page to read + about dependencies between standalone plug-ins.</para> + </section> + + </section> + + <section id="Welcome"> + <title>Welcome to JBoss Developer Studio</title> + <para>In this section we'll show you how to work with the welcome page of the <property moreinfo="none">JBoss + Developer Studio</property>.</para> + <para>The welcome page is the first page you see when you first launch <property moreinfo="none">JBoss Developer + Studio</property>. </para> + + <figure float="0"> + <title>Welcome to JBoss Developer Studio</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>With the help of its page you will be able:</para> + <itemizedlist> + <listitem> + <para>to get quick access to Getting Started Documentation (guides, tutorials and + viewlets)</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Getting Started Documentation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>to create new Seam projects, jBPM Process, JSF or Struts projects using JBDS + wizards</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Create New...</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>to get short description of perspectives that JBDS offers for more productive + development</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Perspectives</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>to visit JBoss Developer Studio web resources.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Web Resources</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_9.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Start work with <property moreinfo="none">JBoss Developer Studio</property> by clicking on <emphasis> + <property moreinfo="none">Workbench</property> + </emphasis> button or simply close the Welcome page.</para> + + </section> + + <section id="Upgrading"> + <?dbhtml filename="Upgrading.html"?> + <title>Upgrading</title> + <para>To upgrade, just uninstall your current version and install the new one.</para> + </section> + + <section id="Uninstalling"> + <?dbhtml filename="Uninstalling.html"?> + <title>Uninstalling</title> + <itemizedlist> + <listitem> + <para>Make sure <property moreinfo="none">JBoss Developer Studio</property> is not running</para> + </listitem> + <listitem> + <para>Uninstall your current version of <property moreinfo="none">JBoss Developer Studio</property> by running + Uninstaller</para> + </listitem> + </itemizedlist> + </section> + + <section id="Support"> + <?dbhtml filename="Support.html"?> + <title>Support</title> + <para>If you have comments or questions, you can discuss them at our <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... + Developer Studio Forum</ulink>.</para> + <para>When writing to the forum for questions, please include the following information:</para> + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>JBoss Developer Studio version</para> + </listitem> + <listitem> + <para>Exact error message</para> + </listitem> + <listitem> + <para>Steps to reproduce the issue</para> + </listitem> + </orderedlist> + + <para><property moreinfo="none">JBDS</property> subscribers can get necessary support on our <ulink url="https://network.jboss.com/jbossnetwork/login.html">Support Portal</ulink>.</para> + </section> + + + <section id="OtherRelevantResourcesOnTheTopic33"> + <?dbhtml filename="OtherRelevantResourcesOnTheTopic33.html"?> + <title>Other relevant resources on the topic</title> + <para>JBDS on JBoss: <ulink url="http://labs.jboss.com/rhdevstudio/">JBoss Developer + Studio</ulink></para> + <para>Forum: <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... + Forum</ulink></para> + <para>Subscription: <ulink url="https://www.redhat.com/apps/store/developers/jboss_developer_st... + Subscription</ulink></para> + + <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">her... + </section> + +</chapter> + + +<chapter id="manage" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/documentation/guides/GettingStartedGuide/en/modules/manage.xml" xreflabel="manage"> + <?dbhtml filename="manage.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Deploy</keyword> + <keyword>Deployment</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>Manage JBoss AS from JBoss Developer Studio</title> + + <para>In this chapter we'll focus more on how to operate the <property moreinfo="none">JBoss + AS</property> from <property moreinfo="none">JBoss Developer Studio</property>.</para> + <para><property moreinfo="none">JBoss Developer Studio</property> ships with <property moreinfo="none">JBoss EAP + v.4.2</property> bundled. When you followed the default installation of <property moreinfo="none">JBoss + Developer Studio</property>, you should already have a JBoss EAP 4.3 Server installed and + defined. To run JBoss AS you need JDK 1.5, JDK 6 is not formally supported yet, although + you may be able to start the server with it.</para> + + <section id="JBossbundled"> + <?dbhtml filename="JBossbundled.html"?> + <title>How to Manage the JBoss AS Bundled in JBDS</title> + <para>This section covers the basics of working with the <property moreinfo="none">JBoss Server</property> + supported directly by <property moreinfo="none">JBDS</property> via bundled AS plug-in. To read more + about AS plug-in, refer to the <ulink url="../../as/html_single/index.html">Server Manager + guide</ulink>.</para> + + <section id="StartingServer"> + <?dbhtml filename="StartingServer.html"?> + <title>Starting JBoss Server</title> + <para>Starting <property moreinfo="none">JBoss Server</property> is quite simple. <property moreinfo="none">JBoss + Developer Studio</property> allows you to control its behaviour with the help of + a special toolbar, where you could start it in a regular or debug mode, stop it or + restart it.</para> + + <itemizedlist> + <listitem> + <para>To launch the server click the green-with-white-arrow icon on the + <property moreinfo="none">JBoss Server View </property>or right click server name in + this view and select <emphasis> + <property moreinfo="none">Start</property> + </emphasis>. If this view is not open, select <emphasis> + <property moreinfo="none">Window &gt; Show View &gt; Other &gt; Server + &gt; JBoss Server View</property> + </emphasis></para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Starting from Icon</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>While launching, server output is written to the <property moreinfo="none">Console + view</property>:</para> + + <figure float="0"> + <title>Console Output</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>When the server is started you should see <emphasis> + <property moreinfo="none">Started</property> + </emphasis> in the square brackets right next its name in <property moreinfo="none">JBoss Server + View</property>.</para> + + <figure float="0"> + <title>Server is Started</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <!--para>To see event log after the server is started, expand <property>Event + Log</property> branch beneath <property>JBoss Server View</property>:</para> + <figure> + <title>Event Log</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_5.png"/> + </imageobject> + </mediaobject> + </figure--> + </section> + + <section id="StoppingJBoss"> + <?dbhtml filename="StoppingJBoss.html"?> + <title>Stopping JBoss Server</title> + <para>To stop the server, click the <emphasis> + <property moreinfo="none">Stop</property> + </emphasis> icon in <property moreinfo="none">JBoss Server View</property> or right click the server + name and press <emphasis> + <property moreinfo="none">Stop</property>. </emphasis></para> + + <figure float="0"> + <title>Stopping Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>When the server is stopped you will see <emphasis> + <property moreinfo="none">Stopped</property> + </emphasis> in the square brackets next to its name.</para> + </section> + <section id="ServerPreferences"> + <?dbhtml filename="ServerPreferences.html"?> + <title>Server Container Preferences</title> + <para>You can control how <property moreinfo="none">JBoss Developer Studio</property> interacts with + server containers in the <property moreinfo="none">Server editor</property>. Double-click the server + to open it in the editor.</para> + + <figure float="0"> + <title>Server Overview</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Here you can specify some common settings: host name, server name, runtime as well + as settings related to the publishing, timeouts and server ports.</para> + + </section> + </section> + + <section id="JBossInstances"> + <?dbhtml filename="JBossInstances.html"?> + <title>How to Use Your Own JBoss AS Instance with JBDS</title> + <para>Although <property moreinfo="none">JBoss Developer Studio</property> works closely with + <property moreinfo="none">JBoss EAP 4.2</property> we do not ultimately tie you to any particular + server for deployment. There are some servers that Studio supports directly (via the + bundled Eclipse WTP plug-ins). In this section we discuss how to manage self-installed + JBoss AS. Suppose you want to deploy the application to <property moreinfo="none">JBoss 4.2.3 + server</property>. First of all you need to install it.</para> + <section id="JBossInstalling"> + <?dbhtml filename="JBossInstalling.html"?> + <title>JBoss AS Installation</title> + <itemizedlist> + <listitem> + <para>Download the binary package of <property moreinfo="none">JBoss 4.2.3</property> and save + it on your computer: <ulink url="http://labs.jboss.com/jbossas/downloads">http://labs.jb... + </listitem> + </itemizedlist> + <para>It does not matter where on your system you install JBoss server.</para> + + <note> + <title>Note:</title> + <para>The installation of JBoss server into a directory that has a name containing + spaces provokes problems in some situations with Sun-based VMs. Try to avoid + using installation folders that have spaces in their names.</para> + </note> + + <para>There is no requirement for root access to run JBoss Server on UNIX/Linux systems + because none of the default ports are within the 0-1023 privileged port + range.</para> + <itemizedlist> + <listitem> + <para>After you have the binary archive you want to install, use the JDK jar + tool (or any other ZIP extraction tool) to extract the jboss-4.2.3.GA.zip + archive contents into a location of your choice. The jboss-4.2.3.GA.tgz + archive is a gzipped tar file that requires a gnutar compatible tar which + can handle the long pathnames in the archive. The extraction process will + create a jboss-4.2.3.GA directory. </para> + </listitem> + </itemizedlist> + </section> + + <section id="AddingJBossServer"> + <?dbhtml filename="AddingJBossServer.html"?> + <title>Adding and Configuring JBoss Server</title> + <para>Now we should add just installed server into server manager in <property moreinfo="none">JBoss + Developer Studio</property>.</para> + <itemizedlist> + <listitem> + <para>Open the <property moreinfo="none">JBoss Server View</property> by selecting <emphasis> + <property moreinfo="none">Window &gt; Show View &gt; Other &gt; Server + &gt; JBoss Server View</property> + </emphasis></para> + </listitem> + <listitem> + <para>Right click anywhere in this view and select <emphasis> + <property moreinfo="none">New Server</property> + </emphasis></para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">JBoss Community &gt; JBoss 4.2 Server</property> + </emphasis></para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Selecting Server Type</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + + <para>Now in the <property moreinfo="none">New Server wizard</property> there is a separation + between the .org servers (the <emphasis> + <property moreinfo="none">JBoss Community</property> + </emphasis> category) and product server that comes bundled with JBoss EAP (the + <emphasis> + <property moreinfo="none">JBoss Enterprise Middleware</property></emphasis> category).</para> + </note> + + <itemizedlist> + <listitem> + <para>To create a new runtime, which Jboss AS 4.2 matches to, click <emphasis> + <property moreinfo="none">Next</property> + </emphasis></para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para>In the next step make <property moreinfo="none">JBoss Developer Studio</property> to know + where you have installed the Server and define JRE.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Defining JBoss Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_11.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <note> + <title>Note:</title> + <para>When adding a new server you will need to specify what JRE to use. It is + important to set this value to a full JDK, not JRE. Again, you need a full JDK + to run Web applications, JRE will not be enough.</para> + </note> + + <itemizedlist> + <listitem> + <para>In the next dialog verify the specified information and if something is + unfair go back and correct it</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Configuring Projects</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_15.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>In the last wizard's dialog modify the projects that are + configured on the server and click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis>.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Configuring Projects</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_16.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>A new <property moreinfo="none">JBoss Server</property> should now appear in the <property moreinfo="none">JBoss + Server view</property>.</para> + <figure float="0"> + <title>New JBoss Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_17.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Now, we are ready to create the first web application.</para> + </section> + + </section> +</chapter> + + +<chapter id="first_seam" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/documentation/guides/GettingStartedGuide/en/modules/first_seam.xml" xreflabel="first_seam"> + <?dbhtml filename="first_seam.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Seam</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>Write Your First Project with JBoss Developer Studio</title> + + <para>This chapter is a set of hands-on labs. You get step-by-step information about how the JBoss + Developer Studio can be used during the development process.</para> + + <section id="create_seam_application"> + <title>Create a Seam Application</title> + + <para>In this section you get to know how to create a Seam project in JBDS, how to start the + server and what a structure your project has after creating.</para> + + <section id="start_dev_db"> + <title>Start Development Database</title> + + <para>Before opening the JBoss Developer studio you need to <ulink url="http://anonsvn.jboss.org/repos/jbosstools/trunk/documentation/g... and start a Workshop Database.</para> + <para>To start the database just run <property moreinfo="none">./runDBServer.sh</property> or + <property moreinfo="none">runDBServer.bat</property> from the database directory.</para> + <para>The end result should be a console window that looks like:</para> + + <figure float="0"> + <title>Starting DataBase</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="create_deploy_seam"> + <title>Create and deploy Seam Web Project</title> + + <para>Minimize the terminal window and run the <property moreinfo="none">JBoss Developer Studio</property> + from Applications Menu or from the desktop icon.</para> + <para>First of all you get the Workspace Launcher. Change the default workspace location if + it's needed. Click on <property moreinfo="none">Ok</property>. </para> + + <figure float="0"> + <title>Workspace Launcher Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>After startup, you see the welcome page. You could read how to work with welcome pages + in <link linkend="Welcome">previous</link> chapter. Now select <property moreinfo="none">Create + New...</property> icon and then press on <property moreinfo="none">Create Seam Project</property> + link.</para> + + <para>The <property moreinfo="none">New Seam Project wizard</property> is started. You need to enter a name + (e.g., "workshop") and a location directory for your new project. The + wizard has an option for selecting the actual Server (and not just WTP runtime) that will be + used for the project. This allows the wizard to correctly identify where the needed + datasource and driver libraries need to go.</para> + + <figure float="0"> + <title>New Seam Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>All settings are already specified here, you can just modify the Configuration. Click on + the <emphasis> + <property moreinfo="none">Modify...</property> + </emphasis> button to configure your custom facets pattern:</para> + + + <figure float="0" id="ProjectFacetsSpecifyingScreen"> + <title>Project Facets Specifying</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>On the whole the dialog allows to select the "features" you want to use in your project. + Doing this <property moreinfo="none">JBoss Developer Studio</property> setups the appropriate tooling for + your project. Since JBoss Seam integrates all popular Java EE frameworks, you can select any + combination of technologies from the list. Here, for the default configuration, Dynamic Web + Module, Java, JavaServer Faces (JSF), and Seam Facet are already selected for a typical + database-driven web application. The default project facets should suffice.</para> + + <para>In the <property moreinfo="none">Project Facets</property> form you can also bring up server runtimes + panel by clicking <property moreinfo="none"> Runtimes</property> tab on the right corner. This panel shows + available server runtimes.</para> + + <figure float="0"> + <title>Runtimes Selecting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Click on <emphasis> + <property moreinfo="none">Ok</property> + </emphasis> and then <emphasis> + <property moreinfo="none">Next</property> + </emphasis> to proceed further.</para> + + <para>A dynamic web application contains both web pages and Java code. The wizard will ask you + where you want to put those files. You can just leave the default values or choose another + folder.</para> + + <figure float="0"> + <title>Web Module Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>On the next form, you will be able to select where those library JARs come from. The + easiest is just to select the JARs provided by the JBoss AS runtime associated with this + project. That is why it is important to chose the right JBoss AS 4.2 runtime in the project + setup window.</para> + <itemizedlist> + <listitem> + <para>Check <emphasis> + <property moreinfo="none">Server Supplied JSF Implementation</property> + </emphasis>. We will use <ulink url="../../seam/html_single/index.html#addJSFCapab">JSF + implementation</ulink> that comes with JBoss server</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Next</property> + </emphasis></para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>JSF Capabilities Adding</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Next wizard step needs more settings that previous. Let's start with + <property moreinfo="none">General</property> section.</para> + <para>Leave the default Seam runtime and check a WAR deployment.</para> + + <figure float="0"> + <title>Seam Facet Setting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Next <property moreinfo="none">Database</property> section is a little tricky. The <property moreinfo="none">Connection + Profile</property> needs to be edited so that the new project works properly with the + external HSQLDB server. By default the project wizard tries to use the JBoss embedded + HSQLDB, but the tutorial uses an external database to replicate a more real world + development scenario. Click on <property moreinfo="none">Edit</property> to modify the Connection + Profile.</para> + + <figure float="0"> + <title>DataBase Setting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam8_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Select <property moreinfo="none">JDBC Connection Properties</property>. Make sure the URL is set to <emphasis> + <property moreinfo="none">jdbc:hsqldb:hsql://localhost:1701</property> + </emphasis></para> + + <figure float="0"> + <title>JDBC Connection Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Try click on <property moreinfo="none">Test Connection</property> button. It probably won’t work. This + happens if the hsql jdbc driver is not exactly the same. This can be worked around by + modifying the HSQLDB database driver settings. To modify the settings, click the + <property moreinfo="none">“...”</property> next to the drop-down box.</para> + + <para>The proper Driver JAR File should be listed under <property moreinfo="none">Driver File(s)</property>. + Select the hsqldb.jar file found in the database/lib directory and click on + <property moreinfo="none">Ok</property>.</para> + + <figure float="0"> + <title>Driver Details</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam10.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Select <property moreinfo="none">Hypersonic DB</property> and click on <property moreinfo="none">Ok</property>. Again, + this only happens if the selected hsqldb.jar is different from the running database.</para> + + <figure float="0"> + <title>Hypersonic DB Selecting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam11.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Now, the <property moreinfo="none">Test Connection</property> should succeed. After testing the + connection, click on Ok.</para> + + <figure float="0"> + <title>Connection Testing</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam12.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>You can leave the <property moreinfo="none">Code Generation</property> section as is. It refers to Java + packages in which the generated code will be placed.</para> + + <figure float="0"> + <title>Code Generation Setting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam13.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Click on <property moreinfo="none">Finish</property> button. Now, there should be a new Seam project + called “workshop” listed in Package Explorer view.</para> + + <figure float="0"> + <title>"worskhop" Project in the Package Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam14.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="start_JBossAS"> + <title>Start JBoss Application Server</title> + + <para>The complete information on how to manage JBoss AS from JBoss Developer Studio you can + read in a <link linkend="manage">corresponding chapter</link>.</para> + <para>Now you just need to start the server by clicking on green circle/triangle icon in the + JBoss Server View.</para> + + <figure float="0"> + <title>Starting the Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam15.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Then run the project by selecting the project and use <emphasis><property moreinfo="none">Run As... &gt; + Run on Server</property>.</emphasis></para> + + <note> + <title>Note:</title> + <para>If the project does not show up, then you can use a normal browser and use <emphasis> + <property moreinfo="none">http://localhost:8080/workshop/home.seam</property> + </emphasis> as the url.</para> + </note> + + <para>Your project looks like this:</para> + + <figure float="0"> + <title>"workshop" Project Started</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam16.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="workshop_code_overview"> + <title>Workshop Project Code Overview</title> + + <para>Now let's examine the project and its structure. Go back to the Package Explorer view in + JBoss Developer Studio.</para> + + <para>It seems like it's not much for project but this shell application contains a login + screen with default login logic, a menu template that can be further modified, and other + layout templates.</para> + + <para>It's important to note that the business logic will reside in the <emphasis> + <property moreinfo="none">src/hot</property> + </emphasis> folder, by default. And, the package naming conventions that were used in <property moreinfo="none">New Seam + project wizard</property> could have been changed to something different from <emphasis> + <property moreinfo="none">org.domain.workshop.session</property>. + </emphasis> Also, notice that there is a default <property moreinfo="none">Authenticator. java</property> + file. This is where custom security logic can be added. Seam has a nice declarative security + model that we will explore in a bit more detail later on. The <emphasis> + <property moreinfo="none">src/main</property> + </emphasis> folder is a model directory. It stores the project's JPA entity beans.</para> + + <figure float="0"> + <title>Project Structure</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam17.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The view tier of the + application is also important. Seam uses facelets and there is a built-in facelets GUI + editor that has some nice WYSIWYG and component drag/drop functionality. Try this out by + opening <property moreinfo="none">home.xhtml</property> from <property moreinfo="none">WebContent</property> folder.</para> + + <figure float="0"> + <title>Facelets GUI Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam18.png" scale="85"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Notice that the templates reside in the <emphasis> + <property moreinfo="none">WebContent/layout</property> + </emphasis> folder. There is a stylesheet in the <emphasis> + <property moreinfo="none">WebContent/stylesheet</property> + </emphasis> folder. There is also a login and default error page. The Facelet editor will be + explored in more detail later in the lab.</para> + + <para>The project already has a datasource that was created per the Seam project wizard + database settings. And, obviously all of the Seam specific configuration files and JAR + dependencies are included and placed in the proper locations. On last noteworthy line item + is related to the build script. There isn’t a build script because the Eclipse WTP(Web Tools + Project) plugin is used to publish web application changes. As you can see, JBoss Developer + Studio is removing a great deal of complexity from the enterprise Java project + setup/deployment process. The end result is a developer that is writing code, not spending + days/weeks trying to figure out how to get a decent development environment and project + build process.</para> + + </section> + + </section> + + + <section id="seam_action_dev"> + <title>Seam Action Development</title> + + <para>Now, it’s time to write some code. The good news is that JBoss Developer Studio can also + help out in this respect. In this section, we will create a new Seam Action POJO and facelet + with some custom business logic and some GUI changes.</para> + + <section id="create_seam_action"> + <title>Create a New Seam Action</title> + + <para>Go to main menu bar and click on <emphasis> + <property moreinfo="none">File &gt; New &gt; New Seam Action</property> + </emphasis> to start the New Seam Action wizard.</para> + + <para>Specify a <property moreinfo="none">Seam component name</property> (e.g., "myAction"). + The other properties will be auto-completed for you so there is no need to change them. + Click on <property moreinfo="none">Finish</property>.</para> + + <figure float="0"> + <title>New Seam Action Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam19.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Now, open the <property moreinfo="none">MyAction.java</property> file and replace the + "myAction" method with this logic:</para> + + <programlisting format="linespecific"><![CDATA[public void myAction() { +Calendar cal = Calendar.getInstance(); +log.info("myAction.myAction() action called"); +facesMessages.add("MyAction Executed on:" + cal.getTime()); +}]]></programlisting> + + <para>You also need to import the <property moreinfo="none">java.util.Calendar</property> class by clicking + <emphasis><property moreinfo="none">CTRL + Shift + O</property>.</emphasis></para> + + </section> + + <section id="test_seam_action"> + <title>Test Seam Action</title> + + <para>The new action can be tested by browsing the workshop-test project. JBoss Developer + Studio has already created a TestNG test case for you.</para> + + <figure float="0"> + <title>"workshop-test" Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam20.png" scale="85"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The test case simulates a Seam component/method execution for the + <property moreinfo="none">MyAction.myAction()</property> logic.</para> + <para>To run the test case, right click on <property moreinfo="none">MyActionTest.xml</property> and click <emphasis> + <property moreinfo="none">Run As &gt; TestNG Suite</property> + </emphasis> or use the <property moreinfo="none">Run As...</property> toolbar shortcut as shown + below.</para> + + <figure float="0"> + <title>TestNG Running</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam21.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>With any luck, the test case will pass. Look at the TestNG view.</para> + + <figure float="0"> + <title>TestNG Results</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam22.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Now, it’s safe to test the new Seam Action in a web browser. The fastest way to do that + is to right click on <property moreinfo="none">myAction.xhtml</property> and use <emphasis> + <property moreinfo="none">Run As... &gt; Run On Server</property> + </emphasis> which will show the appropriate url in the browser. Alternatively you can + manually enter <emphasis> + <property moreinfo="none">http://localhost:8080/workshop/myAction.seam</property> + </emphasis> into a browser.</para> + + <figure float="0"> + <title>Seam Action in a Web Browser</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam23.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="modify_seam_action"> + <title>Modify Seam Action User Interface</title> + + <para>Browse to <emphasis> + <property moreinfo="none">http://localhost:8080/workshop/myAction.seam</property> + </emphasis> and click on <property moreinfo="none">myAction</property>. This executes the “myAction” method. + This looks pretty good, but we could make this page look a little better.</para> + + <para>Open <emphasis> + <property moreinfo="none">WebContent/myAction.xhtml</property> + </emphasis> in JBoss Developer Studio to use the nice facelets editor.</para> + + <figure float="0"> + <title>Open Seam Action with Editor </title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam24.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Right click on the "myAction!" button in the visual part of editor and + select <property moreinfo="none">&lt;h:commandButton&gt; Attributes</property>.</para> + + <figure float="0"> + <title>Seam Action Editing</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam25.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Change the <property moreinfo="none">value</property> of the button to something different. If desired, + you can change any other text on the page. Then, type <emphasis> + <property moreinfo="none">CTRL + S</property> + </emphasis> to save the facelet.</para> + + <figure float="0"> + <title>Attributes Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam26.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Refresh <emphasis> + <property moreinfo="none">http://localhost:8080/workshop/myAction.seam</property> + </emphasis> and now you should see your changes.</para> + + <para>Notice that you did not have to publish the application. JBoss Developer Studio + auto-published it for you.</para> + + <figure float="0"> + <title>Seam Action Is Modified</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam27.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + + </section> + + <section id="declarative_security"> + <title>Declarative Security</title> + + <para>In this section you will see how it’s easy to secure the facelets and facelet components + in Seam. Let’s go ahead and secure the action button, then we will secure the entire + page.</para> + + <section id="edit_login"> + <title>Edit Login Authentication Logic</title> + + <para>There is a class called <property moreinfo="none">Authenticator.java</property>. The login page will + execute the <property moreinfo="none">Authenticator.authenticate()</property> method by default, so we’ll + start by adding some custom login logic.</para> + <para>Open <property moreinfo="none">Authenticator.java</property> in JBoss Developer Studio and replace the + <property moreinfo="none">authenticate()</property> method with this code:</para> + + <programlisting format="linespecific"><![CDATA[public boolean authenticate() { +if (identity.getUsername().equals("admin") +&& identity.getPassword().equals("password")) { +identity.addRole("admin"); +return true; +} +else +return true; +}]]></programlisting> + + </section> + <section id="secure_seam_page"> + <title>Secure Seam Page Component</title> + + <para>Open <property moreinfo="none">myAction.xhtml</property> and add a new secured command button:</para> + <programlisting format="linespecific"><![CDATA[<h:commandButton id="myActionSecured" +value="Secured Action Button" +action="#{myAction.myAction}" +rendered="#{s:hasRole('admin')}"/>]]></programlisting> + + <para>Refresh <emphasis> + <property moreinfo="none">http://localhost:8080/workshop/myAction.seam</property> + </emphasis> If you are not logged in you will only see one button. If you are logged in, + there will be two buttons.</para> + + + <figure float="0"> + <title>One Button on a Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam28.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The secured button is not visible because the user isn’t logged in as + <property moreinfo="none">"admin"</property>.</para> + + <figure float="0"> + <title>Secured Button is Visible</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam29.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The user is logged in as <property moreinfo="none">"admin"</property>. Securing + components is easy but securing pages is pretty simple as well. </para> + <para>Open <emphasis> + <property moreinfo="none">WebContent/WEB-INF/pages.xml</property> + </emphasis>. Then add this markup directly underneath the &lt;pages&gt; + element:</para> + + <programlisting format="linespecific"><![CDATA[<page view-id="/myAction.xhtml" login-required="true"/>]]></programlisting> + + <para>Refresh <emphasis> + <property moreinfo="none">http://localhost:8080/workshop/myAction.seam</property> + </emphasis> If you are not logged in you will get bounced back to the login page.</para> + + <figure float="0"> + <title>Login Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam30.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Thus, if you enter login credentials for the + <property moreinfo="none">"admin"</property> user, you will be re-directed to the + secured page and secured component. If you enter different login credentials, page access + will be granted, but the secured component will not be displayed.</para> + + <para>Congratulations! You have secured your new action both at the facelet component and page + level. You also added custom authentication logic to the login action.</para> + + </section> + + </section> + + <section id="browsing_workshop_db"> + <title>Browsing Workshop Database</title> + + <para>In this section you get to know how to use the workshop database that was started at the + beginning of the lab.</para> + + <section id="database_connectivity"> + <title>Database Connectivity Setup</title> + + <para>The workshop data can be browsed inside of JBoss Developer Studio.</para> + + <para>To open the Data Source Explorer, click on <emphasis><property moreinfo="none">Window &gt; Open Perspective + &gt; Other &gt; Database Development</property>.</emphasis></para> + <para>In the Data Source Explorer, expand a <property moreinfo="none">Databases</property> node and select a + <property moreinfo="none">Default</property> database. Right click on it, select + <property moreinfo="none">Connect</property> from the context menu.</para> + + <figure float="0"> + <title>Data Source Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam31.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="browsing_workshop_db2"> + <title>Browse Workshop Database</title> + + <para>Then in the current view, drill down to the <property moreinfo="none">CUSTOMERS</property> table.</para> + + <figure float="0"> + <title>"CUSTOMERS" Table</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam32.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Right click on <property moreinfo="none">CUSTOMERS</property>, select <emphasis> + <property moreinfo="none">Data &gt; Sample Contents</property> + </emphasis> to view the data in the table.</para> + + <para>There should be a SQL Results view on the workbench, but it could be hidden. Click on + the <property moreinfo="none">"Result1"</property> tab in the right side and you should + see the data in the CUSTOMERS table.</para> + + + <figure float="0"> + <title>SQL Results View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam33.png" scale="92"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para>If you can’t find the SQL Results view tab, click on <emphasis><property moreinfo="none">Window &gt; Show + View &gt; Other &gt; SQL Development &gt; SQL Results</property>.</emphasis></para> + </note> + + <para>Congratulations! You just connected to the workshop database and queried the content + using Database Explorer tools.</para> + + </section> + + </section> + + <section id="db_programming"> + <title>Database Programming</title> + + <para>Now, it’s time to reverse engineer the workshop database into a fully functioning Seam + CRUD(Create Read Update Delete) application.</para> + + <section id="reverse_engineer_crud"> + <title>Reverse Engineer CRUD from a Running Database</title> + + <para>In <property moreinfo="none">JBoss Developer Studio</property>, switch to <property moreinfo="none">Seam + perspective</property>, and then right-click the project and select + <emphasis><property moreinfo="none">New &gt; Seam Generate Entities</property>.</emphasis></para> + + <para>"workshop" project in the <property moreinfo="none">Seam Generate Entities + wizard</property> will be selected automatically. There is no need to change something + more, click <emphasis> + <property moreinfo="none">Next</property> + </emphasis> to proceed further.</para> + + <figure float="0"> + <title>Generate Seam Entities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam34.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>On the next page use the <emphasis> + <property moreinfo="none">Include</property> + </emphasis> button to include all the tables from the database and click <emphasis> + <property moreinfo="none">Finish</property>.</emphasis></para> + + <figure float="0"> + <title>Selecting Tables</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam34a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>After running the Generate Entities action, you will see new <emphasis> + <property moreinfo="none">org.domain.workshop.entity</property> + </emphasis> classes. These classes represent insert/update/delete/query logic.</para> + + <figure float="0"> + <title>org.domain.workshop.entity Classes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam35.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>There are also <emphasis> + <property moreinfo="none">org.domain.workshop.entity</property> + </emphasis> package that contains the JPA classes. These are the entity beans that are + mapped to database tables.</para> + + <para>Last, but not least, there are facelets for all of the CRUD screens. The best way to get + a feel for the generated code is to open a browser and play around with the application. Go + to <emphasis> + <property moreinfo="none">http://localhost:8080/workshop</property> + </emphasis> and insert/update/delete/query a few records. There is quite a bit of AJAX in + this application, but which we will explore further later on in the lab. For now, take note + of the page tabs, required field logic and data table sorting in the list pages. </para> + + <figure float="0"> + <title>CustomersList.xhtml in the Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam36.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Congratulations! You now have a fully functioning CRUD application that is already AJAX + enabled.</para> + + </section> + + <section id="use_hibernate_tools"> + <title>Use Hibernate Tools to Query Data via JPA</title> + + <para>Now, it's time to write some JPA queries using the Hibernate perspective in + <property moreinfo="none">JBoss Developer Studio</property>.</para> + <para>In the upper right corner of the workbench there is a small icon (see the figure below), + click on it and choose <property moreinfo="none">Hibernate</property>.</para> + + <figure float="0"> + <title>Hibernate Perspective</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam37.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Look at the Hibernate Configurations view. In the "workshop" project, + drill down on the <property moreinfo="none">Session Factory</property> and notice that the JPA + entities/attributes are listed in a nice tree view.</para> + + <figure float="0"> + <title>Hibernate Configurations View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam38.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Right click on the <property moreinfo="none">Session Factory</property> and select <property moreinfo="none">HQL + Editor</property>. This will open a JPA query scratch pad window.</para> + + <para>Write your query and click on the "Hibernate Dynamic SQL Preview" tab. + You should see the SQL that will be executed if this JPA query is run.</para> + + <figure float="0"> + <title>JPA Query Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam39.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Run the query by clicking on the green run icon.</para> + + <para>The results are listed in the "Hibernate Query Result" tab. There is a + "Properties" tab in the workbench that can be used to see a specific JPA + result. These results represent the JPA objects because our query did not specify column + names.</para> + + <figure float="0"> + <title>Hibernate Query Result View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam40.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The query can be refined, and take note that there is nice code completion in the JPA + query editor.</para> + + <figure float="0"> + <title>Code Completion</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam41.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>A refined query will return results that are more ResultSet oriented. Notice the join + logic that JPA supports.</para> + + <figure float="0"> + <title>The Results</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam42.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para>There was no need to specify an <property moreinfo="none">Employees</property> table in the + <property moreinfo="none">from</property> part of the JPA query because JPA supports reference traversal + via Java class attribute references. Not only are JPA and HQL queries fully supported, but + Criteria based queries can also be written in the Criteria Editor. You should spend some + time tinkering with different queries and possibly Criteria based queries, even though the + instructions are not provided in this lab.</para> + + <figure float="0"> + <title>Criteria Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam43.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="use_hibernate_to_vizualize"> + <title>Use Hibernate Tools to visualize the Data Model</title> + + <para>Now, it’s time to view the data model for the workshop database.</para> + + <para>In the Hibernate Configurations view, select "workshop" project and + expand the <property moreinfo="none">Configuration</property> node. Select the + <property moreinfo="none">Customers</property> entity, right click on it, choose <property moreinfo="none">Open Mapping + Diagram</property>.</para> + + <figure float="0"> + <title>Mapping Diagram Opening</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam44.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para>You see a Diagram tab for the CUSTOMERS table and any tables that have FK references. + This is a handy way to view the data model and JPA mappings. Now, you’ve got access to + something that the Erwin Data Modeler can’t do.</para> + + + <figure float="0"> + <title>Diagram Tab</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam45.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + </section> + + + <section id="rich_components"> + <title>Rich Components</title> + + <para>This lab will conclude with one last AJAX twist. In this section we add a RichFaces + <property moreinfo="none">inputNumberSlider</property> to the Order Details edit screen.</para> + + <section id="add_richfaces"> + <title>Add a Richfaces component to the CRUD Application</title> + + <para>Switch to Seam perspective, open <emphasis> + <property moreinfo="none">WebContent/OrderdetailsEdit.xhtml</property> + </emphasis> in JBoss Developer Studio.</para> + <para>Change the form field values using the visual editor. Seam has generated the form field + names that match the database column names. This is not ideal for business users.</para> + + <figure float="0"> + <title>Form Fields Editing</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam46.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Also, replace the QTY Ordered input field with a <property moreinfo="none">inputNumberSlider</property>. + You can use the JBoss Developer Studio palette or right click on the form and insert the + RichFaces component.</para> + + <figure float="0"> + <title>RichFaces Component Inserting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam47.png" scale="85"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>One the last option is to use the source view and manually copy the inputNumberSlider + markup listed below:</para> + + <programlisting format="linespecific"><![CDATA[<rich:inputNumberSlider id="quantityOrdered" required="true" + value="#{orderdetailsHome.instance.quantityordered}"/>]]></programlisting> + + <figure float="0"> + <title>Adding the Source</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam48.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The end result is an edit page that has better form labels and a new RichFaces + control.</para> + + <figure float="0"> + <title>The Result Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam49.png" scale="85"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Congratulations! You have completed the JBoss Developer Studio lab.</para> + + </section> + + </section> +</chapter> + + +<chapter id="jsp_application" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/documentation/guides/GettingStartedGuide/en/modules/jsp_application.xml" xreflabel="jsp_application"> + <?dbhtml filename="jsp_application.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>JSP</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + <title>Developing a simple JSP web application</title> + + <note> + <title>Note:</title> + <para>We highly recommend developing in <property moreinfo="none">Seam</property>. This chapter is for users + who for some reason cannot use Seam.</para> + </note> + + <para>In this chapter you'll find out how to create a simple <ulink url="http://java.sun.com/products/jsp/">JSP</ulink> application using the + <property moreinfo="none">JBoss Developer Studio</property>. The application will show a classic + "Hello World!" on the page.</para> + <para>We'll assume that you have already launched <property moreinfo="none">JBoss Developer + Studio</property> and also that the <property moreinfo="none">Web Development</property> perspective is the + current perspective. If not, make it active by selecting <emphasis> + <property moreinfo="none">Window &gt; Open Perspective &gt; Web Development</property> + </emphasis> from the menu bar or by selecting <emphasis> + <property moreinfo="none">Window &gt; Open Perspective &gt; Other...</property> + </emphasis> from the menu bar and then selecting Web Development from the Select Perspective + dialog box.</para> + + <section id="SettingUpTheProject"> + <?dbhtml filename="SettingUpTheProject.html"?> + <title>Setting Up the Project</title> + <para>We are going to start with the creating a Dynamic Web Project with a minimal + structure, i.e. with just required facets. Thus this section will perform you all + necessary steps on how to do this.</para> + <itemizedlist> + <listitem> + <para>Go to the menu bar and select <emphasis> + <property moreinfo="none">File &gt; New &gt; Other...</property> + </emphasis></para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">Web &gt; Dynamic Web Project</property> + </emphasis> in the New Project dialog box</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Next</property> + </emphasis> + </para> + </listitem> + <listitem> + <para>Enter "jspHello" as a project name</para> + </listitem> + <listitem> + <para>Then select <emphasis> + <property moreinfo="none">Minimal Configuration</property> + </emphasis> from the list of possible configurations and click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Create New Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The <emphasis> + <property moreinfo="none">jspHello</property> + </emphasis> node should appear in the upper-left <property moreinfo="none">Package Explorer</property> + view.</para> + <figure float="0"> + <title>New Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="CreatingJSPPage"> + <?dbhtml filename="CreatingJSPPage.html"?> + <title>Creating JSP Page</title> + <para>This section covers all the points how to create, edit and then preview JSP page.</para> + <para>In our simple application we need to create only one JSP page which displays a + <emphasis>"Hello World!"</emphasis> message.</para> + <itemizedlist> + <listitem> + <para>Right click <emphasis><property moreinfo="none">WebContent &gt; New &gt; + JSP</property>. </emphasis></para> + </listitem> + <listitem> + <para>Type "hello.jsp" for a file name and click the <emphasis> + <property moreinfo="none">Next</property> + </emphasis> button.</para> + </listitem> + </itemizedlist> + <para>In the next window you can choose a template for your jsp page and see its preview.</para> + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">New JSP File (xhtml)</property> + </emphasis> template and click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Create JSP Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Our <emphasis><property moreinfo="none">hello.jsp</property></emphasis> page will now appear in + <property moreinfo="none">Project Explorer</property>. + </para> + <section id="EditingJSPPage"> + <?dbhtml filename="EditingJSPPage.html"?> + <title>Editing a JSP Page</title> + <para>Let's now make a little change so that a jsp page displays + <emphasis>"Hello World!"</emphasis> message.</para> + <itemizedlist> + <listitem> + <para>Insert this line inside the <emphasis role="bold"> + <property moreinfo="none">&lt;body&gt;</property> + </emphasis><emphasis role="bold"> + <property moreinfo="none">&lt;/body&gt;</property> + </emphasis> tag: </para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="XML"><![CDATA[<% System.out.println("Hello World!"); %>]]> +</programlisting> + + <para>Notice that content assist functionality is always available when you are typing:</para> + <figure float="0"> + <title>Content Assist in JSP Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>After changes made your <emphasis> + <property moreinfo="none">hello.jsp</property> + </emphasis> page should look like this:</para> + <figure float="0"> + <title>Hello.jsp Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>This line will actually output <emphasis>"Hello + World!"</emphasis> message in the <property moreinfo="none">Console</property>. To make the + message displayed in the Browser, just replace this line with the simple + <emphasis>Hello World!</emphasis>.</para> + </section> + + <section id="WebXML"> + <?dbhtml filename="WebXML.html"?> + <title>web.xml file</title> + <para>When you are creating web project the wizard creates the <emphasis> + <property moreinfo="none">web.xml</property> + </emphasis> for you automatically. The <property moreinfo="none">web.xml file editor</property> + provided by <property moreinfo="none">JBoss Developer Studio</property> is available in two modes: + <property moreinfo="none">Tree</property> and <property moreinfo="none">Source</property>.</para> + <figure float="0"> + <title>Web.xml in Design and Source Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_6.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Both modes are fully synchronized. Let's add mapping to our <emphasis> + <property moreinfo="none">hello.jsp</property> + </emphasis> page in <emphasis> + <property moreinfo="none">web.xml</property> + </emphasis> file.</para> + <itemizedlist> + <listitem> + <para>Switch to <property moreinfo="none">Source</property> tab.</para> + </listitem> + <listitem> + <para>Add the next code into <emphasis role="bold"> + <property moreinfo="none">&lt;welcome-file-list&gt;</property> + </emphasis>:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="XML"><![CDATA[<welcome-file>hello.jsp</welcome-file> +]]></programlisting> + <para>If you come back to <property moreinfo="none">Tree</property> mode you will see that the changes + made are automatically reflected in that mode.</para> + <para>Actually you don't really need to do any configurations right now.</para> + </section> + + <section id="DeployTheProject"> + <?dbhtml filename="DeployTheProject.html"?> + <title>Deploying the project</title> + <para>While creating any web project you could experience a pain writing ant scripts and + managing the packaging even when writing the most trivial web applications. With + <property moreinfo="none">JBoss Developer Studio</property> you are saved from such a pain. All + you need is to start <property moreinfo="none">JBoss Server</property> and launch your application + in your favorite browser.</para> + <para>You can also create a war archive with <ulink url="../../as/html_single/index.html#Project_archivesView">JBDS's Archive Tools</ulink> + and export it to any web server.</para> + <section id="WarConfig"> + <?dbhtml filename="WarConfig.html"?> + <title>WAR Config</title> + <para>Project archives managing is available through <ulink url="../../as/html_single/index.html#Project_archivesView">Project Archives view</ulink>.</para> + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">Window &gt; Show view &gt; Other &gt; JBoss + Tools &gt; Project archives</property> + </emphasis> from menu bar</para> + </listitem> + <listitem> + <para>Select a project in Package Explorer you want to be archived</para> + </listitem> + </itemizedlist> + <para>In <property moreinfo="none">Project Archives</property> you will see available archive types + for the project:</para> + <figure float="0"> + <title>Project Archives</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Click, for example, <emphasis> + <property moreinfo="none">WAR</property> + </emphasis> option to create war archive</para> + </listitem> + </itemizedlist> + <para>In the <property moreinfo="none">New WAR</property> dialog you can see automatically selected + default values.</para> + <figure float="0"> + <title>New WAR Archive</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Next</property> + </emphasis> to see a stub archive configuration for your project: <figure float="0"> + <title>Stub Archive Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_10.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Finish</property>. </emphasis> The + <emphasis>.war</emphasis> file will appear in <property moreinfo="none">Package + Explorer</property> and also in <property moreinfo="none">Project Archives</property> + view as structure tree: <figure float="0"> + <title>Archive is Created</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_11.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <figure float="0"> + <title>Archive in Project Archives View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_12.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </para> + </listitem> + </itemizedlist> + <para>Via <property moreinfo="none">Project Archives</property> view you could now edit your + archive, add new folders, publish to server, and so on:</para> + <figure float="0"> + <title>Configure Archive</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_13.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="AutoRedeploy"> + <?dbhtml filename="AutoRedeploy.html"?> + <title>Auto redeploy</title> + <para>When you are creating a web application and register it on <property moreinfo="none">JBoss + Server</property> it is automatically deployed into + <emphasis>/deploy</emphasis> directory of the server. JBDS comes with the + feature of auto-redeploy. It means that you don't need to restart + <property moreinfo="none">JBoss Server</property>. Any changes made in the application in + exploded format will trigger a redeployment on the server.</para> + </section> + </section> + + <section id="Previewtab"> + <?dbhtml filename="Previewtab.html"?> + <title>JSP Page Preview</title> + <para><property moreinfo="none">JBDS</property> comes with JSP design-time preview features. When + designing JSP pages you can easily preview how they will look during runtime. You + can even <ulink url="../../jsf/html_single/index.html#el_exp_para">attach your stylesheet to the + Preview</ulink>.</para> + <itemizedlist> + <listitem> + <para>Make a little change to <emphasis> + <property moreinfo="none">hello.jsp</property> + </emphasis> page, e.g. put this code snippet:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="XML"><![CDATA[<%= new java.util.Date() %> +]]></programlisting> + <itemizedlist> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Save</property> + </emphasis> button.</para> + </listitem> + <listitem> + <para>Switch to Preview page by clicking <property moreinfo="none">Preview</property> tab at the + bottom of the page. You will see how the page will look at runtime.</para> + </listitem> + </itemizedlist> + <!-- <figure> + <title>Preview Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_14.png"/> + </imageobject> + </mediaobject> + </figure> +--> + </section> + <section id="LaunchingTheProject"> + <?dbhtml filename="LaunchingTheProject.html"?> + <title>Launch JSP Project</title> + <para>Let's now launch our project on server. We'll use + <property moreinfo="none">JBoss Server</property> that is shipped with <property moreinfo="none">JBoss Developer + Studio</property>. You can do it by performing one of the following actions:</para> + <itemizedlist> + <listitem> + <para>Start JBoss Server from <ulink url="../../as/html_single/index.html#JBossServerView">JBoss + Server view</ulink> by clicking the Start icon.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Starting Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_15.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Click the Run icon or right click your project folder and select <emphasis> + <property moreinfo="none">Run As &gt; Run on Server</property>. </emphasis> If you + haven't made any changes in <emphasis> + <property moreinfo="none">web.xml</property> + </emphasis> file or cleared it out you can launch the application by right + clicking the <emphasis> + <property moreinfo="none">hello.jsp</property> + </emphasis> page and selecting <emphasis> + <property moreinfo="none">Run on the Server</property>. </emphasis></para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Run Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_16.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>You should see the next page in a Browser :</para> + <figure float="0"> + <title>Running Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_17.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Thus with the help of this chapter you've learnt how to organize a Dynamic + Web Project with a minimal configuration, add any staff to it (in our case it's + just one jsp page) and deploy and run it on the <property moreinfo="none">JBoss Server</property> + shipped with <property moreinfo="none">JBDS</property>. + </para> + </section> + + </section> +</chapter> + + +<chapter id="rad_jsf_application" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/documentation/guides/GettingStartedGuide/en/modules/rad_jsf_application.xml" xreflabel="rad_jsf_application"> + <?dbhtml filename="rad_jsf_application.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>JSF</keyword> + <keyword>JBoss</keyword> + <keyword>RAD</keyword> + </keywordset> + </chapterinfo> + <title>RAD development of a simple JSF application</title> + + <note> + <title>Note:</title> + <para>We highly recommend developing in <property moreinfo="none">Seam</property>. This chapter is for users + who for some reason cannot use <property moreinfo="none">Seam</property>.</para> + </note> + + <para>In this chapter you will see how to create a simple JSF application being based on + <property moreinfo="none">"RAD"</property> philosophy. We will create the familiar + Guess Number application. The scenario is the following. You are asked to guess a number + between 0 and 100. If the guess is correct, a success page is displayed with a link to play + again. If the guess is incorrect, a message is printed notifying that a smaller or a larger + number should be entered and the game continues.</para> + <para>We'll show you how to create such an application from scratch, along the way + demonstrating powerful features of JBoss Developer Studio such as project templating, Visual + Page Editor, code completion and others. You will design the JSF application and then run + the application from inside JBoss Developer Studio using the bundled JBoss server.</para> + + <section id="SettingUpTheProject12"> + <?dbhtml filename="SettingUpTheProject12.html"?> + <title>Setting up the project</title> + <para>First, you should create a JSF 1.2 project using an integrated JBDS's new + project wizard and predefined templates. Follow the next steps:</para> + <itemizedlist> + <listitem> + <para>In Web Projects View (if it is not open select <emphasis> + <property moreinfo="none">Window &gt; Show View &gt; Others &gt; JBoss Tools Web + &gt; Web Projects View</property>) </emphasis> click <emphasis> + <property moreinfo="none">Create New JSF Project</property> + </emphasis> button. <figure float="0"> + <title>Create New JSF Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure></para> + </listitem> + + <listitem> + <para>Put <property moreinfo="none">GuessNumber</property> as a project name, in JSF Environment + drop down list choose <property moreinfo="none">JSF 1.2</property></para> + </listitem> + <listitem> + <para>Leave everything else as it is and click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + </itemizedlist> + <para>Our project will appear in Project Explorer and Web Projects Views. As you can see + JBoss Developer Studio has created for us the whole skeleton for the project with all + needed libraries, faces-config.xml and web.xml files.</para> + <figure float="0"> + <title>New JSF Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>As the project has been set up, new JSP pages should be created now.</para> + </section> + <section id="CreatingJSPPages"> + <?dbhtml filename="CreatingJSPPages.html"?> + <title>Creating JSP Pages</title> + + <para>Here, we are going to add two pages to our application. The first page is + inputnumber.jsp. It prompts you to enter a number. If the guess is incorrect, the same + page will be redisplayed with a message indicating whether a smaller or a larger number + should be tried. The second page is success.jsp. This page will be shown after you guess + the number correctly. From this page you also have the option to play the game again.</para> + + <para>Now, we will guide you through the steps on how to do this.</para> + <itemizedlist> + <listitem> + <para>Open <emphasis> + <property moreinfo="none">faces-config.xml</property> + </emphasis> file</para> + </listitem> + <listitem> + <para>Right click anywhere on the diagram mode</para> + </listitem> + <listitem> + <para>From the context menu select <emphasis> + <property moreinfo="none">New View</property> + </emphasis></para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Create New View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + + <listitem> + <para>Type <emphasis> + <property moreinfo="none">pages/inputnumber</property> + </emphasis> as the value for <emphasis> + <property moreinfo="none">From-view-id</property> + </emphasis></para> + </listitem> + <listitem> + <para>Leave everything else as is and click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + <listitem> + <para>In the same way create another jsf view. Type <emphasis> + <property moreinfo="none">pages/success</property> + </emphasis> as the value for <emphasis> + <property moreinfo="none">From-view-id</property> + </emphasis></para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">File &gt; Save</property> + </emphasis></para> + </listitem> + </itemizedlist> + <para>On the diagram you will see two created views.</para> + <figure float="0"> + <title>New Views</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="CreatingTransition"> + <?dbhtml filename="CreatingTransition.html"?> + <title>Creating Transition between two views</title> + <para>Then, we should create connection between jsp pages.</para> + <itemizedlist> + <listitem> + <para>In the diagram, select the <emphasis> + <property moreinfo="none">Create New Connection</property> + </emphasis> icon third from the top along the upper left side of the diagram to + get an arrow cursor with a two-pronged plug at the arrow's bottom <figure float="0"> + <title>Create Connection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </para> + </listitem> + <listitem> + <para>Click on the <emphasis> + <property moreinfo="none">pages/inputnumber</property> + </emphasis> page icon and then click on the <emphasis> + <property moreinfo="none">pages/success</property> + </emphasis> page icon</para> + </listitem> + </itemizedlist> + <para>A transition should appear between the two icons of views.</para> + <figure float="0"> + <title>Created Connection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">File &gt; Save</property> + </emphasis> from the menu bar</para> + </listitem> + </itemizedlist> + </section> + + <section id="CreatingResourceFile"> + <?dbhtml filename="CreatingResourceFile.html"?> + <title>Creating Resource File</title> + <para>A resource file is just a file with a <emphasis>.properties</emphasis> extension for + collecting text messages in one central place. JBoss Developer Studio allows you to + create quickly a resource file. The messages stored in resource file can be displayed to + you on a Web page during application execution. </para> + <para>With resource file first, you don't hard code anything into the JSP pages. + And second, it makes it easier to translate your application to other languages. All you + have to do is to translate all your messages to the other language and save them in a + new properties file with a name that ends with the appropriate ISO-639 language code.</para> + <para>It is a good idea to keep your resources inside the <emphasis> + <property moreinfo="none">JavaSource</property> + </emphasis> folder, where you keep your .java files. Every time you build the project, + all <emphasis>.properties</emphasis> files will then be copied to the + <emphasis>classes</emphasis> folder by default.</para> + <itemizedlist> + <listitem> + <para>Right click <emphasis> + <property moreinfo="none">JavaSource</property> + </emphasis> folder and select <emphasis> + <property moreinfo="none">New &gt; Folder</property> + </emphasis></para> + </listitem> + <listitem> + <para>Type <emphasis> + <property moreinfo="none">game</property> + </emphasis> for Folder name and click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + </itemizedlist> + <para>Your resource file and java bean will be stored in this folder.</para> + <itemizedlist> + <listitem> + <para>Right click on <emphasis> + <property moreinfo="none">game folder</property> + </emphasis> and select <emphasis> + <property moreinfo="none">New &gt; Properties File</property> + </emphasis></para> + </listitem> + <listitem> + <para>Type <emphasis> + <property moreinfo="none">messages</property> + </emphasis> as the value for "name" attribute and click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + </itemizedlist> + <para>JBoss Developer Studio will automatically open + <property moreinfo="none">messages.properties</property> file for editing.</para> + <figure float="0"> + <title>Messages.properties File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Add</property> + </emphasis> button for adding new attribute to your resource file</para> + </listitem> + <listitem> + <para>Type <emphasis role="italic"> + <property moreinfo="none">how_to_play</property> + </emphasis> for "name" and <emphasis role="italic"> + <property moreinfo="none">Please pick a number between 0 and 100.</property> + </emphasis> for value</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + <listitem> + <para>In such a way add the next properties:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="JAVA"><![CDATA[makeguess_button=Make Guess +trayagain_button=Play Again? +success_text=How cool.. You have guessed the number, {0} is correct! +tryagain_smaller=Oops..incorrect guess. Please try a smaller number. +tryagain_bigger=Oops..incorrect guess. Please try a bigger number. +]]></programlisting> + <itemizedlist> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">File &gt; Save</property> + </emphasis> from the menu bar</para> + </listitem> + </itemizedlist> + <para>Your .properties file should now look like follows:</para> + <figure float="0"> + <title>Properties are Added</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para><emphasis> + <property moreinfo="none">Up</property></emphasis> + and <emphasis> + <property moreinfo="none">Down</property> + </emphasis> buttons allow you to move you attribute on the list. For delete the attribute, choose it and press <emphasis> + <property moreinfo="none">Delete</property></emphasis> button.</para> + <para>If you want to change a value or a name of your attribute, click on it and than on <emphasis> + <property moreinfo="none">Edit</property></emphasis> button.</para> + </section> + + <section id="CreatingJavaBean"> + <?dbhtml filename="CreatingJavaBean.html"?> + <title>Creating Java Bean</title> + <para>In this section you'll see how to create a Java bean that will hold business + logic of our application.</para> + <itemizedlist> + <listitem> + <para>Right click <emphasis> + <property moreinfo="none">game folder</property> + </emphasis></para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">New &gt; Class</property> + </emphasis></para> + </listitem> + <listitem> + <para>Type <emphasis> + <property moreinfo="none">NumberBean</property> + </emphasis> for bean name</para> + </listitem> + </itemizedlist> + <para>A java bean is created.</para> + <itemizedlist> + <listitem> + <para>Declare the variable of your entered number:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="JAVA"><![CDATA[Integer userNumber; +]]></programlisting> + <para>JBDS allows to quickly generate getters and setters for java bean.</para> + <itemizedlist> + <listitem> + <para>Right click <emphasis> + <property moreinfo="none">NumberBean.java</property> + </emphasis> in Package Explorer</para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">Source &gt; Generate Getters and Setters...</property> + </emphasis></para> + </listitem> + <listitem> + <para>Check <emphasis> + <property moreinfo="none">userNumber</property> + </emphasis> box and click <emphasis> + <property moreinfo="none">OK</property> + </emphasis> + <figure float="0"> + <title>Generate Getters and Setters</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </para> + </listitem> + <listitem> + <para>Add the declaration of the second variable</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="JAVA"><![CDATA[int randomNumber; +]]></programlisting> + <itemizedlist> + <listitem> + <para>.. other bean methods:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="JAVA"><![CDATA[public NumberBean () +{ + randomNumber = (int)(Math.random()*100); + System.out.println ( "Random number: "+randomNumber); + } + public String playagain () + { + FacesContext context = FacesContext.getCurrentInstance(); + HttpSession session = + (HttpSession) context.getExternalContext().getSession(false); + session.invalidate(); + return "playagain"; + } + public String checkGuess () + { + + // if guessed, return 'success' for navigation + if ( userNumber.intValue() == randomNumber ) + { + return "success"; + } +else + { + FacesContext context = FacesContext.getCurrentInstance(); + ResourceBundle bundle = ResourceBundle.getBundle("game.messages", + context.getViewRoot().getLocale()); + String msg = ""; + // if number bigger, get appropriate message + if ( userNumber.intValue() > randomNumber ) + msg = bundle.getString("tryagain_smaller"); + else // if number smaller, get appropriate message + msg = bundle.getString("tryagain_bigger"); + // add message to be displayed on the page via <h:messages> tag + context.addMessage (null, new FacesMessage(msg)); + // return 'tryagain' for navigation + return "tryagain"; + } + } +]]></programlisting> + <itemizedlist> + <listitem> + <para>And the import declarations:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="JAVA"><![CDATA[import javax.faces.context.FacesContext; +import javax.servlet.http.HttpSession; +import javax.faces.application.FacesMessage; +import java.util.Locale; +import java.util.ResourceBundle; +]]></programlisting> + <para>The whole java bean should look as follows:</para> + <programlisting format="linespecific" role="JAVA"><![CDATA[import javax.faces.context.FacesContext; +import javax.servlet.http.HttpSession; +import javax.faces.application.FacesMessage; +import java.util.Locale; +import java.util.ResourceBundle; + +public class NumberBean +{ + Integer userNumber; + int randomNumber; // random number generated by application +public Integer getUserNumber () + { + return userNumber; + } + public void setUserNumber (Integer value) + { + this.userNumber = value; + } + + // constructor, generates random number + public NumberBean () + { + randomNumber = (int)(Math.random()*100); + System.out.println ( + "Random number: " + randomNumber); + } + + public String playagain () + { + FacesContext context = FacesContext.getCurrentInstance(); + HttpSession session = + (HttpSession) context.getExternalContext().getSession(false); + session.invalidate(); + return "playagain"; + } + + // check if user guessed the number + public String checkGuess () + { + // if guessed, return 'success' for navigation + if ( userNumber.intValue() == randomNumber ) + { + return "success"; + } + // incorrect guess + else + { + // get a reference to properties file to retrieve messages + FacesContext context = FacesContext.getCurrentInstance(); + ResourceBundle bundle = + ResourceBundle.getBundle("game.messages", + context.getViewRoot().getLocale()); + String msg = ""; + // if number is bigger, get appropriate message + if ( userNumber.intValue() > randomNumber ) + msg = bundle.getString("tryagain_smaller"); + else // if number smaller, get appropriate message + msg = bundle.getString("tryagain_bigger"); + + // add message to be displayed on the page via <h:messages> tag + context.addMessage (null, new FacesMessage(msg)); + // return 'tryagain' for navigation + return "tryagain"; + } + } +} +]]></programlisting> + </section> + + <section id="EditingFacesConfig"> + <?dbhtml filename="EditingFacesConfig.html"?> + <title>Editing faces-config.xml File</title> + <para>In this section you know about faces-config.xml file.</para> + <para>This file holds two navigation rules and defines the backing bean used.</para> + <itemizedlist> + <listitem> + <para>Open faces-config.xml file in a source mode</para> + </listitem> + <listitem> + <para>Add here one more navigation rule and a managed bean declarations that the + content of the file looks like this:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="XML"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> +<faces-config version="1.2" xmlns="http://java.sun.com/xml/ns/javaee +xmlns:xi="http://www.w3.org/2001/XInclude" +xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" +xsi:schemaLocation="http://java.sun.com/xml/ns/javaee + http://java.sun.com/xml/ns/javaee/web-facesconfig_1_2_.xsd"> + + <navigation-rule> + <from-view-id>*</from-view-id> + <navigation-case> + <from-outcome>playagain</from-outcome> + <to-view-id>/pages/inputnumber.jsp</to-view-id> + </navigation-case> + </navigation-rule> + + <navigation-rule> + <from-view-id>/pages/inputnumber.jsp</from-view-id> + <navigation-case> + <from-outcome>success</from-outcome> + <to-view-id>/pages/success.jsp</to-view-id> + </navigation-case> + </navigation-rule> + + <managed-bean> + <managed-bean-name>NumberBean</managed-bean-name> + <managed-bean-class>game.NumberBean</managed-bean-class> + <managed-bean-scope>session</managed-bean-scope> + </managed-bean> + +</faces-config> +]]></programlisting> + <para>The first navigation rule states that from any page (<property moreinfo="none">*</property> stands for + any page) an outcome of playagain will take you to <emphasis> + <property moreinfo="none">/pages/inputnumber.jsp</property> + </emphasis>. Outcome values are returned from backing bean methods in this example. The + second navigation rule states that if you are at the page <emphasis> + <property moreinfo="none">/pages/inputnumber.jsp</property> + </emphasis>, and the outcome is success, then navigate to the <emphasis> + <property moreinfo="none">/pages/success.jsp</property> + </emphasis> page. </para> + </section> + <section id="EditingTheJSPViewFiles2"> + <?dbhtml filename="EditingTheJSPViewFiles2.html"?> + <title>Editing the JSP View Files</title> + <para>Now, we will continue editing the JSP files for our two "views" using + Visual Page Editor.</para> + <section id="EditingInputjsp"> + <?dbhtml filename="EditingInputjsp.html"?> + <title>Editing inputnumber.jsp page</title> + <para>First, let's dwell on how to edit inputnumber.jsp.</para> + <para>On this page we will have an output text component displaying a message, a text + field for user's number entering and a button for input submission.</para> + <itemizedlist> + <listitem> + <para>Open inputnumber.jsp by double-clicking on the <emphasis> + <property moreinfo="none">/pages/inputnumber. jsp</property> + </emphasis> icon</para> + </listitem> + </itemizedlist> + <para>The Visual Page Editor will open in a screen split between source code along the + top and a WYSIWIG view along the bottom. You can see that some JSF code will be + already generated as we choose a template when creating the page.</para> + <para>At the beginning it's necessary to create a <emphasis role="bold"> + <property moreinfo="none">&lt;h:form&gt;</property> + </emphasis> component where all others components are put.</para> + <itemizedlist> + <listitem> + <para>Place the mouse cursor inside <emphasis role="bold"> + <property moreinfo="none">&lt;f:view&gt;</property> + </emphasis><emphasis role="bold"> + <property moreinfo="none">&lt;/f:view&gt;</property> + </emphasis></para> + </listitem> + <listitem> + <para>Go to JBoss Tools Palette and expand JSF HTML folder by selecting + it</para> + </listitem> + <listitem> + <para>Click on <emphasis role="bold"> + <property moreinfo="none">&lt;h:form&gt;</property> + </emphasis> tag <figure float="0"> + <title>Insert h:form</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_10.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </para> + </listitem> + <listitem> + <para>In the dialog Insert Tag select <emphasis> + <property moreinfo="none">id</property> + </emphasis> and click on this line below the value header. A blinking cursor + will appear in a input text field inviting to enter a value of id <figure float="0"> + <title>Define Id of Form</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_11.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </para> + </listitem> + <listitem> + <para>Type <emphasis> + <property moreinfo="none">inputNumbers</property> + </emphasis> and click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + </itemizedlist> + <para>In source view you can see the declaration of a form.</para> + <figure float="0"> + <title>Created Form</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_12.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>First let's declare the properties file in inputnumber.jsp page using the + loadBundle JSF tag.</para> + <itemizedlist> + <listitem> + <para>Put this declaration on the top of a page, right after the first two + lines:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="XML"><![CDATA[<f:loadBundle basename="game.messages" var="msg"/> +]]></programlisting> + <para>As always JBDS provides code assist:</para> + <figure float="0"> + <title>Code Assist</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_13.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Switch to Visual tab, so it could be possible to work with the editor + completely in its WYSIWYG mode</para> + </listitem> + <listitem> + <para>Click on <emphasis> + <property moreinfo="none">outputText</property>, </emphasis> drag the cursor over to the + editor, and drop it inside the blue box in the editor</para> + </listitem> + + <listitem> + <para>Select <emphasis> + <property moreinfo="none">value</property> + </emphasis> and click on this line below "value" + header</para> + </listitem> + <listitem> + <para>Click <property moreinfo="none">...</property> button next to the value field</para> + </listitem> + </itemizedlist> + <para>JBDS will nicely propose you to choose within available values:</para> + <figure float="0"> + <title>Choose Value</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_14.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Expand <emphasis> + <property moreinfo="none">Resource Bundles &gt; msg</property> + </emphasis></para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">how_to_play</property> + </emphasis> value and click <emphasis> + <property moreinfo="none">Ok</property>. </emphasis> Then click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> + <figure float="0"> + <title>Selecting Value</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_15.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </para> + </listitem> + </itemizedlist> + <para>The text will appear on the page:</para> + <figure float="0"> + <title>Created OutputText Component</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_16.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Switch to Source mode and insert <emphasis role="bold"> + <property moreinfo="none">&lt;br/&gt;</property> + </emphasis> tag after <emphasis role="bold"> + <property moreinfo="none">&lt;h:outputText&gt;</property> + </emphasis> component to make a new line.</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Save</property> + </emphasis> button.</para> + </listitem> + <listitem> + <para>On the Palette click on <emphasis> + <property moreinfo="none">inputText</property>, </emphasis> drag the cursor over to the + editor, and drop it inside the editor after the text.</para> + </listitem> + <listitem> + <para>Switch to a Source mode and insert <emphasis role="bold"> + <property moreinfo="none">&lt;br/&gt;</property> + </emphasis> tag after <emphasis role="bold"> + <property moreinfo="none">&lt;h:outputText&gt;</property> + </emphasis> component to make a new line</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Save</property> + </emphasis> button</para> + </listitem> + <listitem> + <para>On the Palette click on <emphasis> + <property moreinfo="none">inputText</property>, </emphasis> drag the cursor over to the + editor, and drop it inside the editor after the text</para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">value</property> + </emphasis> and click on this line below "value" + header</para> + </listitem> + <listitem> + <para>Click <property moreinfo="none">...</property> button next to the value field</para> + </listitem> + <listitem> + <para>Expand <emphasis> + <property moreinfo="none">Managed Beans &gt; NumberBean</property> + </emphasis></para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">userNumber</property> + </emphasis> value and click <emphasis> + <property moreinfo="none">Ok</property> + </emphasis></para> + </listitem> + <listitem> + <para>Switch <emphasis> + <property moreinfo="none">Advanced</property> + </emphasis> tab</para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">id</property> + </emphasis> and click on this line below "value" + header</para> + </listitem> + <listitem> + <para>Type <emphasis> + <property moreinfo="none">userNumber</property> + </emphasis> in text field</para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">required</property> + </emphasis> and click on this line below "value" + header</para> + </listitem> + <listitem> + <para>Click <property moreinfo="none">...</property> button next to the value field</para> + </listitem> + <listitem> + <para>Expand <emphasis> + <property moreinfo="none">Enumeration</property> + </emphasis> and select <emphasis> + <property moreinfo="none">true</property> + </emphasis> as a value</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Add "required" Attribute</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_17.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Ok</property>, </emphasis> then click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + <listitem> + <para>Go to Source mode</para> + </listitem> + <listitem> + <para>Add the validation attribute to <emphasis role="bold"> + <property moreinfo="none">&lt;f:validateLongRange&gt;</property> + </emphasis> for user input validation</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="XML"><![CDATA[<h:inputText id="userNumber" value="#{NumberBean.userNumber}" required="true"> + <f:validateLongRange minimum="0" maximum="100"/> +</h:inputText> +]]></programlisting> + <itemizedlist> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Save</property> + </emphasis> button</para> + </listitem> + <listitem> + <para>Again select <emphasis> + <property moreinfo="none">Visual</property> + </emphasis> mode</para> + </listitem> + <listitem> + <para>On the Palette, click on <emphasis> + <property moreinfo="none">commandButton</property>, </emphasis> drag the cursor over to + the editor, and drop it inside the editor after the inputText + component.</para> + </listitem> + <listitem> + <para>In the editing dialog select <emphasis> + <property moreinfo="none">value</property> + </emphasis> and click on this line below "value" + header</para> + </listitem> + <listitem> + <para>Click <property moreinfo="none">...</property> button next to the value field</para> + </listitem> + <listitem> + <para>Expand <emphasis> + <property moreinfo="none">Resource Bundles &gt; msg</property> + </emphasis> and select <emphasis> + <property moreinfo="none">makeguess_button</property> + </emphasis> as a value</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Ok</property> + </emphasis></para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">action</property> + </emphasis> and click on this line below "value" + header</para> + </listitem> + <listitem> + <para>Type <emphasis> + <property moreinfo="none">NumberBean.checkGuess</property> + </emphasis> in text field</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + <listitem> + <para>In Source mode add <emphasis role="bold"> + <property moreinfo="none">&lt;br/&gt;</property> + </emphasis> tags between <emphasis role="bold"> + <property moreinfo="none">&lt;outputText&gt;</property> + </emphasis>, <emphasis role="bold"> + <property moreinfo="none">&lt;inputText&gt;</property> + </emphasis> and <emphasis role="bold"> + <property moreinfo="none">&lt;commandButton&gt;</property> + </emphasis> components to place them on different lines</para> + </listitem> + </itemizedlist> + <para>inputnumber.jsp page should look like this:</para> + <programlisting format="linespecific" role="XML"><![CDATA[<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h" %> +<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f" %> +<f:loadBundle basename="game.messages" var="msg"/> + +<html> + <f:view> + <h:form id="inputNumbers"> + <h:outputText value="#{msg.how_to_play}"/> + <br/> + <h:messages style="color: blue"/> + <br/> + <h:inputText id="userNumber" value="#{NumberBean.userNumber}" required="true"> + <f:validateLongRange minimum="0" maximum="100"/> + </h:inputText> + <br/><br/> + <h:commandButton value= + "#{msg.makeguess_button}" action="#{NumberBean.checkGuess}"/> + </h:form> + </f:view> +</html> +]]></programlisting> + </section> + <section id="EditingSuccessJsp"> + <?dbhtml filename="EditingSuccessJsp.html"?> + <title>Editing success.jsp page</title> + <para>In the same way like inputnumber.jsp, edit success.jsp page. Its whole source + should be the next:</para> + <programlisting format="linespecific" role="XML"><![CDATA[<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h" %> +<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f" %> +<f:loadBundle basename="game.messages" var="msg"/> + +<html> + <f:view> + <h:form id="result"> + <h:outputFormat value="#{msg.success_text}"> + <f:param value="#{NumberBean.userNumber}"/> + </h:outputFormat> + <br/><br/> + <h:commandButton value= + "#{msg.trayagain_button}" action="#{NumberBean.playagain}"/> + </h:form> + </f:view> +</html> +]]></programlisting> + <para>Again you can use code assist provided by JBDS when editing jsp page:</para> + <figure float="0"> + <title>Code Assist for &lt;f:param&gt;</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_18.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>This page, success.jsp, is shown if you correctly guessed the number. The + <emphasis role="bold"> + <property moreinfo="none">&lt;h:outputFormat&gt;</property> + </emphasis> tag will get the value of success_text from the properties file. The {0} + in success_text will be substituted for by the value of the value attribute within + the <emphasis role="bold"> + <property moreinfo="none">&lt;f:param&gt;</property> + </emphasis> tag during runtime.</para> + <para>At the end, you have a button which allows you to replay the game. The action + value references a backing bean method. In this case, the method only terminates the + current session so that when you are shown the first page, the input text box is + clear and a new random number is generated.</para> + <itemizedlist> + <listitem> + <para>Switch to Preview mode to see how this page will look in a browser:</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Success.jsp in Preview Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_19.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + <section id="CreatingIndexjsp"> + <?dbhtml filename="CreatingIndexjsp.html"?> + <title>Creating index.jsp page</title> + <para>Now you know how to create index.jsp page.</para> + <para>The index.jsp page is the entry point of our application. It's just + forwarding to inputnumber.jsp page.</para> + <itemizedlist> + <listitem> + <para>Right click <emphasis> + <property moreinfo="none">WebContent &gt; New &gt; JSP File</property> + </emphasis></para> + </listitem> + <listitem> + <para>Type <emphasis> + <property moreinfo="none">index</property> + </emphasis> for name field and choose <emphasis> + <property moreinfo="none">JSPRedirect</property> + </emphasis> as a template</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + <listitem> + <para>The source for this page should be like the following:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="XML"><![CDATA[<!doctype html public "-//w3c//dtd html 4.0 transitional//en"> +<html> + <body> + <jsp:forward page="/pages/inputnumber.jsf" /> + </body> +</html> + +]]></programlisting> + <para>Note the <emphasis>.jsf</emphasis> extension of a page. It means that we trigger the + JSF controller servlet to handle the page according the servlet mapping in the + faces-config.xml file.</para> + </section> + <section id="RunningTheApplication33"> + <?dbhtml filename="RunningTheApplication33.html"?> + <title>Running the Application</title> + <para>Finally, we have all the pieces needed to run the application.</para> + <itemizedlist> + <listitem> + <para>Start up JBoss server by clicking on the <emphasis> + <property moreinfo="none">Start</property> + </emphasis> icon in JBoss Server view. (If JBoss is already running, stop it by + clicking on the red icon and then start it again. After the messages in the + Console tabbed view stop scrolling, JBoss is available)</para> + </listitem> + <listitem> + <para>Right-click on project <emphasis> + <property moreinfo="none">Run AS &gt; Run on Server</property> + </emphasis></para> + </listitem> + <listitem> + <para>Play with the application by entering correct as well as incorrect + values</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>You are Asked to Enter a Number Between 0 and 100</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_20.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <figure float="0"> + <title>Your Input is Validated and an Error Message is Displayed if Invalid Input was + Entered</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_21.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <figure float="0"> + <title>After You Enter a Guess, the Application Tells You Whether a Smaller or a Larger + Number Should be Tried</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_22.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <figure float="0"> + <title>Your Guess is Correct</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_23.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> +</chapter> + + + +<chapter id="project_examples" role="new" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/documentation/guides/GettingStartedGuide/en/modules/project_examples.xml" xreflabel="project_examples"> + <?dbhtml filename="project_examples.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + <title>Project Examples</title> + + <para><emphasis><property moreinfo="none">JBoss Developer Studio</property></emphasis> provides an option to download and import a ready-made + project that you can explore and derive some useful technology implementation lessons. </para> + + + <section id="DownloadingProjectExample"> + <title>Downloading a Project Example</title> + + <para>To download a project example and start working with it you need to take a few steps:</para> + <itemizedlist> + <listitem> + <para>Go to the menu bar and select <emphasis><property moreinfo="none">File &gt; New &gt; Other...</property></emphasis> + </para></listitem> + + <listitem><para>Select <emphasis><property moreinfo="none">Jboss Tools &gt; Project Examples</property></emphasis>(You can also call the <emphasis><property moreinfo="none">Project Examples</property></emphasis> from menu bar: <emphasis><property moreinfo="none">Help &gt; Project Examples...</property></emphasis>)</para></listitem> + + + </itemizedlist> + + <figure float="0"> + <title>Project Examples</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/project_examples/pr_example_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem><para>Now in the New Project Example dialog you can select a project you would like to explore</para> + <para>Project Examples Wizard provides a filter field to more easily locate the project examples you want, so you can type in the project you would like to explore in the field.</para></listitem> + + </itemizedlist> + + + <figure float="0"> + <title>Selecting a Project Example</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/project_examples/pr_example_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <note> + <title>Note:</title> + <para> + The <emphasis><property moreinfo="none">Show the Quick Fix Dialog</property></emphasis> option is described in the <link linkend="QuickFixes">Quick Fixes</link> section. + </para> + </note> + + <itemizedlist> + <listitem><para>Press <emphasis><property moreinfo="none">Finish</property></emphasis> to start downloading the project from the repository + </para></listitem> + + </itemizedlist> + + <para>When downloading is finished the project will be imported automatically and you will be able to see it in the Package Explorer.</para> + + <para>Now you can run the application on the server.</para> + + <figure float="0"> + <title>Seam Demo Application run on the Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/project_examples/pr_example_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="QuickFixes"> + <title>Quick Fixes</title> + <para> + Project Examples Wizard has an option for making quick fixes + for the imported project to easily fix possible issues like missing servers, Seam runtimes etc. + </para> + <para>To enable quick fixing option you need to check the + <emphasis><property moreinfo="none">Show the Quick Fix dialog</property></emphasis> while choosing the <link linkend="DownloadingProjectExample">Project Example</link>.</para> + + <para>When the project you selected is downloaded it will be checked for missing dependences and if there are some you will see a dialog listing the problems.</para> + <figure float="0"> + <title>Quick Fix Dialog box</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/project_examples/pr_example_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>To fix the problem you need to:</para> + + <itemizedlist> + <listitem><para>Select the problem from the list</para></listitem> + <listitem><para>Click <emphasis><property moreinfo="none">Quick Fix</property></emphasis> button</para></listitem> + </itemizedlist> + + <para>You will be offered a solution or a number of solutions to the problem.</para> + + <figure float="0"> + <title>Quick Fix Dialog box: Selecting a Fix</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/project_examples/pr_example_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>In this case(see the image above), when the <emphasis><property moreinfo="none">Finish</property></emphasis> button is pressed, Seam Settings dialog box will be displayed where you need to provide a path to the Seam environment to fix the issue.</para> + + <para>When the problem is fixed you will be returned to the Quick Fix dialog box with the remaining problems to be fixed.</para> + + </section> + + +</chapter> + + + +<chapter id="gsg_faq" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/documentation/guides/GettingStartedGuide/en/modules/gsg_faq.xml" xreflabel="gsg_faq"> + <?dbhtml filename="gsg_faq.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + <title>FAQ</title> + + <para>For more information on <property moreinfo="none">JBoss Developer Studio</property> features, refer to the + following FAQ to get the answers on the most "popular" questions.</para> + + <section id="question_1"> + <title>What should I do if Visual Page Editor does not start under Linux</title> + + <para>Linux users may need to do the following to get the <property moreinfo="none">Visual Page + Editor</property> to work correctly on their machines.</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>On Red Hat based Linux distributions install the xpLib.i386 package</para> + </listitem> + <listitem> + <para>Type</para> + <programlisting format="linespecific" role="JAVA"><![CDATA[ln -s libstdc++.so.5.0.7 libstdc++.so.5 +]]></programlisting> + </listitem> + <listitem> + <para>and/or use</para> + <programlisting format="linespecific" role="JAVA"><![CDATA[yum install libXp +]]></programlisting> + </listitem> + <listitem> + <para>Open the JBDS perspective. If you see the Help view open, close it and restart + JBDS</para> + </listitem> + <listitem> + <para>If none of these work, do the following:</para> + <itemizedlist> + <listitem> + <para>Clear the Eclipse log file, + <emphasis>&lt;workspace&gt;\.metadata\.log</emphasis></para> + </listitem> + <listitem> + <para>Start Eclipse with the -debug option:</para> + <programlisting format="linespecific" role="JAVA"><![CDATA[eclipse -debug +]]></programlisting> + </listitem> + <listitem> + <para>Post the Eclipse log file + (<emphasis>&lt;workspace&gt;\.metadata\.log</emphasis>) on + the forums.</para> + </listitem> + </itemizedlist> + </listitem> + </orderedlist> + </section> + + <section id="question_2"> + <title>Do I need to have JBoss Server installed to run JBoss Developer Studio?</title> + + <para>No. <property moreinfo="none">JBoss Developer Studio</property> already comes bundled with JBoss + Server. We bundle it together so that you don't need to download any additional + software and can test your application in a Web browser right away.</para> + <para>If you want to use a different JBoss server installation, after <property moreinfo="none">JBoss + Developer Studio</property> is installed open Servers View (select + <emphasis><property moreinfo="none">Window &gt; Show View &gt; Others &gt; Server + &gt; Servers</property>),</emphasis> then right click on this <emphasis> + <property moreinfo="none">view &gt; New &gt; Server</property> + </emphasis> and follow the wizards steps to point to another Jboss Server + installation.</para> + <para><property moreinfo="none">JBoss Developer Studio</property> works with any servlet container, not just + JBoss. For more information on deployment, please see the Deploying Your Application + section.</para> + </section> + + <section id="question_3"> + <title>I have an existing Seam 1.2.1 project. Can I migrate/import the project to a JBDS + Seam project?</title> + + <para>We highly recommend you to create Seam 1.2.1 project using the + <property moreinfo="none">JBDS</property>. In other case try to do manually:</para> + + <itemizedlist> + <listitem> + <para>Create a Seam Web project to get the JBoss tools structure</para> + </listitem> + </itemizedlist> + <para>Then from your Seam 1.2.1 seam-gen project start doing the following:</para> + <itemizedlist> + <listitem> + <para>Copy <property moreinfo="none">src</property> to <property moreinfo="none">src</property></para> + </listitem> + <listitem> + <para>Copy <property moreinfo="none">view</property> to <property moreinfo="none">Web content</property></para> + </listitem> + <listitem> + <para>Copy resources individual files to where they are in the seam web project + etc.</para> + </listitem> + </itemizedlist> + + </section> + <section id="questio_4"> + <title>I have an existing Struts or JSF project. Can I open the project in JBDS?</title> + + <para>Yes. From main menu select <emphasis> + <property moreinfo="none">File &gt; Import &gt; Other &gt; JSF Project (or Struts + Project)</property> + </emphasis> and follow wizards steps.</para> + + </section> + + <section id="question_5"> + <title>Can I import a .war file?</title> + + <para>Yes. Select <emphasis><property moreinfo="none">File &gt; Import &gt; Web &gt; WAR + file</property>, </emphasis> then follow importing steps.</para> + </section> + + <section id="question_6"> + <title>Is it possible to increase the performance of Eclipse after installing your + product?</title> + + <para><property moreinfo="none">JBoss Developer Studio</property> preconfigures eclipse via the eclipse.ini + file to allocate extra memory, but if you for some reason need more memory then by + default, you can manually make adjustments in this file. For example:</para> + <programlisting format="linespecific" role="XML"> + <![CDATA[-vmargs -Xms128m -Xmx512m -XX:MaxPermSize=128m +]]></programlisting> + </section> + + <section id="question_7"> + <title>How can I add my own tag library to the JBoss Tools Palette?</title> + + <para>See <ulink url="../../jsf/html_single/index.html#AddingCustomJSFTagsToTheRedHatPalette7433">Adding Tag + Libraries</ulink> in Visual Web Tools Guide.</para> + </section> + + <section id="question_8"> + <title>How to get Code Assist for Seam specific resources in an externally generated + project?</title> + + <para>To get Code Assist for Seam specific resources in an externally generated project, you + should enable Seam features in Project Preferences. Right click an imported project and + navigate <emphasis> + <property moreinfo="none">Properties &gt; Seam Settings</property>.</emphasis> Check <emphasis> + <property moreinfo="none">Seam support</property> + </emphasis> box to enable all available <ulink url="../../seam/html_single/index.html#project_pref">Seam + Settings</ulink>.</para> + </section> + + <section id="question_9"> + <title>How to import an example Seam project from jboss-eap directory?</title> + + <para>To import an example Seam project from <emphasis> + <property moreinfo="none">jboss-eap</property> + </emphasis> into your working directory, you should perform the following steps:</para> + + <itemizedlist> + <listitem> + <para>Go to <emphasis> + <property moreinfo="none">New &gt; Other &gt; Java Project from Existing Buildfile</property> + </emphasis></para> + </listitem> + + <listitem> + <para>Point to the <emphasis> + <property moreinfo="none">build.xml</property> + </emphasis> of any chosen project by pressing <emphasis> + <property moreinfo="none">Browse</property> + </emphasis> button</para> + </listitem> + + <listitem> + <para>Hit <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> to open the project</para> + </listitem> + </itemizedlist> + + <para>As these seam examples are non WTP projects, next you should enable Seam support for + them. To do that, right click the project and go to <emphasis> + <property moreinfo="none">Properties &gt; Seam Settings</property>.</emphasis></para> + </section> + + <section id="question_10"> + <title>Is a cross-platform project import possible for JBDS?</title> + + <para>Yes. You can easily import created in Linux JSF, Struts or Seam project to Windows and + vice versa.</para> + + <para>To do the transferring JSF, Struts or Seam project, go to <emphasis> + <property moreinfo="none">Menu &gt; Import &gt; General &gt; Existing Projects into Workspace</property>,</emphasis> + select the folder where your project stored and press <emphasis> + <property moreinfo="none">Finish</property>.</emphasis></para> + </section> +</chapter> + + +<chapter id="further_reading" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/documentation/guides/GettingStartedGuide/en/modules/further_reading.xml" xreflabel="further_reading"> + <?dbhtml filename="further_reading.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Deploy</keyword> + <keyword>Deployment</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>Further Reading</title> + + <para> + <emphasis role="bold">JSF Tools Reference Guide</emphasis> + <ulink url="../../jsf_tools_ref_guide/html_single/index.html">(html)</ulink> + + </para> + <para> From this guide you'll discover all peculiarities of work at a JSF project. You'll + learn all shades that cover the process of project creation and take a closer look at the JSF + configuration file. Also you'll get to know managed beans and how to work with them and + find out, how to create and register a custom converter, custom validator and referenced beans + in a JSF project. </para> + +<itemizedlist> + <listitem> + <para> + <emphasis role="bold">JSF Tools Tutorial</emphasis> + <ulink url="../../jsf_tools_tutorial/html_single/index.html">(html)</ulink> + </para> + <para> This tutorial will describe how to deal with classic/old style of JSF development and how + to create a simple JSF application using the JBoss Developer Studio. </para> + </listitem> + + <listitem> <para> + <emphasis role="bold">Struts Tools Reference Guide</emphasis> + <ulink url="../../struts_tools_ref_guide/html_single/index.html">(html)</ulink> + </para> + <para> In Struts Tools Reference Guide you will learn how to create and work with a new struts + project. This guide also provides information about graphical editor for struts configuration + files, tiles files, and struts validation files. </para> + </listitem> + +<listitem> + <para> + <emphasis role="bold">Struts Tools Tutorial</emphasis> + <ulink url="../../struts_tools_tutorial/html_single/index.html">(html)</ulink> + </para> + <para> This tutorial will describe the classical style of Struts development, and will + step-by-step show you how to create a simple Struts application in JBoss Developer Studio.</para> +</listitem> + +<listitem> + <para> + <emphasis role="bold">Seam Dev Tools Reference Guide</emphasis> + <ulink url="../../seam/html_single/index.html">(html)</ulink> + </para> + <para> This guide helps you to understand what Seam is and how to install Seam plug-in into + Eclipse. It tells you the necessary steps to start working with Seam Framework and assists in a + simple Seam Project creation. Also you will learn how to create and run the CRUD Database + Application with Seam as well as find out what Seam Editors Features and Seam Components are. </para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">Visual Web Tools Reference Guide</emphasis> + <ulink url="../../jsf/html_single/index.html">(html)</ulink> + </para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">JBoss Server Manager Reference Guide</emphasis> + <ulink url="../../as/html_single/index.html">(html)</ulink> + </para> + <para> This guide covers the basics of working with the JBoss server manager. You will read how to + install runtimes and servers and quickly learn how to configure, start, stop the server and know + how deployment and archiving process. You will find out how to manage installed JBoss Servers + via JBoss AS Perspective. You will also read how to deploy modules onto the server. </para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">jBPM Tools Reference Guide</emphasis> + <ulink url="../../jbpm/html_single/index.html">(html)</ulink> + </para> + <para>With jBPM Tools Reference Guide we'll help you to facilitate a cross-product + learning and know how you can speed your development using special editors and visual designers. + We'll also guide you through the steps on how to create a simple process and test it + within jBPM jPDL perspective.</para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">Hibernate Tools Reference Guide</emphasis> + <ulink url="../../hibernatetools/html_single/index.html">(html)</ulink> + </para> + <para>Throughout this guide you will learn how to install and use Hibernate Tools bath via Ant and + through Eclipse. We'll supply you with the information on how to create mapping files, + configuration file as well as a file for controlling reverse engineering by using specific + wizards that Hibernate tooling provides. Also you will know about Code Generation and + peculiarities of work within Hibernate Console Perspective.</para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">ESB Editor Reference Guide</emphasis> + <ulink url="../../esb_ref_guide/html_single/index.html">(html)</ulink> + </para> + <para>This guide provides you with the information on ESB Editor which allows you to develop ESB + file.</para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">JBoss Portal Tools Reference Guide</emphasis> + <ulink url="../../jboss_portal_tools_ref_guide/html_single/index.html">(html)</ulink> + </para> + <para>The guide gives a detail look at how you can easily build a Portlet Web Application with + JBoss Tools and deploy it onto JBoss Portal.</para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">JBoss WS User Guide</emphasis> + <ulink url="../../ws_ref_guide/html_single/index.html">(html)</ulink> + </para> + <para>This guide gives you practical help on JBossWS usage.</para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">Exadel Studio Migration Guide</emphasis> + <ulink url="../../Exadel-migration/html_single/index.html">(html)</ulink> + </para> + <para>This document is intended to help you to migrate an existing Exadel JSF or Struts projects + from Exadel Studio into JBoss Developer Studio. </para> + </listitem> + +</itemizedlist> +</chapter> + + +</book> Added: branches/jbosstools-3.0.x/documentation/jbds-docs/all-guides.xml =================================================================== --- branches/jbosstools-3.0.x/documentation/jbds-docs/all-guides.xml (rev 0) +++ branches/jbosstools-3.0.x/documentation/jbds-docs/all-guides.xml 2009-03-06 18:46:29 UTC (rev 14086) @@ -0,0 +1,203 @@ +<?xml version="1.0" encoding="UTF-8"?> +<assembly> + <id>all-guides</id> + + <formats> + <format>dir</format> + </formats> + <includeBaseDirectory>false</includeBaseDirectory> + <fileSets> + <fileSet> + <directory>index/target/docbook/publish/en-US/html_single/</directory> + <outputDirectory>../</outputDirectory> + <filtered>false</filtered> + <lineEnding>keep</lineEnding> + <includes> + <include>index.html</include> + </includes> + <useStrictFiltering>false</useStrictFiltering> + <useDefaultExcludes>true</useDefaultExcludes> + <fileMode>0644</fileMode> + <directoryMode>0755</directoryMode> + </fileSet> + + <fileSet> + <directory>../guides/Legacy-jsf-struts/target/docbook/publish/en-US</directory> + <outputDirectory>/Legacy-jsf-struts</outputDirectory> + <filtered>false</filtered> + <lineEnding>keep</lineEnding> + <includes> + <include>**/*.*</include> + </includes> + <useStrictFiltering>false</useStrictFiltering> + <useDefaultExcludes>true</useDefaultExcludes> + <fileMode>0644</fileMode> + <directoryMode>0755</directoryMode> + </fileSet> + <fileSet> + <directory>../../as/docs/reference/target/docbook/publish/en-US</directory> + <outputDirectory>/as</outputDirectory> + <filtered>false</filtered> + <lineEnding>keep</lineEnding> + <includes> + <include>**/*.*</include> + </includes> + <useStrictFiltering>false</useStrictFiltering> + <useDefaultExcludes>true</useDefaultExcludes> + <fileMode>0644</fileMode> + <directoryMode>0755</directoryMode> + </fileSet> + <fileSet> + <directory>../../hibernatetools/docs/reference/target/docbook/publish/en-US</directory> + <outputDirectory>/hibernatetools</outputDirectory> + <filtered>false</filtered> + <lineEnding>keep</lineEnding> + <includes> + <include>**/*.*</include> + </includes> + <useStrictFiltering>false</useStrictFiltering> + <useDefaultExcludes>true</useDefaultExcludes> + <fileMode>0644</fileMode> + <directoryMode>0755</directoryMode> + </fileSet> + + <fileSet> + <directory>../../jbpm/docs/reference/target/docbook/publish/en-US</directory> + <outputDirectory>/jbpm</outputDirectory> + <filtered>false</filtered> + <lineEnding>keep</lineEnding> + <includes> + <include>**/*.*</include> + </includes> + <useStrictFiltering>false</useStrictFiltering> + <useDefaultExcludes>true</useDefaultExcludes> + <fileMode>0644</fileMode> + <directoryMode>0755</directoryMode> + </fileSet> + <fileSet> + <directory>../../seam/docs/reference/target/docbook/publish/en-US</directory> + <outputDirectory>/seam</outputDirectory> + <filtered>false</filtered> + <lineEnding>keep</lineEnding> + <includes> + <include>**/*.*</include> + </includes> + <useStrictFiltering>false</useStrictFiltering> + <useDefaultExcludes>true</useDefaultExcludes> + <fileMode>0644</fileMode> + <directoryMode>0755</directoryMode> + </fileSet> + + <fileSet> + <directory>../../jsf/docs/jsf_tools_ref_guide/target/docbook/publish/en-US</directory> + <outputDirectory>/jsf_tools_ref_guide</outputDirectory> + <filtered>false</filtered> + <lineEnding>keep</lineEnding> + <includes> + <include>**/*.*</include> + </includes> + <useStrictFiltering>false</useStrictFiltering> + <useDefaultExcludes>true</useDefaultExcludes> + <fileMode>0644</fileMode> + <directoryMode>0755</directoryMode> + </fileSet> + + + <fileSet> + <directory>../../jsf/docs/jsf_tools_tutorial/target/docbook/publish/en-US</directory> + <outputDirectory>/jsf_tools_tutorial</outputDirectory> + <filtered>false</filtered> + <lineEnding>keep</lineEnding> + <includes> + <include>**/*.*</include> + </includes> + <useStrictFiltering>false</useStrictFiltering> + <useDefaultExcludes>true</useDefaultExcludes> + <fileMode>0644</fileMode> + <directoryMode>0755</directoryMode> + </fileSet> + + <fileSet> + <directory>../../struts/docs/struts_tools_tutorial/target/docbook/publish/en-US</directory> + <outputDirectory>/struts_tools_tutorial</outputDirectory> + <filtered>false</filtered> + <lineEnding>keep</lineEnding> + <includes> + <include>**/*.*</include> + </includes> + <useStrictFiltering>false</useStrictFiltering> + <useDefaultExcludes>true</useDefaultExcludes> + <fileMode>0644</fileMode> + <directoryMode>0755</directoryMode> + </fileSet> + + <fileSet> + <directory>../../struts/docs/struts_tools_ref_guide/target/docbook/publish/en-US</directory> + <outputDirectory>/struts_tools_ref_guide</outputDirectory> + <filtered>false</filtered> + <lineEnding>keep</lineEnding> + <includes> + <include>**/*.*</include> + </includes> + <useStrictFiltering>false</useStrictFiltering> + <useDefaultExcludes>true</useDefaultExcludes> + <fileMode>0644</fileMode> + <directoryMode>0755</directoryMode> + </fileSet> + <fileSet> + <directory>../../esb/docs/esb_ref_guide/target/docbook/publish/en-US</directory> + <outputDirectory>/esb_ref_guide</outputDirectory> + <filtered>false</filtered> + <lineEnding>keep</lineEnding> + <includes> + <include>**/*.*</include> + </includes> + <useStrictFiltering>false</useStrictFiltering> + <useDefaultExcludes>true</useDefaultExcludes> + <fileMode>0644</fileMode> + <directoryMode>0755</directoryMode> + </fileSet> + + <fileSet> + <directory>../guides/Exadel-migration/target/docbook/publish/en-US</directory> + <outputDirectory>/Exadel-migration</outputDirectory> + <filtered>false</filtered> + <lineEnding>keep</lineEnding> + <includes> + <include>**/*.*</include> + </includes> + <useStrictFiltering>false</useStrictFiltering> + <useDefaultExcludes>true</useDefaultExcludes> + <fileMode>0644</fileMode> + <directoryMode>0755</directoryMode> + </fileSet> + <fileSet> + <directory>../guides/GettingStartedGuide/target/docbook/publish/en-US</directory> + <outputDirectory>/GettingStartedGuide</outputDirectory> + <filtered>false</filtered> + <lineEnding>keep</lineEnding> + <includes> + <include>**/*.*</include> + </includes> + <useStrictFiltering>false</useStrictFiltering> + <useDefaultExcludes>true</useDefaultExcludes> + <fileMode>0644</fileMode> + <directoryMode>0755</directoryMode> + </fileSet> + <fileSet> + <directory>../../jsf/docs/userguide/target/docbook/publish/en-US</directory> + <outputDirectory>/jsf</outputDirectory> + <filtered>false</filtered> + <lineEnding>keep</lineEnding> + <includes> + <include>**/*.*</include> + </includes> + <useStrictFiltering>false</useStrictFiltering> + <useDefaultExcludes>true</useDefaultExcludes> + <fileMode>0644</fileMode> + <directoryMode>0755</directoryMode> + </fileSet> + + </fileSets> + +</assembly> \ No newline at end of file Added: branches/jbosstools-3.0.x/documentation/jbds-docs/clean.sh =================================================================== --- branches/jbosstools-3.0.x/documentation/jbds-docs/clean.sh (rev 0) +++ branches/jbosstools-3.0.x/documentation/jbds-docs/clean.sh 2009-03-06 18:46:29 UTC (rev 14086) @@ -0,0 +1,9 @@ +-rm './Exadel-migration/html/images/jboss-logo copy.png' +-rm './Exadel-migration/html_single/images/jboss-logo copy.png' +-rm './Exadel-migration/eclipse/images/jboss-logo copy.png' +-rm './GettingStartedGuide/html/images/jboss-logo copy.png' +-rm './GettingStartedGuide/html_single/images/jboss-logo copy.png' +-rm './GettingStartedGuide/eclipse/images/jboss-logo copy.png' +-rm './jsf/html/images/jboss-logo copy.png' +-rm './jsf/html_single/images/jboss-logo copy.png' +-rm './jsf/eclipse/images/jboss-logo copy.png' Added: branches/jbosstools-3.0.x/documentation/jbds-docs/index/en/images/favicon.ico =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.0.x/documentation/jbds-docs/index/en/images/favicon.ico ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.0.x/documentation/jbds-docs/index/en/master.xml =================================================================== --- branches/jbosstools-3.0.x/documentation/jbds-docs/index/en/master.xml (rev 0) +++ branches/jbosstools-3.0.x/documentation/jbds-docs/index/en/master.xml 2009-03-06 18:46:29 UTC (rev 14086) @@ -0,0 +1,123 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.oasis-open.org/docbook/xml/4.3CR3/docbookx.dtd"> +<book> + <bookinfo> + <title>JBoss Tools Guides - Latest Version</title> + <pubdate>Last published: <?dbtimestamp format="B d, Y"?></pubdate> + <copyright> + <year>2007</year> + <year>2009</year> + <holder>JBoss, a division of Red Hat</holder> + </copyright> + </bookinfo> + <index> + <title/> + <indexentry> + <primaryie>Getting Started with JBoss Developer Studio Guide <ulink + url="en/GettingStartedGuide/html/index.html">(html)</ulink> + <ulink url="en/GettingStartedGuide/html_single/index.html">(html single)</ulink> + <ulink url="en/GettingStartedGuide/pdf/Getting_Started_Guide.pdf" + >(pdf)</ulink> + </primaryie> + </indexentry> + + <indexentry> + <primaryie>Seam Dev Tools Reference Guide <ulink url="en/seam/html/index.html" + >(html)</ulink> + <ulink url="en/seam/html_single/index.html">(html single)</ulink> + <ulink url="en/seam/pdf/Seam_Reference_Guide.pdf">(pdf)</ulink> + </primaryie> + </indexentry> + + <indexentry> + <primaryie>Visual Web Tools Reference Guide <ulink url="en/jsf/html/index.html" + >(html)</ulink> + <ulink url="en/jsf/html_single/index.html">(html single)</ulink> + <ulink url="en/jsf/pdf/Visual_Web_Tools_Reference_Guide.pdf">(pdf)</ulink> + </primaryie> + </indexentry> + + <indexentry> + <primaryie>JBoss Server Manager Reference Guide <ulink url="en/as/html/index.html" + >(html)</ulink> + <ulink url="en/as/html_single/index.html">(html single)</ulink> + <ulink url="en/as/pdf/AS_Reference_Guide.pdf">(pdf)</ulink> + </primaryie> + </indexentry> + + <indexentry> + <primaryie>jBPM Tools Reference Guide <ulink url="en/jbpm/html/index.html">(html)</ulink> + <ulink url="en/jbpm/html_single/index.html">(html single)</ulink> + <ulink url="en/jbpm/pdf/JBPM_Reference_Guide.pdf">(pdf)</ulink> + </primaryie> + </indexentry> + + <indexentry> + <primaryie>Hibernate Tools Reference Guide + <ulink url="en/hibernatetools/html/index.html">(html)</ulink> + <ulink url="en/hibernatetools/html_single/index.html">(html single)</ulink> + <ulink url="en/hibernatetools/pdf/Hibernatetools_Reference_Guide.pdf" + >(pdf)</ulink> + </primaryie> + </indexentry> + + <indexentry> + <primaryie>ESB Editor Reference Guide <ulink + url="en/esb_ref_guide/html/index.html">(html)</ulink> + <ulink url="en/esb_ref_guide/html_single/index.html">(html single)</ulink> + <ulink url="en/esb_ref_guide/pdf/ESB_Reference_Guide.pdf" + >(pdf)</ulink> + </primaryie> + </indexentry> + + + <indexentry> + <primaryie>JSF Tools Reference Guide <ulink + url="en/jsf_tools_ref_guide/html/index.html">(html)</ulink> + <ulink url="en/jsf_tools_ref_guide/html_single/index.html">(html single)</ulink> + <ulink url="en/jsf_tools_ref_guide/pdf/JSF_Tools_Reference_Guide.pdf" + >(pdf)</ulink> + </primaryie> + </indexentry> + + <indexentry> + <primaryie>JSF Tools Tutorial <ulink url="en/jsf_tools_tutorial/html/index.html" + >(html)</ulink> + <ulink url="en/jsf_tools_tutorial/html_single/index.html">(html single)</ulink> + <ulink url="en/jsf_tools_tutorial/pdf/JSF_Tools_Tutorial.pdf">(pdf)</ulink> + </primaryie> + </indexentry> + + <indexentry> + <primaryie>Struts Tools Reference Guide <ulink + url="en/struts_tools_ref_guide/html/index.html">(html)</ulink> + <ulink url="en/struts_tools_ref_guide/html_single/index.html">(html single)</ulink> + <ulink url="en/struts_tools_ref_guide/pdf/Struts_Tools_Reference_Guide.pdf" + >(pdf)</ulink> + </primaryie> + </indexentry> + + <indexentry> + <primaryie>Struts Tools Tutorial <ulink + url="en/struts_tools_tutorial/html/index.html">(html)</ulink> + <ulink url="en/struts_tools_tutorial/html_single/index.html">(html single)</ulink> + <ulink url="en/struts_tools_tutorial/pdf/Struts_Tools_Tutorial.pdf" + >(pdf)</ulink> + </primaryie> + </indexentry> + + + + <indexentry> + <primaryie>Exadel Studio Migration Guide <ulink + url="en/Exadel-migration/html/index.html">(html)</ulink> + <ulink url="en/Exadel-migration/html_single/index.html">(html single)</ulink> + <ulink url="en/Exadel-migration/pdf/Exadel_Studio_Migration_Guide.pdf" + >(pdf)</ulink> + </primaryie> + </indexentry> + + + </index> +</book> Added: branches/jbosstools-3.0.x/documentation/jbds-docs/index/pom.xml =================================================================== --- branches/jbosstools-3.0.x/documentation/jbds-docs/index/pom.xml (rev 0) +++ branches/jbosstools-3.0.x/documentation/jbds-docs/index/pom.xml 2009-03-06 18:46:29 UTC (rev 14086) @@ -0,0 +1,90 @@ +<project xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + + <modelVersion>4.0.0</modelVersion> + + <groupId>org.jboss.tools</groupId> + <artifactId>all-guides-index</artifactId> + <version>1.0-SNAPSHOT</version> + <packaging>jdocbook</packaging> + <name>All_Userguides_index</name> + + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.1.0-200803311251UTC-MPJDOCBOOK-8</version> + + <extensions>true</extensions> + + <dependencies> + <dependency> + <groupId>org.jboss</groupId> + <artifactId>jbossorg-docbook-xslt</artifactId> + <version>1.1.0</version> + </dependency> + <dependency> + <groupId>org.jboss</groupId> + <artifactId>jbossorg-jdocbook-style</artifactId> + <version>1.1.0</version> + <type>jdocbook-style</type> + </dependency> + </dependencies> + + <configuration> + <sourceDocumentName>master.xml</sourceDocumentName> + <sourceDirectory>${pom.basedir}/en</sourceDirectory> + <imageResource> + <directory>${pom.basedir}/en</directory> + <includes> + <include>images/**/*</include> + </includes> + </imageResource> + <cssResource> + <directory>${pom.basedir}/${cssdir}</directory> + </cssResource> + + <formats> + <format> + <formatName>html_single</formatName> + <stylesheetResource>file:${pom.basedir}/${stylesdir}/xslt/org/jboss/tools/xhtml-single.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + <options> + <xincludeSupported>true</xincludeSupported> + <xmlTransformerType>saxon</xmlTransformerType> + <!-- needed for uri-resolvers; can be ommitted if using 'current' uri scheme --> + <!-- could also locate the docbook dependency and inspect its version... --> + <docbookVersion>1.72.0</docbookVersion> + </options> + + </configuration> + </plugin> + </plugins> + </build> + + <distributionManagement> + <repository> + <!-- Copy the dist to the local checkout of the JBoss maven2 repo ${maven.repository.root} --> + <!-- It is anticipated that ${maven.repository.root} be set in user's settings.xml --> + <!-- todo : replace this with direct svn access once the svnkit providers are available --> + <id>repository.jboss.org</id> + <url>file://${maven.repository.root}</url> + </repository> + <snapshotRepository> + <id>snapshots.jboss.org</id> + <name>JBoss Snapshot Repository</name> + <url>dav:https://snapshots.jboss.org/maven2</url> + </snapshotRepository> + </distributionManagement> + + <properties> + <stylesdir>../../jbosstools-docbook-xslt/src/main/resources/</stylesdir> + <cssdir>../../jbosstools-jdocbook-style/src/main/org/css/</cssdir> + <translation>en-US</translation> + </properties> + +</project> Added: branches/jbosstools-3.0.x/documentation/jbds-docs/pom.xml =================================================================== --- branches/jbosstools-3.0.x/documentation/jbds-docs/pom.xml (rev 0) +++ branches/jbosstools-3.0.x/documentation/jbds-docs/pom.xml 2009-03-06 18:46:29 UTC (rev 14086) @@ -0,0 +1,55 @@ +<project xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + + <modelVersion>4.0.0</modelVersion> + + <groupId>org.jboss.tools</groupId> + <artifactId>all-guides</artifactId> + <version>1.0-SNAPSHOT</version> + <packaging>pom</packaging> + <name>All_Userguides</name> + + <modules> + <module>../jbosstools-docbook-xslt</module> + <module>../guides/Exadel-migration</module> + <module>../guides/GettingStartedGuide</module> + <module>../../as/docs/reference</module> + <module>../../hibernatetools/docs/reference</module> + <module>../../jbpm/docs/reference</module> + <module>../../jsf/docs/userguide</module> + <module>../../jsf/docs/jsf_tools_ref_guide</module> + <module>../../jsf/docs/jsf_tools_tutorial</module> + <module>../../seam/docs/reference</module> + <module>../../struts/docs/struts_tools_ref_guide</module> + <module>../../struts/docs/struts_tools_tutorial</module> + <module>../../esb/docs/esb_ref_guide</module> + + <module>index</module> + </modules> + + <build> + <plugins> + + <plugin> + <artifactId>maven-assembly-plugin</artifactId> + <version>2.2-beta-2</version> + <configuration> + <descriptors> + <descriptor>all-guides.xml</descriptor> + </descriptors> + <finalName>en</finalName> + <outputDirectory>jbds-docs</outputDirectory> + <appendAssemblyId>false</appendAssemblyId> + <ignoreDirFormatExtensions>true</ignoreDirFormatExtensions> + </configuration> + </plugin> + + </plugins> + </build> + + <properties> + <translation>en-US</translation> + </properties> + +</project> Added: branches/jbosstools-3.0.x/documentation/jbds-docs/settings.xml =================================================================== --- branches/jbosstools-3.0.x/documentation/jbds-docs/settings.xml (rev 0) +++ branches/jbosstools-3.0.x/documentation/jbds-docs/settings.xml 2009-03-06 18:46:29 UTC (rev 14086) @@ -0,0 +1,95 @@ +<!-- +added to fix build error. +running with regular hudson maven fails with error resolving + +maven-jdocbook-plugin 2.1.0-200803311251UTC-MPJDOCBOOK-8 + + --> + +<settings> + <proxies> + </proxies> + <servers> + </servers> + <mirrors> + </mirrors> + <profiles> + <profile> + <id>jboss</id> + <repositories> + <repository> + <releases> + <enabled>true</enabled> + </releases> + <snapshots> + <enabled>false</enabled> + <updatePolicy>never</updatePolicy> + </snapshots> + <id>repository.jboss.com</id> + <name>Jboss Repository for Maven</name> + <url> + http://repository.jboss.com/maven2/ + </url> + <layout>default</layout> + </repository> + <repository> + <releases> + <enabled>true</enabled> + </releases> + <snapshots> + <enabled>true</enabled> + <updatePolicy>never</updatePolicy> + </snapshots> + <id>snapshots.jboss.org</id> + <name>Jboss Repository for Maven</name> + <url> + http://snapshots.jboss.org/maven2/ + </url> + <layout>default</layout> + </repository> + <repository> + <id>java.net</id> + <url>https://maven-repository.dev.java.net/nonav/repository</url> + <layout>legacy</layout> + </repository> + </repositories> + <pluginRepositories> + <pluginRepository> + <releases> + <enabled>true</enabled> + </releases> + <snapshots> + <enabled>false</enabled> + <updatePolicy>never</updatePolicy> + </snapshots> + <id>repository.jboss.com</id> + <name>Jboss Repository for Maven</name> + <url> + http://repository.jboss.com/maven2/ + </url> + <layout>default</layout> + </pluginRepository> + <pluginRepository> + <releases> + <enabled>false</enabled> + </releases> + <snapshots> + <enabled>true</enabled> + <updatePolicy>never</updatePolicy> + </snapshots> + <id>snapshots.jboss.org</id> + <name>Jboss Repository for Maven</name> + <url> + http://snapshots.jboss.org/maven2/ + </url> + <layout>default</layout> + </pluginRepository> + </pluginRepositories> + </profile> + </profiles> + + <activeProfiles> + <activeProfile>jboss</activeProfile> + </activeProfiles> + +</settings> Added: branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/master_output.xml =================================================================== --- branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/master_output.xml (rev 0) +++ branches/jbosstools-3.0.x/esb/docs/esb_ref_guide/en/master_output.xml 2009-03-06 18:46:29 UTC (rev 14086) @@ -0,0 +1,891 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + +[<!ENTITY introduction SYSTEM "modules/introduction.xml"> +<!ENTITY esb_support SYSTEM "modules/esb_support.xml"> +<!ENTITY esb_editor SYSTEM "modules/esb_editor.xml"> + +<!ENTITY seamlink "../../seam/html_single/index.html"> +<!ENTITY aslink "../../as/html_single/index.html"> +<!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> +<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html"> +<!ENTITY jbpmlink "../../jbpm/html_single/index.html"> +<!ENTITY jsflink "../../jsf/html_single/index.html"> +<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html"> +<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html"> +<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html"> +<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> + +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + + <bookinfo> + <title>ESB Tools Reference Guide</title> + <author&gt;&lt;firstname&gt;Svetlana&lt;/firstname&gt;&lt;surname&gt;Mukhina&lt;/surname&gt;&lt;email&gt;smukhina(a)exadel.com&lt;/email&gt;&lt;/author&gt; + <author><firstname>Tatyana</firstname><surname>Romanovich</surname></author> + + <pubdate>April 2008</pubdate> + <copyright> + <year>2007</year> + <year>2009</year> + <holder>JBoss, a division of Red Hat</holder> + </copyright> + <releaseinfo> + Version: 1.1.0.GA + </releaseinfo> + +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/esb_ref_gu... version</ulink> + </para> +</abstract> + +</bookinfo> + <toc></toc> + + +<chapter id="introduction" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/esb/docs/esb_ref_guide/en/modules/introduction.xml"> + <?dbhtml filename="introduction.html"?> + + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + <keyword>JBoss Tools</keyword> + <keyword>JBDS</keyword> + <keyword>ESB</keyword> + </keywordset> + </chapterinfo> + + <title>Introduction</title> + + <section> + + <title>What is ESB?</title> + + <para>ESB (Enterprise Service Bus) - an abstraction layer on top of implementation of an + enterprise messaging system that provides the features Service Oriented + Architectures may be implemented with.</para> + <para>If you want to develop applications using ESB technology JBoss ESB also meets your + needs. The JBoss Tools provide an ESB editor and all necessary wizards for creating an ESB + file.</para> + <para>In this guide we provide you with the information on JBoss ESB support (installation, configuration and deployment) and usage of ESB Editor which allows you to + develop an ESB file much faster and with far fewer errors so sparing your time.</para> + + </section> + + <section> + <title>Other relevant resources on the topic</title> + + <para>You can find a set of benefits and other extra information on:</para> + <itemizedlist> + <listitem> + <para> + <ulink url="http://www.jboss.org/jbossesb">JBoss ESB</ulink> + </para> + </listitem> + <listitem> + <para> + <ulink url="http://wiki.jboss.org/wiki/JBossESB">JBoss Wiki</ulink> + </para> + </listitem> + <listitem> + <para> + <ulink url="http://www.jboss.org/jbossesb/docs/index.html">JBoss ESB + Documentation Library</ulink> + </para> + </listitem> + </itemizedlist> + + <para>The latest <property moreinfo="none">JBoss Tools/JBoss Developer Studio</property> documentation + builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">her... + + </section> +</chapter> + + +<chapter id="esb_support" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/esb/docs/esb_ref_guide/en/modules/esb_support.xml"> + <?dbhtml filename="esb_support.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>ESB</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>ESB Support</title> + + <para>In this section we will focus on all concepts that <property moreinfo="none">JBoss Tools</property> + integrate for working with JBoss ESB.</para> + + <section> + <title>ESB Tools Installation</title> + + <para>This chapter will provide you with the information on how to install + JBoss ESB plugin into Eclipse.</para> + + <para>ESB Tools come as one module of JBoss Tools project. Since ESB Tools have a + dependence on other JBoss Tools modules we recommend you to install a bundle + of all <ulink url="http://labs.jboss.com/tools/download/index.html">JBoss + Tools plug-ins</ulink>. You can find all necessary installation instructions on JBoss Wiki in the <ulink url="http://labs.jboss.com/wiki/InstallingJBossTools">Instal... section.</para> + </section> + + <section> + <title>Creating a ESB Project</title> + <para>In this chapter we suggest a step-by-step walk-through of creating a new + ESB project. Let's try to create a new JBoss ESB project.</para> + + <para>We will show you how to use the ESB Project Creation wizard for creating a new ESB project and setting basic ESB classpath.</para> + + <para>Select <emphasis> + <property moreinfo="none">File &gt;New &gt; Project...</property> + </emphasis> in the main menu bar or context menu for selected project and + then <emphasis> + <property moreinfo="none">ESB &gt; ESB Project</property> + </emphasis> in the dialog opened:</para> + + <figure float="0"> + <title>Select a Wizard dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/01_create_esb_project.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> Clicking <emphasis> + <property moreinfo="none">Next</property> + </emphasis> brings you to the JBoss ESB Project wizard page where a project name, ESB version and target JBoss Runtime are to be specified. Specify, for example, <emphasis> + <property moreinfo="none">helloworld</property> + </emphasis> as a Project name and accept the default ESB version.</para> + <figure float="0"> + <title>JBoss ESB Project wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/02_create_esb_project.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> Clicking <emphasis> + <property moreinfo="none">Next</property> + </emphasis> brings you to the ESB facet installation page where you can + specify Java Source Directory and ESB Content Directory. ESB Content Directory is a folder that contains the most of + artifacts that an ESB archive needs. You also can configure ESB libraries to the project by selecting a ESB runtime using one of the options: + </para> + <para>1. Use <emphasis> + <property moreinfo="none">Server Supplied ESB Runtime</property> + </emphasis> + + </para> + <para> 2. Select a ESB runtime from the JBoss ESB runtime list predefined in the preferences + </para> + <para>If you choose the first option, make sure that the project has the Target JBoss Runtime set and this runtime has a ESB runtime installed. + </para> + <figure float="0"> + <title>Install ESB facet step</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/03_create_esb_project.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> and a ESB project with the default <emphasis><property moreinfo="none">jboss-esb.xml</property></emphasis> + will be created. </para> + + <figure float="0"> + <title>The generated ESB project structure</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/04_create_esb_project.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="ESB_project_wizard" xreflabel="here"> + <title>Creating ESB Project using JBoss Tools Project Examples Wizard</title> + <para>JBoss Tools provides a Project Example wizard that is an easy way for users to create some kinds of projects to be used as examples with some predefined structure. Let's start + creating a ESB project using this wizard.</para> + + <para>Before creating a ESB project example create JBoss Runtime with name <emphasis><property moreinfo="none"> + JBoss 4.2 Runtime</property></emphasis>, it will be used by your ESB project example. </para> + + <para>Select <emphasis> + <property moreinfo="none">File &gt;New &gt; Others </property> + </emphasis> , in the main menu bar or context menu for selected project and + then <emphasis> + <property moreinfo="none">JBoss Tools &gt; Project Examples</property> + </emphasis> in the New dialog:</para> + + <figure float="0"> + <title>Select a wizard - Project Examples</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/05_esb_project_example.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> Clicking <emphasis> + <property moreinfo="none">Next</property> + </emphasis> brings you to the wizard page where you can select a ESB project example from the example list. + Every ESB example has two projects, one is a ESB project and another is a Java project used to test the ESB project.</para> + <para>Here is a list of ready examples available:</para> + + <itemizedlist> + + <listitem><para><emphasis role="bold">JBoss ESB HelloWorld Example</emphasis> - demonstrates the minimal files necessary to make a basic ESB component execute as well as to prove that the ESB os properly configured.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB HelloWorld Action Example</emphasis> - demonstrates the use of multiple action invocations from a single configuration. You can use a single Action class and make multiple method calls or use multiple Action classes. </para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB HelloWorld File Action Example</emphasis> - demonstrates using the File gateway feature of the JBoss ESB. Files that are found in a particular directory with a particular extension are sent to a JMS queue with actions for processing.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Web Service consumer1 Example</emphasis> - demonstrates how to consume a 181 Web Service in an ESB action.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Web Service producer Example</emphasis> - demonstrates how to deploy a JSR181 Webservice endpoint on JBossESB using the SOAPProcessor action.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Smooks CSV -&gt; XML Example</emphasis> - demonstrates how to transform a comma separated value (CSV) file to an XML.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Smooks XML -&gt; POJO Example</emphasis> - demonstrates the use of Smooks performing a simpe transformation by converting an XML file into Java POJOs.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Smooks XML -&gt; XML date-manipulation Example</emphasis> - demonstrates how to manually define and apply a Message Transformation within JBoss ESB.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Smooks XML -&gt; XML Example</emphasis> - a very basic example of how to manually define and apply a Message Transformation within JBoss ESB. It applies a very simple XSLT to a SampleOrder.xml message and prints the before and after XML to the console. </para></listitem> + + </itemizedlist> + + + + <para>We will take as our example <emphasis><property moreinfo="none">JBoss ESB HelloWorld Example</property> </emphasis> ESB and Client project:</para> + + + <figure float="0"> + <title>JBoss Tools ESB Project Examples</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/06_esb_project_example.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para>Choose them using the Ctrl button and then click + <emphasis><property moreinfo="none">Finish</property></emphasis>. As a result you will get two projects created:</para> + <figure float="0"> + <title>JBoss ESB Project Examples: helloworld and helloworld_testclient</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/07_esb_project_example.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> Deploy the HelloWorld ESB project and run a test class in the client Java project to see the test result in the Console view.</para> + </section> + + <section> + <title>Deploying a ESB Project</title> + <para>In this chapter youwill see how to deploy a ESB project using the WTP deployment framework.</para> + + <para>Before deploying the project, open the JBoss Server View by selecting <emphasis><property moreinfo="none">Window &gt; Show View &gt; Other &gt; + Server &gt; JBoss Server View</property></emphasis>, + create a JBoss Server in the Server view and start it, and then right click the created JBoss server, + select <emphasis><property moreinfo="none"> </property> Add and Remove Projects</emphasis>, + and add the ESB projects you want to deploy from the left side to the right side in the opened dialog. </para> + + <figure float="0"> + <title>Add and Remove Projects</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/08_esb_project_deploy.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Click <emphasis><property moreinfo="none">Finish</property> </emphasis> to add the project to the server. + You also can drag the ESB project from the Project View to the server.</para> + + <figure float="0"> + <title>JBoss Server View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/09_esb_runtime_new.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Thus, you have just added the ESB project to the JBoss server module list. Right click the JBoss Server and select <emphasis><property moreinfo="none">Publish</property></emphasis> to publish the project on the server. + You can check the deploying result in the Console view.</para> + <para>The <emphasis><property moreinfo="none">Run</property></emphasis> and <emphasis><property moreinfo="none">Debug</property></emphasis> options work on ESB projects causing a (re)deploy for a user designated server.</para> + <para>You can also use the "Finger touch" for a quick restart of the project without restarting the server:</para> + <figure float="0"> + <title>Finger Touch button</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/23_finger_touch.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The "Finger" touches descriptors dependent on project (i.e. web.xml for WAR, application.xml for EAR) and now it is also available for jboss-esb.xml in ESB projects.</para> + <para>You can also deploy your ESB project as an .esb archive. Right-click on the project, choose <emphasis><property moreinfo="none">Export</property></emphasis>:</para> + + <figure float="0"> + <title>Export of ESB project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/24_export_button.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Choose <emphasis><property moreinfo="none">ESB</property></emphasis> &gt; <emphasis><property moreinfo="none">ESB File</property></emphasis> and click <emphasis><property moreinfo="none">Next</property></emphasis>:</para> + + <figure float="0"><title>Choosing ESB File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/25_esb_file.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>And finally export the ESB project to the file system: choose the destination, choose the target runtime if need a specific one and make the appropriate settings for the archive. Then click <emphasis><property moreinfo="none">Finish</property></emphasis>.</para> + + <figure float="0"><title>ESB Export</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/26_esb_export.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Your project is deployed as an .esb archive.</para> + <para>An ESB archive can be created for ESB projects only. It is also possible to deploy an .esb archive to a JBoss AS based server with JBoss ESB installed.</para> + + + </section> + + <section> + <title>Creating a ESB File</title> + <para>In this chapter we suggest a step-by-step walk-through of creating your own + simple file. Let's try to organize a new ESB file.</para> + + <para>We will show you how to use the Creation wizard for creating a new ESB file.</para> + + <para>At first you should open any project. Select <emphasis> + <property moreinfo="none">File &gt;New &gt; Other...</property> + </emphasis> in the main menu bar or context menu for selected project and + then <emphasis> + <property moreinfo="none">ESB &gt; ESB File</property> + </emphasis> in the New dialog:</para> + + <figure float="0"> + <title>Select a wizard - ESB File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_support/01_create_esb.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> Clicking <emphasis> + <property moreinfo="none">Next</property> + </emphasis> brings you to the wizard page where a folder, a name and a version for the file should be specified. Choose, for example, <emphasis> + <property moreinfo="none">jboss-esb.xml</property> + </emphasis> as the name and accept the selected projects folder and the default + version.</para> + <figure float="0"> + <title>Folder, Name and Version for ESB file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_support/02_create_esb.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Thus, your file will be created in the selected projects folder by default. If + you want to change the folder for your future file click <emphasis> + <property moreinfo="none">Browse...</property> + </emphasis> button to set needed folder or simply type it.</para> + + <para>Clicking on <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> results in the file being generated. The wizard creates one xml + file.</para> + + </section> + + <section> + <title>Configuring ESB Runtime in Preferences</title> + <para>In this chapter you will know how to predefine a JBoss ESB runtime on the Preferences page.</para> + + <para>You may already know, there are two ways to set JBoss ESB runtime when creating a ESB project, + one is to use the project target JBoss runtime, and another is to select a JBoss ESB runtime predefined in JBoss Tools preferences. + Let's configure it.</para> + + <para>Select <emphasis> + <property moreinfo="none">Window &gt;Preferences &gt; JBoss Tools &gt; JBoss ESB Runtime</property> + </emphasis>, to open the JBoss ESB Runtime Preferences page where you can add, remove and Edit a JBoss ESB runtime.</para> + + <figure float="0"> + <title>JBoss ESB Runtimes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/10_esb_runtime.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> Select <emphasis><property moreinfo="none">Add</property></emphasis> to open a dialog where you can specify the JBoss ESB runtime location, name and version number. + You also can customize the libraries of the runtime by checking the <emphasis><property moreinfo="none">Customize JBoss ESB Runtime jars</property> </emphasis> checkbox. </para> + + <figure float="0"> + <title>Configure new JBoss ESB Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/11_esb_runtime_new.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The new JBoss ESB Runtime will be configured. Click <emphasis> <property moreinfo="none">OK</property> </emphasis> to finish and save the preferences. + You can use the configuration when creating a JBoss ESB project. </para> + <para>When a ESB runtime is configured for your ESB project you are able to change it to any other using the classpath container page for ESB runtime. To do that, turn to the Package Explorer view and right-click the "JBoss ESB Runtime" library. Select <emphasis><property moreinfo="none">Properties</property></emphasis> and a table listing all available JBoss ESB runtimes will appear:</para> + + <figure float="0"> + <title>Classpath Container Page to change ESB runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/20_classpath_container.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + + <para>Choose one of them to set to the ESB project and click <emphasis><property moreinfo="none">Ok</property></emphasis>.</para> + <para>ESB container allows Source and JavaDoc locations to be set via the Properties dialog on each contained .jar: right-click on any .jar file, select <emphasis><property moreinfo="none">Properties</property></emphasis>. Choose <emphasis><property moreinfo="none">Java Source Attachment</property></emphasis> and select location (folder, JAR or zip) containing new source for the chosen .jar using one of the suggested options (workspace, external folder or file) or enter the path manually:</para> + + <figure float="0"> + <title>Classpath Container: Java Source Attachment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/21_source.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click on <emphasis><property moreinfo="none">Apply</property></emphasis> and then on <emphasis><property moreinfo="none">Ok</property></emphasis>.</para> + <para>To change Javadoc Location choose <emphasis><property moreinfo="none">Javadoc Location</property></emphasis> and specify URL to the documentation generated by Javadoc. The Javadoc location will contain a file called <emphasis><property moreinfo="none">package-list</property></emphasis>:</para> + + <figure float="0"> + <title>Classpath Container: Javadoc Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/22_Javadoc.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click on <emphasis><property moreinfo="none">Apply</property></emphasis> and then on <emphasis><property moreinfo="none">Ok</property></emphasis>.</para> + + </section> + + + <section id="using_SOA"> + <title>Using and Configuring SOA Platform</title> + + <para>In this chapter you will know what is JBoss Enterprise SOA Platform and how you can configure it to use for your ESB projects. </para> + + <para>JBoss Enterprise SOA Platform delivers a flexible, standards-based platform to integrate applications, SOA services, business events and automate business processes. The SOA Platform integrates specific versions of JBoss ESB, jBPM, Drools and the JBoss Enterprise Application Platform that are certified to work together in a single supported enterprise distribution.</para> + <para>Having configured JBoss Enterprise SOA Platform for your ESB project you don't need to install and configure ESB server and runtime as they are already included.</para> + + <para>Check here to find more details on the platform: <ulink url="http://www.jboss.com/products/platforms/soa">JBoss Enterprise SOA Platform</ulink> and <ulink url="http://www.jboss.com/products/platforms/soa/components">... Enterprise SOA Platform Component Details</ulink>.</para> + <para>You can find out what is SOA here: <ulink url="http://www.jboss.org/jbossesb/resources/SOABasics.html">... of SOA</ulink> and <ulink url="http://www.jboss.org/jbossesb/resources/SOAEOA.html">SOA and EOA</ulink>.</para> + + <para>To configure the JBoss Enterprise SOA platform select <emphasis> + <property moreinfo="none">Window &gt; Preferences &gt; Server &gt; Runtime Enironments</property></emphasis>, that will open the Server Runtime Environments Preferences page where you can add, remove and edit a Server Runtime Environment.</para> + + <figure float="0"> + <title>Configure new Server Runtime Environment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/13NewServerRuntimeEnv.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Select <emphasis><property moreinfo="none">Add</property></emphasis>, choose <emphasis><property moreinfo="none">JBoss 4.2 Runtime</property></emphasis> as a type of runtime environment, check the <emphasis><property moreinfo="none">Create a new local server</property></emphasis> checkbox and click <emphasis><property moreinfo="none">Next</property></emphasis>:</para> + <figure float="0"> + <title>Type of Server Runtime Environment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/14typeOfRuntime.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>On the next step you can specify a name of the server runtime environement and browse to its location. Click <emphasis><property moreinfo="none">Finish</property></emphasis> to add the server runtime environment.</para> + + + <figure float="0"> + <title>New Server Runtime Environment Details</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/15AddNew.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Now you have your SOA platform configured. To check the configuration create a ESB Project using instructions described <xref linkend="ESB_project_wizard"></xref>. As a result you will have two projects created:</para> + + <figure float="0"> + <title>Helloworld Projects Created</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/16HelloworldProjects.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Then you will need to add JBoss ESB libraries to your projects to configure the SOA server runtime exactly for your projects. Right-click on your project, select <emphasis><property moreinfo="none">Build Path &gt; Add Libraries</property></emphasis>:</para> + + <figure float="0"> + <title>Add Libraries</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/17_Add_new_libraries.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Choose <emphasis><property moreinfo="none">JBoss ESB Libraries</property></emphasis> and click <emphasis><property moreinfo="none">Next</property></emphasis>:</para> + + <figure float="0"> + <title>ESB Libraries</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/18_select_libraries.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Select the necessary runtime to add to the project classpath:</para> + + + <figure float="0"> + <title>Select a ESB runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/19_select_runtime.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click <emphasis><property moreinfo="none">Finish</property></emphasis>.</para> + <para>Now you can deploy your Helloworld project to the server and run a test class in the client Java project to see the test result in the Console view.</para> + + + +</section> + + + + + + + + + + +</chapter> + + +<chapter id="esb_editor" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/esb/docs/esb_ref_guide/en/modules/esb_editor.xml" xreflabel="esb_editor"> + <?dbhtml filename="esbEditor.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss ESB</keyword> + <keyword>Editor</keyword> + <keyword>ESB</keyword> + </keywordset> + </chapterinfo> + + <title>ESB Editor</title> + + <para> ESB editor has lots of useful features, they are described in details in this chapter. In + addition you'll get to know with how <property moreinfo="none">ESB Editor</property> uses combined + visual and source editing of esb files.</para> + + <section id="esb_file"> + + <title>ESB File Editor</title> + <para><property moreinfo="none">ESB File Editor</property> is a powerful and customizable tool. ESB File + Editor allows developing an application using ESB technology.</para> + + <para>ESB file editor has two tabs: Tree and Source.</para> + + <para>You can switch to Tree. The Tree view for the editor displays all ESB artifacts in a + tree format. By selecting any node you can see and edit its properties which will appear + in the right-hand area. For example, a Provider:</para> + <figure float="0"> + <title>Tree View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/01_esb_tree_view.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>You can easily switch from Tree to Source by selecting the Source tab at the bottom of + the editor and work in <property moreinfo="none">Source view</property>.</para> + + <figure float="0" id="sourceView"> + <title>Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/02_esb_source_view.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The Source view for the editor displays a text content of the ESB file. It is always + synchronized with <property moreinfo="none">Tree view</property>, so any changes made in one of the + views will immediately appear in the other.</para> + + <para>No matter what view you select, you get full integration with <property moreinfo="none">Outline + view</property>. For example, you can work in the Source view with the help of the + Outline view. The Outline view shows a tree structure of the ESB file. Simply select any + element in the <property moreinfo="none">Outline view</property> and it will jump to the same place in + the Source editor, so you can navigate through the source code with Outline view.</para> + <figure float="0"> + <title>Outline View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/03_esb_outline_view.png" scale="70"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Adding, editing or deleting of some artifacts operations are available right in the + <property moreinfo="none">Tree view</property> . Right-click any node and select one of the + available actions in the context menu. For example, you can easily add a new Provider:</para> + <para></para> + <figure float="0"> + <title>Adding New Provider</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/04_esb_add_provider.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Then you can add Channels and Properties for the Providers the same way or using the forms with <property moreinfo="none">Add</property>, <property moreinfo="none">Edit</property> and + <property moreinfo="none">Remove</property> buttons to the right.</para> + + <para>You can easily add a new Service too:</para> + <figure float="0"> + <title>Adding New Service</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/05_esb_add_service.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The same way you can create a listener for service and other elements of ESB:</para> + <figure float="0"> + <title>Adding New Listener for Service</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/06_esb_add_listener.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The same actions can be done in the right part of <property moreinfo="none">Tree view</property> tab + (Form editor) using <property moreinfo="none">Add</property>, <property moreinfo="none">Edit</property> and + <property moreinfo="none">Remove</property> buttons.</para> + + + <para>In order to add a new generic Action to your ESB XML file you should select the + Actions node under the Services, then right-click and choose <emphasis> + <property moreinfo="none">New &gt; Generic Action</property>. </emphasis></para> + + <figure float="0"> + <title>Adding New Action in the Tree View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/11_esb_editor.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Or instead make use of <emphasis> + <property moreinfo="none">Add...</property> + </emphasis> button in the <property moreinfo="none">Form editor</property> on the left.</para> + <figure float="0"> + <title>Adding New Action in the Form Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/12_esb_editor.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>As you can see on the bath figures above, the context menu will also prompt you to + insert one of the Actions that are supplied out-of-the-box with <property moreinfo="none">JBoss + ESB</property>. After choosing one an appeared <property moreinfo="none">New Action wizard</property> + will ask you to fill out a name field and other fields specific for each Action + property. For example, for <emphasis> + <property moreinfo="none">Content Based Router</property> + </emphasis> Action the wizard looks as follows:</para> + + <figure float="0"> + <title>New Action Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/13_esb_editor.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>After confirming creating the Action you can see it in the Tree under the <emphasis> + <property moreinfo="none">Actions</property> + </emphasis> node and preview as well as edit its settings in the <property moreinfo="none">Form + editor</property> on the left.</para> + + <figure float="0"> + <title>Form Editor for Content Based Router</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/14_esb_editor.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para><property moreinfo="none">ESB editor</property> can recognize some specific objects. On the figure you + can see <emphasis>org.jboss.soa.esb.actions.ContentBasedRouter</emphasis> in the <emphasis> + <property moreinfo="none">Class</property> + </emphasis> section.</para> + + </section> + + <section id="esb_editors_features"> + + <title>ESB Editors Features</title> + <para>JBoss ESB tooling has powerful editor features that help you easily make use of + content and code assist.</para> + <para>This last chapter covers capabilities on how you can use ESB editor.</para> + + <section id="ESBsyntaxvalidation84"> + + <title>ESB syntax validation</title> + <para>When working in <property moreinfo="none">JBoss ESB editor</property> you are constantly provided + with feedback and contextual error checking as you type. In the Source viewer, if at + any point a tag is incorrect or incomplete, an error will be indicated next to the + line and also in the <property moreinfo="none">Problems view</property> below.</para> + </section> + + <section id="ESBSupportXMLSchema"> + <title>Support for XML Schema</title> + + <para>JBoss ESB Framework fully <link linkend="sourceView">supports XML files based on + schemas as well as DTDs</link>.</para> + <note><title>Note:</title> + <para>The schema used behind ESB editor now uses the latest version available (from SOA-P 4.3). This removes the errors/warnings some users have reported seeing when using SOA-P specific esb.xml files.</para> </note> + + </section> + + <!--<section id="OpenOnSelection"> + + <title>OpenOn</title> + + <para><property>OpenOn</property> let&apos;s you easily navigate through your + project without using the Package Explorer view (project tree). With OpenOn, you can + simply click on a reference to another file and that file will be opened.</para> + + <para>OpenOn is available for the XML files </para> + + <para>Press and hold down the Ctrl key. As you move the mouse cursor over different + file references in the file, they display an underline. When you have the mouse + cursor over the name of the file you want to open, click and the file will open + in its own editor. In this example the managed bean NameBean will open.</para> + + </section> + --> + + <section id="ESBContentAssist"> + + <title>Content Assist for ESB XML file</title> + + <para>When you work with any ESB XML file <property moreinfo="none">Content Assist</property> is + available to help you. It provides pop-up tip to help you complete your code + statements. It allows you to write your code faster and with more accuracy. Content + assist is always available in the Source mode. Simply type <emphasis> + <property moreinfo="none">Ctrl-Space</property> + </emphasis> to see what is available.</para> + + <para>Content Assist for ESB XML file:</para> + <figure float="0"> + <title>Content Assist for ESB XML file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/08_esb_features.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Content Assist for attributes:</para> + <figure float="0"> + <title>Content Assist for attributes:</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/09_esb_features.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + <!-- </section> + + <section id="ContentAssistWithinTreeEditor"> + + <title>Content Assist within Tree ESB Editor</title> + + <para>JBoss Developer Studio also provides Content Assist when working within the Tree ESB editor. + Just click <emphasis><property>Ctrl-Space</property>.</emphasis></para> + <figure> + <title>Content Assist in Tree ESB Editor</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/esb_file/09_editors_features.png" scale="85"/> + </imageobject> + </mediaobject> + </figure> + </section> --> + </section> + + <section id="FullControlOverSourceFiles-SynchronizedSourcAndVisualEditing"> + + <title>Synchronized Source and Visual Editing</title> + + <para>ESB file can be edited in either source or extra visual modes at the same time.</para> + + <para>JBoss Tools provide you two different editors to speed your development: a + graphical view (<property moreinfo="none">Tree</property>) and source (<property moreinfo="none">Source</property>). + At the same time, you always have full control over esb source file. Any changes you + make in the source view will immediately appear in the tree view. Both views are + synchronized, you can edit the file in any view.</para> + + <figure float="0"> + <title>Two Views are Synchronized</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/10_esb_features.png" scale="70"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In summary, this reference supplies you with all necessary information on the + functionality that JBoss ESB Editor provides for work with JBoss ESB.</para> + </section> + </section> +</chapter> + + +</book> Added: branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/master_output.xml =================================================================== --- branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/master_output.xml (rev 0) +++ branches/jbosstools-3.0.x/hibernatetools/docs/reference/en/master_output.xml 2009-03-06 18:46:29 UTC (rev 14086) @@ -0,0 +1,5191 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + +[ +<!ENTITY preface SYSTEM "modules/preface.xml"> +<!ENTITY setup SYSTEM "modules/setup.xml"> +<!ENTITY codegenarchitecture SYSTEM "modules/codegenarchitecture.xml"> +<!ENTITY plugins SYSTEM "modules/plugins.xml"> +<!ENTITY ant SYSTEM "modules/ant.xml"> +<!ENTITY reveng SYSTEM "modules/reverseengineering.xml"> +<!ENTITY codegen SYSTEM "modules/codegen.xml"> + +<!ENTITY seamlink "../../seam/html_single/index.html"> +<!ENTITY aslink "../../as/html_single/index.html"> +<!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> +<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html"> +<!ENTITY jbpmlink "../../jbpm/html_single/index.html"> +<!ENTITY jsflink "../../jsf/html_single/index.html"> +<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html"> +<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html"> +<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html"> +<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> + +]><book lang="en" xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + <bookinfo> + <title>Hibernate Tools Reference Guide</title> + + <author&gt;&lt;firstname&gt;Max&lt;/firstname&gt;&lt;surname&gt;Andersen&lt;/surname&gt;&lt;email&gt;max.andersen(a)jboss.com&lt;/email&gt;&lt;/author&gt; + <author><firstname>Olga</firstname><surname>Chikvina</surname></author> + <author&gt;&lt;firstname&gt;Svetlana&lt;/firstname&gt;&lt;surname&gt;Mukhina&lt;/surname&gt;&lt;email&gt;smukhina(a)exadel.com&lt;/email&gt;&lt;/author&gt; + + <pubdate>April 2008</pubdate> + <copyright> + <year>2007</year> + <year>2009</year> + <holder>JBoss, a division of Red Hat</holder> + </copyright> + + <releaseinfo> + Version: 3.2.4.GA + </releaseinfo> + + + <mediaobject> + <imageobject> + <imagedata fileref="images/hibernate_logo_a.png" format="PNG"></imagedata> + </imageobject> + </mediaobject> + +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/hibernatet... version</ulink> + </para> +</abstract> + + </bookinfo> + <toc></toc> + + +<chapter id="preface" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/hibernatetools/docs/reference/en/modules/preface.xml"> + + <title>Preface</title> + + <para><property moreinfo="none">Hibernate Tools</property> is a toolset for <ulink url="http://www.hibernate.org/6.html">Hibernate 3</ulink> and <ulink url="http://www.hibernate.org/27.html">related projects</ulink>. The tools provide Ant + tasks and Eclipse plugins for performing reverse engineering, code generation, visualization + and interaction with Hibernate.</para> + + <section id="hibernate_key_features"> + <title>Key Features</title> + + <para>First, we propose to look through the list of key features that you can benefit from + if you start using <property moreinfo="none">Hibernate Tools</property>.</para> + + <table> + <title>Key Functionality for Hibernate Tools</title> + <tgroup cols="3"> + + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec colnum="2" colwidth="5*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + + <tbody> + + <row> + <entry> + <para>Code Generation through Ant Task</para> + </entry> + <entry> + <para>Allows to execute mapping or Java code generation from reverse + engineering, schema generation and generation of other artifacts + during the build process.</para> + </entry> + <entry><link linkend="ant">ant task</link></entry> + </row> + + <row> + <entry> + <para>Wizards for creation + purposes and code + generation</para> + </entry> + <entry> + <para> A set of wizards are provided with the Hibernate Eclipse tools to + quickly create common Hibernate files such as configuration + (cfg.xml) files, mapping files and revenge.xml as well. Code + Generation wizard helps to generate a series of various artifacts, + there is even support for completely reverse engineer an existing + database schema.</para> + </entry> + <entry> <link linkend="map_file_wizard">hibernate mapping file</link> + <link linkend="hib_config_file">hibernate configuration file</link> + <link linkend="code_gen">code generation</link> + </entry> + </row> + + + <row> + <entry> + <para> + Mapping and Configuration files + Editors + </para> + </entry> + <entry> + <para>Support auto-completion and syntax highlighting. Editors also + support semantic auto-completion for class names and property/field + names, making it much more versatile than a normal XML + editor.</para> + </entry> + <entry> <link linkend="map_config_editor">mapping and configuration files editors</link></entry> + </row> + + <row> + <entry> + <para>Tools for organizing and controlling Reverse Engineering</para> + </entry> + <entry> + <para>Code Generation wizard provides powerful functionality for + generating a series of various artifacts like domain model classes, + mapping files, annotated EJB3 entity beans, etc. and reveng.xml file + editor allows to control this processes.</para> + </entry> + <entry><link linkend="code_gen">code generation</link> + <link linkend="rev_xml_editor">reveng.xml editor</link></entry> + </row> + + <row> + <entry> + <para>Hibernate Console</para> + </entry> + <entry> + <para>It is a new perspective in Eclipse which provides an overview of + your Hibernate Console configurations, were you also can get an + interactive view of your persistent classes and their relationships. + The console allows you to execute HQL queries against your database + and browse the result directly in Eclipse.</para> + </entry> + <entry><link linkend="hib_console">hibernate console</link></entry> + </row> + + <row> + <entry> + <para>Functional Mapping Diagram</para> + </entry> + <entry> + <para>Makes possible to visualize structure of entities and + relationships between them.</para> + </entry> + <entry><link linkend="map_diagram">mapping diagram</link></entry> + </row> + + + <row> + <entry> + <para>Eclipse JDT integration</para> + </entry> + <entry> + <para>Hibernate Tools integrates into the Java code completion and build + support of Java in Eclipse. This gives you code completion of HQL + inside Java code. Additionally, Hibernate Tools will add problem + markers if your queries are not valid against the console + configuration associated with the project.</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + </section> + + <section> + <title>Other relevant resources on the topic</title> + + <para>Hibernate Tools page on the <ulink url="http://www.hibernate.org/255.html">hibernate.org</ul... + <para>All JBoss Developer Studio/JBoss Tools documentation you can find <ulink url="http://www.jboss.com/products/devstudio/docs">here</... + <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">her... + </section> + +</chapter> + + +<chapter id="setup" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/hibernatetools/docs/reference/en/modules/setup.xml"> + <title>Download and install Hibernate Tools</title> + + <para><property moreinfo="none">Hibernate Tools</property> can be used "standalone" via Ant + 1.6.x or fully integrated into an Eclipse 3.3.x + WTP 2.x based IDE, such as <property moreinfo="none">JBoss + Tools</property> or a default Eclipse 3.3.x + WTP 2.x installation. The following describes + the install steps in these environments.</para> + + <section> + <title>JBoss Tools</title> + + <para><property moreinfo="none">JBoss Tools 2.x</property> includes <property moreinfo="none">Hibernate Tools</property> and + thus nothing is required besides <ulink url="http://labs.jboss.com/tools/download/index.html">downlo... and <ulink url="../../GettingStartedGuide/html_single/index.html#JBossToolsInstall">installing JBoss Tools</ulink>. If you need to update to a newer version of the + <property moreinfo="none">Hibernate Tools</property> just follow the instructions in the Eclipse IDE + section.</para> + </section> + + <section> + <title>Eclipse IDE</title> + + <para>To install into any <property moreinfo="none">Eclipse 3.3.x</property> based Eclipse IDE you can either + download the <property moreinfo="none">Hibernate Tools</property> distribution from the <ulink url="http://www.hibernate.org/6.html">Hibernate website</ulink> or use the <ulink url="http://download.jboss.org/jbosstools/updates/stable/">J... Tools Update Site</ulink> + (see also <ulink url="http://tools.hibernate.org">http://tools.hibernate.org</ulink> for links + to the update site).</para> + + <para>If you download the <property moreinfo="none">Hibernate Tools</property> distribution you need to place + the <emphasis> + <property moreinfo="none">/plugins</property> + </emphasis> and <emphasis> + <property moreinfo="none">/feature</property> + </emphasis> directory into your eclipse directory or eclipse extensions directory. Sometimes + Eclipse does not automatically detect new plugins and thus the tools will not be activated. To + ensure eclipse sees these changes just clean up the cached plugin information by running eclipse with the <emphasis> + <property moreinfo="none">-clean</property></emphasis> option, e.g. <emphasis> + <property moreinfo="none">eclipse + -clean</property>.</emphasis> Using the updatesite does not require any additional steps.</para> + + <note> + <title>Note:</title> + <para>If you need more basic instructions on installing plugins and general usage of eclipse + then check out <ulink url="https://eclipse-tutorial.dev.java.net/">https://eclipse... and especially <ulink url="https://eclipse-tutorial.dev.java.net/visual-tutorials/updatema... which + covers using the update manager.</para> + </note> + + <section> + <title>Usage of Eclipse WTP</title> + + <para>The <property moreinfo="none">Hibernate Tools</property> plugins currently use <property moreinfo="none">WTP + 2.x</property> which at this time is the latest stable release from the Eclipse Webtools + project.</para> + + <para>Because the WTP project not always have had proper versioning of their plugins there + might exist WTP plugins in your existing eclipse directory from other Eclipse based projects + that are from an earlier WTP release but has either the same version number or higher. It is + thus recommended that if you have issues with WTP provided features to try and install the + plugins on a clean install of eclipse to ensure there are no version collisions.</para> + + </section> + </section> + + <section> + <title>Ant</title> + + <para>To use the tools via Ant you need the <emphasis> + <property moreinfo="none">hibernate-tools.jar</property> + </emphasis> and associated libraries. The libraries are included in the distribution from the + Hibernate website and the Eclipse updatesite. The libraries are located in the eclipse plugins + directory at <emphasis> + <property moreinfo="none">/plugins/org.hibernate.eclipse.x.x.x/lib/tools/</property></emphasis>. These libraries are 100% + independent from the eclipse platform. How to use these via ant tasks are described in the + <link linkend="ant">Ant Tools</link> chapter.</para> + </section> +</chapter> + + +<chapter id="codegenarchitecture" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/hibernatetools/docs/reference/en/modules/codegenarchitecture.xml"> + <title>Code generation architecture</title> + + <para>The code generation mechanism in the <property moreinfo="none">Hibernate Tools</property> consists of a few + core concepts. This section explains their overall structure which are the same for the Ant and + Eclipse tools.</para> + + <section> + <title>Hibernate Meta Model</title> + + <para>The meta model is the model used by Hibernate Core to perform its object relational + mapping. The model includes information about tables, columns, classes, properties, + components, values, collections etc. The API is in <literal moreinfo="none">org.hibernate.mapping</literal> + and its main entry point is the <literal moreinfo="none">Configuration</literal> class, the same class that is + used to build a session factory.</para> + + <para>The model represented by the <literal moreinfo="none">Configuration</literal> class can be build in many + ways. The following list the currently supported ones in <property moreinfo="none">Hibernate Tools</property>. </para> + + <para> + <itemizedlist> + <listitem> + <para>A Core configuration uses Hibernate Core and supports reading <emphasis> + <property moreinfo="none">hbm.xml</property> + </emphasis> files, requires a <emphasis> + <property moreinfo="none">hibernate.cfg.xml</property> + </emphasis>. Named core in Eclipse and <emphasis> + <property moreinfo="none"> + <literal moreinfo="none">&lt;configuration&gt;</literal> + </property> + </emphasis> in ant.</para> + </listitem> + + <listitem> + <para>An Annotation configuration uses Hibernate Annotations and supports <emphasis> + <property moreinfo="none">hbm.xml</property> + </emphasis> and annotated classes, requires a <emphasis> + <property moreinfo="none">hibernate.cfg.xml</property> + </emphasis>. Named annotations in Eclipse and <emphasis> + <property moreinfo="none"> + <literal moreinfo="none">&lt;annotationconfiguration&gt;</literal> + </property> + </emphasis> in ant.</para> + </listitem> + + <listitem> + <para>A JPA configuration uses a Hibernate EntityManager and supports <emphasis> + <property moreinfo="none">hbm.xml</property> + </emphasis> and annotated classes requires that the project has a <emphasis> + <property moreinfo="none">META-INF/persistence.xml</property> + </emphasis> in its classpath. Named JPA in Eclipse and <emphasis> + <property moreinfo="none"> + <literal moreinfo="none">&lt;jpaconfiguration&gt;</literal> + </property> + </emphasis> in ant.</para> + </listitem> + + <listitem> + <para>A JDBC configuration uses <property moreinfo="none">Hibernate Tools</property> reverse engineering + and reads its mappings via JDBC metadata + additional reverse engineering files + (reveng.xml). Automatically used in Eclipse when doing reverse engineering from JDBC and + named <emphasis> + <property moreinfo="none"> + <literal moreinfo="none">&lt;jdbcconfiguration&gt;</literal> + </property> + </emphasis> in ant.</para> + </listitem> + </itemizedlist> + </para> + + <para>In most projects you will normally use only one of the Core, Annotation or JPA + configuration and possibly the JDBC configuration if you are using the reverse engineering + facilities of <property moreinfo="none">Hibernate Tools</property>. </para> + + <note> + <title>Note:</title> + <para>No matter which Hibernate Configuration type you are using <property moreinfo="none">Hibernate + Tools</property> supports them.</para> + </note> + + <para>The following drawing illustrates the core concepts:</para> + + <para> + <figure float="0"> + <title>Hibernate Core Concepts</title> + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="images/code_generation/code_generation_1.png" format="PNG"></imagedata> + </imageobject> + + <imageobject role="html"> + + <imagedata align="center" fileref="images/code_generation/code_generation_1.png" format="PNG"></imagedata> + </imageobject> + </mediaobject> + </figure> + </para> + + <para>The code generation is done based on the Configuration model no matter which type of + configuration have been used to create the meta model, and thus the code generation is + independent on the source of the meta model and represented via Exporters.</para> + </section> + + <section> + <title>Exporters</title> + + <para>Code generation is done in so called Exporters. An <literal moreinfo="none">Exporter</literal> is handed a + Hibernate Meta Model represented as a <literal moreinfo="none">Configuration</literal> instance and it is then + the job of the exporter to generate a set of code artifacts.</para> + + <para>The tools provides a default set of Exporter's which can be used in both Ant and the + Eclipse UI. Documentation for these Exporters is in the <link linkend="ant">Ant Tools</link> + and <link linkend="plugins">Eclipse Plugins</link> chapters.</para> + + <para>Users can provide their own customer Exporter's, either by custom classes implementing the + Exporter interface or simply be providing custom templates. This is documented at <xref linkend="hbmtemplate"></xref></para> + </section> +</chapter> + + +<chapter id="plugins" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/hibernatetools/docs/reference/en/modules/plugins.xml"> + <title>Eclipse Plugins</title> + + <para>This chapter will introduce you to the functionality that <property moreinfo="none">Hibernate + Tools</property> provide within Eclipse. That is a set of wizards and editors for simplifying + the work with <property moreinfo="none">Hibernate</property>.</para> + + <section> + <title>Introduction</title> + + <para>Hibernate Eclipse Tools include wizards for creating Hibernate mapping files, + configuration files (.cfg.xml), revenge.xml as well as wizards for adjusting Console + Configuration and Code Generation. Special structured and XML editors, editors for executing + HQL and Criteria queries are also provided in Hibernate Console. Refer to <link linkend="hibernate_key_features">Key Features</link> section to find all benefits that you + can take advantage of while using the tools within Eclipse.</para> + + <note> + <title>Note:</title> + <para>Please note that these tools do not try to hide any functionality of + <property moreinfo="none">Hibernate</property>. The tools make working with <property moreinfo="none">Hibernate</property> + easier, but you are still encouraged/required to read the <ulink url="http://www.hibernate.org/5.html">Hibernate Documentation</ulink> to fully utilize + <property moreinfo="none">Hibernate Tools</property> and especially <property moreinfo="none">Hibernate</property> it + self.</para> + </note> + </section> + + <section id="map_file_wizard"> + <title>Creating a Hibernate Mapping File</title> + + <para>Hibernate mapping files are used to specify how your objects are related to database + tables.</para> + + <para>For creating a skeleton mapping file, i. e. any <emphasis> + <property moreinfo="none">.hbm.xml</property> + </emphasis>, Hibernate Tools provide a basic wizard which you can bring up by navigating <emphasis> + <property moreinfo="none">New &gt; Hibernate XML mapping file</property>.</emphasis></para> + + <figure float="0"> + <title>Hibernate XML Mapping File Wizard</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_0.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>At first you'll be asked to specify the location and the name for a new mapping + file. On the next dialog you should type or browse the class to map.</para> + <figure float="0"> + <title>Specifying the Class to Map</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_0_a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Pressing finish creates the file and opens it in the <link linkend="map_config_struct_editor">structured hbm.xml editor</link>.</para> + + <para> If you start the wizard from the selected class, all values will be detected there + automatically.</para> + + <figure float="0"> + <title>Creating Mapping File for Selected Class</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_0_b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="hib_config_file"> + <title>Creating a Hibernate Configuration File</title> + + <para>To be able to reverse engineer, prototype queries, and of course to simply use + <property moreinfo="none">Hibernate Core</property> a <emphasis> + <property moreinfo="none">hibernate.properties</property> + </emphasis> or <emphasis> + <property moreinfo="none">hibernate.cfg.xml</property> + </emphasis> file is needed. The <property moreinfo="none">Hibernate Tools</property> provide a wizard for + generating the <emphasis> + <property moreinfo="none">hibernate.cfg.xml</property> + </emphasis> file if you do not already have such one.</para> + + <para>Start the wizard by clicking <emphasis> + <property moreinfo="none">New &gt; Other (Ctrl+N)</property> + </emphasis>, then <emphasis> + <property moreinfo="none">Hibernate &gt; Hibernate Configuration File (cfg.xml)</property> + </emphasis> and press <emphasis> + <property moreinfo="none">Next</property> + </emphasis>. After selecting the wanted location for the <emphasis> + <property moreinfo="none">hibernate.cfg.xml</property> + </emphasis> file, you will see the following page:</para> + + <figure float="0"> + <title>Hibernate Configuration File Wizard</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_1.png" format="PNG"></imagedata> + </imageobject> + + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_1.png" format="PNG"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para>The contents in the combo boxes for the JDBC driver class and JDBC URL change + automatically, depending on the Dialect and actual driver you have chosen.</para> + </note> + + <para>Enter your configuration information in this dialog. Details about the configuration + options can be found in <ulink url="http://docs.jboss.org/ejb3/app-server/Hibernate3/reference/en/h... + Reference Documentation</ulink>.</para> + + <para>Press <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> to create the configuration file, after optionally creating a Console + configuration, the <emphasis> + <property moreinfo="none">hibernate.cfg.xml</property> + </emphasis> will be automatically opened in an editor. The last option <emphasis> + <property moreinfo="none">Create Console Configuration</property> + </emphasis> is enabled by default and when enabled, it will automatically use the <emphasis> + <property moreinfo="none">hibernate.cfg.xml</property> + </emphasis> for the basis of a Console configuration.</para> + </section> + + <section id="console_conf"> + <title>Creating a Hibernate Console Configuration</title> + + <para>A Console configuration describes how the <property moreinfo="none">Hibernate plugin</property> should + configure <property moreinfo="none">Hibernate</property> and what configuration files, including which + classpath are needed to load the POJO's, JDBC drivers etc. It is required to make usage of + query prototyping, reverse engineering and code generation. You can have multiple named + console configurations. Normally you would just need one per project, but more is definitely + possible if your project requires this.</para> + + <para>You create a console configuration by running the <property moreinfo="none">Console Configuration + Wizard</property>, shown in the following screenshot. The same wizard will also be used if + you are coming from the <emphasis> + <property moreinfo="none">hibernate.cfg.xml</property> + </emphasis> wizard and had enabled <emphasis> + <property moreinfo="none">Create Console Configuration</property> + </emphasis>.</para> + + <note> + <title>Note:</title> + <para>The wizard will look at the current selection in the IDE and try and auto-detect the + settings which you then can just approve or modify to suit your needs.</para> + </note> + <para></para> + + <para>The dialog consists of five tabs: </para> + + <itemizedlist> + <listitem> + <para><emphasis> + <property moreinfo="none">Main</property> + </emphasis> for the basic/required settings</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title> Creating Hibernate Console Configuration</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_2.png" format="PNG"></imagedata> + </imageobject> + + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_2.png" format="PNG"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The following table describes the available settings on the <emphasis> + <property moreinfo="none">Main</property> + </emphasis> tab. The wizard can automatically detect default values for most of these if you + started the wizard with the relevant java project or resource selected.</para> + + <table> + <title>Hibernate Console Configuration Parameters</title> + + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + + <colspec colnum="2" colwidth="3*"></colspec> + + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry align="center"> + <para>Parameter</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + + <entry align="center"> + <para>Auto detected value</para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para>Name</para> + </entry> + + <entry> + <para>The unique name of the console configuration</para> + </entry> + + <entry> + <para>Name of the selected project</para> + </entry> + </row> + + <row> + <entry> + <para>Type</para> + </entry> + + <entry> + <para>Choose between "Core", "Annotations" and + "JPA". Note that the two latter requires running Eclipse IDE with + a JDK 5 runtime, otherwise you will get classloading and/or version errors.</para> + </entry> + + <entry> + <para>No default value</para> + </entry> + </row> + + <row> + <entry> + <para>Project</para> + </entry> + + <entry> + <para>The name of a java project which classpath should be used in the console + configuration</para> + </entry> + + <entry> + <para>Name of the selected project</para> + </entry> + </row> + + <row> + <entry> + <para>Database connection</para> + </entry> + + <entry> + <para>DTP provided connection that you can use instead of what is in cfg.xml and jpa + persistence.xml. It's possible to use already configured connection or + specify a new one here.</para> + </entry> + + <entry> + <para>[Hibernate Configured connection]</para> + </entry> + </row> + + <row> + <entry> + <para>Property file</para> + </entry> + + <entry> + <para>Path to a hibernate.properties file</para> + </entry> + + <entry> + <para>First hibernate.properties file found in the selected project</para> + </entry> + </row> + + <row> + <entry> + <para>Configuration file</para> + </entry> + + <entry> + <para>Path to a hibernate.cfg.xml file</para> + </entry> + + <entry> + <para>First hibernate.cfg.xml file found in the selected project</para> + </entry> + </row> + + <row> + <entry> + <para>Persistence unit</para> + </entry> + + <entry> + <para>Name of the persistence unit to use</para> + </entry> + + <entry> + <para>No default value (lets Hibernate Entity Manager find the persistence + unit)</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + + <tip> + <title>Tip:</title> + + <para>The two latter settings are normally not required if you specify a project and it has <emphasis> + <property moreinfo="none"> + <literal moreinfo="none"> /hibernate.cfg.xml </literal> + </property> + </emphasis> or <emphasis> + <property moreinfo="none"> + <literal moreinfo="none">/META-INF/persistence.xml</literal> + </property> + </emphasis> in its project classpath.</para> + </tip> + + + <itemizedlist> + <listitem> + <para> + <emphasis> + <property moreinfo="none">Options</property> + </emphasis> for the additional/optional settings</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Options Tab of the Console Configuration Wizard</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_2_a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The next table describes Hibernate Console Configuration options available on the <emphasis> + <property moreinfo="none">Options</property> + </emphasis> tab.</para> + + <table> + <title>Hibernate Console Configuration Options</title> + + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + + <colspec colnum="2" colwidth="3*"></colspec> + + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry align="center"> + <para>Parameter</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + + <entry align="center"> + <para>Auto detected value</para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para>Naming strategy</para> + </entry> + + <entry> + <para>Fully qualified classname of a custom NamingStrategy. Only required if you use a + special naming strategy.</para> + </entry> + + <entry> + <para>No default value</para> + </entry> + </row> + + <row> + <entry> + <para>Entity resolver</para> + </entry> + + <entry> + <para>Fully qualified classname of a custom EntityResolver. Only required if you have + special xml entity includes in your mapping files.</para> + </entry> + + <entry> + <para>No default value</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + + <itemizedlist> + <listitem> + <para><emphasis> + <property moreinfo="none">Classpath</property> + </emphasis> for classpath</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Specifying Classpath in Hibernate Console Configuration</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_3.png" format="PNG"></imagedata> + </imageobject> + + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_3.png" format="PNG"></imagedata> + </imageobject> + + </mediaobject> + </figure> + + <para>The following table specifies the parameters of the Classpath tab of the wizard.</para> + + <table> + <title>Hibernate Console Configuration Classpath</title> + + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + + <colspec colnum="2" colwidth="3*"></colspec> + + <colspec colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry align="center"> + <para>Parameter</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + + <entry align="center"> + <para>Auto detected value</para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para>Classpath</para> + </entry> + + <entry> + <para>The classpath for loading POJO and JDBC drivers; only needed if the default + classpath of the Project does not contain the required classes. Do not add Hibernate + core libraries or dependencies, they are already included. If you get ClassNotFound + errors then check this list for possible missing or redundant + directories/jars.</para> + </entry> + + <entry> + <para>Empty</para> + </entry> + </row> + + <row> + <entry> + <para>Include default classpath from project</para> + </entry> + + <entry> + <para>When enabled the project classpath will be appended to the classpath specified + above</para> + </entry> + + <entry> + <para>Enabled</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + + <itemizedlist> + <listitem> + <para><emphasis> + <property moreinfo="none">Mappings</property> + </emphasis> for additional mappings</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Specifying additional Mappings in Hibernate Console Configuration</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_4.png" format="PNG"></imagedata> + </imageobject> + + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_4.png" format="PNG"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Parameters of the Mappings tab of the <property moreinfo="none">Hibernate Console Configuration + wizard</property> are explained below:</para> + <table> + <title>Hibernate Console Configuration Mappings</title> + + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + + <colspec colnum="2" colwidth="3*"></colspec> + + <colspec colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry align="center"> + <para>Parameter</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + + <entry align="center"> + <para>Auto detected value</para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para>Mapping files </para> + </entry> + + <entry> + <para>List of additional mapping files that should be loaded. Note: A + hibernate.cfg.xml or persistence.xml can also contain mappings. Thus if these are + duplicated here, you will get "Duplicate mapping" errors when using the console + configuration.</para> + </entry> + + <entry> + <para>empty</para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <itemizedlist> + <listitem> + <para>and the last tab <emphasis> + <property moreinfo="none">Common</property> + </emphasis></para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Common Tab of the Console Configuration Wizard</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_4_a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>It allows to define general aspects of the launch configuration including storage + location, console encoding and some others.</para> + + <para>Clicking <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> creates the configuration and shows it in the <property moreinfo="none">Hibernate Configurations + view</property>.</para> + + <figure float="0"> + <title>Console Overview</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_5.png" format="PNG"></imagedata> + </imageobject> + + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_5.png" format="PNG"></imagedata> + </imageobject> + + </mediaobject> + </figure> + </section> + + <section id="refeng_codegen" > + <title>Reverse Engineering and Code Generation</title> + + <para>A "click-and-generate" reverse engineering and code generation facility + is available. This facility allows you to generate a range of artifacts based on database or + an already existing Hibernate configuration, be that mapping files or annotated classes. Some + of these are POJO Java source file, Hibernate <emphasis> + <property moreinfo="none">.hbm.xml</property> + </emphasis>, <emphasis> + <property moreinfo="none">hibernate.cfg.xml</property> + </emphasis> generation and schema documentation.</para> + + <para>To start working with this process, start the <property moreinfo="none">Hibernate Code + Generation</property> which is available in the toolbar via the + <property moreinfo="none">Hibernate</property> icon or via the <emphasis> + <property moreinfo="none">Run &gt; Hibernate Code Generation</property> + </emphasis> menu item.</para> + + <section id="code_gen"> + <title>Code Generation Launcher</title> + + <para>When you click on <emphasis> + <property moreinfo="none">Open Hibernate Code Generation Dialog...</property> + </emphasis> the standard Eclipse launcher dialog will appear. In this dialog you can create, + edit and delete named Hibernate code generation "launchers".</para> + + <figure float="0" id="hib_code_gen"> + <title>Getting Hibernate Code Generation Wizard</title> + <mediaobject> + <imageobject role="fo"> + <imagedata fileref="images/plugins/plugins_6.png" format="PNG"></imagedata> + </imageobject> + + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_6.png" format="PNG"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para></para> + + <figure float="0"> + <title>Hibernate Code Generation Wizard</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_7.png" format="PNG" scale="80"></imagedata> + </imageobject> + + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_7.png" format="PNG"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The first time you create a code generation launcher you should give it a meaningful + name, otherwise the default prefix <emphasis> + <property moreinfo="none">New_Generation</property> + </emphasis> will be used.</para> + + <tip> + <title>Tip:</title> + <para>The "At least one exporter option must be selected" is just a + warning stating that for this launch to work you need to select an exporter on the + Exporter tab. When an exporter has been selected the warning will disappear.</para> + </tip> + + <para>The dialog also have the standard tabs <emphasis> + <property moreinfo="none">Refresh</property> + </emphasis> and <emphasis> + <property moreinfo="none">Common</property> + </emphasis> that can be used to configure which directories should be automatically + refreshed and various general settings launchers, such as saving them in a project for + sharing the launcher within a team.</para> + + <para>On the <emphasis> + <property moreinfo="none">Main</property> + </emphasis> tab you see the following fields:</para> + + <table> + <title>Code generation "Main" tab fields</title> + + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + + <colspec colnum="2" colwidth="3*"></colspec> + + <colspec colnum="3" colwidth="0.5*"></colspec> + + <thead> + <row> + <entry align="center"> + <para>Field</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para>Console Configuration</para> + </entry> + + <entry> + <para>The name of the console configuration which should be used when code + generating</para> + </entry> + </row> + + <row> + <entry> + <para>Output directory</para> + </entry> + + <entry> + <para>Path to a directory where all output will be written by default. Be aware that + existing files will be overwritten, so be sure to specify the correct + directory.</para> + </entry> + </row> + + <row> + <entry> + <para>Reverse engineer from JDBC Connection</para> + </entry> + + <entry> + <para>If enabled, the tools will reverse engineer the database available via the + connection information in the selected Hibernate Console Configuration and + generate code based on the database schema. If not enabled, the code generation + will just be based on the mappings already specified in the Hibernate Console + configuration.</para> + </entry> + </row> + + <row> + <entry> + <para>Package</para> + </entry> + + <entry> + <para>The package name here is used as the default package name for any entities + found when reverse engineering</para> + </entry> + </row> + + <row> + <entry> + <para>reveng.xml</para> + </entry> + + <entry> + <para>Path to a reveng.xml file. A reveng.xml file allows you to control certain + aspects of the reverse engineering. e.g. how jdbc types are mapped to hibernate + types and especially important which tables are included/excluded from the + process. Clicking "setup" allows you to select an existing reveng.xml file or + create a new one. See more details about the reveng.xml file in <xref linkend="reverseengineering"></xref>.</para> + </entry> + </row> + + <row> + <entry> + <para>reveng. strategy</para> + </entry> + + <entry> + <para>If reveng.xml does not provide enough customization you can provide your own + implementation of an ReverseEngineeringStrategy. The class needs to be in the + classpath of the Console Configuration, otherwise you will get class not found + exceptions. See <xref linkend="custom-reveng-strategy"></xref> for details and an + example of a custom strategy.</para> + </entry> + </row> + + <row> + <entry> + <para>Generate basic typed composite ids</para> + </entry> + + <entry> + <para>A table that has a multi-colum primary key a &lt;composite-id&gt; + mapping will always be created. If this option is enabled and there are matching + foreign-keys each key column is still considered a 'basic' scalar (string, long, + etc.) instead of a reference to an entity. If you disable this option a + &lt;key-many-to-one&gt; instead. Note: a &lt;many-to-one&gt; + property is still created, but is simply marked as non-updatable and + non-insertable.</para> + </entry> + </row> + + <row> + <entry> + <para>Detect optimistic lock columns</para> + </entry> + + <entry> + <para>Automatically detect optimistic lock columns. Controllable via reveng. + strategy; the current default is to use columns named VERSION or TIMESTAMP.</para> + </entry> + </row> + + <row> + <entry> + <para>Detect many-to-many tables</para> + </entry> + + <entry> + <para>Automatically detect many-to-many tables. Controllable via reveng. + strategy.</para> + </entry> + </row> + + <row> + <entry> + <para>Detect one-to-one associations</para> + </entry> + + <entry> + <para> + Reverse engineering detects one-to-one associations via primary key and both hbm.xml and annotation generation generates the proper code for it. + </para> + <para> + The detection is enabled by default (except for Seam 1.2 and Seam 2.0) reverse engineering. + For Hibernate Tools generation there is a checkbox to disable if not wanted. + + </para> + </entry> + </row> + + + + + <row> + <entry> + <para>Use custom templates</para> + </entry> + + <entry> + <para>If enabled, the Template directory will be searched first when looking up the + templates, allowing you to redefine how the individual templates process the + hibernate mapping model.</para> + </entry> + </row> + + <row> + <entry> + <para>Template directory</para> + </entry> + + <entry> + <para>A path to a directory with custom templates</para> + </entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="exportes"> + <title>Exporters</title> + + <para>The <emphasis> + <property moreinfo="none">Exporters</property> + </emphasis> tab is used to specify which type of code that should be generated. Each + selection represents an Exporter that is responsible for generating the code, hence the + name.</para> + + <figure float="0"> + <title>Selecting Exporters</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_8.png" format="PNG" scale="80"></imagedata> + </imageobject> + + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_8.png" format="PNG"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The following table describes in short the various exporters. Remember you can + add/remove any Exporters depending on your needs.</para> + + <table> + <title>Code generation "Exporter" tab fields</title> + + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + + <colspec colnum="2" colwidth="3*"></colspec> + + <thead> + <row> + <entry align="center"> + <para>Field</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para>Domain code</para> + </entry> + + <entry> + <para>Generates POJO's for all the persistent classes and components found in the + given Hibernate configuration.</para> + </entry> + </row> + + <row> + <entry> + <para>DAO code</para> + </entry> + + <entry> + <para>Generates a set of DAO's for each entity found.</para> + </entry> + </row> + + <row> + <entry> + <para>Hibernate XML Mappings</para> + </entry> + + <entry> + <para>Generate mapping (hbm.xml) files for each entity.</para> + </entry> + </row> + + <row> + <entry> + <para>Hibernate XML Configuration</para> + </entry> + + <entry> + <para>Generate a hibernate.cfg.xml file. Used to keep the hibernate.cfg.xml update + with any new found mapping files.</para> + </entry> + </row> + + <row> + <entry> + <para>Schema Documentation (.html)</para> + </entry> + + <entry> + <para>Generates a set of html pages that documents the database schema and some of + the mappings.</para> + </entry> + </row> + + <row> + <entry> + <para>Generic Exporter (hbmtemplate)</para> + </entry> + + <entry> + <para>Fully customizable exporter which can be used to perform custom + generation.</para> + </entry> + </row> + + <row> + <entry> + <para>Schema Export (.ddl)</para> + </entry> + + <entry> + <para>Generates the appropriate SQL DDL and allows you to store the result in a file + or export it directly to the database.</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + + <para>Each Exporter listens to certain properties and these can be setup in the <emphasis> + <property moreinfo="none">Properties</property> + </emphasis> section where you can add/remove predefined or customer properties for each of + the exporters. The following table lists the time of writing predefined properties:</para> + + <para> + <table> + <title>Exporter Properties</title> + + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + + <colspec colnum="2" colwidth="3*"></colspec> + + <thead> + <row> + <entry align="center"> + <para>Name</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para>jdk5</para> + </entry> + + <entry> + <para>Generate Java 5 syntax</para> + </entry> + </row> + + <row> + <entry> + <para>ejb3</para> + </entry> + + <entry> + <para>Generate EJB 3 annotations</para> + </entry> + </row> + + <row> + <entry> + <para>for_each</para> + </entry> + + <entry> + <para>Specifies for which type of model elements the exporter should create a file + and run through the templates. Possible values are: entity, component, + configuration</para> + </entry> + </row> + + <row> + <entry> + <para>template_path</para> + </entry> + + <entry> + <para>Custom template directory for this specific exporter. You can use Eclipse + variables.</para> + </entry> + </row> + + <row> + <entry> + <para>template_name</para> + </entry> + + <entry> + <para>Name for template relative to the template path</para> + </entry> + </row> + + <row> + <entry> + <para>outputdir</para> + </entry> + + <entry> + <para>Custom output directory for this specific exporter. You can use Eclipse + variables.</para> + </entry> + </row> + + <row> + <entry> + <para>file_pattern</para> + </entry> + + <entry> + <para>Pattern to use for the generated files, relatively for the output dir. + Example: {package-name}/{class-name}.java .</para> + </entry> + </row> + + + + <row> + <entry> + <para>dot.executable</para> + </entry> + + <entry> + <para>Executable to run GraphViz (only relevant, but optional for Schema + documentation)</para> + </entry> + </row> + + <row> + <entry> + <para>drop</para> + </entry> + + <entry> + <para>Output will contain drop statements for the tables, indices and + constraints</para> + </entry> + </row> + + <row> + <entry> + <para>delimiter</para> + </entry> + + <entry> + <para>If specified the statements will be dumped to this file</para> + </entry> + </row> + + <row> + <entry> + <para>create</para> + </entry> + + <entry> + <para>Output will contain create statements for the tables, indices and + constraints</para> + </entry> + </row> + + <row> + <entry> + <para>scriptToConsole</para> + </entry> + + <entry> + <para>The script will be output to Console</para> + </entry> + </row> + + <row> + <entry> + <para>exportToDatabase</para> + </entry> + + <entry> + <para>Executes the generated statements against the database</para> + </entry> + </row> + + <row> + <entry> + <para>outputFileName</para> + </entry> + + <entry> + <para>If specified the statements will be dumped to this file</para> + </entry> + </row> + + <row> + <entry> + <para>haltOnError</para> + </entry> + + <entry> + <para>Halts the build process if an error occurs</para> + </entry> + </row> + + <row> + <entry> + <para>format</para> + </entry> + + <entry> + <para>Applies basic formatting to the statements</para> + </entry> + </row> + + <row> + <entry> + <para>schemaUpdate</para> + </entry> + + <entry> + <para>Updates a schema</para> + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + + <para>To add a property to the chosen Exporter click the <emphasis> + <property moreinfo="none">Add</property> + </emphasis> button in the <property moreinfo="none">Properties</property> section. In the appeared dialog + you should select the property from the proposed list and the value for it.</para> + + <figure float="0"> + <title>Adding the Property for Schema Export (.ddl)</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_8a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + + <para>If the property is a directory, it is + possible to browse directories in the Value field.</para> + </tip> + + <figure float="0"> + <title>Specifying the Property Value</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_8b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + + <section id="map_config_editor"> + <title>Hibernate Mapping and Configuration File Editor</title> + + <para>The <property moreinfo="none">Hibernate Mapping File editor</property> provides XML editing functionality + for the <emphasis> + <property moreinfo="none">hbm.xml </property> + </emphasis> and <emphasis> + <property moreinfo="none">cfg.xml</property> + </emphasis> files. The editor is based on the Eclipse WTP tools and extends its functionality + to provide Hibernate specific code completion.</para> + + <figure float="0"> + <title>XML Editing Functionality</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_9.png" format="PNG" scale="80"></imagedata> + </imageobject> + + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_9.png" format="PNG"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <section> + <title>Java property/class completion</title> + + <para>Package, class, and field completion is enabled for relevant XML attributes. The + auto-completion detects its context and limits the completion for e.g. <emphasis> + <property moreinfo="none">&lt;property&gt;</property> + </emphasis> and only shows the properties/fields available in the enclosing <emphasis> + <property moreinfo="none">&lt;class&gt;</property> + </emphasis>, <emphasis> + <property moreinfo="none">&lt;subclass&gt;</property> + </emphasis> etc. It is also possible to navigate from the <emphasis> + <property moreinfo="none">hbm.xml</property> + </emphasis> files to the relevant class/field in java code.</para> + + <figure float="0"> + <title>Navigation Functionality</title> + + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_10.png" format="PNG" scale="80"></imagedata> + </imageobject> + + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_10.png" format="PNG"></imagedata> + </imageobject> + </mediaobject> + + </figure> + + <para>This is done via the standard hyperlink navigation functionality in Eclipse; per default + it is done by pressing F3 while the cursor is on a class/field or by pressing <emphasis> + <property moreinfo="none">Ctrl</property> + </emphasis> and the mouse button to perform the same navigation.</para> + + <para>For java completion and navigation to work the file needs to reside inside an Eclipse + Java project, otherwise no completion will occur.</para> + <note> + <title>Note:</title> + <para>Java completion does not require a Hibernate console configuration to be used.</para> + </note> + </section> + + <section> + <title>Table/Column completion</title> + + <para>Table and column completion is also available for all table and column attributes. </para> + + <figure float="0"> + <title>Table and Column Completion</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_11.png" format="PNG" scale="80"></imagedata> + </imageobject> + + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_11.png" format="PNG"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <important> + <title>Important:</title> + <para>Table/Column completion requires a proper configured hibernate console configuration + and this configuration should be the default for the project where the <emphasis> + <property moreinfo="none">hbm.xml</property> + </emphasis> resides.</para> + </important> + + <para>You can check which console configuration is selected under the Properties of a project + and look under the <emphasis> + <property moreinfo="none">Hibernate Settings</property> + </emphasis> page. When a proper configuration is selected it will be used to fetch the + table/column names in the background.</para> + + <note> + <title>Note:</title> + <para>Currently it is not recommended to use this feature on large databases since it does + not fetch the information iteratively. It will be improved in future versions.</para> + </note> + </section> + + <section> + <title>Configuration property completion</title> + + <para>In <emphasis> + <property moreinfo="none">cfg.xml</property> + </emphasis> code completion for the value of <emphasis> + <property moreinfo="none">&lt;property&gt; name</property> + </emphasis> attributes is available.</para> + + + <figure float="0"> + <title>Property Completion</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_12.png" format="PNG" scale="80"></imagedata> + </imageobject> + + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_12.png" format="PNG"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + </section> + + <section id="map_config_struct_editor"> + <title>Structured Hibernate Mapping and Configuration File Editor</title> + <para>The structured editor represents the file in the tree form. It also allows to modify the + structure of the file and its elements with the help of tables provided on the right-hand + area.</para> + + <para>To open any mapping file in the editor, choose <emphasis> + <property moreinfo="none">Open With &gt; Hibernate 3.0 XML Editor</property> + </emphasis> option from the context menu of the file. The editor should look as + follows:</para> + + <figure float="0"> + <title>Structured hbm.xml Editor</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_12_a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>For the configuration file you should choose <emphasis> + <property moreinfo="none">Open With &gt; Hibernate Configuration 3.0 XML Editor</property> + </emphasis>option.</para> + + <figure float="0"> + <title>Structured cfg.xml Editor</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_12_b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="rev_xml_editor"> + <title>Reveng.xml Editor</title> + + <para>A <emphasis> + <property moreinfo="none">reveng.xml </property> + </emphasis> file is used to customize and control how reverse engineering is performed by the + tools. The plugins provide an editor to ease the editing of this file and hence used to + configure the reverse engineering process.</para> + + <para>The editor is intended to allow easy definition of type mappings, table include/excludes + and specific override settings for columns, e.g. define an explicit name for a column when the + default naming rules are not applicable.</para> + + <note> + <title>Note:</title> + <para> Not all the features of the <emphasis> + <property moreinfo="none">.reveng.xml </property> + </emphasis> file are exposed or fully implemented in the editor, but the main functionality + is there. To understand the full flexibility of the <emphasis> + <property moreinfo="none">reveng.xml</property> + </emphasis>, please see <xref linkend="hibernaterevengxmlfile"></xref> + </para> + </note> + + <para>The editor is activated as soon as an <emphasis> + <property moreinfo="none">.reveng.xml </property> + </emphasis> file is opened. To get an initial <emphasis> + <property moreinfo="none">reveng.xml </property> + </emphasis> file the <property moreinfo="none">Reverse Engineering File Wizard</property> can be started via <emphasis> + <property moreinfo="none">Ctrl+N</property> + </emphasis> and <emphasis> + <property moreinfo="none">Hibernate &gt; Hibernate Reverse Engineering File (reveng.xml)</property> + </emphasis> then.</para> + + <figure float="0"> + <title>Overview Page</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_22.png" format="PNG" scale="80"></imagedata> + </imageobject> + + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_22.png" format="PNG"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Or you can get it via the <property moreinfo="none">Code Generation Launcher</property> by checking the + proper section in the <emphasis> + <property moreinfo="none">Main</property> + </emphasis> tab of the <link linkend="hib_code_gen">Hibernate Code Generation + Wizard</link>.</para> + + <para>The following screenshot shows the <emphasis> + <property moreinfo="none">Overview</property> + </emphasis> page where the wanted console configuration is selected (auto-detected if + Hibernate 3 support is enabled for the project)</para> + + <figure float="0"> + <title>Overview Page</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_13.png" format="PNG" scale="80"></imagedata> + </imageobject> + + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_13.png" format="PNG"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The <emphasis> + <property moreinfo="none">Table Filter</property> + </emphasis> page allows you to specify which tables to include and exclude. Pressing <emphasis> + <property moreinfo="none">Refresh</property> + </emphasis> shows the tables from the database that have not yet been excluded.</para> + + <figure float="0"> + <title>Table Filters Page</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_14.png" format="PNG" scale="80"></imagedata> + </imageobject> + + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_14.png" format="PNG"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The <emphasis> + <property moreinfo="none">Type Mappings</property> + </emphasis> page is used for specifying type mappings from JBDC types to any Hibernate type + (including usertypes) if the default rules are not applicable. Here again to see the database + tables press <emphasis> + <property moreinfo="none">Refresh</property> + </emphasis> button underneath. More about type mappings you can find further in the <link linkend="type_map">Type Mappings</link> section.</para> + + <figure float="0"> + <title>Type Mappings Page</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_15.png" format="PNG" scale="80"></imagedata> + </imageobject> + + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_15.png" format="PNG"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The <emphasis> + <property moreinfo="none">Table and Columns</property> + </emphasis> page allows you to explicit set e.g. which hibernatetype and propertyname that + should be used in the reverse engineered model. For more details on how to configure the + tables while reverse engineering read the <link linkend="tab_and_col">Specific table + configuration</link> section.</para> + + <figure float="0"> + <title>Table and Columns Page</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_16.png" format="PNG" scale="80"></imagedata> + </imageobject> + + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_16.png" format="PNG"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Now that you have configured all necessary parts, you can learn how to work with + <property moreinfo="none">Hibernate Console Perspective</property>.</para> + </section> + + <section id="hib_console"> + <title>Hibernate Console Perspective</title> + + <para>The <property moreinfo="none">Hibernate Console Perspective</property> combines a set of views which allow + you to see the structure of your mapped entities/classes, edit HQL queries, execute the + queries, and see the results. To use this perspective you need to create a <link linkend="console_conf">Console configuration</link>.</para> + + <section> + <title>Viewing the entity structure</title> + + <para>To view your new configuration and entity/class structure, switch to <property moreinfo="none">Hibernate + Configurations View</property>. Expanding the tree allows you to browse the class/entity + structure and see the relationships.</para> + + <figure float="0"> + <title>Hibernate Console Perspective</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_17.png" scale="80"></imagedata> + </imageobject> + + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_17.png"></imagedata> + </imageobject> + </mediaobject> + + </figure> + + <para>The <property moreinfo="none">Console Configuration</property> does not dynamically adjust to changes + done in mappings and java code. To reload the configuration select the configuration and + click the <emphasis> + <property moreinfo="none">Reload</property> + </emphasis> button in the view toolbar or in the context menu.</para> + + <para>Besides, it's possible to open source and mapping files for objects showed in + <property moreinfo="none">Hibernate Configurations View</property>. Just bring up the context menu for a + necessary object and select <emphasis> + <property moreinfo="none">Open Source File</property> + </emphasis> to see appropriate Java class or <emphasis> + <property moreinfo="none">Open Mapping File</property> + </emphasis> to open a proper <emphasis> + <property moreinfo="none">.hbm.xml</property>.</emphasis></para> + + <figure float="0"> + <title>Opening Source for Objects</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_17_a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <section id="map_diagram"> + <title>Mapping Diagram</title> + + <para>In order to get a visual feel on how entities are related as well as view their + structures, a <property moreinfo="none">Mapping Diagram</property> is provided. It is available by right + clicking on the entity you want a mapping diagram for and then choosing <emphasis> + <property moreinfo="none">Open Mapping Diagram</property>.</emphasis></para> + + <figure float="0"> + <title>Mapping Diagram</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_18.png" scale="80"></imagedata> + </imageobject> + + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_18.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>For better navigating on the Diagram use <property moreinfo="none">Outline view</property> which is + available in the structural and graphical modes.</para> + <figure float="0"> + <title>Navigating in the Structural Mode</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_18_a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>To switch over between the modes use the buttons in the top-right corner of the + <property moreinfo="none">Outline view</property>.</para> + + <figure float="0"> + <title>Navigating in the Graphical Mode</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_18_b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>As in <property moreinfo="none">Hibernate Configurations View</property> in <property moreinfo="none">Mapping + Diagram</property> it's also possible to open source/mapping file for a chosen + object by selecting appropriate option in the context menu. </para> + + <figure float="0"> + <title>Navigating on the Diagram</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_18_c.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>If you ask to open source/mapping file by right clicking on any entity element, this + element will be highlighted in the open file.</para> + + <figure float="0"> + <title>Opening Source for Object</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_18_d.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Finally, if you need to have your Diagram exported as <emphasis><property moreinfo="none">.png + </property>,</emphasis> + <emphasis> + <property moreinfo="none">.jpeg</property> + </emphasis> or <emphasis><property moreinfo="none">.bmp </property>,</emphasis> you should right-click + anywhere in the <property moreinfo="none">Mapping Diagram editor</property> and select <emphasis> + <property moreinfo="none">Export as Image</property> + </emphasis>.</para> + + <figure float="0"> + <title>Mapping Diagram Export</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_18_e.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>As you can see on the figure above, <emphasis><property moreinfo="none">Undo</property>, </emphasis> + <emphasis> + <property moreinfo="none">Redo</property> + </emphasis> and <emphasis> + <property moreinfo="none">Auto layout </property> + </emphasis> options are also available through the context menu.</para> + </section> + </section> + + <section> + <title>Prototyping Queries</title> + + <para>Queries can be prototyped by entering them in the <property moreinfo="none">HQL</property> or + <property moreinfo="none">Criteria Editor</property>. The query editors are opened by right-clicking the + <property moreinfo="none">Console Configuration</property> and selecting either <property moreinfo="none">HQL + Editor</property> or <property moreinfo="none">Hibernate Criteria Editor</property>. The editors + automatically detect the chosen configuration.</para> + + <para>If the menu item is disabled then you need at first to create a <property moreinfo="none">Session + Factory</property>. That is done by simply expanding the <property moreinfo="none">Session + Factory</property> node.</para> + + <para>By brining up the context menu for a chosen entity or property in the <property moreinfo="none">Console + Configuration</property> and opening <emphasis> + <property moreinfo="none">HQL Editor</property> + </emphasis> or <emphasis> + <property moreinfo="none">Hibernate Criteria Editor</property> + </emphasis> you'll get a prefill query.</para> + + <figure float="0"> + <title>Entering Simple Queries</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_19.png" format="PNG" scale="80"></imagedata> + </imageobject> + + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_19.png" format="PNG"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>To copy a portion of code from .java file into a HQL or Criteria editor, make use of the + Quick Fix option (Ctrl + 1).</para> + + <figure float="0"> + <title>Quick Fix Option Demonstration</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_19_b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>You can also update the original java code according to changes in the HQL or Criteria + editor. For that you should save your HQL/Criteria query and submit the replacing in + appeared confirmation dialog.</para> + + <figure float="0"> + <title>Updating Java Code</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_19_c.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Executing the query is done by clicking the green run button in the toolbar or pressing <emphasis> + <property moreinfo="none">Ctrl+Enter</property> + </emphasis>.</para> + + <para>Errors during creation of the <property moreinfo="none">Session Factory</property> or running the + queries (e.g. if your configuration or query is incorrect) will be shown in a message dialog + or inclined in the view that detected the error, you may get more information about the + error in the <property moreinfo="none">Error Log View</property> on the right pane.</para> + + <para>Results of a query will be shown in the <property moreinfo="none">Hibernate Query Result View</property> + and details of possible errors (syntax errors, database errors, etc.) can be seen in the + <property moreinfo="none">Error Log View</property>.</para> + + + <note> + <title>Note:</title> + <para>HQL queries are executed by default using <literal moreinfo="none">list()</literal> thus without any + limit of the size of the output the query could return a large result set. You might run + out of memory. To avoid this you can put a value in the Max results field to reduce the + number of elements returned.</para> + </note> + + <section> + <title>Dynamic Query Translator</title> + + <para>If the <property moreinfo="none">Hibernate Dynamic Query Translator View</property> is visible while + writing in the <property moreinfo="none">HQL Editor</property> it will show the generated SQL for a HQL + query.</para> + + <figure float="0"> + <title>Hibernate Dynamic Query Translator View</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_20.png" format="PNG" scale="80"></imagedata> + </imageobject> + + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_20.png" format="PNG"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The translation is done each time you stop typing into the editor, if there are errors + in the HQL the parse exception will be shown embedded in the view.</para> + </section> + </section> + + <section> + <title>Properties View</title> + + <para>As you can see on the figure, <property moreinfo="none">Properties view</property> shows the number of + query results as well as the time of executing.</para> + + <figure float="0"> + <title>Properties View</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_21_a.png" format="PNG" scale="80"></imagedata> + </imageobject> + + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_21_a.png" format="PNG"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>It also displays the structure of any persistent object selected in the + <property moreinfo="none">Hibernate Query Results View</property>. Editing is not yet supported.</para> + + <figure float="0"> + <title>Properties View for Selected Object</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_21_b.png" format="PNG" scale="80"></imagedata> + </imageobject> + + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_21_b.png" format="PNG"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + + <section id="debug_log"> + <title>Enable debug logging in the plugins</title> + + <para>It is possible to configure the eclipse plugin to route all logging made by the plugins + and hibernate code it self to the <property moreinfo="none">Error Log View</property> in Eclipse.</para> + + <para>This is done by editing the <emphasis> + <property moreinfo="none">hibernate-log4j.properties</property> + </emphasis> in <emphasis> + <property moreinfo="none">org.hibernate.eclipse/ directory/jar</property> + </emphasis>. This file includes a default configuration that only logs WARN and above to a set + of custom appenders (PluginFileAppender and PluginLogAppender). You can change these settings + to be as verbose or silent as you please - see <ulink url="http://www.hibernate.org/5.html">Hibernate Documentation</ulink> for interesting categories and Log4j documentation.</para> + + <section> + <title>Relevant Resources Links</title> + <para>Find more on how to configure logging via a log4j property file in <ulink url="http://supportweb.cs.bham.ac.uk/docs/tutorials/docsystem/build/tutorials/log4j/log4j.html">Log4j documentation</ulink>.</para> + </section> + </section> + + <section id="dali_integration"> + <title>Hibernate support for Dali plugins in Eclipse WTP</title> + + <para>Starting from 3.0.0 Alpha1 version of <property moreinfo="none">JBoss Tools</property> Hibernate plugins + support Eclipse Dali integration what now makes it possible to use a Hibernate as a complete + JPA development platform.</para> + + <para>When starting your new JPA project from <emphasis> + <property moreinfo="none">New &gt; Other... &gt; JPA &gt; JPA Project</property> + </emphasis> (or simply <emphasis> + <property moreinfo="none">New &gt; JPA Project</property> + </emphasis> in <property moreinfo="none">JPA Perspective</property>) on the JPA Facet page you'll be + prompted to choose Hibernate as a target platform.</para> + + <figure float="0"> + <title>Targeting at Hibernate Platform</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_23.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>By enabling Hibernate platform specific features you can now generate DDL and Entities. + For that find <emphasis> + <property moreinfo="none">JPA Tools &gt; Generate DDL.../Generate Entities...</property> + </emphasis> options in the context menu of your JPA project.</para> + + <figure float="0"> + <title>Generate DDL/Entities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_24.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The Generate DDL/Entities wizards first will ask you to choose the <property moreinfo="none">Console + Configuration</property>.</para> + + <figure float="0"> + <title>Generate Entities Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_25.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + + <para>Please note, if you choose Hibernate as a platform and leave the Target Runtime + with &lt;none&gt;, the wizard does not require you to have a <link linkend="console_conf">Hibernate Console Configuration</link>. A Hibernate Console Configuration is created when the wizard finishes its work.</para> + </note> + </section> +</chapter> + + +<chapter id="ant" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/hibernatetools/docs/reference/en/modules/ant.xml"> + <title>Ant Tools</title> + + <para>Maybe somebody will find it more preferable to use Ant for generation purposes. Thus, this + chapter is intended to get you ready to start using Hibernate Tools via Ant tasks.</para> + + <section> + <title>Introduction</title> + + <para>The <emphasis> + <property moreinfo="none">hibernate-tools.jar</property> + </emphasis> contains the core for the <property moreinfo="none">Hibernate Tools</property>. It is used as the + basis for both the Ant tasks described in this document and the eclipse plugins both available + from tools.hibernate.org. The <emphasis> + <property moreinfo="none">hibernate-tools.jar</property> + </emphasis> is located in your eclipse plugins directory at <emphasis> + <property moreinfo="none">/plugins/org.hibernate.eclipse.x.x.x/lib/tools/hibernate-tools.jar</property>.</emphasis></para> + <para>This jar is 100% independent from the eclipse platform and can thus be used independently + of eclipse.</para> + + <note> + <title>Note:</title> + <para>There might be incompatibilities with respect to the Hibernate3.jar bundled with the + tools and your own jar. Thus to avoid any confusion it is recommended to use the + hibernate3.jar and hibernate-annotations.jar bundled with the tools when you want to use the + Ant tasks. Do not worry about using e.g. Hibernate 3.2 jar's with e.g. a Hibernate 3.1 + project since the output generated will work with previous Hibernate 3 versions. </para> + </note> + </section> + + <section> + <title>The &lt;hibernatetool&gt; Ant Task</title> + + <para>To use the ant tasks you need to have the <emphasis> + <property moreinfo="none">hibernatetool</property> + </emphasis> task defined. That is done in your <emphasis> + <property moreinfo="none">build.xml</property> + </emphasis> by inserting the following xml (assuming the jars are in the + <literal moreinfo="none">lib</literal> directory): </para> + + <programlisting format="linespecific" role="XML"><![CDATA[<path id="toolslib"> + <path location="lib/hibernate-tools.jar" /> + <path location="lib/hibernate3.jar" /> + <path location="lib/freemarker.jar" /> + <path location="${jdbc.driver.jar}" /> +</path> + +<taskdef name="hibernatetool" + classname="org.hibernate.tool.ant.HibernateToolTask" + classpathref="toolslib" /> +]]></programlisting> + + <para>This <emphasis> + <property moreinfo="none"> + <literal moreinfo="none">&lt;taskdef&gt;</literal> + </property> + </emphasis> defines an Ant task called <emphasis> + <property moreinfo="none"> hibernatetool </property> + </emphasis> which now can be used anywhere in your ant <emphasis> + <property moreinfo="none">build.xml</property> + </emphasis> files. It is important to include all the <property moreinfo="none">Hibernate Tools</property> + dependencies as well as the jdbc driver.</para> + + <para>Notice that to use the annotation based Configuration you must <ulink url="http://annotations.hibernate.org">get a release</ulink>. </para> + + <para></para> + + <para>When using the <emphasis> + <property moreinfo="none"> hibernatetool </property> + </emphasis> task you have to specify one or more of the following:</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<hibernatetool + destdir="defaultDestinationDirectory" + templatepath="defaultTemplatePath" +> + <classpath ...> + <property key="propertyName" value="value"/> + <propertyset ...> + (<configuration ...>|<annotationconfiguration ...>| + <jpaconfiguration ...>|<jdbcconfiguration ...>) + (<hbm2java>,<hbm2cfgxml>,<hbmtemplate>,...) +</hibernatetool>]]></programlisting> + + <table frame="topbot"> + <title>Hibernatetool attributes</title> + + <tgroup cols="3"> + + <colspec colwidth="0.3*"></colspec> + + <colspec colwidth="1.0*"></colspec> + + <colspec colwidth="0.3*"></colspec> + + + <thead> + <row> + <entry>Attribute name</entry> + + <entry>Definition</entry> + + <entry>Attribute use</entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para>destdir</para> + </entry> + + <entry> + <para>Destination directory for files generated with exporters</para> + </entry> + + <entry> + <para>Required</para> + </entry> + </row> + + <row> + <entry> + <para>templatepath</para> + </entry> + + <entry> + <para>A path to be used to look up user-edited templates</para> + </entry> + + <entry> + <para>Optional</para> + </entry> + </row> + + <row> + <entry> + <para>classpath</para> + </entry> + + <entry> + <para>A classpath to be used to resolve resources, such as mappings and + usertypes</para> + </entry> + + <entry> + <para>Optional, but very often required</para> + </entry> + </row> + + + <row> + <entry> + <para>property (and propertyset)</para> + </entry> + + <entry> + <para>Used to set properties to control the exporters. Mostly relevant for providing + custom properties to user defined templates</para> + </entry> + + <entry> + <para>Optional</para> + </entry> + </row> + + <row> + <entry> + <para>configuration (annotationconfiguration, jpaconfiguration, + jdbcconfiguration)</para> + </entry> + + <entry> + <para>One of four different ways of configuring the Hibernate Meta Model must be + specified</para> + </entry> + + <entry> + <para></para> + </entry> + </row> + + <row> + <entry> + <para>hbm2java (hbm2cfgxml, hbmtemplate, etc.)</para> + </entry> + + <entry> + <para>One or more of the exporters must be specified</para> + </entry> + + <entry> + <para></para> + </entry> + </row> + + </tbody> + + </tgroup> + </table> + + <section> + <title>Basic examples</title> + + <para>The following example shows the most basic setup for generating pojo's via <emphasis> + <property moreinfo="none">&lt;hbm2java&gt;</property> + </emphasis> from a normal <emphasis> + <property moreinfo="none"> + <literal moreinfo="none">hibernate.cfg.xml</literal> + </property>. </emphasis> The output will be put in the <emphasis> + <property moreinfo="none">${build.dir}/generated</property> + </emphasis> directory.</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<hibernatetool destdir="${build.dir}/generated"> + <classpath> + <path location="${build.dir}/classes"/> + </classpath> + + <configuration configurationfile="hibernate.cfg.xml"/> + <hbm2java/> +</hibernatetool>]]></programlisting> + + + <para>The following example is similar, but now we are performing multiple exports from the + same configuration. We are exporting the schema via <emphasis> + <property moreinfo="none">&lt;hbm2dll&gt;</property>, </emphasis> generates some DAO code via <emphasis> + <property moreinfo="none">&lt;hbm2dao&gt;</property> + </emphasis> and finally runs a custom code generation via <emphasis> + <property moreinfo="none">&lt;hbmtemplate&gt;</property>. </emphasis> This is again from a normal <emphasis> + <property moreinfo="none">hibernate.cfg.xml</property> + </emphasis> and the output is still put in the <emphasis> + <property moreinfo="none"> + <literal moreinfo="none">${build.dir}/generated</literal> + </property> + </emphasis> directory. Furthermore the example also shows where a classpath is specified + when you e.g. have custom usertypes or some mappings that is needed to be looked up as a + classpath resource.</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<hibernatetool destdir="${build.dir}/generated"> + <classpath> + <path location="${build.dir}/classes"/> + </classpath> + + <configuration configurationfile="hibernate.cfg.xml"/> + <hbm2ddl/> + <hbm2dao/> + <hbmtemplate + filepattern="{package-name}/I{class-name}Constants.java" + templatepath="${etc.dir}/customtemplates" + template="myconstants.vm" + /> +</hibernatetool>]]></programlisting> + + </section> + </section> + + <section> + <title>Hibernate Configurations</title> + + <para><literal moreinfo="none">Hibernatetool</literal> supports four different Hibernate configurations: A + standard Hibernate configuration <emphasis> + (<property moreinfo="none">&lt;configuration&gt;</property>), </emphasis> Annotation based + configuration <emphasis> (<property moreinfo="none">&lt;annotationconfiguration&gt;</property>), + </emphasis> JPA persistence based configuration <emphasis> + (<property moreinfo="none">&lt;jpaconfiguration&gt;</property>) </emphasis> and a JDBC based + configuration <emphasis> (<property moreinfo="none">&lt;jdbcconfiguration&gt;</property>) </emphasis> + for use when reverse engineering.</para> + + <para>Each have in common that they are able to build up a Hibernate Configuration object from + which a set of exporters can be run to generate various output. </para> + + <note> + <title>Note:</title> + <para>Output can be anything, e.g. specific files, statements execution against a database, + error reporting or anything else that can be done in java code.</para> + </note> + + <para>The following sections describe what the various configurations can do, plus lists the + individual settings they have.</para> + + <section> + <title>Standard Hibernate Configuration (&lt;configuration&gt;)</title> + + <para>A <emphasis> + <property moreinfo="none">&lt;configuration&gt;</property> + </emphasis> is used to define a standard Hibernate configuration. A standard Hibernate + configuration reads the mappings from a <emphasis> + <property moreinfo="none">cfg.xml</property> + </emphasis> and/or a fileset.</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<configuration + configurationfile="hibernate.cfg.xml" + propertyfile="hibernate.properties" + entityresolver="EntityResolver classname" + namingstrategy="NamingStrategy classname" +> + <fileset...> + + </configuration>]]></programlisting> + + <table frame="topbot"> + <title>Configuration attributes</title> + + <tgroup cols="3"> + + <colspec colwidth="0.3*"></colspec> + + <colspec colwidth="1.0*"></colspec> + + <colspec colwidth="0.3*"></colspec> + + + <thead> + <row> + <entry>Attribute name</entry> + + <entry>Definition</entry> + + <entry>Attribute use</entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para>configurationfile</para> + </entry> + + <entry> + <para>The name of a Hibernate configuration file, e.g. "hibernate.cfg.xml"</para> + </entry> + + <entry> + <para>Optional</para> + </entry> + </row> + + <row> + <entry> + <para>propertyfile</para> + </entry> + + <entry> + <para>The name of a property file, e.g. "hibernate.properties"</para> + </entry> + + <entry> + <para>Optional</para> + </entry> + </row> + + <row> + <entry> + <para>entity-resolver</para> + </entry> + + <entry> + <para>Name of a class that implements org.xml.sax.EntityResolver. Used if the + mapping files require custom entity resolver</para> + </entry> + + <entry> + <para>Optional</para> + </entry> + </row> + + + <row> + <entry> + <para>namingstrategy</para> + </entry> + + <entry> + <para>Name of a class that implements org.hibernate.cfg.NamingStrategy. Used for + setting up the naming strategy in Hibernate which controls the automatic naming of + tables and columns.</para> + </entry> + + <entry> + <para>Optional</para> + </entry> + </row> + + <row> + <entry> + <para>fileset</para> + </entry> + + <entry> + <para>A standard Ant fileset. Used to include hibernate mapping files. Remember that + if mappings are already specified in the hibernate.cfg.xml then it should not be + included via the fileset as it will result in duplicate import exceptions.</para> + </entry> + + <entry> + <para></para> + </entry> + </row> + + </tbody> + + </tgroup> + </table> + + <section> + <title>Example</title> + + <para>This example shows an example where no <emphasis> + <property moreinfo="none"> + <literal moreinfo="none">hibernate.cfg.xml</literal> + </property> + </emphasis> exists, and a <emphasis> + <property moreinfo="none"> hibernate.properties </property> + </emphasis> and fileset is used instead. </para> + + <note> + <title>Note:</title> + <para> Hibernate will still read any global <emphasis> + <property moreinfo="none">hibernate.properties</property> + </emphasis> available in the classpath, but the specified properties file here will + override those values for any non-global property.</para> + </note> + + <programlisting format="linespecific" role="XML"><![CDATA[<hibernatetool destdir="${build.dir}/generated"> + <configuration propertyfile="{etc.dir}/hibernate.properties"> + <fileset dir="${src.dir}"> + <include name="**/*.hbm.xml"/> + <exclude name="**/*Test.hbm.xml"/> + </fileset> + </configuration> + + <!-- list exporters here --> + +</hibernatetool>]]></programlisting> + + </section> + </section> + + <section> + <title>Annotation based Configuration (&lt;annotationconfiguration&gt;)</title> + + <para>An <emphasis> + <property moreinfo="none">&lt;annotationconfiguration&gt;</property> + </emphasis> is used when you want to read the metamodel from EJB3/Hibernate Annotations + based POJO's.</para> + + <important> + <title>Important:</title> + <para>To use it remember to put the jar files needed for using hibernate annotations in the + classpath of the <emphasis> + <property moreinfo="none">&lt;taskdef&gt;</property>, </emphasis> i. e. + hibernate-annotations.jar and hibernate-commons-annotations.jar.</para> + </important> + + <para>The <emphasis> + <property moreinfo="none">&lt;annotationconfiguration&gt;</property> + </emphasis> supports the same attributes as a <emphasis> + <property moreinfo="none">&lt;configuration&gt;</property> + </emphasis> except that the configurationfile attribute is now required as that is from + where an <literal moreinfo="none">AnnotationConfiguration</literal> gets the list of classes/packages it + should load.</para> + + <para>Thus the minimal usage is:</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<hibernatetool destdir="${build.dir}/generated"> + <annotationconfiguration + configurationfile="hibernate.cfg.xml"/> + + <!-- list exporters here --> + +</hibernatetool> +]]></programlisting> + + </section> + + <section> + <title>JPA based configuration (&lt;jpaconfiguration&gt;)</title> + + <para>A <emphasis> + <property moreinfo="none">&lt;jpaconfiguration&gt;</property> + </emphasis> is used when you want to read the metamodel from JPA/Hibernate Annotation where + you want to use the auto-scan configuration as defined in the JPA spec (part of EJB3). In + other words, when you do not have a <emphasis> + <property moreinfo="none">hibernate.cfg.xml</property>, </emphasis> but instead have a setup where you use + a <emphasis> + <property moreinfo="none">persistence.xml</property> + </emphasis> packaged in a JPA compliant manner.</para> + + <para>The <emphasis> + <property moreinfo="none">&lt;jpaconfiguration&gt;</property> + </emphasis> will simply just try and auto-configure it self based on the available + classpath, e.g. look for <emphasis> + <property moreinfo="none">META-INF/persistence.xml</property>. </emphasis></para> + + <para>The <emphasis> + <property moreinfo="none">persistenceunit</property> + </emphasis> attribute can be used to select a specific persistence unit. If no <emphasis> + <property moreinfo="none">persistenceunit</property> + </emphasis> is specified it will automatically search for one and if a unique one is found, + use it, but if multiple persistence units are available it will error.</para> + + <para>To use a <emphasis> + <property moreinfo="none">&lt;jpaconfiguration&gt;</property> + </emphasis> you will need to specify some additional jars from Hibernate EntityManager in + the <emphasis> + <property moreinfo="none">&lt;taskdef&gt;</property> + </emphasis> of the hibernatetool. The following shows a full setup:</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<path id="ejb3toolslib"> + <path refid="jpatoolslib"/> <!-- ref to previously defined toolslib --> + <path location="lib/hibernate-annotations.jar" /> + <path location="lib/ejb3-persistence.jar" /> + <path location="lib/hibernate-entitymanager.jar" /> + <path location="lib/jboss-archive-browsing.jar" /> + <path location="lib/javaassist.jar" /> +</path> + +<taskdef name="hibernatetool" + classname="org.hibernate.tool.ant.HibernateToolTask" + classpathref="jpatoolslib" /> + +<hibernatetool destdir="${build.dir}"> + <jpaconfiguration persistenceunit="caveatemptor"/> + <classpath> + <!-- it is in this classpath you put your classes dir, + and/or jpa persistence compliant jar --> + <path location="${build.dir}/jpa/classes" /> + </classpath> + + <!-- list exporters here --> + +</hibernatetool> +]]></programlisting> + + + <note> + <title>Note:</title> + <para>ejb3configuration was the name used in previous versions. It still works but will emit + a warning telling you to use <literal moreinfo="none">jpaconfiguration</literal> instead.</para> + </note> + + </section> + + <section> + <title>JDBC Configuration for reverse engineering (&lt;jdbcconfiguration&gt;)</title> + + <para>A <emphasis> + <property moreinfo="none"> + <literal moreinfo="none">&lt;jdbcconfiguration&gt;</literal> + </property> + </emphasis> is used to perform reverse engineering of the database from a JDBC connection.</para> + + <para>This configuration works by reading the connection properties either from <emphasis> + <property moreinfo="none">hibernate.cfg.xml</property> + </emphasis> or <emphasis> + <property moreinfo="none">hibernate.properties</property> + </emphasis> with a fileset.</para> + + <para>The <emphasis> + <property moreinfo="none"> + <literal moreinfo="none">&lt;jdbcconfiguration&gt;</literal> + </property> + </emphasis> has the same attributes as a <emphasis> + <property moreinfo="none"> + <literal moreinfo="none">&lt;configuration&gt;</literal> + </property> + </emphasis> plus the following additional attributes:</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<jdbcconfiguration + ... + packagename="package.name" + revengfile="hibernate.reveng.xml" + reversestrategy="ReverseEngineeringStrategy classname" + detectmanytomany="true|false" + detectoptmisticlock="true|false" +> + ... + </jdbcconfiguration>]]></programlisting> + + <table frame="topbot"> + <title>Jdbcconfiguration attributes</title> + + <tgroup cols="3"> + + <colspec colwidth="0.3*"></colspec> + + <colspec colwidth="1.0*"></colspec> + + <colspec colwidth="0.3*"></colspec> + + + <thead> + <row> + <entry>Attribute name</entry> + + <entry>Definition</entry> + + <entry>Attribute use</entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para>packagename</para> + </entry> + + <entry> + <para>The default package name to use when mappings for classes are created</para> + </entry> + + <entry> + <para>Optional</para> + </entry> + </row> + + <row> + <entry> + <para>revengfile</para> + </entry> + + <entry> + <para>The name of a property file, e.g. "hibernate.properties"</para> + </entry> + + <entry> + <para>Optional</para> + </entry> + </row> + + <row> + <entry> + <para>reversestrategy</para> + </entry> + + <entry> + <para>Name of a class that implements + org.hibernate.cfg.reveng.ReverseEngineeringStrategy. Used for setting up the + strategy the tools will use to control the reverse engineering, e.g. naming of + properties, which tables to include/exclude etc. Using a class instead of (or as + addition to) a reveng.xml file gives you full programmatic control of the reverse + engineering.</para> + </entry> + + <entry> + <para>Optional</para> + </entry> + </row> + + + <row> + <entry> + <para>detectManytoMany</para> + </entry> + + <entry> + <para>If true, tables which are pure many-to-many link tables will be mapped as + such. A pure many-to-many table is one which primary-key contains exactly two + foreign-keys pointing to other entity tables and has no other columns.</para> + </entry> + + <entry> + <para>Default: true</para> + </entry> + </row> + + <row> + <entry> + <para>detectOptimisticLock</para> + </entry> + + <entry> + <para>If true, columns named VERSION or TIMESTAMP with appropriate types will be + mapped with the appropriate optimistic locking corresponding to + &lt;version&gt; or &lt;timestamp&gt;.</para> + </entry> + + <entry> + <para>Default: true</para> + </entry> + </row> + + </tbody> + + </tgroup> + </table> + + <section> + <title>Example</title> + + <para>Here is an example of using <emphasis> + <property moreinfo="none"> + <literal moreinfo="none">&lt;jdbcconfiguration&gt;</literal> + </property> + </emphasis> to generate Hibernate xml mappings via <emphasis> + <property moreinfo="none">&lt;hbm2hbmxml&gt;</property>.</emphasis> The connection settings here + is read from a <emphasis> + <property moreinfo="none"> hibernate.properties </property> + </emphasis> file but could just as well have been read from a <emphasis> + <property moreinfo="none">hibernate.cfg.xml</property>. </emphasis></para> + + <programlisting format="linespecific" role="XML"><![CDATA[<hibernatetool> + <jdbcconfiguration propertyfile="etc/hibernate.properties" /> + <hbm2hbmxml destdir="${build.dir}/src" /> +</hibernatetool> +]]></programlisting> + </section> + </section> + </section> + + <section> + <title>Exporters</title> + + <para>Exporters are the parts that do the actual job of converting the hibernate metamodel into + various artifacts, mainly code. The following section describes the current supported set of + exporters in the <property moreinfo="none">Hibernate Tool</property> distribution. It is also possible for + userdefined exporters, that is done through the <emphasis> + <property moreinfo="none"> + <literal moreinfo="none">&lt;hbmtemplate&gt;</literal> + </property> + </emphasis> exporter.</para> + + <section> + <title>Database schema exporter (&lt;hbm2ddl&gt;)</title> + + <para><emphasis> + <property moreinfo="none">&lt;hbm2ddl&gt;</property> + </emphasis> lets you run schemaexport and schemaupdate which generates the appropriate SQL + DDL and allow you to store the result in a file or export it directly to the database. + Remember that if a custom naming strategy is needed it is placed on the configuration + element.</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<hbm2ddl + export="true|false" + update="true|false" + drop="true|false" + create="true|false" + outputfilename="filename.ddl" + delimiter=";" + format="true|false" + haltonerror="true|false" + >]]></programlisting> + + <table frame="topbot"> + <title>Hbm2ddl exporter attributes</title> + + <tgroup cols="3"> + + <colspec colwidth="0.3*"></colspec> + + <colspec colwidth="1.0*"></colspec> + + <colspec colwidth="0.3*"></colspec> + + + <thead> + <row> + <entry>Attribute name</entry> + + <entry>Definition</entry> + + <entry>Attribute use</entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para>export</para> + </entry> + + <entry> + <para>Executes the generated statements against the database</para> + </entry> + + <entry> + <para>Default: true</para> + </entry> + </row> + + <row> + <entry> + <para>update</para> + </entry> + + <entry> + <para>Try and create an update script representing the "delta" + between what is in the database and what the mappings specify. Ignores + create/update attributes. (<emphasis>Do *not* use against production databases, no + guarantees at all that the proper delta can be generated nor that the underlying + database can actually execute the needed operations</emphasis>).</para> + </entry> + + <entry> + <para>Default: false</para> + </entry> + </row> + + <row> + <entry> + <para>drop</para> + </entry> + + <entry> + <para>Output will contain drop statements for the tables, indices and + constraints</para> + </entry> + + <entry> + <para>Default: false</para> + </entry> + </row> + + + <row> + <entry> + <para>create</para> + </entry> + + <entry> + <para>Output will contain create statements for the tables, indices and + constraints</para> + </entry> + + <entry> + <para>Default: true</para> + </entry> + </row> + + <row> + <entry> + <para>outputfilename</para> + </entry> + + <entry> + <para>If specified the statements will be dumped to this file</para> + </entry> + + <entry> + <para>Optional</para> + </entry> + </row> + + <row> + <entry> + <para>delimiter</para> + </entry> + + <entry> + <para>If specified the statements will be dumped to this file</para> + </entry> + + <entry> + <para>Default: ";"</para> + </entry> + </row> + + <row> + <entry> + <para>format</para> + </entry> + + <entry> + <para>Apply basic formatting to the statements</para> + </entry> + + <entry> + <para>Default: false</para> + </entry> + </row> + + <row> + <entry> + <para>haltonerror</para> + </entry> + + <entry> + <para>Halt build process if an error occurs</para> + </entry> + + <entry> + <para>Default: false</para> + </entry> + </row> + </tbody> + + </tgroup> + </table> + + <section> + <title>Example</title> + + <para>Basic example of using <emphasis> + <property moreinfo="none">&lt;hbm2ddl&gt;</property>, </emphasis> which does not export to the + database but simply dumps the sql to a file named <emphasis> + <property moreinfo="none">sql.ddl</property>. </emphasis></para> + + <programlisting format="linespecific" role="XML"><![CDATA[<hibernatetool destdir="${build.dir}/generated"> + <configuration configurationfile="hibernate.cfg.xml"/> + <hbm2ddl export="false" outputfilename="sql.ddl"/> +</hibernatetool>]]></programlisting> + </section> + </section> + + <section> + <title>POJO java code exporter (<literal moreinfo="none">&lt;hbm2java&gt;</literal>)</title> + + <para><emphasis> + <property moreinfo="none">&lt;hbm2java&gt;</property> + </emphasis> is a java codegenerator. Options for controlling whether JDK 5 syntax can be + used and whether the POJO should be annotated with EJB3/Hibernate Annotations.</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<hbm2java + jdk5="true|false" + ejb3="true|false" +>]]></programlisting> + + <table frame="topbot"> + <title>Hbm2java exporter attributes</title> + + <tgroup cols="3"> + + <colspec colwidth="0.3*"></colspec> + + <colspec colwidth="1.0*"></colspec> + + <colspec colwidth="0.3*"></colspec> + + + <thead> + <row> + <entry>Attribute name</entry> + + <entry>Definition</entry> + + <entry>Default value</entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para>jdk</para> + </entry> + + <entry> + <para>Code will contain JDK 5 constructs such as generics and static imports</para> + </entry> + + <entry> + <para>False</para> + </entry> + </row> + + <row> + <entry> + <para>ejb3</para> + </entry> + + <entry> + <para>Code will contain EJB 3 features, e.g. using annotations from + javax.persistence and org.hibernate.annotations</para> + </entry> + + <entry> + <para>False</para> + </entry> + </row> + + </tbody> + + </tgroup> + </table> + + <section> + <title>Example</title> + + <para>Basic example of using <emphasis> + <property moreinfo="none">&lt;hbm2java&gt;</property> + </emphasis> to generate POJO's that utilize jdk5 constructs.</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<hibernatetool destdir="${build.dir}/generated"> + <configuration configurationfile="hibernate.cfg.xml"/> + <hbm2java jdk5="true"/> +</hibernatetool>]]></programlisting> + </section> + </section> + + <section> + <title>Hibernate Mapping files exporter (<literal moreinfo="none">&lt;hbm2hbmxml&gt;</literal>)</title> + + <para><emphasis> + <property moreinfo="none">&lt;hbm2hbmxml&gt;</property> + </emphasis> generates a set of .hbm files. Intended to be used together with a <emphasis> + <property moreinfo="none">&lt;jdbcconfiguration&gt;</property> + </emphasis> when performing reverse engineering, but can be used with any kind of + configuration. e.g. to convert from annotation based pojo's to <emphasis> + <property moreinfo="none">hbm.xml</property>. </emphasis></para> + + <note> + <title>Note:</title> + <para>Not every possible mapping transformation is possible/implemented (contributions + welcome) so some hand editing might be necessary.</para> + </note> + + <programlisting format="linespecific" role="XML"><![CDATA[<hbm2hbmxml/>]]></programlisting> + + <section> + <title>Example</title> + + <para>Basic usage of <emphasis> + <property moreinfo="none">&lt;hbm2hbmxml&gt;</property>. </emphasis></para> + + <programlisting format="linespecific" role="XML"><![CDATA[<hibernatetool destdir="${build.dir}/generated"> + <configuration configurationfile="hibernate.cfg.xml"/> + <hbm2hbmxml/> +</hibernatetool>]]></programlisting> + + <para><emphasis> + <property moreinfo="none">&lt;hbm2hbmxml&gt;</property> + </emphasis> is normally used with a <emphasis> + <property moreinfo="none">&lt;jdbcconfiguration&gt;</property> + </emphasis> like in the above example, but any other configuration can also be used to + convert between the different ways of performing mappings. Here is an example of that, + using an <emphasis> + <property moreinfo="none">&lt;annotationconfiguration&gt;</property> + </emphasis>.</para> + + <note> + <title>Note:</title> + <para>Not all conversions are implemented (contributions welcome), so some hand editing + might be necessary.</para> + </note> + + <programlisting format="linespecific" role="XML"><![CDATA[<hibernatetool destdir="${build.dir}/generated"> + <annotationconfiguration configurationfile="hibernate.cfg.xml"/> + <hbm2hbmxml/> +</hibernatetool>]]></programlisting> + </section> + </section> + + <section> + <title>Hibernate Configuration file exporter (<literal moreinfo="none">&lt;hbm2cfgxml&gt;</literal>)</title> + + <para><emphasis> + <property moreinfo="none">&lt;hbm2cfgxml&gt;</property> + </emphasis> generates a <emphasis> + <property moreinfo="none">hibernate.cfg.xml</property>. </emphasis> Intended to be used together with a <emphasis> + <property moreinfo="none">&lt;jdbcconfiguration&gt;</property> + </emphasis> when performing reverse engineering, but it can be used with any kind of + configuration. The <emphasis> + <property moreinfo="none">&lt;hbm2cfgxml&gt;</property> + </emphasis> will contain the properties used and adds mapping entries for each mapped class.</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<hbm2cfgxml + ejb3="true|false" +/> +]]></programlisting> + + <table frame="topbot"> + <title>Hbm2cfgxml exporter attribute</title> + + <tgroup cols="3"> + + <colspec colwidth="0.3*"></colspec> + + <colspec colwidth="1.0*"></colspec> + + <colspec colwidth="0.3*"></colspec> + + + <thead> + <row> + <entry>Attribute name</entry> + + <entry>Definition</entry> + + <entry>Default value</entry> + </row> + </thead> + + <tbody> + + <row> + <entry> + <para>ejb3</para> + </entry> + + <entry> + <para>The generated cfg.xml will have &lt;mapping class=".."/&gt;, opposed + to &lt;mapping resource="..."/&gt; for each mapping.</para> + </entry> + + <entry> + <para>False</para> + </entry> + </row> + + </tbody> + + </tgroup> + </table> + + </section> + + <section> + <title>Documentation exporter (<literal moreinfo="none">&lt;hbm2doc&gt;</literal>)</title> + + <para><emphasis> + <property moreinfo="none">&lt;hbm2doc&gt;</property> + </emphasis> generates html documentation a'la javadoc for the database schema et.al.</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<hbm2doc/>]]></programlisting> + </section> + + <section> + <title>Query exporter (&lt;query&gt;)</title> + + <para><emphasis> + <property moreinfo="none">&lt;query&gt;</property> + </emphasis> is used to execute a HQL query statements and optionally sends the output to a + file. It can be used for verifying the mappings and for basic data extraction.</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<query + destfile="filename"> + <hql>[a HQL query string]</hql> +</query> +]]></programlisting> + + <para>Currently one session is opened and used for all queries and the query is executed via + the list() method. In the future more options might become available, like performing + executeUpdate(), use named queries and etc.</para> + + <para></para> + + <section> + <title>Examples</title> + + <para>The simplest usage of <emphasis> + <property moreinfo="none">&lt;query&gt;</property> + </emphasis> will just execute the query without dumping to a file. This can be used to + verify that queries can actually be performed.</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<hibernatetool> + <configuration configurationfile="hibernate.cfg.xml"/> + <query>from java.lang.Object</query> +</hibernatetool>]]></programlisting> + + <para>Multiple queries can be executed by nested <emphasis> + <property moreinfo="none">&lt;hql&gt;</property> + </emphasis> elements. In this example we also let the output be dumped to <emphasis> + <property moreinfo="none">queryresult.txt</property>. </emphasis></para> + + <note> + <title>Note:</title> + <para> Currently the dump is simply a call to toString on each element.</para> + </note> + + <programlisting format="linespecific" role="XML"><![CDATA[<hibernatetool> + <configuration configurationfile="hibernate.cfg.xml"/> + <query destfile="queryresult.txt"> + <hql>select c.name from Customer c where c.age > 42</hql> + <hql>from Cat</hql> +</hibernatetool>]]></programlisting> + + </section> + </section> + + <section id="hbmtemplate"> + <title>Generic Hibernate metamodel exporter (<literal moreinfo="none">&lt;hbmtemplate&gt;</literal>)</title> + + <para>Generic exporter that can be controlled by a user provides a template or class.</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<hbmtemplate + filepattern="{package-name}/{class-name}.ftl" + template="somename.ftl" + exporterclass="Exporter classname" +/>]]></programlisting> + + <note> + <title>Note:</title> + <para>Previous versions of the tools used Velocity. We are now using Freemarker which + provides us much better exception and error handling.</para> + </note> + + <section> + <title>Exporter via &lt;hbmtemplate&gt;</title> + + <para>The following is an example of reverse engineering via <emphasis> + <property moreinfo="none">&lt;jdbcconfiguration&gt;</property> + </emphasis> and usage of a custom Exporter via the <emphasis> + <property moreinfo="none">&lt;hbmtemplate&gt;</property> + </emphasis>.</para> + + <programlisting format="linespecific" role="XML"><![CDATA[ <hibernatetool destdir="${destdir}"> + <jdbcconfiguration + configurationfile="hibernate.cfg.xml" + packagename="my.model"/> + + <!-- setup properties --> + <property key="appname" value="Registration"/> + <property key="shortname" value="crud"/> + + <hbmtemplate + exporterclass="my.own.Exporter" + filepattern="."/> + +</hibernatetool> +]]></programlisting> + + </section> + <section> + <title>Relevant Resources Links</title> + + <para>Read more about <ulink url="http://velocity.apache.org/">Velocity</ulink> and <ulink url="http://freemarker.org/">Freemarker</ulink> to find out why using the last is better + or refer to Max Andersen discussion on the topic in <ulink url="http://in.relation.to/2110.lace;jsessionid=3462F47B17556604C15DF1B96572E940">"A story about FreeMarker and Velocity"</ulink>.</para> + </section> + </section> + </section> + + + + <section> + <title>Using properties to configure Exporters</title> + + <para>Exporters can be controlled by user properties. The user properties are specified via <emphasis> + <property moreinfo="none">&lt;property&gt;</property> + </emphasis> or <emphasis> + <property moreinfo="none"> + <literal moreinfo="none">&lt;propertyset&gt;</literal> + </property> + </emphasis> and each exporter will have access to them directly in the templates and via + <property moreinfo="none">Exporter.setProperties()</property>.</para> + + <section> + <title><literal moreinfo="none">&lt;property&gt;</literal> and + <literal moreinfo="none">&lt;propertyset&gt;</literal></title> + + <para>The <emphasis> + <property moreinfo="none">&lt;property&gt;</property> + </emphasis> allows you bind a string value to a key. The value will be available in the + templates via <emphasis> + <property moreinfo="none">$&lt;key&gt;</property> + </emphasis>. The following example will assign the string value <emphasis> + <property moreinfo="none">"true"</property> + </emphasis> to the variable <emphasis> + <property moreinfo="none">$descriptors</property> + </emphasis>.</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<property key="descriptors" value="true"/>]]></programlisting> + + <para>Most times using <emphasis> + <property moreinfo="none"> + <literal moreinfo="none">&lt;property&gt;</literal> + </property> + </emphasis> is enough for specifying the properties needed for the exporters. Still the ant + tools supports the notion of <emphasis> + <property moreinfo="none"> + <literal moreinfo="none">&lt;propertyset&gt;</literal> + </property> + </emphasis> that is used for grouping a set of properties. More about the functionality of <emphasis> + <property moreinfo="none"> + <literal moreinfo="none">&lt;propertyset&gt;</literal> + </property> + </emphasis> is explained in detail in the <ulink url="http://ant.apache.org/manual/">Ant + manual</ulink>.</para> + </section> + + <section> + <title>Getting access to user specific classes</title> + + <para>If the templates need to access some user class it becomes possible by specifying a <emphasis> + <property moreinfo="none">"toolclass"</property> + </emphasis> in the properties.</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<property key="hibernatetool.sometool.toolclass" value="x.y.z.NameOfToolClass"/> +]]></programlisting> + + <para>Placing the above <emphasis> + <property moreinfo="none"> + <literal moreinfo="none">&lt;property&gt;</literal> + </property> + </emphasis> tag in <emphasis> + <property moreinfo="none"> + <literal moreinfo="none">&lt;hibernatetool&gt;</literal> + </property> + </emphasis> or inside any exporter will automatically create an instance of + <literal moreinfo="none">x.y.z.NameOfToolClass</literal> and it will be available in the templates as + <literal moreinfo="none">$sometool</literal>. This is useful to delegate logic and code generation to java + code instead of placing such logic in the templates.</para> + + <section> + <title>Example</title> + + <para>Here is an example that uses <emphasis> + <property moreinfo="none">&lt;hbmtemplate&gt;</property> + </emphasis> together with <emphasis> + <property moreinfo="none">&lt;property&gt;</property> + </emphasis> which will be available to the templates/exporter. </para> + <note> + <title>Note:</title> + <para> This example actually simulates what &lt;hbm2java&gt; actually does.</para> + </note> + + <programlisting format="linespecific" role="XML"><![CDATA[<hibernatetool destdir="${build.dir}/generated"> +<configuration + configurationfile="etc/hibernate.cfg.xml"/> + <hbmtemplate + templateprefix="pojo/" + template="pojo/Pojo.ftl" + filepattern="{package-name}/{class-name}.java"> + <property key="jdk5" value="true" /> + <property key="ejb3" value="true" /> + </hbmtemplate> +</hibernatetool> +]]></programlisting> + </section> + </section> + </section> +</chapter> + + +<chapter id="reverseengineering" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/hibernatetools/docs/reference/en/modules/reverseengineering.xml"> + <title>Controlling reverse engineering</title> + + <para>When using the <emphasis> + <property moreinfo="none">&lt;jdbcconfiguration&gt;</property>, </emphasis> the ant task will read the + database metadata and thus will perform a reverse engineering of the database schema into a + normal Hibernate Configuration. It is from this object e.g. <emphasis> + <property moreinfo="none">&lt;hbm2java&gt;</property> + </emphasis>can generate other artifacts such as <emphasis> + <property moreinfo="none">.java</property> + </emphasis>, <emphasis> + <property moreinfo="none">.hbm.xml</property> + </emphasis> etc.</para> + + <para>To govern this process <property moreinfo="none">Hibernate</property> uses a reverse engineering strategy. A + reverse engineering strategy is mainly called to provide more java like names for tables, column + and foreignkeys into classes, properties and associations. It also used to provide mappings from + SQL types to <property moreinfo="none">Hibernate</property> types. The strategy can be customized by a user. The + user can even provide its own custom reverse engineering strategy if the provided strategy is + not enough, or simply just provide a small part of the strategy and delegate the rest to the + default strategy.</para> + + <para>Thus, further in this chapter we will discuss how you can configure the process of a reverse + engineering, what default reverse engineering strategy includes as well as some custom concepts.</para> + + <section> + <title>Default reverse engineering strategy</title> + + <para>The default strategy uses some rules for mapping JDBC artifact names to java artifact + names. It also provide basic typemappings from JDBC types to <property moreinfo="none">Hibernate</property> + types. It is the default strategy that uses the packagename attribute to convert a table name + to a fully qualified classname.</para> + </section> + + <section id="hibernaterevengxmlfile"> + <title>hibernate.reveng.xml file</title> + + <para>To have fine control over the process a <emphasis> + <property moreinfo="none">hibernate.reveng.xml</property> + </emphasis> file can be provided. In this file you can specify type mappings and table + filtering. This file can be created by hand (it's just basic XML) or you can use the + <ulink url="http://www.hibernate.org/30.html">Hibernate plugins</ulink> which have a + specialized editor.</para> + + <note> + <title>Note:</title> + <para>Many databases are case-sensitive with their names and thus if you cannot make some + table match and you are sure it is not excluded by a &lt;table-filter&gt; then check + if the case matches; most databases stores table names in uppercase.</para> + </note> + + <para>Below you can see an example of a <emphasis> + <property moreinfo="none">reveng.xml</property>. </emphasis> Following the example gives you more details + about the format.</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE hibernate-reverse-engineering + SYSTEM "http://hibernate.sourceforge.net/hibernate-reverse-engineering-3.0.dtd" > + +<hibernate-reverse-engineering> + +<type-mapping> + <!-- jdbc-type is name fom java.sql.Types --> + <sql-type jdbc-type="VARCHAR" length='20' hibernate-type="SomeUserType" /> + <sql-type jdbc-type="VARCHAR" length='1' hibernate-type="yes_no" /> + <!-- length, scale and precision can be used to specify the mapping precisly --> + <sql-type jdbc-type="NUMERIC" precision='1' hibernate-type="boolean" /> + <!-- the type-mappings are ordered. This mapping will be consulted last, + thus overriden by the previous one if precision=1 for the column --> + <sql-type jdbc-type="NUMERIC" hibernate-type="long" /> +</type-mapping> + +<!-- BIN$ is recycle bin tables in Oracle --> +<table-filter match-name="BIN$.*" exclude="true" /> + +<!-- Exclude DoNotWantIt from all catalogs/schemas --> +<table-filter match-name="DoNotWantIt" exclude="true" /> + +<!-- exclude all tables from the schema SCHEMA in catalog BAD. --> +<table-filter match-catalog="BAD" match-schema="SCHEMA" match-name=".*" exclude="true" /> + +<!-- table allows you to override/define how reverse engineering + is done for a specific table --> +<table name="ORDERS"> + <primary-key> + <!-- setting up a specific id generator for a table --> + <generator class="sequence"> + <param name="table">seq_table</param> + </generator> + <key-column name="CUSTID"/> + </primary-key> + <column name="NAME" property="orderName" type="string" /> + <!-- control many-to-one and set names for a specific named foreign key constraint --> + <foreign-key constraint-name="ORDER_CUST"> + <many-to-one property="customer"/> + <set property="orders"/> + </foreign-key> + <!-- can also control a pure (shared pk) one-to-one --> + <foreign-key constraint-name="ADDRESS_PERSON"> + <one-to-one exclude="false"/> + <inverse-one-to-one exclude="true"/> + </foreign-key> +</table> + +</hibernate-reverse-engineering>]]></programlisting> + + + <section> + <title>Schema Selection (&lt;schema-selection&gt;)</title> + + <para><emphasis> + <property moreinfo="none">&lt;schema-selection&gt;</property> + </emphasis> is used to drive which schemas the reverse engineering will try and + process.</para> + + <para>By default the reverse engineering will read all schemas and then use <emphasis> + <property moreinfo="none">&lt;table-filter&gt;</property> + </emphasis> to decide which tables get reverse engineered and which do not; this makes it + easy to get started but can be inefficient on databases with many schemas.</para> + + <para>With <emphasis> + <property moreinfo="none">&lt;schema-selection&gt;</property> + </emphasis> it is thus possible to limit the actual processed schemas and thus significantly + speed-up the reverse engineering. <emphasis> + <property moreinfo="none">&lt;table-filter&gt;</property> + </emphasis> is still used to then decide which tables will be included/excluded.</para> + + <note> + <title>Note:</title> + <para>If no <literal moreinfo="none">&lt;schema-selection&gt;</literal> is specified, the reverse + engineering works as if all schemas should be processed. This is equal to: + <![CDATA[<schema-selection/>]]>. Which in turn is equal to: + <![CDATA[<schema-selection match-catalog=".*" match-schema=".*" match-table=".*"/>]]></para> + </note> + + <section> + <title>Examples</title> + + <para>The following will process all tables from <emphasis> + <property moreinfo="none">"MY_SCHEMA"</property>. + </emphasis></para> + + <programlisting format="linespecific" role="XML"><![CDATA[<schema-selection match-schema="MY_SCHEMA"/>]]></programlisting> + + <para>It is possible to have multiple <literal moreinfo="none">schema-selection</literal>'s to support + multi-schema reading or simply to limit the processing to very specific tables. The + following example processes all tables in <emphasis> + <property moreinfo="none">"MY_SCHEMA"</property>, + </emphasis> a specific <emphasis> + <property moreinfo="none">"CITY"</property> + </emphasis> table plus all tables that starts with <emphasis> + <property moreinfo="none">"CODES_"</property> + </emphasis> in <emphasis> + <property moreinfo="none">"COMMON_SCHEMA"</property>. + </emphasis></para> + + <programlisting format="linespecific" role="XML"><![CDATA[<schema-selection match-schema="MY_SCHEMA"/> +<schema-selection match-schema="COMMON_SCHEMA" match-table="CITY"/> +<schema-selection match-schema="COMMON_SCHEMA" match-table="CODES_.*"/>]]></programlisting> + </section> + </section> + + <section id="type_map"> + <title>Type mappings (&lt;type-mapping&gt;)</title> + + <para>The <emphasis> + <property moreinfo="none">&lt;type-mapping&gt;</property> + </emphasis> section specifies how the JDBC types found in the database should be mapped to + Hibernate types. e.g. <emphasis> + <property moreinfo="none">java.sql.Types.VARCHAR</property></emphasis> with a length of 1 should be mapped to the + Hibernate type <emphasis> + <property moreinfo="none">yes_no</property></emphasis> or <emphasis> + <property moreinfo="none">java.sql.Types.NUMERIC</property></emphasis> should generally just be + converted to the Hibernate type <literal moreinfo="none">long</literal>.</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<type-mapping> + <sql-type + jdbc-type="integer value or name from java.sql.Types" + length="a numeric value" + precision="a numeric value" + scale="a numeric value" + not-null="true|false" + hibernate-type="hibernate type name" + /> +</type-mapping>]]></programlisting> + + <para>The number of attributes specified and the sequence of the <literal moreinfo="none">sql-type</literal>'s + is important. Meaning that <property moreinfo="none">Hibernate</property> will search for the most specific + first, and if no specific match is found it will seek from top to bottom when trying to + resolve a type mapping.</para> + + <section> + <title>Example</title> + + <para>The following is an example of a type-mapping which shows the flexibility and the + importance of ordering of the type mappings.</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<type-mapping> + <sql-type jdbc-type="NUMERIC" precision="15" hibernate-type="big_decimal"/> + <sql-type jdbc-type="NUMERIC" not-null="true" hibernate-type="long" /> + <sql-type jdbc-type="NUMERIC" not-null="false" hibernate-type="java.lang.Long" /> + <sql-type jdbc-type="VARCHAR" length="1" not-null="true" + hibernate-type="java.lang.Character"/> + <sql-type jdbc-type="VARCHAR" hibernate-type="your.package.TrimStringUserType"/> + <sql-type jdbc-type="VARCHAR" length="1" hibernate-type="char"/> + <sql-type jdbc-type="VARCHAR" hibernate-type="string"/> +</type-mapping>]]></programlisting> + + <para>The following table shows how this affects an example table named <emphasis> + <property moreinfo="none">CUSTOMER</property>:</emphasis></para> + + <table frame="topbot"> + <title>sql-type examples</title> + + <tgroup cols="7"> + <colspec colwidth="0.4*"></colspec> + + <colspec colwidth="0.4*"></colspec> + + <colspec colwidth="0.2*"></colspec> + + <colspec colwidth="0.3*"></colspec> + + <colspec colwidth="0.2*"></colspec> + + <colspec colwidth="1.0*"></colspec> + + <colspec colwidth="0.7*"></colspec> + + <thead> + <row> + <entry>Column</entry> + + <entry>jdbc-type</entry> + + <entry>length</entry> + + <entry>precision</entry> + + <entry>not-null</entry> + + <entry>Resulting hibernate-type</entry> + + <entry>Rationale</entry> + </row> + </thead> + + <tbody> + <row> + <entry>ID</entry> + + <entry>INTEGER</entry> + + <entry></entry> + + <entry>10</entry> + + <entry>true</entry> + + <entry>int</entry> + + <entry>Nothing is defined for INTEGER. Falling back to default behavior.</entry> + </row> + + <row> + <entry>NAME</entry> + + <entry>VARCHAR</entry> + + <entry>30</entry> + + <entry></entry> + + <entry>false</entry> + + <entry>your.package.TrimStringUserType</entry> + + <entry>No type-mapping matches length=30 and not-null=false, but type-mapping + matches the 2 mappings which only specifies VARCHAR. The type-mapping that comes + first is chosen.</entry> + </row> + + <row> + <entry>INITIAL</entry> + + <entry>VARCHAR</entry> + + <entry>1</entry> + + <entry></entry> + + <entry>false</entry> + + <entry>char</entry> + + <entry>Even though there is a generic match for VARCHAR, the more specific + type-mapping for VARCHAR with not-null="false" is chosen. The first VARCHAR + sql-type matches in length but has no value for not-null and thus is not + considered.</entry> + </row> + + <row> + <entry>CODE</entry> + + <entry>VARCHAR</entry> + + <entry>1</entry> + + <entry></entry> + + <entry>true</entry> + + <entry>java.lang.Character</entry> + + <entry>The most specific VARCHAR with not-null="true" is selected</entry> + </row> + + <row> + <entry>SALARY</entry> + + <entry>NUMERIC</entry> + + <entry></entry> + + <entry>15</entry> + + <entry>false</entry> + + <entry>big_decimal</entry> + + <entry>There is a precise match for NUMERIC with precision 15</entry> + </row> + + <row> + <entry>AGE</entry> + + <entry>NUMERIC</entry> + + <entry></entry> + + <entry>3</entry> + + <entry>false</entry> + + <entry>java.lang.Long</entry> + + <entry>type-mapping for NUMERIC with not-null="false"</entry> + </row> + </tbody> + </tgroup> + </table> + + <para></para> + </section> + </section> + + <section> + <title>Table filters (&lt;table-filter&gt;)</title> + + <para>The <emphasis> + <property moreinfo="none">&lt;table-filter&gt;</property> + </emphasis> let you specify matching rules for performing general filtering/setup for + tables, e.g. let you include or exclude specific tables based on the schema or even a + specific prefix.</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<table-filter + match-catalog="catalog_matching_rule" + match-schema="schema_matching_rule" + match-name="table_matching_rule" + exclude="true|false" + package="package.name" +/>]]></programlisting> + + <table frame="topbot"> + <title>Table-filter attributes</title> + + <tgroup cols="3"> + + <colspec colwidth="0.3*"></colspec> + + <colspec colwidth="1.0*"></colspec> + + <colspec colwidth="0.3*"></colspec> + + + <thead> + <row> + <entry>Attribute name</entry> + + <entry>Definition</entry> + + <entry>Default value</entry> + </row> + </thead> + + <tbody> + <row> + <entry><para>match-catalog</para></entry> + + <entry><para>Pattern for matching catalog part of the table</para></entry> + + <entry><para>.*</para></entry> + </row> + + <row> + <entry><para>match-schema</para></entry> + + <entry><para>Pattern for matching schema part of the table</para></entry> + + <entry><para>.*</para></entry> + </row> + + <row> + <entry><para>match-table</para></entry> + + <entry><para>Pattern for matching table part of the table</para></entry> + + <entry><para>.*</para></entry> + </row> + + <row> + <entry><para>exclude </para></entry> + + <entry><para>If true the table will not be part of the reverse + engineering</para></entry> + + <entry><para>false</para></entry> + </row> + + <row> + <entry><para>package</para></entry> + + <entry><para>The default package name to use for classes based on tables + matched by this table-filter</para></entry> + + <entry><para>""</para></entry> + </row> + </tbody> + + </tgroup> + </table> + + </section> + + <section id="tab_and_col"> + <title>Specific table configuration (&lt;table&gt;)</title> + + <para><emphasis> + <property moreinfo="none">&lt;table&gt;</property> + </emphasis> allows you to provide explicit configuration on how a table should be reverse + engineered. Amongst other things it allows controlling over the naming of a class for the + table, specifying which identifier generator should be used for the primary key etc.</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<table + catalog="catalog_name" + schema="schema_name" + name="table_name" + class="ClassName" +> + <primary-key.../> + <column.../> + <foreign-key.../> + </table>]]></programlisting> + + <table frame="topbot"> + <title>Table attributes</title> + + <tgroup cols="3"> + + <colspec colwidth="0.3*"></colspec> + + <colspec colwidth="1.0*"></colspec> + + <colspec colwidth="0.3*"></colspec> + + + <thead> + <row> + <entry>Attribute name</entry> + + <entry>Definition</entry> + + <entry>Attribute use</entry> + </row> + </thead> + + <tbody> + <row> + <entry><para>catalog</para></entry> + + <entry><para>Catalog name for a table. It has to be specified if you are + reverse engineering multiple catalogs or if it is not equal to + hiberante.default_catalog.</para></entry> + + <entry><para>Optional</para></entry> + </row> + + <row> + <entry><para>schema</para></entry> + + <entry><para>Schema name for a table. It has to be specified if you are + reverse engineering multiple schemas or if it is not equal to + hiberante.default_schema.</para></entry> + + <entry><para>Optional</para></entry> + </row> + + <row> + <entry><para>name</para></entry> + + <entry><para>Name for a table.</para></entry> + + <entry><para>Required</para></entry> + </row> + + <row> + <entry><para>class</para></entry> + + <entry><para>The class name for a table. Default name is a camelcase version + of the table name.</para></entry> + + <entry><para>Optional</para></entry> + </row> + + </tbody> + + </tgroup> + </table> + + <section> + <title>&lt;primary-key&gt;</title> + + <para>A <emphasis> + <property moreinfo="none">&lt;primary-key&gt;</property> + </emphasis> allows you to define a primary-key for tables that don't have it + defined in the database, and probably more importantly it allows you to define which + identifier strategy should be used (even for already existing primary-key's).</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<primary-key + <generator class="generatorname"> + <param name="param_name">parameter value</param> + </generator> + <key-column...> + </primary-key>]]></programlisting> + + <table frame="topbot"> + <title>Primary-key attributes</title> + + <tgroup cols="3"> + + <colspec colwidth="0.3*"></colspec> + + <colspec colwidth="1.0*"></colspec> + + <colspec colwidth="0.3*"></colspec> + + + <thead> + <row> + <entry>Attribute name</entry> + + <entry>Definition</entry> + + <entry>Attribute use</entry> + </row> + </thead> + + <tbody> + <row> + <entry><para>generator/class</para></entry> + + <entry><para>Defines which identifier generator should be used. + The class name is any hibernate short hand name or fully qualified class name for an + identifier strategy.</para></entry> + + <entry><para>Optional</para></entry> + </row> + + <row> + <entry><para>generator/param</para></entry> + + <entry><para>Allows to specify which parameter with a name and + value should be passed to the identifier generator.</para></entry> + + <entry><para>Optional</para></entry> + </row> + + <row> + <entry><para>key-column</para></entry> + + <entry><para>Specifies which column(s ) the primary-key consists of. A + key-column is same as column, but does not have the exclude property.</para></entry> + + <entry><para>Optional</para></entry> + </row> + + </tbody> + + </tgroup> + </table> + + </section> + + <section> + <title>&lt;column&gt;</title> + + <para>With a <emphasis> + <property moreinfo="none">&lt;column&gt;</property> + </emphasis> it is possible to explicitly name the resulting property for a column. It is + also possible to redefine what jdbc and/or Hibernate type a column should be processed as + and finally it is possible to completely exclude a column from processing.</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<column + name="column_name" + jdbc-type="java.sql.Types type" + type="hibernate_type" + property="propertyName" + exclude="true|false" +/>]]></programlisting> + + <table frame="topbot"> + <title>Column attributes</title> + + <tgroup cols="3"> + + <colspec colwidth="0.3*"></colspec> + + <colspec colwidth="1.0*"></colspec> + + <colspec colwidth="0.3*"></colspec> + + + <thead> + <row> + <entry>Attribute name</entry> + + <entry>Definition</entry> + + <entry>Attribute use</entry> + </row> + </thead> + + <tbody> + <row> + <entry><para>name</para></entry> + + <entry><para>Column name</para></entry> + + <entry><para>Required</para></entry> + </row> + + <row> + <entry><para>jdbc-type</para></entry> + + <entry><para>Which jdbc-type this column should be processed as. A + value from java.sql.Types, either numerical (93) or the constant name + (TIMESTAMP).</para></entry> + + <entry><para>Optional</para></entry> + </row> + + <row> + <entry><para>type</para></entry> + + <entry><para>Which hibernate-type to use for this specific column</para></entry> + + <entry><para>Optional</para></entry> + </row> + + + <row> + <entry><para>property</para></entry> + + <entry><para>What property name will be generated for this + column</para></entry> + + <entry><para>Optional</para></entry> + </row> + + <row> + <entry><para>exclude</para></entry> + + <entry><para>Set to true if this column should be ignored</para></entry> + + <entry><para>default: false</para></entry> + </row> + + </tbody> + + </tgroup> + </table> + + </section> + + <section> + <title>&lt;foreign-key&gt;</title> + + <para>The <emphasis> + <property moreinfo="none">&lt;foreign-key&gt;</property> + </emphasis> has two purposes. One for allowing to define foreign-keys in databases that + does not support them or does not have them defined in their schema. Secondly, to allow + defining the name of the resulting properties (many-to-one, one-to-one and one-to-many's).</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<foreign-key + constraint-name="foreignKeyName" + foreign-catalog="catalogName" + foreign-schema="schemaName" + foreign-table="tableName" + > + <column-ref local-column="columnName" foreign-column="foreignColumnName"/> + <many-to-one + property="aPropertyName" + exclude="true|false"/> + <set + property="aCollectionName" + exclude="true|false" + + <one-to-one + property="aPropertyName" + exclude="true|false"/> + <inverse-one-to-one + property="aPropertyName" + exclude="true|false"/> + </foreign-key>]]></programlisting> + <table frame="topbot"> + <title>Foreign-key attributes</title> + + <tgroup cols="3"> + + <colspec colwidth="0.3*"></colspec> + + <colspec colwidth="1.0*"></colspec> + + <colspec colwidth="0.3*"></colspec> + + + <thead> + <row> + <entry>Attribute name</entry> + + <entry>Definition</entry> + + <entry>Attribute use</entry> + </row> + </thead> + + <tbody> + <row> + <entry><para>constraint-name</para></entry> + + <entry><para>Name of the foreign key constraint. Important when + naming many-to-one, one-to-one and set. It is the constraint-name that is used to link the + processed foreign-keys with the resulting property names.</para></entry> + + <entry><para>Required</para></entry> + </row> + + <row> + <entry><para>foreign-catalog</para></entry> + + <entry><para>Name of the foreign table's catalog. (Only + relevant if you want to explicitly define a foreign key).</para></entry> + + <entry><para>Optional</para></entry> + </row> + + <row> + <entry><para>foreign-schema</para></entry> + + <entry><para>Name of the foreign table's schema. (Only relevant + if you want to explicitly define a foreign key).</para></entry> + + <entry><para>Optional</para></entry> + </row> + + + <row> + <entry><para>foreign-table</para></entry> + + <entry><para>Name of the foreign table. (Only relevant if you + want to explicitly define a foreign key).</para></entry> + + <entry><para>Optional</para></entry> + </row> + + <row> + <entry><para>column-ref </para></entry> + + <entry><para>Defines that the foreign-key constraint between a + local-column and foreign-column name. (Only relevant if you want to explicitly + define a foreign key).</para></entry> + + <entry><para>Optional</para></entry> + </row> + + <row> + <entry><para>many-to-one</para></entry> + + <entry><para>Defines that a many-to-one should be created and the + property attribute specifies the name of the resulting property. Exclude can be + used to explicitly define that it should be created or not.</para></entry> + + <entry><para>Optional</para></entry> + </row> + + <row> + <entry><para>set</para></entry> + + <entry><para>Defines that a set should be created based on this foreign-key + and the property attribute specifies the name of the resulting (set) property. + Exclude can be used to explicitly define that it should be created or not.</para></entry> + + <entry><para>Optional</para></entry> + </row> + + <row> + <entry><para>one-to-one</para></entry> + + <entry><para>Defines that a one-to-one should be created and the + property attribute specifies the name of the resulting property. Exclude can be + used to explicitly define that it should be created or not.</para></entry> + + <entry><para>Optional</para></entry> + </row> + + <row> + <entry><para>inverse-one-to-one</para></entry> + + <entry><para>Defines that an inverse one-to-one should be created based on this foreign-key + and the property attribute specifies the name of the resulting property. + Exclude can be used to explicitly define that it should be created or not.</para></entry> + + <entry><para>Optional</para></entry> + </row> + </tbody> + + </tgroup> + </table> + + </section> + </section> + </section> + + <section id="custom-reveng-strategy"> + <title>Custom strategy</title> + + <para>It is possible to implement a user strategy. Such strategy must implement <emphasis> + <property moreinfo="none">org.hibernate.cfg.reveng.ReverseEngineeringStrategy</property>. + </emphasis> It is recommended that one uses the + <property moreinfo="none">DelegatingReverseEngineeringStrategy</property> and provide a public constructor + which takes another <property moreinfo="none">ReverseEngineeringStrategy </property> as an argument. This will + allow you to only implement the relevant methods and provide a fallback strategy. Example of + custom delegating strategy which converts all column names that ends with <emphasis> + <property moreinfo="none">"PK"</property> + </emphasis> into a property named <emphasis> + <property moreinfo="none">"id"</property>. + </emphasis></para> + + <programlisting format="linespecific" role="JAVA"><![CDATA[public class ExampleStrategy extends DelegatingReverseEngineeringStrategy { + + public ExampleStrategy(ReverseEngineeringStrategy delegate) { + super(delegate); + } + + public String columnToPropertyName(TableIdentifier table, String column) { + if(column.endsWith("PK")) { + return "id"; + } else { + return super.columnToPropertyName(table, column); + } + } +}]]></programlisting> + </section> + + <section> + <title>Custom Database Metadata</title> + + <para>By default the reverse engineering is performed by reading using the JDBC database + metadata API. This is done via the class <emphasis> + <property moreinfo="none">org.hibernate.cfg.reveng.dialect.JDBCMetaDataDialect</property> + </emphasis> which is an implementation of <emphasis> + <property moreinfo="none">org.hibernate.cfg.reveng.dialect.MetaDataDialect</property>. + </emphasis></para> + + <para>The default implementation can be replaced with an alternative implementation by setting + the property <emphasis> + <property moreinfo="none">hibernatetool.metadatadialect</property> + </emphasis> to a fully qualified classname for a class that implements + <property moreinfo="none">JDBCMetaDataDialect</property>.</para> + + <para>This can be used to provide database specific optimized metadata reading. If you create an + optimized/better metadata reading for your database it will be a very welcome + contribution.</para> + </section> +</chapter> + + +<chapter id="codegen" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/hibernatetools/docs/reference/en/modules/codegen.xml"> + <title>Controlling POJO code generation</title> + + <para>When using <emphasis> + <property moreinfo="none">&lt;hbm2java&gt;</property> + </emphasis> or the eclipse plugin to generate POJO java code you have the possibility to control + certain aspects of the code generation. This is primarily done with the <emphasis> + <property moreinfo="none">&lt;meta&gt;</property> + </emphasis> tag in the mapping files. The following section describes the possible <emphasis> + <property moreinfo="none">&lt;meta&gt;</property> + </emphasis> tags and their use.</para> + + <section> + <title>The <literal moreinfo="none">&lt;meta&gt;</literal> attribute</title> + + <para>The <emphasis> + <property moreinfo="none">&lt;meta&gt;</property> + </emphasis> tag is a simple way of annotating the <emphasis> + <property moreinfo="none">hbm.xml</property> + </emphasis> with information, so tools have a natural place to store/read information that is + not directly related to the Hibernate core.</para> + + <para>You can use the <emphasis> + <property moreinfo="none">&lt;meta&gt;</property> + </emphasis> tag to e.g. tell <emphasis> + <property moreinfo="none">&lt;hbm2java&gt;</property> + </emphasis> to only generate <emphasis> + <property moreinfo="none">"protected"</property> + </emphasis> setters, have classes always implement a certain set of interfaces or even have + them extend a certain base class and even more.</para> + + <para>The following example shows how to use various <emphasis> + <property moreinfo="none">&lt;meta&gt;</property> + </emphasis> attributes and the resulting java code.</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<class name="Person"> + <meta attribute="class-description"> + Javadoc for the Person class + @author Frodo + </meta> + <meta attribute="implements">IAuditable</meta> + <id name="id" type="long"> + <meta attribute="scope-set">protected</meta> + <generator class="increment"/> + </id> + <property name="name" type="string"> + <meta attribute="field-description">The name of the person</meta> + </property> +</class>]]></programlisting> + + <para>The above <emphasis> + <property moreinfo="none">hbm.xml</property> + </emphasis> will produce something like the following (code shortened for better + understanding). Notice the Javadoc comment and the protected set methods:</para> + + <programlisting format="linespecific" role="JAVA"><![CDATA[// default package + +import java.io.Serializable; +import org.apache.commons.lang.builder.EqualsBuilder; +import org.apache.commons.lang.builder.HashCodeBuilder; +import org.apache.commons.lang.builder.ToStringBuilder; + +/** + * Javadoc for the Person class + * @author Frodo + */ +public class Person implements Serializable, IAuditable { + + public Long id; + + public String name; + + public Person(java.lang.String name) { + this.name = name; + } + + public Person() { + } + + public java.lang.Long getId() { + return this.id; + } + + protected void setId(java.lang.Long id) { + this.id = id; + } + + /** + * The name of the person + */ + public java.lang.String getName() { + return this.name; + } + + public void setName(java.lang.String name) { + this.name = name; + } + +}]]></programlisting> + + <table frame="topbot"> + <title>Supported meta tags</title> + + <tgroup cols="2"> + <colspec colwidth="1.0*"></colspec> + + <colspec colwidth="2*"></colspec> + + <thead> + <row> + <entry>Attribute</entry> + + <entry>Description</entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <literal moreinfo="none">class-description</literal> + </entry> + + <entry>inserted into the javadoc for classes</entry> + </row> + + <row> + <entry> + <literal moreinfo="none">field-description</literal> + </entry> + + <entry>inserted into the javadoc for fields/properties</entry> + </row> + + <row> + <entry> + <literal moreinfo="none">interface</literal> + </entry> + + <entry>If true, an interface is generated instead of an class.</entry> + </row> + + <row> + <entry> + <literal moreinfo="none">implements</literal> + </entry> + + <entry>interface the class should implement</entry> + </row> + + <row> + <entry> + <literal moreinfo="none">extends</literal> + </entry> + + <entry>class that the current class should extend (ignored for subclasses)</entry> + </row> + + <row> + <entry> + <literal moreinfo="none">generated-class</literal> + </entry> + + <entry>overrule the name of the actual class generated</entry> + </row> + + <row> + <entry> + <literal moreinfo="none">scope-class</literal> + </entry> + + <entry>scope for class</entry> + </row> + + <row> + <entry> + <literal moreinfo="none">scope-set</literal> + </entry> + + <entry>scope for setter method</entry> + </row> + + <row> + <entry> + <literal moreinfo="none">scope-get</literal> + </entry> + + <entry>scope for getter method</entry> + </row> + + <row> + <entry> + <literal moreinfo="none">scope-field</literal> + </entry> + + <entry>scope for actual field</entry> + </row> + + <row> + <entry> + <literal moreinfo="none">default-value</literal> + </entry> + + <entry>default initialization value for a field</entry> + </row> + + <row> + <entry> + <literal moreinfo="none">use-in-tostring</literal> + </entry> + + <entry>include this property in the <literal moreinfo="none">toString()</literal></entry> + </row> + + <row> + <entry> + <literal moreinfo="none">use-in-equals</literal> + </entry> + + <entry>include this property in the <literal moreinfo="none">equals()</literal> and + <literal moreinfo="none">hashCode()</literal> method. If no use-in-equals is specified, no + equals/hashcode will be generated.</entry> + </row> + + <row> + <entry> + <literal moreinfo="none">gen-property</literal> + </entry> + + <entry>property will not be generated if false (use with care)</entry> + </row> + + <row> + <entry> + <literal moreinfo="none">property-type</literal> + </entry> + + <entry>Overrides the default type of property. Use this with any tag's to specify the + concrete type instead of just Object.</entry> + </row> + + <row> + <entry> + <literal moreinfo="none">class-code</literal> + </entry> + + <entry>Extra code that will inserted at the end of the class</entry> + </row> + + <row> + <entry> + <literal moreinfo="none">extra-import</literal> + </entry> + + <entry>Extra import that will inserted at the end of all other imports</entry> + </row> + </tbody> + </tgroup> + </table> + + <para>Attributes declared via the <emphasis> + <property moreinfo="none">&lt;meta&gt;</property> + </emphasis> tag are per default <emphasis> + <property moreinfo="none">"inherited"</property> + </emphasis> inside an <emphasis> + <property moreinfo="none">hbm.xml</property> + </emphasis> file.</para> + + <para>What does that mean? It means that if you e.g want to have all your classes implement + <literal moreinfo="none">IAuditable</literal> then you just add an <emphasis> &lt;meta + attribute="implements"&gt;IAuditable&lt;/meta&gt;</emphasis> in the top of the <emphasis> + <property moreinfo="none">hbm.xml</property> + </emphasis> file, just after <emphasis> + <property moreinfo="none">&lt;hibernate-mapping&gt;</property>. </emphasis> Now all classes defined + in that <emphasis> + <property moreinfo="none">hbm.xml</property> + </emphasis> file will implement <literal moreinfo="none">IAuditable</literal>!</para> + + <note> + <title>Note:</title> + <para>This applies to <emphasis>all</emphasis> + <literal moreinfo="none">&lt;meta&gt;</literal>-tags. Thus it can also e.g. be used to specify that + all fields should be declare protected, instead of the default private. This is done by + adding <literal moreinfo="none">&lt;meta + attribute="scope-field"&gt;protected&lt;/meta&gt;</literal> at e.g. just under + the <literal moreinfo="none">&lt;class&gt;</literal> tag and all fields of that class will be + protected.</para> + </note> + + <para>To avoid having a <emphasis> + <property moreinfo="none">&lt;meta&gt;</property> + </emphasis> tag inherited then you can simply specify <emphasis> inherit = "false"</emphasis> + for the attribute, e.g. <emphasis> &lt;meta attribute = "scope-class" inherit = + "false"&gt;public abstract&lt;/meta&gt;</emphasis> will restrict the <emphasis> + <property moreinfo="none">"class-scope"</property> + </emphasis> to the current class, not the subclasses.</para> + + <section> + <title>Recommendations</title> + + <para>The following are some good practices when using <emphasis> + <property moreinfo="none">&lt;meta&gt;</property> + </emphasis> attributes.</para> + + <section> + <title>Dangers of a class level <literal moreinfo="none">use-in-string and use-in-equals</literal> meta + attributes when having bi-directional associations</title> + + <para>If we have two entities with a bi-directional association between them and define at + class scope level the meta attributes: <emphasis> + <property moreinfo="none">use-in-string</property>, </emphasis> + <emphasis> + <property moreinfo="none">use-in-equals</property>: </emphasis></para> + + <programlisting format="linespecific" role="XML"><![CDATA[<hibernate-mapping> + <class name="Person"> + <meta attribute="use-in-tostring">true</meta> + <meta attribute="use-in-equals">true</meta> + ... + </class> +</hibernate-mapping>]]></programlisting> + + <para>And for <emphasis> + <property moreinfo="none">Event.hbm</property> + </emphasis> file:</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<hibernate-mapping> + <class name="events.Event" table="EVENTS"> + <meta attribute="use-in-tostring">true</meta> + <meta attribute="use-in-equals">true</meta> + <id name="id" column="EVENT_ID"> + <generator class="native"/> + </id> + <property name="date" type="timestamp" column="EVENT_DATE"/> + <property name="title"/> + <set name="participants" table="PERSON_EVENT" inverse="true"> + <key column="EVENT_ID"/> + <many-to-many column="PERSON_ID" class="events.Person"/> + </set> + </class> +</hibernate-mapping>]]></programlisting> + + <para>Then <emphasis> + <property moreinfo="none">&lt;hbm2java&gt;</property> + </emphasis> will assume you want to include all properties and collections in the + <property moreinfo="none">toString()/equals()</property> methods and this can result in infinite + recursive calls.</para> + + <para>To remedy this you have to decide which side of the association will include the other + part (if at all) in the <property moreinfo="none">toString()/equals()</property> methods. Therefore it is + not a good practice to put at class scope such <emphasis> + <property moreinfo="none">meta</property> + </emphasis> attributes, unless you are defining a class without bi-directional + associations.</para> + + <para>We recomend instead to add the <emphasis> + <property moreinfo="none">meta</property> + </emphasis> attributes at the property level:</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<hibernate-mapping> + <class name="events.Event" table="EVENTS"> + <id name="id" column="EVENT_ID"> + <meta attribute="use-in-tostring">true</meta> + <generator class="native"/> + </id> + <property name="date" type="timestamp" column="EVENT_DATE"/> + <property name="title"> + <meta attribute="use-in-tostring">true</meta> + <meta attribute="use-in-equals">true</meta> + </property> + <set name="participants" table="PERSON_EVENT" inverse="true"> + <key column="EVENT_ID"/> + <many-to-many column="PERSON_ID" class="events.Person"/> + </set> + </class> +</hibernate-mapping>]]></programlisting> + + <para>and now for <property moreinfo="none">Person</property>:</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<hibernate-mapping> + <class name="Person"> + <meta attribute="class-description"> + Javadoc for the Person class + @author Frodo + </meta> + <meta attribute="implements">IAuditable</meta> + <id name="id" type="long"> + <meta attribute="scope-set">protected</meta> + <meta attribute="use-in-tostring">true</meta> + <generator class="increment"/> + </id> + <property name="name" type="string"> + <meta attribute="field-description">The name of the person</meta> + <meta attribute="use-in-tostring">true</meta> + </property> + </class> +</hibernate-mapping>]]></programlisting> + </section> + + <section> + <title>Be aware of putting at class scope level <literal moreinfo="none">&lt;meta&gt;</literal> + attribute <literal moreinfo="none">use-in-equals</literal></title> + + <para>For <property moreinfo="none">equal()/hashCode()</property> method generation, you have to take into + account that the attributes that participate on such method definition, should take into + account only attributes with business meaning (the name, social security number, etc, but + no generated id's, for example).</para> + + <para>This is important because Java's hashbased collections, such as + <property moreinfo="none">java.util.Set</property> relies on <property moreinfo="none">equals()</property> and + <property moreinfo="none">hashcode()</property> to be correct and not change for objects in the set; + this can be a problem if the id gets assigned for an object after you inserted it into a + set.</para> + + <para>Therefore automatically configuration of the generation of + <property moreinfo="none">equals()/hashCode()</property> methods specifying at class scope level the <emphasis> + <property moreinfo="none">&lt;meta&gt;</property> + </emphasis> attribute <emphasis> + <property moreinfo="none">use-in-equals</property> + </emphasis> could be a dangerous decision that could produce non expected + side-effect.</para> + + <para><ulink url="http://www.hibernate.org/109.html">Here</ulink> you can get more in-depth + explanation on the subject of <property moreinfo="none">equals()</property> and + <property moreinfo="none">hashcode()</property>.</para> + </section> + </section> + + <section> + <title>Advanced &lt;meta&gt; attribute examples</title> + + <para>This section shows an example for using meta attributes (including userspecific + attributes) together with the code generation features in <property moreinfo="none">Hibernate + Tools</property>.</para> + + <para>The usecase being implemented is to automatically insert some pre- and post-conditions + into the getter and setters of the generated POJO. </para> + + <section> + <title>Generate pre/post-conditions for methods</title> + + <para>With a <emphasis> &lt;meta attribute="class-code"&gt;</emphasis>, you can add + additional methods on a given class, nevertheless such <emphasis> + <property moreinfo="none">&lt;meta&gt;</property> + </emphasis> attribute can not be used at a property scope level and <property moreinfo="none">Hibernate + Tools</property> does not provide such <emphasis> + <property moreinfo="none">&lt;meta&gt;</property> + </emphasis> attributes.</para> + + <para>A possible solution for this is to modify the freemarker templates responsible for + generating the POJO's. If you look inside <emphasis> + <property moreinfo="none">hibernate-tools.jar</property>, </emphasis> you can find the template: <emphasis> + <property moreinfo="none">pojo/PojoPropertyAccessor.ftl</property> + </emphasis></para> + + <para>This file is as the name indicates used to generate property accessors for + pojo's.</para> + + <para>Extract the <emphasis> + <property moreinfo="none">PojoPropertyAccessor.ftl</property> + </emphasis> into a local folder i.e. <emphasis> + <property moreinfo="none">${hbm.template.path}</property>, </emphasis> respecting the whole path, for + example: <emphasis> + <property moreinfo="none">${hbm.template.path}/pojo/PojoPropertyAccessor.ftl</property> + </emphasis></para> + + <para>The contents of the file is something like this:</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<#foreach property in pojo.getAllPropertiesIterator()> + ${pojo.getPropertyGetModifiers(property)} + ${pojo.getJavaTypeName(property, jdk5)} + ${pojo.getGetterSignature(property)}() { + return this.${property.name}; + } + + ${pojo.getPropertySetModifiers(property)} void set${pojo.getPropertyName(property)} + (${pojo.getJavaTypeName(property, jdk5)} ${property.name}) + { + this.${property.name} = ${property.name}; + } +</#foreach>]]></programlisting> + + <para>We can add conditionally pre/post-conditions on our <literal moreinfo="none">set</literal> method + generation just adding a little Freemarker syntax to the above source code:</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<#foreach property in pojo.getAllPropertiesIterator()> + ${pojo.getPropertyGetModifiers(property)} + ${pojo.getJavaTypeName(property, jdk5)} + ${pojo.getGetterSignature(property)}() + { + return this.${property.name}; + } + + ${pojo.getPropertySetModifiers(property)} void set${pojo.getPropertyName(property)} + (${pojo.getJavaTypeName(property, jdk5)} ${property.name}) + { + <#if pojo.hasMetaAttribute(property, "pre-cond")> + ${c2j.getMetaAsString(property, "pre-cond","\n")} + </#if> + this.${property.name} = ${property.name}; + <#if pojo.hasMetaAttribute(property, "post-cond")> + ${c2j.getMetaAsString(property, "post-cond","\n")} + </#if> +} +</#foreach>]]> +</programlisting> + + <para>Now if in any <emphasis> + <property moreinfo="none">.hbm.xml</property> + </emphasis> file we define the <emphasis> + <property moreinfo="none">&lt;meta&gt;</property> + </emphasis> attributes: <literal moreinfo="none">pre-cond</literal> or <literal moreinfo="none">post-cond</literal>, their + contents will be generated into the body of the relevant <literal moreinfo="none">set</literal> + method.</para> + + <para>As an example let us add a pre-condition for property <literal moreinfo="none">name</literal> + preventing no <property moreinfo="none">Person</property> can have an empty name. Hence we have to modify + the <emphasis> + <property moreinfo="none">Person.hbm.xml</property> + </emphasis> file like this:</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<hibernate-mapping> + <class name="Person"> + <id name="id" type="long"> + <generator class="increment"/> + </id> + <property name="firstName" type="string"> + <meta attribute="pre-cond"> + if ((firstName != null) &amp;&amp; (firstName.length() == 0) ) { + throw new IllegalArgumentException("firstName can not be an empty String"); + } + </meta> + </property> +</class> +</hibernate-mapping>]]></programlisting> + + <note> + <title>Note:</title> + <para>I) To escape the &amp; symbol we put &amp;amp;. You can use + &lt;![CDATA[]]&gt; instead.</para> + <para>II) Note that we are referring to "firstName" directly and this is the parameter + name not the actual field name. If you want to refer the field you have to use + "this.firstName" instead. </para> + </note> + + <para>Finally we have to generate the <emphasis> + <property moreinfo="none">Person.java</property> + </emphasis> class, for this we can use both Eclipse and Ant as long as you remember to set + or fill in the templatepath setting. For Ant we configure <emphasis> + <property moreinfo="none">&lt;hibernatetool&gt;</property> + </emphasis> task via <literal moreinfo="none">the templatepath</literal> attribute as in:</para> + + <programlisting format="linespecific" role="XML"><![CDATA[ + <target name="hbm2java"> + <taskdef name="hibernatetool" + classname="org.hibernate.tool.ant.HibernateToolTask" + classpathref="lib.classpath"/> + <hibernatetool destdir="${hbm2java.dest.dir}" + templatepath="${hbm.template.path}"> + <classpath> + <path refid="pojo.classpath"/> + </classpath> + <configuration> + <fileset dir="${hbm2java.src.dir}"> + <include name="**/*.hbm.xml"/> + </fileset> + </configuration> + <hbm2java/> + </hibernatetool> + </target>]]></programlisting> + + <para>Invoking the target <emphasis> + <property moreinfo="none">&lt;hbm2java&gt;</property> + </emphasis> will generate on the <emphasis> + <property moreinfo="none">${hbm2java.dest.dir}</property> + </emphasis> the file <emphasis> + <property moreinfo="none">Person.java</property> + </emphasis>:</para> + + <programlisting format="linespecific" role="JAVA"><![CDATA[// default package +import java.io.Serializable; +public class Person implements Serializable { + + public Long id; + + public String name; + + public Person(java.lang.String name) { + this.name = name; + } + + public Person() { + } + + public java.lang.Long getId() { + return this.id; + } + + public void setId(java.lang.Long id) { + this.id = id; + } + + public java.lang.String getName() { + return this.name; + } + + public void setName(java.lang.String name) { + if ((name != null) &amp;&amp; (name.length() == 0)) { + throw new IllegalArgumentException("name can not be an empty String"); + } + this.name = name; + } + }]]></programlisting> + + <para>In conclusion, this document is intended to introduce you to Hibernate plugin specific + features related to tools bath for the Eclipse and Ant tasks.</para> + + <para>In the <link linkend="plugins">Eclipse Plugins</link> chapter you've learnt + about a set of wizards for creating Mapping files, Configuration file, Console + Configuration, got familiar with Mapping and Configuration files editors, tooling for + organizing and controlling Reverse Engineering, Hibernate Console and Mapping diagram as + well.</para> + + <para>The rest chapters have shown the aspects of using the <property moreinfo="none">Hibernate + Tools</property> via Ant tasks.</para> + + <para>Please, visit <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... + Tools Users Forum</ulink> to leave questions or/and suggestions on the topic. Your + feedback is always appreciated.</para> + </section> + </section> + + </section> + +</chapter> + + + + </book> Added: branches/jbosstools-3.0.x/jbpm/docs/reference/en/master_output.xml =================================================================== --- branches/jbosstools-3.0.x/jbpm/docs/reference/en/master_output.xml (rev 0) +++ branches/jbosstools-3.0.x/jbpm/docs/reference/en/master_output.xml 2009-03-06 18:46:29 UTC (rev 14086) @@ -0,0 +1,1288 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + + +[<!ENTITY introduction SYSTEM "modules/Introduction.xml"> +<!ENTITY jboss_jbpm_runtime_installation SYSTEM "modules/jboss_jbpm_runtime_installation.xml"> +<!ENTITY guided_tour_jboss_jbpmgpd SYSTEM "modules/guided_tour_jboss_jbpmgpd.xml"> +<!ENTITY the_views SYSTEM "modules/the_views.xml"> +<!ENTITY Test_Drive_Proc SYSTEM "modules/Test_Drive_Proc.xml"> +<!ENTITY The_JBoss_jBPM_Int_Mech SYSTEM "modules/The_JBoss_jBPM_Int_Mech.xml"> +<!ENTITY Quick_Howto_Guide SYSTEM "modules/Quick_Howto_Guide.xml"> + +<!ENTITY seamlink "../../seam/html_single/index.html"> +<!ENTITY aslink "../../as/html_single/index.html"> +<!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> +<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html"> +<!ENTITY jbpmlink "../../jbpm/html_single/index.html"> +<!ENTITY jsflink "../../jsf/html_single/index.html"> +<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html"> +<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html"> +<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html"> +<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> + + ]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + <bookinfo> + <title>jBPM Tools Reference Guide</title> + + <author> + <firstname>Anatoly</firstname> + <surname>Fedosik</surname> + </author> + <author> + <firstname>Koen</firstname> + <surname>Aers</surname> + <email&gt;koen.aers(a)jboss.com&lt;/email&gt; + </author> + <author> + <firstname>Olga</firstname> + <surname>Chikvina</surname> + </author> + <author> + <firstname>Svetlana</firstname> + <surname>Mukhina</surname> + <email&gt;smukhina(a)exadel.com&lt;/email&gt; + </author> + <author> + <firstname>Tom</firstname> + <surname>Baeyens</surname> + <email&gt;tom.baeyens(a)jboss.com&lt;/email&gt; + </author> + + + <pubdate>April 2008</pubdate> + <copyright> + <year>2007</year> + <year>2009</year> + <holder>JBoss, a division of Red Hat</holder> + </copyright> + <releaseinfo> Version: 3.1.5.GA</releaseinfo> + +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jbpm/pdf/J... version</ulink> + </para> +</abstract> + + </bookinfo> + + <toc></toc> + +<chapter id="Introduction" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/Introduction.xml" xreflabel="Introduction"> + <?dbhtml filename="TargetAudience.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword>Target</keyword> + <keyword>developers</keyword> + <keyword>Audience</keyword> + </keywordset> + </chapterinfo> + <title>Introduction</title> + <para>All developers and process analysts who are beginning to use JBoss jBPM should read this + Getting Started guide. It will give them a jumpstart showing how to create a process definition.</para> + <section id="Preface"> + <?dbhtml filename="Preface.html"?> + <title>Preface</title> + <para>This document introduces the use of the JBoss jBPM Graphical Process Designer (GPD) to + create workflow processes. It will help first time users with the following tasks :</para> + <itemizedlist> + <listitem> + <para>Install the JBoss jBPM GPD Eclipse plugin available from the JBoss jBPM download + area</para> + </listitem> + <listitem> + <para>Set up a Java project in Eclipse and prepare it to do test driven process + development</para> + </listitem> + <listitem> + <para>Using the creation wizard to create an empty process definition</para> + </listitem> + <listitem> + <para>Use the designer palette to draw the first processdefinition</para> + </listitem> + <listitem> + <para>Show how the xml processdefinition can be inspected as an xml file</para> + </listitem> + <listitem> + <para>Set up a Java project in Eclipse and prepare it to do test driven process + development</para> + </listitem> + <listitem> + <para>Write an example process test case</para> + </listitem> + </itemizedlist> + <para>If you have questions, please feel free to contact <ulink url="mailto:koen.aers@jboss.com">Koen Aers</ulink> or <ulink url="mailto:tom.baeyens@jboss.com">Tom Baeyens</ulink> for more + information.</para> + </section> + + <section id="feature_list"> + + <title>Feature list</title> + + <para> JBoss jBPM is a workflow that enables creating and automatization business processes. Look + at the list of features below to understand its main functionality.</para> + <table> + <title>Key Functionality for JBoss jBPM</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + </row> + </thead> + <tbody> + + <row> + <entry> + <link linkend="minimal_process_definition">jBDL support</link> + </entry> + <entry>Enables managing workflow processes as well as human tasks and interactions between + them. jBDL combines the best both Java and declarative process techniques.</entry> + </row> + + <row> + <entry> + <link linkend="GuidedTourJBossjBPMGPD">Support of Graphical Process Designer (GPD)</link> + </entry> + <entry>Is used for simplifying declarative process development and visualizations of all + actions.</entry> + </row> + + <row> + <entry> + <link linkend="CreatingjBPMProject">Project Creation wizard</link> + </entry> + <entry>Allows to create a new jBPM template project that already includes all advanced + artifacts and core jBPM libraries.</entry> + </row> + + <row> + <entry> + <link linkend="minimal_process_definition">Rich palette of pre-build process nodes</link> + </entry> + <entry>Provides process-building functionality and gives opportunity even non-programmers to + develop processes.</entry> + </row> + + <row> + <entry> + <link linkend="source_mode">Support of XML code view</link> + </entry> + <entry>Shows the corresponding XML that's generated automatically in the Source view + of the process definition editor when developing the process.</entry> + </row> + + <row> + <entry> + <link linkend="the_properties_view">Properties view</link> + </entry> + <entry>Facilitates configuring and editing of all nodes properties.</entry> + </row> + + <row> + <entry>Interaction with all of the J2EE based integration technologies including Web Services, + Java Messaging, J2EE Connectors, JBDC, EJBs.</entry> + <entry>Enables implementation, provides better functionality and flexibility.</entry> + </row> + + <row> + <entry>Integration with jBoss Seam</entry> + <entry>Allows to write applications with complex workflows and provides easier interactions + between them.</entry> + </row> + + </tbody> + </tgroup> + </table> + </section> + + <section> + <title>Other relevant resources on the topic</title> + <para>All JBoss Developer Studio/JBoss Tools documentation you can find <ulink url="http://docs.jboss.org/tools/2.1.0.GA/">here</ulink&g... + <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">her... + </section> + +</chapter> + + +<chapter id="jboss_jbpm_runtime_installation" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/jboss_jbpm_runtime_installation.xml" xreflabel="jboss_jbpm_runtime_installation"> + <?dbhtml filename="jboss_jbpm_runtime_installation.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword>designer</keyword> + <keyword>process</keyword> + <keyword>JBoss Developer Studio</keyword> + <keyword>jBPM runtime</keyword> + </keywordset> + </chapterinfo> + <title>JBoss jBPM Runtime Installation</title> + <para>The main purpose of this chapter is to let you know how to launch the <property moreinfo="none">JBoss + jBPM</property> (business process management).</para> + <para>The jBPM plugin (jBPM Designer) is already included in the <property moreinfo="none">JBoss Tools</property>. + To make it work, you should only download the jBPM runtime (<ulink url="http://sourceforge.net/project/showfiles.php?group_id=70542&... currently) and specify the directory where you extracted the runtime + either when you create a jBPM project or by using the jBPM preference pages.</para> + + <note> + <title>Note:</title> + <para>Try to avoid using spaces in the names of installation folders. It can provoke problems in + some situations with Sun-based VMs.</para> + </note> + + <para>Navigate to <emphasis> + <property moreinfo="none">Window &gt; Preferences &gt; JBoss jBPM &gt; Runtime Locations</property>. + </emphasis> Here you can add, edit and remove JBoss jBPM installation locations. Click <emphasis> + <property moreinfo="none">Add</property> + </emphasis> button. In the dialog that appeared enter a name for a newly added jBPM runtime and + point to the correct location of this package on your harddrive. Click <emphasis> + <property moreinfo="none">OK</property> + </emphasis> then click <emphasis> + <property moreinfo="none">OK</property> + </emphasis> again.</para> + + <figure float="0"> + <title>Adding jBPM Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtime_installation/runtime_installation_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Now, when you have a runtime installed, we are going to demonstrate some powerful features of + the jBPM.</para> +</chapter> + + +<chapter id="GuidedTourJBossjBPMGPD" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/guided_tour_jboss_jbpmgpd.xml" xreflabel="GuidedTourJBossjBPMGPD"> + <?dbhtml filename="GuidedTourJBossjBPMGPD.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword>JBoss</keyword> + <keyword>Process</keyword> + <keyword>Definition</keyword> + </keywordset> + </chapterinfo> + <title>A Guided Tour of JBoss jBPM GPD</title> + <para>In this chapter we suggest a step-by-step walk-through of creating and configuring your + own simple process. Let's try to organize a new jBPM project.</para> + <para>A wizard for creating a jBPM project is included in the GPD plugin. We have opted to + create a project based on a template already containing a number of advanced artifacts that + we will ignore for this section. In the future we will elaborate this wizard and offer the + possibility to create an empty jBPM project as well as projects based on templates taken + from the jBPM tutorial.</para> + <section id="CreatingjBPMProject"> + <?dbhtml filename="CreatingjBPMProject.html"?> + <title>Creating a jBPM Project</title> + <para>This section will show you how to use the Creation wizard for creating a new jBPM + project with already included source folders.</para> + <para>At first you should select <emphasis> + <property moreinfo="none">File &gt;New Project...</property> + </emphasis> and then <emphasis> + <property moreinfo="none">JBoss jBPM &gt; Process Project</property> + </emphasis> in the New Project dialog:</para> + <figure float="0"> + <title>New Project Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para> Clicking <emphasis> + <property moreinfo="none">Next</property> + </emphasis> brings us to the wizard page where it's necessary to specify the + name and location for the project. We choose, for example, <emphasis> + <property moreinfo="none">HellojBPM</property> + </emphasis> as the name and accept the default location. </para> + <figure float="0"> + <title>Process Name and Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Thus, our project will be created in the workspace root directory by default. If you + want to change the directory for your future project, deselect <emphasis> + <property moreinfo="none">Use default location</property> + </emphasis> and click <emphasis> + <property moreinfo="none">Browse...</property> + </emphasis> button to set needed location or simply type it.</para> + <para>On the next screen you'll be prompted to select the core jBPM location that + we have defined in the previous chapter.</para> + <figure float="0"> + <title>Core jBPM Location Specifying</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Clicking on <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> results in the project being generated. The wizard creates four source + folders: one for the processes (<emphasis> + <property moreinfo="none">src/main/jpdl</property> + </emphasis>), one for the java sources (<emphasis> + <property moreinfo="none">src/main/java</property> + </emphasis>), one for the unit tests (<emphasis> + <property moreinfo="none">src/test/java</property> + </emphasis>) and one for the resources such as the jbpm.properties and the + hibernate.properties files (<emphasis> + <property moreinfo="none">src/main/config</property> + </emphasis>). In addition a classpath container with all the core jBPM libraries is + added to the project</para> + <figure float="0"> + <title>Layout of the Process Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Looking inside the different source folders will reveal a number of other artifacts + that were generated, but we will leave these untouched for the moment. Instead, we will + look at another wizard that enables us to create an empty process definition.</para> + </section> + <section id="creating_an_empty_process_definition"> + <?dbhtml filename="creating_an_empty_process_definition.html"?> + <title>Creating an Empty Process Definition</title> + <para>Now when the project is set up, we can use a Creation wizard to create an empty + process definition. Bring up the <emphasis> + <property moreinfo="none">New</property> + </emphasis> wizard by clicking the <emphasis> + <property moreinfo="none">File &gt; New &gt; Other...</property> + </emphasis> menu item. The wizard opens on the <emphasis> + <property moreinfo="none">Select Wizard</property> + </emphasis> page.</para> + <figure float="0"> + <title>The Select Wizard Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Selecting the <emphasis> + <property moreinfo="none">JBoss jBPM</property> + </emphasis> category, then the <emphasis> + <property moreinfo="none">Process Definition</property> + </emphasis> item and clicking on the <emphasis> + <property moreinfo="none">Next</property> + </emphasis> button brings us to the <emphasis> + <property moreinfo="none">Create Process Definition</property> + </emphasis> page.</para> + <figure float="0"> + <title>The Create New Process Definion Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>We choose <emphasis> + <property moreinfo="none">hello</property> + </emphasis> as the name of the process archive file. Click on the <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button to end the wizard and open the process definition editor.</para> + <figure float="0"> + <title>The Process Definition Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_6.png" scale="60"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para>You can see in the Package Explorer that creating a process definition involves + creating a folder with the name of the process definition and populating this folder + with two .xml files : <emphasis> + <property moreinfo="none">gpd.xml</property> + </emphasis> and <emphasis> + <property moreinfo="none">processdefinition.xml</property>. </emphasis></para> + <para>The <emphasis> + <property moreinfo="none">gpd.xml</property> + </emphasis> contains the graphical information used by the process definition editor. + The <emphasis> + <property moreinfo="none">processdefinition.xml</property> + </emphasis> file contains the actual process definition info without the graphical + rendering info. At present, the GPD assumes that these two files are siblings. More + sophisticated configuration will be supported later.</para> + + <section id="minimal_process_definition"> + <?dbhtml filename="minimal_process_definition.html"?> + <title>A Minimal Process Definition</title> + <para>Now we are ready to create a very simple process definition consisting of a begin + state, an intermediate state and an end state.</para> + <para>To make the configuration of actions much easier it's better to use the + jPDL perspective. It provides the tabbed Properties Editor which allows to configure + all the relevant properties of the current selected item. </para> + + <section id="adding_the_nodes"> + <?dbhtml filename="adding_the_nodes.html"?> + <title>Adding the Nodes</title> + <para>At first select respectively <emphasis> + <property moreinfo="none">Start</property>, </emphasis> + <emphasis> + <property moreinfo="none">State</property> + </emphasis> and <emphasis> + <property moreinfo="none">End</property> + </emphasis> on the tools palette and click on the canvas to add these nodes to + the process definition. The result should look similar to this:</para> + <figure float="0"> + <title>A Simple Process With Three Nodes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_7.png" scale="60"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="adding_transitions"> + <?dbhtml filename="adding_transitions.html"?> + <title>Adding Transitions</title> + <para>Then, we will connect the nodes with transitions. To do that select the <emphasis> + <property moreinfo="none">Transition</property> + </emphasis> tool in the tools palette and click on the <emphasis> + <property moreinfo="none">Start</property> + </emphasis> node, then move to the <emphasis> + <property moreinfo="none">State</property> + </emphasis> node and click again to see the transition being drawn. Perform the + same steps to create a transition from the <emphasis> + <property moreinfo="none">State</property> + </emphasis> node to the <emphasis> + <property moreinfo="none">End</property> + </emphasis> node. The result will look like:</para> + <figure float="0"> + <title>A Simple Process With Transitions</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_8.png" scale="60"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Now, when you've got background knowledge of simple project creation, + let's move to more advanced tools.</para> + </section> + </section> + </section> + +</chapter> + + +<chapter id="the_views" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/the_views.xml" xreflabel="the_views"> + <?dbhtml filename="the_views.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + </keywordset> + </chapterinfo> + + <title>The views</title> + + <para>Here, it will be explained how to work with views and editors provided by JBDS.</para> + <para>The views are used for representation and navigation the resources you are working on at + the moment. One of the advantages of all the views is that all modifications made in the + current active file are immediately displayed in them. Let’s get acquainted more closely + with those that the <property moreinfo="none">jPDL perspective</property> provides. </para> + + <figure float="0"> + <title>The jPDL Perspective Views and Editors</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_0.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>As you can see in the picture above, the <property moreinfo="none">jPDL perspective</property> contains a + complete set of functionality that's necessary for working on the jBPM project.</para> + + <section id="the_outline_view"> + <?dbhtml filename="the_outline_view.html"?> + <title>The Outline View</title> + <para>To have a way to quickly see an outline of the process use the <emphasis> + <property moreinfo="none">Outline view</property> + </emphasis> that is presented as the classical tree. If it is not visible select <emphasis> + <property moreinfo="none">Window &gt; Show view &gt; Outline</property>. </emphasis></para> + + <figure float="0"> + <title>The Overview View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="the_overview"> + <?dbhtml filename="the_outline_view.html"?> + <title>The Overview</title> + <para>The main advantage of this view is that it gives visual representation of the whole + current developing process. Besides, the <emphasis> + <property moreinfo="none">Overview</property> + </emphasis> comes as a scrollable thumbnail which enables a better navigation of the + process structure if it's too large.</para> + + <figure float="0"> + <title>The Overview</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="the_properties_view"> + <?dbhtml filename="the_properties_view.html"?> + <title>The Properties View</title> + <para> Here, we dwell on the JBDS <property moreinfo="none">Properties view</property>.</para> + <para>Notice if it's not visible you can access it by navigating <emphasis> + <property moreinfo="none">Window &gt; Show view &gt; Properties</property>. </emphasis></para> + <para>The view shows the relevant properties of the selected item in the tabbed form. Every + item has its own set of properties, which can be directly editable in the Properties + view or by brining up the context menu.</para> + + <figure float="0"> + <title>The Properties View of selected Transition</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>For example, on the picture above the Properties view displays all the properties for + a selected transition. Its name has been changed to <emphasis> + <property moreinfo="none">to_auction</property>. </emphasis> We've done it directly in + active General tab of the view. The same way let's change the name for the + second transition to <emphasis> + <property moreinfo="none">to_end</property>. </emphasis></para> + <para>If no one item is selected, the view represents the properties of the whole process + definition. </para> + + <figure float="0"> + <title>The Properties View of Process Definition</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In this case, it contains six tabs. The first one is the <emphasis> + <property moreinfo="none">General</property>.</emphasis> It allows to specify a process name and add + necessary description. To illustrate let's change the process definition name + to <emphasis> + <property moreinfo="none">jbay</property>. </emphasis></para> + </section> + + <section id="jbpm_gpd_editor"> + <?dbhtml filename="direct_editing.html"?> + <title>The jBPM Graphical Process Designer editor.</title> + <para>The <property moreinfo="none">jBPM GPD editor</property> includes four modes: Diagram, Deployment, + Design and Source, which are available as switchable tabs at the bottom of the editor. + Let's dwell on each of them.</para> + + <section id="the_diagram_mode"> + <title>The Diagram mode</title> + <para> In this mode we define the process in the form of a diagram by means of tools + provided on the left-hand side of the jBPM GPD. </para> + + <figure float="0"> + <title>The Diagram mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Besides, some properties can be directly edited in the <property moreinfo="none">Diagram + mode</property> of the graphical editor. One example of this is the <emphasis> + <property moreinfo="none">name</property> + </emphasis> property of nodes. You can edit this directly by selecting the node of + which you want to change the name and then click once inside this node. This enables + an editor in the node. We change the name of the node to <emphasis> + <property moreinfo="none">auction</property>. </emphasis></para> + </section> + + <section id="source_mode"> + <?dbhtml filename="the_source_view.html"?> + <title>The Source Mode</title> + <para>Now, that we have defined a simple process definition, we can have a look at the + XML that is being generated under the covers. To see this XML click on the Source + tab of the graphical process designer editor.</para> + + <figure float="0"> + <title>The Source Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The <property moreinfo="none">Source mode</property> enables to easily manipulate our XML. That is + manually inserting and editing necessary elements or attributes. In addition, here + you can take advantage of content assist.</para> + </section> + + <section id="design_mode"> + <?dbhtml filename="the_design_view.html"?> + <title>The Design Mode</title> + <para>One more way to edit your file is to use <property moreinfo="none">Design mode</property>. You can + see it in the next picture:</para> + <figure float="0"> + <title>The Design Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>As you can see above, this mode looks like a table in the first column of which + the process structure is performed. Here, you can also insert, remove and edit + elements or attributes, moreover add comments and instructions. Their values can be + directly edited in the second column of the Design mode table.</para> + <para>For instance, let’s add a comment on the second transition. For that, you should + bring up the context menu for it and choose <emphasis> + <property moreinfo="none">Add Before &gt; Comment</property>. </emphasis></para> + + <figure float="0"> + <title>Adding a Comment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Then, we can put the text <emphasis>This transition leads to the end + state</emphasis> in the right column as its value.</para> + + <figure float="0"> + <title>Comment is added</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="deployment_mode"> + <?dbhtml filename="the_deployment_view.html"?> + <title>The Deployment Mode</title> + <para>Finally, to adjust the deployment settings of the project you should switch on to + the tab that opens the <property moreinfo="none">Deployment mode</property>. On the picture below + the <property moreinfo="none">Deployment mode</property> is performed with default settings. Here, + you can easily modify them or, if the settings won't match your needs, to + reset defaults. </para> + <figure float="0"> + <title>The Deployment Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_10.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The button <emphasis> + <property moreinfo="none">Test Connections</property> + </emphasis> is necessary to make sure whether all your settings are valid before + deploying the process.</para> + <para>Now that we've seen how to work with <property moreinfo="none">jPDL + perspective</property>, let's pass on to the project testing.</para> + </section> + </section> +</chapter> + +<chapter id="Test_Drive_Proc_Development" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/Test_Drive_Proc.xml" xreflabel="Test_Drive_Proc_Development"> + <?dbhtml filename="Test_Drive_Proc_Development.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> + </keywordset> + </chapterinfo> + <title>Test Driven Process Development</title> + + <para> One of the most important advantages of JBoss jBPM's lightweight approach to BPM + and workflow management is that developers can easily leverage their usual programming + skills and techniques. One of these well-known techniques is Unit Testing and Test Driven + Development. </para> + <para>In this chapter we will show how developers, making use of the JBoss jBPM GPD, can use a + technique we have baptized <property moreinfo="none">Test Driven Process Development</property> to create + process definitions and test their correctness. </para> + + <para> When creating the <emphasis> + <property moreinfo="none">HellojBPM</property> + </emphasis> project the Project Creation wizard has already put in place all the library + requirements we need to start writing the jBPM unit tests. They are contained in the jBPM + Library container and the most important of them is the <emphasis> + <property moreinfo="none">.jar</property> + </emphasis> file containing the core jBPM classes. While working on the project you could + find them all in the <property moreinfo="none">Package Explorer</property>.</para> + + <figure float="0"> + <title>The jBPM Libraries</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>It must be noted that it is possible to change the location of the core jBPM installation + by changing the preference settings. More on this <link linkend="change_core_jbpm_inst">see + later</link> in this book.</para> + + <para> With that extra knowledge on the project settings, you can create your first test. To do + this, we create the <emphasis> + <property moreinfo="none">com.jbay</property> + </emphasis> package in the <emphasis> + <property moreinfo="none">test/java</property> + </emphasis> source folder. Then we bring up the context menu on this package and select <emphasis> + <property moreinfo="none">New &gt; Other...</property> + </emphasis></para> + + <figure float="0"> + <title>Call the JUnit Test Case Creation wizard</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> And then <emphasis> + <property moreinfo="none">Java &gt; JUnit &gt; JUnit Test Case</property> + </emphasis> to call the specialized JUnite Test case creation wizard.</para> + <figure float="0"> + <title>Call the JUnit Test Case Creation wizard</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The wizard looks as follows:</para> + + <figure float="0"> + <title>Create Test Dialog</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>By default JUnite 3 version of testing framework is selected. Of course, you can choose + new advanced JUnit 4 version. In this case you'll be prompted to add new JUnit + Library to your build path. To add it automatically just click on the appropriate link. In + the <emphasis> + <property moreinfo="none">Class under test</property> + </emphasis> section you can specify the class to test.</para> + + <figure float="0"> + <title>A First Test Scenario</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Then, we call the test class <emphasis> + <property moreinfo="none">HelloTest</property> + </emphasis> and press <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button to complete.</para> + + <para> Next, we should write a simple test scenario as shown on the next figure. Let's + study the code of this test case. </para> + + <figure float="0" id="hello_test"> + <title>A First Test Scenario</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_6.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In the first line of the method, a jBPM process archive object is created. We use a + constructor accepting the filename of the archive. In our case it is the <emphasis> + <property moreinfo="none">hello</property> + </emphasis> file we created earlier and which lives in the <emphasis> + <property moreinfo="none">src/main/jpdl</property> + </emphasis> folder of our project. After asserting that this object is really created, we + extract a process definition object from it. This object is fed to the constructor of a + process instance object. We have a process instance object, but this process is not yet + started, so we can safely assert that its root token still resides in the start node. After + signalling the token will move to the next state and the process will be in the <emphasis> + <property moreinfo="none">auction</property> + </emphasis> state. Finally another signal will end the process. </para> + + + <para> After writing this test we can check whether it works as expected by running it .</para> + + <figure float="0"> + <title>Running the Process Test</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_7.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>All went well as we have a green light:</para> + + <figure float="0"> + <title>Successful Test Run</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_8.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> Of course, this simple scenario was not very interesting, but the purpose of it was to + show how you can reuse your development skills in a very straightforward way when doing + process development. To see how more interesting processes and process test + scenario's can be developed, we suggest you to read the <ulink url="http://docs.jboss.com/jbpm/v3/userguide/">JBoss jBPM User Guide</ulink> and to + study the API reference. You can find it in the jBPM download folder. (To get started we + downloaded jbpm-jpdl-3.2.2 in <link linkend="jboss_jbpm_runtime_installation">the second + chapter</link>. You should just remember where you extracted it.) All we've mentioned are in the 'javadoc- *' subfolders of the 'doc' folder. + Moreover, some more examples will be given later in this book.</para> + +</chapter> + + +<chapter id="The_JBoss_jBPM_Int_Mech" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/The_JBoss_jBPM_Int_Mech.xml" xreflabel="The_JBoss_jBPM_Int_Mech"> + <?dbhtml filename="The_JBoss_jBPM_Int_Mech.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> + </keywordset> + </chapterinfo> + <title>Actions : The JBoss jBPM Integration Mechanism</title> + + <para> In this chapter we will show how to do software integration with <property moreinfo="none">JBoss + jBPM</property>. The standard mechanism to implement this is to wrap the functionality you + want to integrate in a class that implements the <emphasis> + <property moreinfo="none">ActionHandler</property> + </emphasis> interface. In order to demonstrate it let's specify Hello World action for our + process.</para> + + <section> + <title>Creating a Hello World Action</title> + + <para>Each Hello World process should integrate one or more Hello World actions, so this is + what we will be doing. We can integrate custom code at different points in the process + definition. To do this we have to specify an action handler, represented by an + implementation of the <emphasis> + <property moreinfo="none">ActionHandler</property> + </emphasis> interface, and attach this piece of code to a particular event. These events + are amongst others, going over a transition, leaving or entering nodes, after and before + signalling. </para> + + <para> To make things a little bit more concrete, let's create a new class called <emphasis> + <property moreinfo="none">HelloActionHandler</property>. + </emphasis> For that firstly we'll create a new package <emphasis> + <property moreinfo="none">com.jbay.action</property> + </emphasis> in the <emphasis> + <property moreinfo="none">src/java/main</property> + </emphasis> folder of our project. Then, we should call New Class Creation wizard as + usual by right-clicking and navigating <emphasis> + <property moreinfo="none">New &gt; Class</property>. + </emphasis> </para> + + <figure float="0"> + <title>Creating HelloActionHendler Class</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Notice that two first gaps have been filled automatically. Here, instead of <emphasis> + <property moreinfo="none">Package</property> + </emphasis> option <emphasis> + <property moreinfo="none">Enclose type</property> + </emphasis> option can be selected where a type in which to enclose a new class should + be specified.</para> + + <para>In our case, we leave everything as it is, just type <emphasis> + <property moreinfo="none">HelloActionHandler</property> + </emphasis> as a name of new class and add <emphasis> + <property moreinfo="none">org.jbpm.graph.ActionHendler</property> + </emphasis> interface as it's shown in the picture above.</para> + + <para>Thus, our <emphasis> + <property moreinfo="none">HelloActionHandler</property> + </emphasis> implements the <emphasis> + <property moreinfo="none">ActionHandler</property> + </emphasis> interface including the <emphasis> + <property moreinfo="none">execute</property> + </emphasis> method as shown in the next figure. Here, we add a variable named <emphasis> + <property moreinfo="none">greeting</property> + </emphasis> to the collection of process variables and put a message in it : + <emphasis>"Hello from ActionHandler"</emphasis>. </para> + + <figure float="0"> + <title>A Simple Hello Action</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_2.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Now, as we have <emphasis> + <property moreinfo="none">HelloActionHandler</property> + </emphasis> class defined, let's explore how we can handle it.</para> + </section> + + <section> + <title>Integrating the Hello World Action</title> + + <para>The main purpose of this chapter is to provide you with the steps associating our + Hello World action with a particular event and test the correctness of our actions as + well.</para> + + <para> As good Testcity citizens we will first create a Unit Test that proves the behaviour + we want to achieve by adding the <emphasis> + <property moreinfo="none">ActionHandler</property> + </emphasis> to the process. So we implement another test.</para> + + <para>At first, let's return to the + code we already saw <link linkend="hello_test">in the previous chapter</link> and add new test method <emphasis> + <property moreinfo="none">testActionHendler</property></emphasis> to it. </para> + + <figure float="0"> + <title>Create the Hello Action Test</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_3.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>We assert + that no variable called <emphasis> + <property moreinfo="none">greeting</property> + </emphasis> exist. Then we give the process a signal to move it to the auction state. We + want to associate the execution of the action with the event of going over the + transition from the start state to the auction state. So after the signal, the process + should be in the auction state as in the previous scenario. But moreover, the <emphasis> + <property moreinfo="none">greeting</property> + </emphasis> variable should exist and contain the string <emphasis>"Hello from + ActionHandler"</emphasis>. That's what we assert in the last lines of the test + method.</para> + + + + <para> Running the tests now results in a failure. The point is that we did not associate + the action with any particular event in the process definition, so the process variable + did not get set. </para> + + <figure float="0"> + <title>Test Results Before Integration</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_4.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> Let's do something about it and add an action to the first transition of our + sample process. To do this you can use the Actions tab in the Properties Editor that is + under the graphical canvas. Bring up the popup menu of the action element container and + chose New Action as it's shown on the figure below. The other way to add an action + to the transition is simply to use the dropdown menu that is available under the action + icon in the right upper corner of the Properties View.</para> + + <figure float="0"> + <title>Adding an Action to a Transition</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_5.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>After adding the action a tabbed view with three pages will appear.</para> + + <figure float="0"> + <title>Configuration Dialog for an Action</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_6.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The first of these three pages allows you to give the Action a name. The last page + contains some advanced attributes such as whether the Action is asynchronous. The + Details page is the most important. It allows to choose and configure the actual action + handler implementation. </para> + + <figure float="0"> + <title>The Details page of an Action Configuration Dialog</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_7.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para>Clicking on the <emphasis> + <property moreinfo="none">Search...</property> + </emphasis> button brings us to a Choose Class dialog.</para> + + + <figure float="0"> + <title>The Choose Action Handler Dialog</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para> We choose our previously created 'HelloActionHandler' class and + push the <property moreinfo="none">OK</property> button. After the selection of the action handler for + the action, we can run the test and observe it gives us a green light.</para> + + <figure float="0"> + <title>Test Results</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_9.png" scale="70"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Tere we are. The above objective has been achieved.</para> + </section> + + <section> + <title> Integration Points</title> + + <para> The different integration points in a process definition are thoroughly documented in + the <ulink url="http://docs.jboss.com/jbpm/v3/userguide/">JBoss jBPM User Guide</ulink>. Instance nodes can contain many action + elements. Each of these will appear in the Action element list of the Actions tab. But + each Action also has a properties view of itself. You can navigate to this view by + selecting the added Action in the outline view. </para> + + </section> + +</chapter> + + +<chapter id="Quick_Howto_Guide" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jbpm/docs/reference/en/modules/Quick_Howto_Guide.xml" xreflabel="Quick_Howto_Guide"> + <?dbhtml filename="Quick_Howto_Guide.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> + </keywordset> + </chapterinfo> + <title>Quick Howto Guide</title> + + <para>This chapter contains additional information related to the <property moreinfo="none">JBoss + jBPM</property>.</para> + + <section id="change_core_jbpm_inst"> + <title>Change the Default Core jBPM Installation</title> + + <para> You can change the default <property moreinfo="none">jBPM</property> installation by means of the + Eclipse preference mechanism. Open the Preferences dialog by selecting <emphasis> + <property moreinfo="none">Window &gt; Preferences</property> + </emphasis> and select the <emphasis> + <property moreinfo="none">JBoss jBPM &gt; Runtime Location</property> + </emphasis> category. Using this page you can add multiple <property moreinfo="none">jBPM</property> + installation locations and change the default one. The default installation is used for + the classpath settings when creating a new Process Project. Changing the preferences has + no influence on already created projects. Getting rid of a <property moreinfo="none">jBPM</property> + installation that's being referenced by a project however will cause the + classpath to contain errors. </para> + + + <figure float="0"> + <title>The jBPM Preferences Page</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section> + <title>Configuring Task Nodes</title> + + <para>Here, we'll examine how you can configure the Task nodes in jBPM jPDL GPD.</para> + + <para> You can add Tasks to Task nodes and then configure them in a similar manner as the + Action configuration mechanism. Let's consider the process definition similar + to the previous one that contains three nodes: Start state, Task node and End state. The + <property moreinfo="none">Properties view</property> for selected Task node includes several tabs. </para> + + <figure float="0"> + <title>The Properties View of the selected Task Node</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_2.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>We should choose the Task tab and then bring up the context menu or click the button + in the top right corner of the view to add a Task to our Task node.</para> + + <figure float="0"> + <title>Adding a Task to the Task Node</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_3.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Every added Task has its own configuration possibilities. You can access them through + the <property moreinfo="none">Properties view</property> as well.</para> + + <figure float="0"> + <title>The Task properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_4.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The <property moreinfo="none">General page</property> is a place where you can specify the name of a + Task and its description. For instance, let it be <emphasis> + <property moreinfo="none">approve oder</property> + </emphasis> with appropriate description that you can see in the figure below.</para> + + <figure float="0"> + <title>The Task General Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_5.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Now, look at <property moreinfo="none">Details page</property>. First, you should specify the due date + that is a mandatory property for the Task. The due date is the date on which the task + should be accomplished. Here you can also set a Task priority as well as signalling, + notifying or blocking. The <emphasis> + <property moreinfo="none">Blocking</property> + </emphasis> attribute indicates that the process will not be able to continue if this + task is still unaccomplished. The <emphasis> + <property moreinfo="none">Generate Form...</property> + </emphasis> button is for creating a simple task form that can be rendered by the jBPM + console.</para> + + <figure float="0"> + <title>The Task Details Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_6.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>For our example, we specify the due date as 2 business days, choose the high priority + and also check the <emphasis> + <property moreinfo="none">Signalling</property> + </emphasis> and <emphasis> + <property moreinfo="none">Notify</property> + </emphasis> attributes. It means that the Task should be accomplished in 2 business days + and the assignee will be notified by email when the task is assigned. To specify how the + Task should be assigned switch on to the <property moreinfo="none">Assignment page</property>.</para> + + <figure float="0"> + <title>The Task Assignment Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_7.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>On the <property moreinfo="none">Reminder page</property> you can specify whether the assignee will be reminded of the task + that awaits him.</para> + + <figure float="0"> + <title>The Task Reminder Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_8.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In our case, the assignee will be reminded by email after two business hours and + continue to get reminding every business hour after that.</para> + <para>In the next figure you can see our configuring generated into XML.</para> + <figure float="0"> + <title>The Task Reminder Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_9.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>We hope, our guide will help you to get started with the jPDL process language and jBPM + workflow on the whole. Besides, for additional information you are welcome on <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... forum</ulink>.</para> + </section> +</chapter> + + + <!-- TODO: drools used in this section is not available for eclipse .3.3 &AddBusinessProcess; --> +</book> Added: branches/jbosstools-3.0.x/jsf/docs/jsf_tools_ref_guide/en/master_output.xml =================================================================== --- branches/jbosstools-3.0.x/jsf/docs/jsf_tools_ref_guide/en/master_output.xml (rev 0) +++ branches/jbosstools-3.0.x/jsf/docs/jsf_tools_ref_guide/en/master_output.xml 2009-03-06 18:46:29 UTC (rev 14086) @@ -0,0 +1,1987 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + +[ +<!ENTITY introduction SYSTEM "modules/introduction.xml"> +<!ENTITY jsf_support SYSTEM "modules/jsf_support.xml"> +<!ENTITY projects SYSTEM "modules/projects.xml"> +<!ENTITY jsf_config_file SYSTEM "modules/jsf_config_file.xml"> +<!ENTITY managed_beans SYSTEM "modules/managed_beans.xml"> +<!ENTITY creation_and_registration SYSTEM "modules/creation_and_registration.xml"> +<!ENTITY jsf_project_verification SYSTEM "modules/jsf_project_verification.xml"> + +<!ENTITY seamlink "../../seam/html_single/index.html"> +<!ENTITY aslink "../../as/html_single/index.html"> +<!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> +<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html"> +<!ENTITY jbpmlink "../../jbpm/html_single/index.html"> +<!ENTITY jsflink "../../jsf/html_single/index.html"> +<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html"> +<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html"> +<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html"> +<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> +<!ENTITY migrationlink "../../Exadel-migration/html_single/index.html"> + + +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + <bookinfo> + <title>JSF Tools Reference Guide</title> + + <author><firstname>Anatoly</firstname><surname>Fedosik</surname></author> + <author><firstname>Olga</firstname><surname>Chikvina</surname></author> + <author&gt;&lt;firstname&gt;Svetlana&lt;/firstname&gt;&lt;surname&gt;Mukhina&lt;/surname&gt;&lt;email&gt;smukhina(a)exadel.com&lt;/email&gt;&lt;/author&gt; + + <pubdate>April 2008</pubdate> + <copyright> + <year>2007</year> + <year>2009</year> + <holder>JBoss, a division of Red Hat</holder> + </copyright> + <releaseinfo> + Version: 3.0.0.GA + </releaseinfo> + +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf_tools_... version</ulink> + </para> +</abstract> + + </bookinfo> + + <toc></toc> + + +<chapter id="introduction" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_ref_guide/en/modules/introduction.xml"> + <?dbhtml filename="introduction.html"?> + + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + <keyword>JSF Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Introduction</title> + + <para>JSF Tools are especially designed for supporting JSF and JSF-related technologies. JSF + Tools provide extensible and exemplary tools for building JSF-based applications as well as + adding JSF capabilities to existing web projects, importing JSF projects and choosing any + JSF implementation while developing JSF application.</para> + + <para>In this guide we provide you with the information on JSF tooling which allows you to + develop JSF applications much faster and with far fewer errors so sparing your time.</para> + + <section id="jsf_key_features"> + <title>Key Features of JSF Tools</title> + + <para>Here, we provide you with a key functionality which is integrated in JSF tooling.</para> + + <table> + <title>Key Functionality for JSF Tools</title> + <tgroup cols="3"> + + <colspec align="left" colnum="1" colwidth="2*"></colspec> + <colspec colnum="2" colwidth="4*"></colspec> + <colspec colnum="3" colwidth="2*"></colspec> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + <tbody> + + <row> + <entry>JSF and Facelets support</entry> + <entry>Step-by-step wizards for creating new JSF and Facelets projects with a number of predefined templates, importing existing ones and adding JSF capabilities to non-jsf web projects.</entry> + <entry><link linkend="jsf_support">jsf support</link></entry> + </row> + + <row> + <entry>Flexible and customizable project template management</entry> + <entry>Jump-start development with out-of-the-box templates or easily + customized templates for re-use.</entry> + <entry> + <link linkend="projects">projects</link> + </entry> + </row> + + <row> + <entry>Support for JSF Configuration File</entry> + <entry>Working on file using three modes: diagram, tree and source. + Synchronization between the modes and full control over the code. Easy + moving around the diagram using the Diagram Navigator.</entry> + <entry> + <link linkend="jsf_config_file">graphical editor for jsf</link> + </entry> + </row> + + <row> + <entry>Support for Managed Beans</entry> + <entry>Adding new managed beans, generating code for attributes, properties + and getter/setter methods.</entry> + <entry> + <link linkend="managed_beans">managed beans</link> + </entry> + </row> + + <row> + <entry>Support for Custom Converters and Validators</entry> + <entry>Fast creating of custom converters and validators with tree view of + faces-config.xml file.</entry> + <entry> + <link linkend="creation_and_registration">converters and validators</link> + </entry> + </row> + + <row> + <entry>Verification and Validation</entry> + <entry>All occuring errors will be immediately reported by verification + feature, no matter in what view you are working. Constant validation and + errors checking allows to catch many of the errors during development + process that significantly reduces development time.</entry> + <entry> + <link linkend="jsf_project_verification">verification and + validation</link> + </entry> + + </row> + </tbody> + </tgroup> + </table> + </section> + <section> + <title>Other relevant resources on the topic</title> + <para>All JBoss Developer Studio/JBoss Tools documentation you can find <ulink url="http://docs.jboss.org/tools/">here</ulink>.</p... + <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">her... + </section> +</chapter> + + +<chapter id="jsf_support" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_ref_guide/en/modules/jsf_support.xml"> + <?dbhtml filename="jsf_support.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>JSF Tools</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>JavaServer Faces Support</title> + + <para>We don't lock you into any one <property moreinfo="none">JavaServer + Faces</property> implementation. You can always select the one which is + necessary for you while <link linkend="new_jsf_project">creating a new JSF + project</link>, <link linkend="add_jsf_capability">adding JSF capability</link> to + any existing Eclipse project or <link linkend="ImportingExsJSFProjWithAnyStr74447">importing existing JSF projects</link> as well.</para> + <para>At this point the special wizard will prompt you to specify a proper JSF environment. + It may be JSF 1.1.02 RI or JSF 1.2 which integrates a number of new features and + changes. The wizard also lets you select JSF implementation with a component + orientation such as JSF 1.2 with Facelets or MyFaces 1.1.4.</para> + + <figure float="0"> + <title>Choosing JSF Environment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_11.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>After specifying a proper JSF environment all the required libraries for the selected + version will be added to your project.</para> + + <section id="FaceletsSupport865"> + + <title>Facelets Support</title> + <para>In this section we will focus more on all concepts that are integrated for + working with Facelets.</para> + + <para>The Facelets extends JavaServer Faces by providing a lightweight framework + that radically simplifies the design of presentation pages for JSF. Facelets can be used in a variety of ways that we + will consider further in this section.</para> + + <section> + <title>Facelets templates</title> + <para>If you want to build an application using Facelets, just create a + project with Facelets based on version 1.2 of the JSF Reference + Implementation, i. e. select the <emphasis> + <property moreinfo="none">JSF 1.2 with Facelets</property> + </emphasis> in the JSF Environment section of the New JSF Project + wizard.</para> + + <figure float="0"> + <title>Choosing Facelets Environment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Once you've selected the environment, it's possible + to specify the one of three available templates:</para> + <figure float="0"> + <title>Choosing Facelets Template</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The following table lists possible templates with Facelets for any JSF + project and gives a proper description for each one.</para> + <table> + <title>Facelets Templates</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="2*"></colspec> + <colspec colnum="2" colwidth="3*"></colspec> + + + <thead> + <row> + <entry align="center"> + <para>Template</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + + <tbody> + + <row> + <entry> + <para> + <emphasis> + <property moreinfo="none">FaceletsBlankWithoutLibs</property> + </emphasis> + </para> + </entry> + + <entry> + <para>Some servers already provide + jsf libs and you take risk + of getting conflicting + libraries while deploying + your project. To avoid such + conflicts, use a template + without libs if you have a + server with its own jsf + libraries</para> + </entry> + </row> + + <row> + <entry> + <para> + <emphasis> + <property moreinfo="none">FaceletsKickStartWithRILibs</property> + </emphasis> + </para> + </entry> + + <entry> + <para>A sample application with + Facelets that is ready to + run</para> + </entry> + </row> + + <row> + <entry> + <para> + <emphasis> + <property moreinfo="none">FaceletsKickStartWithoutLibs</property> + </emphasis> + </para> + </entry> + + <entry> + <para>A sample application without + libraries</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + </section> + <section> + <title>Facelets components</title> + + <para>The <ulink url="../../jsf/html_single/index.html#palette">JBoss Tools + Palette</ulink> comes with the Facelets components ready to + use. A useful tip appears when you hover the mouse cursor over the + tag, the tip includes a detailed description of the tag component, + the syntax and available attributes.</para> + + <!-- JBoss Developer Studio does not provide templates for MyFaces right out of the box, but you can easily do it + yourself with the &quot;Save As Template&quot; feature (available on the File submenu). Just create a small project + with MyFaces and Facelets and then save it as a template for future use. + + How can I add Facelets support to an existing project?</para> + <para>A: Right-click on the folder of existing project and select <emphasis>JBoss Tools &gt; Add Custom Capabilities.. &gt; Facelets</emphasis>. </para> + --> + <figure float="0"> + <title>Facelets Components</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_4.png" scale="65"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section> + <title>Code assist for Facelets</title> + + <para>One more feature which comes with Facelets support is code assist + (Ctrl + Space). It is available for <property moreinfo="none">Facelets + tags</property> while editing <emphasis> + <property moreinfo="none">.xhtml</property> + </emphasis> files.</para> + + <figure float="0"> + <title>XHTML File Code Assist</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_5.png" scale="60"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>What's more, code assist is also available for <emphasis role="italic"> + <property moreinfo="none">"jsfc"</property> + </emphasis> attribute in any HTML tag.</para> + + <figure float="0"> + <title>Code Assist for JSFC Attribute</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_6.png" scale="70"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>After selecting <emphasis role="italic"> + <property moreinfo="none">"jsfc"</property> + </emphasis> you get the code assist for JSF components available on + a page.</para> + + <figure float="0"> + <title>Code Assist for JSF Components</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_7.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>When a component is chosen you will see all available attributes for + it.</para> + + <figure float="0"> + <title>Available Attributes for the Component</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_8.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section> + <title>Open On feature</title> + <para>Finally, Eclipse's <emphasis> + <property moreinfo="none">OpenOn</property> + </emphasis> feature for editing Facelets files is supported. Using this feature, + you can easily navigate between the <property moreinfo="none">Facelets + templates</property> and other parts of your projects. Just by + holding down the Control key while hovering the mouse cursor over a + reference to a template, the reference becomes a hyperlink to open + that template.</para> + + + <figure float="0"> + <title>Template Hyperlink</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_9.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <!-- <para>Additionally, when hovering the mouse cursor over <emphasis role="italic"><property>&quot;Facelets tag&quot;</property></emphasis> attributes, JBoss Developer Studio provides a pop-up help tip:</para> + <figure> +<title>Pop-up Help Tip for Facelets Tag Attributes</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/defaultImage.png"/> + </imageobject> +</mediaobject> + </figure> + + --> + <!-- <para>See <link linkend="faq_facelets">FAQ</link> concerning Facelets + support.</para> + --> + </section> + + <!--section> + <title>Relevant Resources Links</title> + <para>Necessary information and support for Facelets find out <ulink + url="https://facelets.dev.java.net/" + >here</ulink>.</para> + </section--> + </section> + + + + + + + + + + + <!--section> + <title>Relevant Resources Links</title> + <para>If you don&apos;t familiar with <ulink + url="http://java.sun.com/javaee/javaserverfaces/">JSF + technology</ulink>, we suggest that you walk through the + information on the topic.</para> + </section--> +</chapter> + + +<chapter id="projects" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_ref_guide/en/modules/projects.xml"> + <?dbhtml filename="projects.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>JSF Tools</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>Projects</title> + <para>To take an advantage of JSF firstly you should perform one of the next + steps:</para> + + <itemizedlist> + <listitem> + <para>Create new JSF projects</para> + </listitem> + <listitem> + <para>Import (open) existing JSF projects</para> + </listitem> + <listitem> + <para>Add JSF capability to any existing Eclipse + project</para> + </listitem> + <listitem> + <para>Import and add JSF capability to any existing project + created outside Eclipse.</para> + </listitem> + </itemizedlist> + <para>In this section we're going to stop on each of them in + detail.</para> + + <section id="new_jsf_project"> + + <title>Creating a New JSF Project</title> + + <para>If you want your project to already contain all JSF + libraries, tag libraries and JSF configuration file, just + organize a new brand JSF project. It is possible to do this easily with the + help of the special wizard. To get it, select<emphasis> + <property moreinfo="none"> File &gt; New &gt; Project + &gt; JBoos Tools Web &gt; JSF + &gt; JSF Project</property> + </emphasis> and click <emphasis> + <property moreinfo="none">Next</property>.</emphasis></para> + + <figure float="0"> + <title>Choosing a JSF Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_10.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>On the next form you'll be prompted to enter + <property moreinfo="none">Project Name</property> and select a + location for the project or just leave a default path.</para> + <para>Here, JSF Version also allows you to select which JSF + implementation to use.</para> + <figure float="0"> + <title>Creating a New JSF Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_11.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>There is a number of predefined project templates that are flexible and + easily customizable. Thus you can pick a different template + on which the projects Importing Existing should be based on. Almost all + templates come in two variations: with jsf libraries and + without ones.</para> + <figure float="0"> + <title>Choosing JSF Templates</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_12.png "></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The table below provides description for each possible JSF + template.</para> + <table> + <title>JSF Project Templates</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec colnum="2" colwidth="3*"></colspec> + + + <thead> + <row> + <entry align="center"> + <para>Template</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + + <tbody> + + <row> + <entry> + <para> + <emphasis> + <property moreinfo="none">JSFBlankWithLibs</property> + </emphasis> + </para> + </entry> + + <entry> + <para>This template will + create a standard + Web project + structure with all + JSF + capabilities</para> + </entry> + </row> + + <row> + <entry> + <para> + <emphasis> + <property moreinfo="none">JSFKickStartWithLibs</property> + </emphasis> + </para> + </entry> + + <entry> + <para>This template will + create a standard + Web project + structure but will + also include a + sample application + that is ready to + run</para> + </entry> + </row> + + <row> + <entry> + <para> + <emphasis> + <property moreinfo="none">JSFKickStartWithoutLibs</property> + </emphasis> + </para> + </entry> + + <entry> + <para>Some servers already + provide jsf libs and + you take risk of + getting conflicting + libraries while + deploying your + project. To avoid + such conflicts, use + a template without + libs if you have a + server with its own + jsf libraries</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + + + <!-- <para>You can of course create your own custom templates. More information + on templates creation could be found in <link + linkend="CreatingCustomJSPTemplates">Chapter 5</link>.</para> + --> + + <para>On the next screen select what <emphasis> + <property moreinfo="none">Servlet version</property> + </emphasis> to use and whether to register this application + with JBoss AS (or other server) for running and testing your application.</para> + + <para>The <emphasis> + <property moreinfo="none">Context Path</property> + </emphasis> is the name under which the application will be + deployed.</para> + + <para>The <emphasis> + <property moreinfo="none">Runtime</property> + </emphasis> value tells Eclipse where to find Web libraries + in order to build (compile) the project. It is not possible + to finish project creation without selecting Runtime. If you + don't have any values, select <emphasis> + <property moreinfo="none">New...</property> + </emphasis> to add new Runtime.</para> + + <para>The <emphasis> + <property moreinfo="none">Target Server</property> + </emphasis> allows you specifying whether to deploy the + application. The Target Server corresponds to the Runtime + value selected above. If you don't want to deploy + the application, uncheck this value.</para> + <figure float="0"> + <title>Registering the Project on Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_14.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>When you are all done, you should have the project that has + been appeared in the Package Explorer view:</para> + <figure float="0"> + <title>A New Project in the Package Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_15.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>At this point you can open <emphasis> + <property moreinfo="none">faces-config.xml</property> + </emphasis> and start working on your application. + There are a lot of features + to develop JSF applications. We will describe the features + further.</para> + </section> + + <section id="ImportingExsJSFProjWithAnyStr74447"> + + <title>Importing Existing JSF Projects with Any Structure</title> + + <para>For detailed information on migration of JSF projects into a workspace see <ulink url="../../Exadel-migration/html_single/index.html#jsf_struts">Migration Guide</ulink>.</para> + + </section> + <section id="add_jsf_capability"> + + <title>Adding JSF Capability to Any Existing Eclipse Project</title> + + <para>It's also possible to add <property moreinfo="none">JSF capability</property> + (JSF libraries, tag libraries) to any existing Eclipse + project in your workspace. After that you'll be + able to make use of such editors as JSF configuration editor, JBoss + Tools JSP editor and any others.</para> + <para>Right click the project and select <emphasis> + <property moreinfo="none">JBoss Tools &gt; Add JSF + Capabilities</property>. </emphasis> This will start + the process of adding all necessary libraries, files to make + this a Web JSF project.</para> + <figure float="0"> + <title>Adding JSF Capabilities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_16.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The wizard will first ask you to show the <emphasis> + <property moreinfo="none">web.xml</property> + </emphasis> file location and the project name.</para> + <figure float="0"> + <title>Project Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_17.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>On the last form you can set the different folders for your + project as well as register this application with a servlet + container.</para> + + <para>Make sure to select <emphasis> + <property moreinfo="none">Add Libraries</property> + </emphasis> to add all required JSF related libraries to this project.</para> + + <para>The <emphasis> + <property moreinfo="none">Context Path</property> + </emphasis> is the name under which the application will be + deployed.</para> + + <para>The <emphasis> + <property moreinfo="none">Runtime</property> + </emphasis> value tells Eclipse where to find Web libraries + in order to build (compile) the project. It is not possible + to finish project import without selecting Runtime. If you + don't have any values, select <emphasis> + <property moreinfo="none">New...</property> + </emphasis> to add new Runtime.</para> + + <para>The <emphasis> + <property moreinfo="none">Target Server</property> + </emphasis> allows you to specify whether to deploy the + application. The Target Server corresponds to the Runtime + value selected above. If you don't want to deploy + the application, uncheck this value.</para> + <figure float="0"> + <title>Project Folders</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_18.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Once your project is imported you can see that JSF related + libraries have been added to your project: <emphasis> + <property moreinfo="none">jsf-api.jar</property> + </emphasis> and <emphasis> + <property moreinfo="none">jsf-impl.jar</property> + </emphasis>.</para> + <note> + <title>Note:</title> + <para>Some application servers provide their own jsf + implementation libraries. Thus, to avoid conflicts you + should not add jsf libraries while adding jsf + capabilities.</para> + </note> + <para>You are now ready to work with JSF by creating a new JSF + configuration file:</para> + + + <figure float="0"> + <title>Creating a New JSF Configuration File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_19.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Once the file has been created, it should be opened in a + special <link linkend="jsf_config_file">Faces Config Editor</link>.</para> + </section> + <section id="AddingYourOwnProjectTemplates853"> + + <title>Adding Your Own Project Templates</title> + <para>Template is a set of files that is served as a basis to facilitate + the creation of a new project. Project templates provide + content and structure for a project.</para> + <para>There is a powerful + templating capability for creating new and importing + existing Struts and JSF projects. This templating facility + has a variety of aspects to consider. But, let's + start with the most straightforward case and consider the + process of creating a template from your existing JSF + project.</para> + + <para>Let's say you have a project that you want to use as + the basis for a new <property moreinfo="none">template</property>. Follow + these steps to make a template out of it:</para> + <itemizedlist> + <listitem> + <para>In the Web Projects view, right-click the + project and select <emphasis> + <property moreinfo="none">JBoss Tools JSF &gt; Save As + Template</property> + </emphasis></para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Saving Your Project as Template</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_20.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>In the first dialog box, you can choose a name + for the template (defaults to the project + name) and confirm what run-time + implementation of the project + technology will be used</para> + </listitem> + + </itemizedlist> + <figure float="0"> + <title>Define Template Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_20_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">Next</property> + </emphasis> and you will be sent to a dialog + box with your project structure displayed + with check boxes. Here you can check only + those parts and files in your project + directory that should be part of the + template</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Define Template Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_20_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>At this point, unless you want to designate + some extra files as having Velocity template + coding inside them, you should click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis>.</para> + </listitem> + </itemizedlist> + <para>That's it. Now, you can use this template with any + new or imported project that uses the same run-time + implementation as the project you turned into a + template.</para> + <para>At this point, you have a fully configured project and now you can + bring some new logic to it starting from JSF configuration + file.</para> + </section> +</chapter> + +<chapter id="jsf_config_file" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_ref_guide/en/modules/jsf_config_file.xml"> + <?dbhtml filename="jsf_config_file.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>JSF Tools</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>JSF Configuration File Editor</title> + + <para>First, we should mention that JSF configuration file (<emphasis> + <property moreinfo="none">faces-config.xml</property> + </emphasis>) is intended for registering JSF application resources such as Converters, + Validators, Managed Beans and page-to-page navigation rules.</para> + <para>Now, let's look at how you can easily configure this file by means of a special + graphical editor for JSF configuration file. The editor has three main views:</para> + + <itemizedlist> + <listitem> + <para>Diagram</para> + </listitem> + <listitem> + <para>Tree</para> + </listitem> + <listitem> + <para>Source</para> + </listitem> + </itemizedlist> + + <para>They can be selected via the tabs at the bottom of the editor.</para> + + <section id="Diagram9553"> + + <title>Diagram view</title> + + <para>Here, we will show you how to work with JSF configuration file through the Diagram + view of the editor.</para> + <para>As you can see on the figure below, the Diagram view displays the navigation rules in + the faces-config.xml:</para> + <figure float="0"> + <title>Diagram View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_21.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>If your diagram is large, make use of the Outline view. Within it you can switch to a <emphasis> + <property moreinfo="none">Diagram Navigator</property> + </emphasis> mode by selecting the middle icon at the top of the view window. It allows + you to easily move around the diagram. Just move the blue area in any direction, and the + diagram on the left will also move:</para> + <figure float="0"> + <title>Outline View for Diagram</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_32.png" scale="50"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>To create a new page here, you should click the page icon (View Template) on the + toolbar from the left and then click anywhere on the diagram. A New Page Wizard will + appear.</para> + + <para>To create a transition for connecting pages:</para> + + <itemizedlist> + <listitem> + <para>Select the transition icon from the toolbar (New Connection).</para> + </listitem> + <listitem> + <para>Click the source page.</para> + </listitem> + <listitem> + <para>Click the target page.</para> + </listitem> + </itemizedlist> + + <para>A transition will appear between the two pages:</para> + <figure float="0"> + <title>Transition between JSP Pages</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_22.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>It is also possible to create a new page with context menu by right-clicking anywhere + on the diagram and selecting <emphasis> + <property moreinfo="none">New View</property>. </emphasis></para> + <figure float="0"> + <title>Creating a New View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_23.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>To edit an existing transition, first select the transition line. Then, place the + mouse cursor over the last black dot (on the target page). The mouse cursor will change + to a big +. At this point, drag the line to a new target page:</para> + <figure float="0"> + <title>Editing Transition between Views</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_24.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="TreeView11123" > + + <title>Tree View</title> + + <para>You can find it more convenient to edit your JSF Configuration file in the Tree view of + the <property moreinfo="none">VPE</property>.</para> + + <para>The view displays all JSF application artifacts referenced in the configuration file + in a tree format. By selecting any node on the left, you can see and edit its properties + which will appear in the right-hand area. Let's look at the structure of this + tree more closely.</para> + + <itemizedlist> + <listitem> + <para>Under the <emphasis> + <property moreinfo="none">Application</property> + </emphasis> node you can adjust JSF application specific settings such as + internationalization, possibility to set extensions, add property and variable + resolvers, etc.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>JSF Application Specific Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_24a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>The <emphasis> + <property moreinfo="none">Components</property> + </emphasis> node is for registering custom JSF components. Right-click and + choose <emphasis> + <property moreinfo="none">New &gt; Component</property> + </emphasis> or just press the <emphasis> + <property moreinfo="none">Add</property> + </emphasis> button in the right-hand area to add a new component to the JSF + Configuration file.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Registering a New JSF Component</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_24b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In the <property moreinfo="none">Add Component wizard</property> you should set a component + type and point to a component class by using the <emphasis> + <property moreinfo="none">Browse</property> + </emphasis> button or create a new class for this component by using the <emphasis> + <property moreinfo="none">Component-Class</property> + </emphasis> link.</para> + + <figure float="0"> + <title>Adding a New JSF Component to the JSF Configuration File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_24c.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Use the <emphasis> + <property moreinfo="none">Render Kit</property> + </emphasis> node to create and register a set of related renderers for custom + JSF components.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Adding a New JSF Component to the JSF Configuration File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_24d.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Under the <emphasis> + <property moreinfo="none">Converters</property> + </emphasis> node you can create a converter class for your JSF application + either with id or for a proper class. How to do that see the <link linkend="CreateAndRegisterACustomConverter94230">Create and Register a + Custom Converter</link> section.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Creating a New Custom Converter</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_59.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>The <emphasis> + <property moreinfo="none">Managed Bean</property> + </emphasis> node is meant for creating and registering Bean classes in your JSF + application. Read more on the topic in the <link linkend="managed_beans">Managed + Beans</link> chapter.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Managed Beans</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_26.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Use the <emphasis> + <property moreinfo="none">Navigation Rules</property> + </emphasis> node to configure a navigation between the pages in your + application: create a new navigation rule and adjust necessary properties for it + in the right-hand area.</para> + </listitem> + </itemizedlist> + <tip> + <title>Tip:</title> + <para>The same you can do in the <link linkend="Diagram9553">Diagram view</link> of the + JSF Configuration file editor.</para> + </tip> + + <figure float="0"> + <title>Configuring Navigation Rules</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_26a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Under the <emphasis> + <property moreinfo="none">Referenced Beans</property> + </emphasis> node you can add a new Referenced Bean and configure various + properties for it. To learn more on this refer to the <link linkend="referenced_beans">Create and Register Referenced Beans</link> + section.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Referenced Beans</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_26b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>The <emphasis> + <property moreinfo="none">Validators</property> + </emphasis> node is needed to create validator classes for organizing the + validation of your application data. You can read more on the topic in the <link linkend="CreateAndRegisterACustomValidator5632">Create and Register a Custom + Validator</link> section.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Validators</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_26c.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>The <emphasis> + <property moreinfo="none">Extensions</property> + </emphasis> node is for setting extensions for your <emphasis> + <property moreinfo="none">faces-config.xml</property>.</emphasis></para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Adding Extensions</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_26d.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In the <property moreinfo="none">Tree view</property> you can also edit the properties of the selected + element with the help of the <property moreinfo="none">Properties view</property> as shown below:</para> + + <figure float="0"> + <title>Properties View </title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_33.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + <section id="SourceView4643"> + + <title>Source View</title> + + <para>Here, we'll discuss how you can configure your faces-config.xml with the help + of Source View.</para> + <para>The Source view for the editor displays a text content of the JSF configuration file. + It is always synchronized with other two views, so any changes made in one of the views + will immediately appear in the other:</para> + <figure float="0"> + <title>Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_27.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para>You can also work in the Source view with the help of the <emphasis> + <property moreinfo="none">Outline view</property>.</emphasis> The Outline view shows a tree + structure of the JSF configuration file. Simply select any element in the Outline view, + and it will jump to the same place in the Source editor, so you can navigate through the + source code with Outline view.</para> + <figure float="0"> + <title>Outline View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_31.png" scale="50"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="jsf_editor_features"> + <title>Editor Features</title> + <para>Here we'll discuss a very important features that JSF configuration file + editor provides for work with JSF resources.</para> + + <section id="jsf_openOn"> + <title>Open On</title> + <para>The JSF configuration file editor comes with a very useful OpenOn navigating + feature. More fully you can read about it in our <ulink url="../../jsf/html_single/index.html#OpenOnSelection4Hyperlinknavigation">Visual Web Tools + Guide</ulink>.</para> + </section> + + <section id="ContentAssist976"> + + <title>Code Assist</title> + <para>Code Assist provides pop-up tip to help you complete your code statements. It + allows you to write your code faster and with more accuracy.</para> + <para>Code assist is always available in the Source mode:</para> + <figure float="0"> + <title>Code Assist in Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_28.png" scale="65"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="ErrorReporting3324"> + + <title>Error Reporting</title> + <para>When you are developing your project, error checking is constantly provided. This + greatly reduces your development time as it allows you to catch many of the errors + during development.</para> + <para>Errors will be reported by <link linkend="jsf_project_verification"> + verification</link> facility:</para> + <figure float="0"> + <title>Error Reporting in Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_29.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Other errors are also reported.</para> + <figure float="0"> + <title>Other Errors Reporting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_30.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + </section> + +</chapter> + + +<chapter id="managed_beans" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_ref_guide/en/modules/managed_beans.xml"> + <?dbhtml filename="managed_beans.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>JSF Tools</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>Managed Beans</title> + + <para>There is lots of power to work with <property moreinfo="none">managed beans</property>.</para> + <itemizedlist> + <listitem> + <para>Add and generate code for new managed beans</para> + <itemizedlist> + <listitem> + <para>Generate code for attributes and getter/setter methods</para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para>Add existing managed beans to JSF configuration file</para> + </listitem> + </itemizedlist> + + <para>Thus, in this section we will guides you through all this possibilities.</para> + + <section id="CodeGenerationForManagedBeans421"> + + <title>Code Generation for Managed Beans</title> + + <para>To start, create a new managed bean in JSF configuration file editor, in the Tree + view.</para> + <figure float="0"> + <title>Creation of New Managed Bean</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_34.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <note> + <title>Note:</title> + <para>When you define a new managed bean, make sure that <emphasis> + <property moreinfo="none">Generate Source Code</property> + </emphasis> is checked as shown in the figure below.</para> + </note> + <figure float="0"> + <title>New Managed Bean</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_35.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>After the <emphasis role="italic"> + <property moreinfo="none">"Java"</property> + </emphasis> class has been generated you can open it for additional editing. There are + two ways to open the <emphasis role="italic"> + <property moreinfo="none">"Java"</property> + </emphasis> class:</para> + + <itemizedlist> + <listitem> + <para>click on <emphasis> + <property moreinfo="none">Managed-Bean-Class</property> + </emphasis> link in the editor</para> + </listitem> + </itemizedlist> + <para>or</para> + <itemizedlist> + <listitem> + <para>right click the <emphasis> + <property moreinfo="none">managed bean</property> + </emphasis> and select <emphasis> + <property moreinfo="none">Open Source</property> + </emphasis></para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Opening of Created Managed Bean</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_36.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The generated Java source should look as follows:</para> + + <figure float="0"> + <title>Java Source Code</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_37.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>You can also generate source code for properties, also includes <emphasis role="italic"> + <property moreinfo="none">"getter"</property> + </emphasis> and <emphasis role="italic"> + <property moreinfo="none">"setter"</property> + </emphasis> methods. Right click on the bean and select <emphasis> + <property moreinfo="none">New &gt; Property</property> + </emphasis>. You will see <property moreinfo="none">Add Property</property> dialog.</para> + <figure float="0"> + <title>Generation of Source Code for Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_38.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>When the form is open make sure that all the check boxes are selected:</para> + <itemizedlist> + <listitem> + <para>Add Java property</para> + </listitem> + <listitem> + <para>Generate Getter</para> + </listitem> + <listitem> + <para>Generate Setter</para> + </listitem> + </itemizedlist> + <para></para> + <figure float="0"> + <title>"Add Property" Form</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_39.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Once the generation is complete, you can open the file and see the added property with + <emphasis role="italic"> + <property moreinfo="none">"get"</property> + </emphasis> and <emphasis role="italic"> + <property moreinfo="none">"set"</property> + </emphasis> methods:</para> + <figure float="0"> + <title>Generated Java Source Code for Property</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_40.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Thus, we've discussed everything which comes to creating a new Managed Bean. + The next section will show you how to add an existing Bean into a JSF configuration + file.</para> + </section> + <section id="AddExistingJavaBeansToAJSFConfigurationFile74332"> + + <title>Add Existing Java Beans to a JSF Configuration File</title> + <para>If you already have a Java bean you can easily add it to a <property moreinfo="none">JSF configuration + file</property>.</para> + <para>You should start the same way you create a new managed bean. Use the <emphasis> + <property moreinfo="none">Browse...</property> + </emphasis> button to add your existing Java class.</para> + <figure float="0"> + <title>New Managed Bean Form</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_42.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Once the class is set, its <emphasis> + <property moreinfo="none">Name</property> + </emphasis> will be set as well. But you can easily substitute it for the other one. + Notice that <emphasis> + <property moreinfo="none">Generate Source Code</property> + </emphasis> option is not available as the <emphasis role="italic"> + <property moreinfo="none">"Java"</property> + </emphasis> class already exists. </para> + <para>After adding your class <emphasis> + <property moreinfo="none">Next</property> + </emphasis> button will be activated. Pressing it you'll get <emphasis> + <property moreinfo="none">Managed Properties</property> + </emphasis> dialog where all corresponding properties are displayed. Check the necessary + ones to add them into your <property moreinfo="none">JSF Configuration File</property>.</para> + + <figure float="0"> + <title>Selection of Bean's Properties.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_43.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>If you don't want to add any, just click <emphasis> + <property moreinfo="none">Finish</property>. </emphasis></para> + <para>Above-listed steps have demonstrated how you can specify an existing Bean in the JSF + configuration file, i.e. <emphasis> + <property moreinfo="none">faces-config.xml</property>. </emphasis> In the next chapter + you'll know how to organize and register another kind of artifacts.</para> + </section> +</chapter> + + +<chapter id="creation_and_registration" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_ref_guide/en/modules/creation_and_registration.xml"> + <?dbhtml filename="creation_and_registration.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>JSF Tools</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + <title>Creation and Registration</title> + + <section id="CreateAndRegisterACustomConverter94230"> + + <title>Create and Register a Custom Converter</title> + + <para>It's also possible to create a + custom Converter in order to specify your own converting rules. Let's look at how you can do this.</para> + + <para>To create and register a custom converter it's necessary to + go through the following steps:</para> + + <itemizedlist> + <listitem> + <para>In the Project Explorer view open <emphasis> + <property moreinfo="none">faces-config.xml</property> + </emphasis> and select <emphasis> + <property moreinfo="none">Tree</property> + </emphasis> tab.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Converters</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_44.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">Converters</property> + </emphasis> and click on<emphasis> + <property moreinfo="none"> Add</property> + </emphasis> button.</para> + </listitem> + <listitem> + <para>On the form type the name of your converter in the <emphasis> + <property moreinfo="none">Converter-id</property> + </emphasis> field and name of the class for + converters. After clicking <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button your custom converter is + registered under the entered name.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Add Converter Form</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_45.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Now you can create <emphasis role="italic"> + <property moreinfo="none">"converter"</property> + </emphasis> class. In the Converter section you + should see your <emphasis> + <property moreinfo="none">Converter-id</property> + </emphasis> and + <emphasis><property moreinfo="none">Converter-class</property>.</emphasis> + Click on <emphasis> + <property moreinfo="none">Converter-class</property> + </emphasis> to generate the source code.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Generation of Source Code for Converter Class</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_46.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>A usual wizard for creating a Java class will appear. + All needed fields here will be adjusted + automatically. Just leave everything without changes + and click <emphasis> + <property moreinfo="none">Finish</property>. + </emphasis></para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>New Java Class Form</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_47.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>To open a converter class click again on <emphasis> + <property moreinfo="none">Converter-class</property> + </emphasis> link in the Converter section.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Converter Class</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_48.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Now you + are able to add a business logic of converter in the + Java editor.</para> + </section> + + <section id="CreateAndRegisterACustomValidator5632"> + + <title>Create and Register a Custom Validator</title> + + <para>It's also quite easy to develop your + own custom Validators. You should perform the actions similar to the + previous one. Go through the following steps:</para> + <itemizedlist> + <listitem> + <para>In the Project Explorer view open<emphasis> + <property moreinfo="none"> faces-config.xml</property> + </emphasis> and select <emphasis> + <property moreinfo="none">Tree </property> + </emphasis>tab.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Validator in Faces Config Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_49.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">Validators</property> + </emphasis> and click on <emphasis> + <property moreinfo="none">Add </property> + </emphasis>button.</para> + </listitem> + <listitem> + <para>Type the name of your validator in the <emphasis> + <property moreinfo="none">Validator-id</property> + </emphasis> field and name of the class for + validators. After clicking <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button your custom validator is + registered under the entered name.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Adding Validator</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_50.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Now you can create the "validator" class. </para> + <itemizedlist> + <listitem> + <para>In the Validator section you can see your <emphasis> + <property moreinfo="none">Validator-id</property> + </emphasis> and <emphasis> + <property moreinfo="none">Validator-class</property></emphasis>. To generate the source code click on <emphasis> + <property moreinfo="none">Validator-class</property>. + </emphasis></para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Creating Validator Class</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_51.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Java class will be created automatically. Leave + everything without changes and click <emphasis> + <property moreinfo="none">Finish</property>. + </emphasis></para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>New Java Class Form</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_52.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>To open validator class click again on <emphasis> + <property moreinfo="none">Validator-Class</property> + </emphasis> link in the Validator section. Now you + are able to write a business logic of validator in + the Java editor.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Converter Class Editing</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_53.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="referenced_beans"> + <title>Create and Register Referenced Beans</title> + + <para>Creation of Referenced Beans is similar to creation of Custom + Validator as well. To perform this, let's walk through the necessary steps.</para> + + <itemizedlist> + <listitem> + <para>In the Project Explorer view open<emphasis> + <property moreinfo="none"> faces-config.xml</property> + </emphasis> and select <emphasis> + <property moreinfo="none">Tree </property> + </emphasis>tab.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Referenced Beans in Faces Config Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_54.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">Referenced Beans</property> + </emphasis> and click on <emphasis> + <property moreinfo="none">Add</property> + </emphasis> button.</para> + </listitem> + <listitem> + <para>Type in the name of your Referenced Bean and type in + or select <emphasis> + <property moreinfo="none">Referenced-Bean-Class</property> + </emphasis> by using <emphasis> + <property moreinfo="none">Browse</property> + </emphasis> button.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Add Referenced Bean</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_55.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>In the Referenced Bean section you should see your <emphasis> + <property moreinfo="none">Referenced-Bean-Name</property> + </emphasis> and + <emphasis><property moreinfo="none">Referenced-Bean-Class</property>.</emphasis> + Click on the link to open the Java creation + wizard.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Create Referenced Bean Class</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_56.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Java class will be created automatically. Leave + everything without changes and click <emphasis> + <property moreinfo="none">Finish</property>. + </emphasis></para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>New Java Class Form</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_57.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>To open Referenced Bean class click again on <emphasis> + <property moreinfo="none">Referenced-Bean-Class</property> + </emphasis> in the Referenced Bean section. Now you + are able to write business logic of Referenced Bean + in the Java editor.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Referenced Bean Class Editing</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_58.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> +</chapter> + +<chapter id="jsf_project_verification" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_ref_guide/en/modules/jsf_project_verification.xml"> + <?dbhtml filename="struts_project_verification.html"?> + + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>JSF Tools</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>JSF Project Verification</title> + + <para>In this chapter we'll discuss a possible verification that you can take advantage + of.</para> + <!-- JBoss Developer Studio checks for many different rules for a JSF project --> + <para>Many different rules are checked for a JSF project that can be configured by selecting <emphasis> + <property moreinfo="none">Window &gt; Preferences</property> + </emphasis> from the menu bar, selecting <emphasis> + <property moreinfo="none">JBoss Tools &gt; Web &gt; Verification</property> + </emphasis> from the Preferences dialog box and then expanding the JSF Rules node.</para> + <figure float="0"> + <title>JSF Rules</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Suppose you are working in the Source viewer for a JSF configuration file as shown below:</para> + <figure float="0"> + <title>Faces-config.xml File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>While typing a class name, you might make a minor typo (like <emphasis role="italic"> + <property moreinfo="none">"jsfHello.PersonBean9"</property> + </emphasis> instead of <emphasis role="italic"> + <property moreinfo="none">"jsfHello.PersonBean"</property> + </emphasis>). After saving the file, verification checks to make sure everything is correct + and finds the error below:</para> + <figure float="0"> + <title>Error in Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_3.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Notice that the Package Explorer View shows a marked folder and a marked file where the + error is.</para> + <para>You can place the cursor over the line with an error message and get a detailed error + message:</para> + <figure float="0"> + <title>Error Message</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Verification also checks navigation rules:</para> + <figure float="0"> + <title>Checking Navigation Rules</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>If you provide a page name that does not exist, verification will let you know about that:</para> + <figure float="0"> + <title>Page Name Verification</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_6.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>You can always call up verification explicitly by right-clicking any element in the tree + and selecting Verify from the context menu. This works from both the Tree and Diagram + viewers for the JSF configuration file editor. You can also invoke verification from the Web + Projects view. Below we are checking all of the elements in the configuration file.</para> + <figure float="0"> + <title>Verify Command</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In summary, this document highlights all the JSF-specific features of <property moreinfo="none">JBoss Tools</property> + meant for enhancing the development of rich Web applications based on JSF technology. The + reference introduces you to wizards for creating and importing JSF projects, JSF + Configuration File editor features, functionality for enabling JSF capabilities and etc.</para> + + <para>If you have questions or good suggestions, please refer to <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... + Tools Forum</ulink>.</para> +</chapter> + +</book> Added: branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/master_output.xml =================================================================== --- branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/master_output.xml (rev 0) +++ branches/jbosstools-3.0.x/jsf/docs/jsf_tools_tutorial/en/master_output.xml 2009-03-06 18:46:29 UTC (rev 14086) @@ -0,0 +1,798 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + +[<!ENTITY introduction SYSTEM "modules/introduction.xml"> +<!ENTITY jsf_application SYSTEM "modules/jsf_application.xml"> +<!ENTITY adding_navigation SYSTEM "modules/adding_navigation.xml"> +<!ENTITY adding_managed_bean SYSTEM "modules/adding_managed_bean.xml"> +<!ENTITY jsp_view_files SYSTEM "modules/jsp_view_files.xml"> +<!ENTITY start_page SYSTEM "modules/start_page.xml"> +<!ENTITY running_application SYSTEM "modules/running_application.xml"> +<!ENTITY relevant_resources SYSTEM "modules/relevant_resources.xml"> + +<!ENTITY seamlink "../../seam/html_single/index.html"> +<!ENTITY aslink "../../as/html_single/index.html"> +<!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> +<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html"> +<!ENTITY jbpmlink "../../jbpm/html_single/index.html"> +<!ENTITY jsflink "../../jsf/html_single/index.html"> +<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html"> +<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html"> +<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html"> +<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> + +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + + <bookinfo> + <title>JSF Tools Tutorial</title> + + <author><firstname>Anatoly</firstname><surname>Fedosik</surname></author> + <author><firstname>Olga</firstname><surname>Chikvina</surname></author> + <author&gt;&lt;firstname&gt;Svetlana&lt;/firstname&gt;&lt;surname&gt;Mukhina&lt;/surname&gt;&lt;email&gt;smukhina(a)exadel.com&lt;/email&gt;&lt;/author&gt; + + <pubdate>April 2008</pubdate> + <copyright> + <year>2007</year> + <year>2009</year> + <holder>JBoss, a division of Red Hat</holder> + </copyright> + + <releaseinfo> + Version: 3.0.0.GA + </releaseinfo> + + +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/struts_too... version</ulink> + </para> +</abstract> + + + </bookinfo> + + <toc></toc> + + + +<chapter id="introduction" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_tutorial/en/modules/introduction.xml" xreflabel="introduction"> + <?dbhtml filename="introduction.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + <title>Introduction</title> + <para>The following chapters describe how to deal with classic/old style of JSF development. We + recommend users to use <ulink url="../../seam/html_single/index.html">JBoss + Seam</ulink> to simplify development, but until then you can read about classical JSF + usage here.</para> + + <para>Thus, in this document we are going to show you how to create a simple <property moreinfo="none">JSF application + </property>using <property moreinfo="none">JBoss Tools</property> plugins for Eclipse. The completed + application will ask a user to enter a name and click a button. The resulting new page + will display the familiar message, "Hello &lt;name&gt;!" This + tutorial will show you how to create and run such an application from the beginning along the + way demonstrating some of the powerful features of <property moreinfo="none">JBoss Tools</property>.</para> + + <section> + <title>Other relevant resources on the topic</title> + <para>All JBoss Developer Studio/JBoss Tools documentation you can find <ulink url="http://www.jboss.com/products/devstudio/docs">here</... + <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">her... + </section> + +</chapter> + + +<chapter id="jsf_application" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_tutorial/en/modules/jsf_application.xml" xreflabel="jsf_application"> + <?dbhtml filename="jsf_application.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>JSF application</keyword> + <keyword>Java</keyword> + </keywordset> + </chapterinfo> + + <title>Creating a Simple JSF Application</title> + + <para>Firstly, we assume that you have already launched Eclipse with <property moreinfo="none">JBoss Tools</property> + plug-ins installed and also that the <property moreinfo="none">Web Development perspective</property> is the current + one. (If not, make it active by selecting <emphasis> + <property moreinfo="none">Window &gt; Open Perspective &gt; Web Development</property> + </emphasis> from the menu bar or by selecting <emphasis> + <property moreinfo="none">Window &gt; Open Perspective &gt; Other...</property> + </emphasis> from the menu bar and then selecting <emphasis> + <property moreinfo="none">Web Development</property> + </emphasis> from the Select Perspective dialog box.)</para> + + <section id="setting_up_the_project"> + <?dbhtml filename="SettingUpTheProject.html"?> + <title>Setting Up the Project</title> + <para>Now we are going to create a new project for the application.</para> + <itemizedlist> + <listitem> + <para>For that go to the menu bar and select <emphasis> + <property moreinfo="none">File &gt; New &gt; Project...</property> + </emphasis></para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">JBoss Tools Web &gt; JSF &gt; JSF Project</property> + </emphasis> in the New Project dialog box</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Next</property> + </emphasis></para> + </listitem> + <listitem> + <para>Enter "jsfHello" as the project name.</para> + </listitem> + <listitem> + <para>Leave everything else as is, and click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + + </itemizedlist> + </section> + + <section id="TheJSFApplicationConfigurationFile"> + <?dbhtml filename="TheJSFApplicationConfigurationFile.html"?> + <title>JSF Configuration File</title> + <para>A jsfHello node should appear in the upper-left Package Explorer view.</para> + <figure float="0"> + <title>Package Explorer View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_application/jsf_application_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Click the plus sign next to <emphasis> + <property moreinfo="none">jsfHello</property> + </emphasis> to reveal the child nodes</para> + </listitem> + <listitem> + <para>Click the plus sign next to <emphasis> + <property moreinfo="none">WebContent</property> + </emphasis> under jsfHello</para> + </listitem> + <listitem> + <para>Click the plus sign next to <emphasis> + <property moreinfo="none">WEB-INF</property> + </emphasis> under WebContent</para> + </listitem> + + <listitem> + <para>Then double-click on the <property moreinfo="none">faces-config.xml</property> node to display + the JSF application configuration file editor</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Configuration File Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_application/jsf_application_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> +</chapter> + + +<chapter id="adding_navigation" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_tutorial/en/modules/adding_navigation.xml" xreflabel="adding_navigation"> + <?dbhtml filename="adding_navigation.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>JSF application</keyword> + <keyword>Java</keyword> + </keywordset> + </chapterinfo> + + <title>Adding Navigation to the Application</title> + + <para>In our simple application, the flow is defined as a single navigation rule connecting + two views (presentation files). At this point, we will create the placeholders for the + two JSP presentation files and then the navigation rule to connect them as views. Later, + we will complete the coding for the JSP presentation files. We can do all of this in the + Diagram mode of the configuration file editor.</para> + <section id="AddingTwoViewsJSPPages"> + <?dbhtml filename="AddingTwoViewsJSPPages.html"?> + <title>Adding Two Views (JSP Pages)</title> + <itemizedlist> + <listitem> + <para>Right-click anywhere on the diagram and select <emphasis> + <property moreinfo="none">New View...</property> + </emphasis> from the pop-up menu</para> + </listitem> + <listitem> + <para>In the dialog box, type <emphasis> + <property moreinfo="none">pages/inputname</property> + </emphasis> as the value for From-view-id</para> + </listitem> + <listitem> + <para>Leave everything else as is</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + <para>If you look in the Package Explorer view you should see a <emphasis> + <property moreinfo="none">pages</property> + </emphasis> folder under WebContent. Opening it will reveal the JSP file you + just created</para> + </listitem> + <listitem> + <para>Back on the diagram, right-click anywhere and select <emphasis> + <property moreinfo="none">New View...</property> + </emphasis> from the pop-up menu</para> + </listitem> + <listitem> + <para>In the dialog box, type <emphasis> + <property moreinfo="none">pages/greeting</property> + </emphasis> as the value for From-view-id</para> + </listitem> + <listitem> + <para>Leave everything else as is</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + </itemizedlist> + + </section> + <section id="CreatingTheTransitionNavigationRule"> + <?dbhtml filename="CreatingTheTransitionNavigationRule.html"?> + <title>Creating the Transition (Navigation Rule)</title> + <itemizedlist> + <listitem> + <para>In the diagram, select the connection icon third from the top along + the upper left side of the diagram</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Connection Icon</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_application/jsf_application_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>to get an arrow cursor with a two-pronged plug at the arrow's bottom.</para> + <itemizedlist> + <listitem> + <para>Click on the <emphasis> + <property moreinfo="none">pages/inputname</property> + </emphasis> page icon and then click on the <emphasis> + <property moreinfo="none">pages/greeting</property> + </emphasis> page icon</para> + </listitem> + + </itemizedlist> + <para>A transition should appear between the two icons.</para> + <figure float="0"> + <title>Transition Between Two Icons</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_application/jsf_application_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">File &gt; Save</property> + </emphasis> from the menu bar</para> + </listitem> + </itemizedlist> + </section> + +</chapter> + +<chapter id="adding_managed_bean" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_tutorial/en/modules/adding_managed_bean.xml" xreflabel="adding_managed_bean"> + <?dbhtml filename="adding_managed_bean.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>JSF application</keyword> + <keyword>Java</keyword> + </keywordset> + </chapterinfo> + + <title>Adding a Managed Bean to the Application</title> + <para>To store data in the application, we will use a managed bean.</para> + <itemizedlist> + <listitem> + <para>Click on the <emphasis> + <property moreinfo="none">Tree</property> + </emphasis> tab at the bottom of the editing window</para> + </listitem> + <listitem> + <para>Select the <emphasis> + <property moreinfo="none">Managed Beans</property> + </emphasis> node and then click the <emphasis> + <property moreinfo="none">Add...</property> + </emphasis> button displayed along the right side of the editor window</para> + </listitem> + <listitem> + <para>Type in <emphasis> + <property moreinfo="none">jsfHello.PersonBean</property> + </emphasis> for Class and <emphasis> + <property moreinfo="none">personBean</property> + </emphasis> for Name. Leave Scope as is and Generate Source Code as is + (checked)</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + <listitem> + <para>personBean will now be selected and three sections of information: <emphasis> + <property moreinfo="none">Managed Bean</property> + </emphasis>, <emphasis> + <property moreinfo="none">Properties</property> + </emphasis>, and <emphasis> + <property moreinfo="none">Advanced</property> + </emphasis>, will be displayed about it. Under the Properties section, click the <emphasis> + <property moreinfo="none">Add...</property> + </emphasis> button</para> + </listitem> + <listitem> + <para>Type in <emphasis> + <property moreinfo="none">name</property> + </emphasis> for Property-Name. Leave everything else as is. (When Property- + Class is not filled in, String is the assumed type)</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + <listitem> + <para>Select the <emphasis> + <property moreinfo="none">personBean</property> + </emphasis> node in the tree</para> + </listitem> + </itemizedlist> + <para>You should see this now:</para> + <figure float="0"> + <title>Tree View in Config Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_application/jsf_application_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">File &gt; Save</property> + </emphasis> from the menu bar</para> + </listitem> + </itemizedlist> + <para>You have now registered the <emphasis> + <property moreinfo="none">managed bean</property> + </emphasis> and created a <emphasis> + <property moreinfo="none">stub-coded class</property> + </emphasis> file for it.</para> + + </chapter> + +<chapter id="jsp_view_files" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_tutorial/en/modules/jsp_view_files.xml" xreflabel="jsp_view_files"> + <?dbhtml filename="jsp_view_files.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>JSF application</keyword> + <keyword>Java</keyword> + </keywordset> + </chapterinfo> + + <title>Editing the JSP View Files</title> + + <para>Now we will finish editing the JSP files for our two "views" using + JSP Visual Page.</para> + <section id="Inputname.jsp"> + <title>inputname.jsp</title> + <itemizedlist> + <listitem> + <para>Click on the <emphasis> + <property moreinfo="none">Diagram</property> + </emphasis> tab for the configuration file editor</para> + </listitem> + <listitem> + <para>Open the editor for this first JSP file by double-clicking on the <emphasis> + <property moreinfo="none">/pages/inputname. jsp</property> + </emphasis> icon</para> + </listitem> + </itemizedlist> + + <para>The Visual Page Editor will open in a screen split between source code along the + top and a WYSIWIG view along the bottom:</para> + <figure float="0"> + <title>Visual Page Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_application/jsf_application_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Some JSF code is already in the file, because we have chosen a template to create + a page.</para> + <itemizedlist> + <listitem> + <para>Select the <emphasis> + <property moreinfo="none">Visual</property> + </emphasis> tab, so we can work with the editor completely in its WYSIWYG + mode</para> + </listitem> + <listitem> + <para>To the right of the editor, in the JBoss Tools Palette, expand the <emphasis> + <property moreinfo="none">JSF HTML</property> + </emphasis> palette folder by selecting it</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>JBoss Tools Palette</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_application/jsf_application_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Click on <emphasis> + <property moreinfo="none">form</property> + </emphasis> within this folder, drag the cursor over to the editor, and drop + it inside the red box in the editor</para> + </listitem> + <listitem> + <para>Another red box will appear inside the first red box</para> + </listitem> + <listitem> + <para>Right-click on the innermost box and select <emphasis role="bold"> + <property moreinfo="none">&lt;h:form&gt;</property> + </emphasis> Attributes from the menu</para> + </listitem> + <listitem> + <para>In the value field next to id, type <emphasis> + <property moreinfo="none">greeting</property> + </emphasis> and click on the <emphasis> + <property moreinfo="none">Close</property> + </emphasis> button</para> + </listitem> + <listitem> + <para>Type "Please enter name:" inside the boxes</para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">inputText</property> + </emphasis> within the JSF HTML palette folder and drag it into the + innermost box in the editor after "Please enter + name:"</para> + </listitem> + <listitem> + <para>In the attributes dialog, click in the <emphasis> + <property moreinfo="none">value</property> + </emphasis> field next to the value attribute and click on the <property moreinfo="none">... + </property>button</para> + </listitem> + <listitem> + <para>Then, select the <emphasis> + <property moreinfo="none">Managed Beans &gt; personBean &gt; name</property> + </emphasis> node and click on the <emphasis> + <property moreinfo="none">Ok</property> + </emphasis> button</para> + </listitem> + <listitem> + <para>Back in the attributes dialog, select the <emphasis> + <property moreinfo="none">Advanced</property> + </emphasis> tab, type in <emphasis> + <property moreinfo="none">name</property> + </emphasis> as the value for the <emphasis role="italic"> + <property moreinfo="none">"id"</property> + </emphasis> attribute, and then click on the <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button</para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">commandButton</property> + </emphasis> within the JSF HTML palette folder and drag it into the + innermost box in the editor after the input box</para> + </listitem> + <listitem> + <para>In the attributes dialog, click in the value field next to the <emphasis role="italic"> + <property moreinfo="none">"action"</property> + </emphasis> attribute and click on the <property moreinfo="none">... + </property>button</para> + </listitem> + <listitem> + <para>Then, select the <emphasis> + <property moreinfo="none">View Actions &gt; greeting</property> + </emphasis> node and click on the <emphasis> + <property moreinfo="none">OK</property> + </emphasis> button</para> + </listitem> + <listitem> + <para>Back in the attributes dialog box, type in "Say Hello" + as the value for the value attribute ("Say Hello") and + then click on the <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button</para> + </listitem> + </itemizedlist> + <para>The source coding should be something like this now:</para> + <programlisting format="linespecific" role="XML"><![CDATA[<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h" %> +<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f" %> +<html> +<head> +<title></title> +</head> +<body> +<f:view> +<h:form id="greeting"> +<para>Please enter a name:</para> +<h:inputText id="name" value="#{personBean.name}"/> +<h:commandButton value=" Say Hello " action="greeting"/> +</h:form> +</f:view> +</body> +</html> +]]></programlisting> + <para>The editor should look like this:</para> + <figure float="0"> + <title>Visual Page Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_application/jsf_application_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Save the file by selecting <emphasis> + <property moreinfo="none">File &gt; Save</property> + </emphasis> from the menu bar</para> + </listitem> + </itemizedlist> + </section> + <section id="Greeting.jsp"> + <title>greeting.jsp</title> + <itemizedlist> + <listitem> + <para>Click on the <emphasis> + <property moreinfo="none">faces-config.xml</property> + </emphasis> tab to bring the diagram back</para> + </listitem> + <listitem> + <para>Open the editor for the second file by double-clicking on the <emphasis> + <property moreinfo="none">/pages/greeting.jsp</property> + </emphasis> icon</para> + </listitem> + <listitem> + <para>Select the <emphasis> + <property moreinfo="none">Visual</property> + </emphasis> tab, so we can work with the editor completely in its WYSIWYG + mode</para> + </listitem> + <listitem> + <para>Type "Hello "(note space after Hello) into the + box</para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">outputText</property> + </emphasis> within the JSF HTML palette folder and drag it into the + innermost box in the editor after "Hello"</para> + </listitem> + <listitem> + <para>In the attributes dialog, click in <emphasis> + <property moreinfo="none">value</property> + </emphasis> field next to the value attribute and click on the + <property moreinfo="none">...</property> (Browse) button</para> + </listitem> + <listitem> + <para>Then, select the <emphasis> + <property moreinfo="none">Managed Beans &gt; personBean &gt; name</property> + </emphasis> node, click on the <emphasis> + <property moreinfo="none">Ok</property> + </emphasis> button, and then click on the <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button</para> + </listitem> + <listitem> + <para>Right after the output field, type an <emphasis> + <property moreinfo="none">exclamation point</property> + </emphasis> (<emphasis> + <property moreinfo="none">!</property> + </emphasis>)</para> + </listitem> + </itemizedlist> + <para>The source coding should be something like this now:</para> + <programlisting format="linespecific" role="XML"><![CDATA[<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h" %> +<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f" %> +<html> +<head> +<title></title> +</head> +<body> +<f:view> +Hello <h:outputText value="#{personBean.name}"/>! +</f:view> +</body> +</html> +]]></programlisting> + <itemizedlist> + <listitem> + <para>Save the file</para> + </listitem> + </itemizedlist> + </section> + </chapter> + +<chapter id="start_page" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_tutorial/en/modules/start_page.xml" xreflabel="start_page"> + <?dbhtml filename="start_page.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>JSF application</keyword> + <keyword>Java</keyword> + </keywordset> + </chapterinfo> + + <title>Creating the Start Page</title> + <para>You also need to create a start page as an entry point into the application.</para> + <itemizedlist> + <listitem> + <para>In the Package Explorer view to the left, right-click <emphasis> + <property moreinfo="none">jsfHello &gt; WebContent</property> + </emphasis> and select <emphasis> + <property moreinfo="none">New &gt; JSP File</property> + </emphasis></para> + </listitem> + <listitem> + <para>For Name type in <emphasis> + <property moreinfo="none">index</property> + </emphasis>, for Template select <emphasis> + <property moreinfo="none">JSPRedirect</property> + </emphasis> and click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + </itemizedlist> + <para>A JSP editor will open up on the newly created file.</para> + + <itemizedlist> + <listitem> + <para>In the Source part of the split screen, type <emphasis> + <property moreinfo="none">/pages/inputname.jsf</property> + </emphasis> in between the quotes for the page attribute</para> + </listitem> + </itemizedlist> + <para>The source coding should look like this now:</para> + <programlisting format="linespecific" role="XML"><![CDATA[<!doctype html public "-//w3c//dtd html 4.0 transitional//en"> +<html> +<head></head> +<body> +<jsp:forward page="/pages/inputname.jsf" /> +</body> +</html> +]]></programlisting> + + <para>Note the <emphasis> + <property moreinfo="none">.jsf</property> + </emphasis> extension for the file name. This is a mapping defined in the web.xml file + for the project for invoking <property moreinfo="none">JavaServer Faces</property> when you run the + application.</para> + <itemizedlist> + <listitem> + <para>Select<emphasis> + <property moreinfo="none"> File &gt; Save</property> + </emphasis> from the menu bar</para> + </listitem> + </itemizedlist> + </chapter> + +<chapter id="running_application" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_tutorial/en/modules/running_application.xml" xreflabel="running_application"> + <?dbhtml filename="running_application.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>JSF application</keyword> + <keyword>Java</keyword> + </keywordset> + </chapterinfo> + + <title>Running the Application</title> + <para>Everything is now ready for running our application by using the JBoss engine. For + controlling JBoss server there is JBoss Server view:</para> + <figure float="0"> + <title>JBoss Server View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_application/jsf_application_9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Start up JBoss by clicking on the icon in JBoss Server view. (If JBoss is + already running, stop it by clicking on the red icon and then start it again. + Remember, the JSF run-time requires restarting the servlet engine when any + changes have been made.) After the messages in the Console tabbed view stop + scrolling, JBoss is available</para> + </listitem> + + <listitem> + <para>Click the Run icon or right click your project folder and select <emphasis> + <property moreinfo="none">Run As &gt; Run on Server</property> + </emphasis>:</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Run Icon</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_application/jsf_application_10.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>This is the equivalent of launching the browser and typing <emphasis> + <property moreinfo="none">http://localhost:8080/jsfHello</property> + </emphasis> into your browser. Our <property moreinfo="none">JSF application</property> should now + appear.</para> + </chapter> + +<chapter id="relevant_resources" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/jsf_tools_tutorial/en/modules/relevant_resources.xml" xreflabel="relevant_resources"> + <?dbhtml filename="relevant_resources.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>JSF application</keyword> + <keyword>Java</keyword> + </keywordset> + </chapterinfo> + + <title>Other Relevant Resources on the topic</title> + <para>JSF on Sun: <ulink url="http://java.sun.com/javaee/javaserverfaces/">JavaServer Faces + Technology</ulink></para> + <para>Core JSF: <ulink url="http://www.horstmann.com/corejsf/">Core JavaServer Faces</ulink></para> + <para>API: <ulink url="http://java.sun.com/javaee/javaserverfaces/1.1/docs/api/index.h... + API</ulink></para> + <para>JSF Tags: <ulink url="http://www.horstmann.com/corejsf/jsf-tags.html">JSF Core + Tags</ulink></para> + <para>HTML Tags Reference: <ulink url="http://www.exadel.com/tutorial/jsf/jsftags-guide.html">JSF HTML Tags Reference</ulink></para> + <para>JSF Central: <ulink url="http://www.jsfcentral.com/">JSF Central - Your JavaServer Faces + Community</ulink></para> + <para>FAQ: <ulink url="http://wiki.java.net/bin/view/Projects/JavaServerFacesSpecFaq&q... + FAQ</ulink></para> + <para>Download: <ulink url="http://java.sun.com/javaee/javaserverfaces/download.html"&... + Faces Technology - Download</ulink></para> + + <para>In summary, with this tutorial you should now know how to organize JSF sample application + using the wizards provided by <property moreinfo="none">JBoss Tools</property>, configure its stuff and + finally run it on the <property moreinfo="none">JBoss Server</property>.</para> + + <para>Find out more features on JSF tooling in our <ulink url="../../jsf_tools_ref_guide/html_single/index.html">JSF Tools + Reference Guide</ulink>. If you have questions and suggestions, please refer to <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... + Tools Forum</ulink>.</para> +</chapter> + +</book> Added: branches/jbosstools-3.0.x/jsf/docs/userguide/en/master_output.xml =================================================================== --- branches/jbosstools-3.0.x/jsf/docs/userguide/en/master_output.xml (rev 0) +++ branches/jbosstools-3.0.x/jsf/docs/userguide/en/master_output.xml 2009-03-06 18:46:29 UTC (rev 14086) @@ -0,0 +1,4476 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + +[ +<!ENTITY Visual_Web_Tools SYSTEM "modules/Visual_Web_Tools.xml"> +<!ENTITY springTools SYSTEM "modules/spring_tools.xml"> +<!ENTITY editors SYSTEM "modules/editors.xml"> +<!ENTITY palette SYSTEM "modules/palette.xml"> +<!ENTITY richfaces_support SYSTEM "modules/richfaces_support.xml"> +<!ENTITY web_projects SYSTEM "modules/web_projects.xml"> +<!ENTITY preferences SYSTEM "modules/preferences.xml"> + +<!ENTITY seamlink "../../seam/html_single/index.html"> +<!ENTITY aslink "../../as/html_single/index.html"> +<!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> +<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html"> +<!ENTITY jbpmlink "../../jbpm/html_single/index.html"> +<!ENTITY jsflink "../../jsf/html_single/index.html"> +<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html"> +<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html"> +<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html"> +<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> +<!ENTITY migrationlink "../../Exadel-migration/html_single/index.html"> + +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + <bookinfo> + <title>Visual Web Tools Reference Guide</title> + + <pubdate>April 2008</pubdate> + <copyright> + <year>2007</year> + <year>2009</year> + <holder>JBoss, a division of Red Hat</holder> + </copyright> + <releaseinfo> + Version: 2.0.0.GA + </releaseinfo> +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf/pdf/Vi... version</ulink> + </para> +</abstract> + + + </bookinfo> +<toc></toc> + + +<chapter id="Visual_Web_Tools" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/userguide/en/modules/Visual_Web_Tools.xml" xreflabel="Visual_Web_Tools"> + <?dbhtml filename="Visual_Web_Tools.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>JBDS</keyword> + <keyword>Java</keyword> + <keyword>Web Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Visual Web Tools</title> + + <para>This guide covers the usage of Visual Web Tools in <property moreinfo="none">JBoss Developer + Studio</property> and <property moreinfo="none">JBoss Tools</property>. The difference between these products is + that JBoss Tools are just a set of Eclipse plugins where JBoss Developer Studio adds the following functionality:</para> + <itemizedlist> + <listitem> + <para>an installer</para> + </listitem> + <listitem> + <para>Eclipse and Web Tools preconfigured</para> + </listitem> + <listitem> + <para>JBoss EAP with JBoss AS and Seam preconfigured</para> + </listitem> + <listitem> + <para>3rd party plugins bundled and configured</para> + </listitem> + <listitem> + <para>access to RHEL and Red Hat Network</para> + </listitem> + <listitem> + <para>access to the JBoss/Red Hat supported software</para> + </listitem> + </itemizedlist> + + <para>For additional information, please visit the JBoss Developer Studio home page at: <ulink url="http://www.jboss.com/products/devstudio">http://www.jbo... + + <para>In JBoss Tools there is an extensive collection of specialized wizards, editors and views + that can be used in various scenarios while developing Web applications. The following chapters + walk through these features.</para> + + <section id="key_features"> + <title>Key Features of Visual Web Tools</title> + <para>Here is the table of the main features of Visual Web Tools:</para> + + <table> + + <title>Key Functionality for Visual Web Tools</title> + <tgroup cols="3"> + + <colspec align="left" colnum="1" colwidth="2*"></colspec> + <colspec colnum="2" colwidth="4*"></colspec> + <colspec align="left" colnum="3" colwidth="2*"></colspec> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + <tbody> + <row> + <entry>Visual Page Editor</entry> + <entry>Powerful and customizable visual page editor. Possibility to develop an application + using any web technology: jsf, seam, struts, jsp, html and others. Developing using four + tabs: visual/source, visual, source and preview. Fast and easy switching between these tabs. + Split screen design of visual and source views. Full and instant synchronization between + source and visual views. Integration with properties and outline views. Graphical toolbar to + add inline styling to any tag.</entry> + <entry> + <link linkend="visual_page">visual page editor</link> + </entry> + </row> + + <row> + <entry>JBoss Tools Palette</entry> + <entry>Organizing various tags by groups, inserting tags into a jsp or xhtml page with one + click, adding custom or 3rd party tag libraries into the palette, easy controling the number + of tag groups shown on the palette.</entry> + <entry> + <link linkend="palette">jboss tools palette</link> + </entry> + </row> + + <row> + <entry>Web Projects View</entry> + <entry>Visualizing and displaying projects by function. Easy selecting of different kinds of + items and dropping them into jsp pages. Using context menus to develop the application. Using + icon shortcuts to create and import JSF and Struts projects. Expanding and inspecting tag + library files. Selecting custom and third-party tag libraries to drag and drop onto the JBoss + Tools Palette.</entry> + <entry> + <link linkend="web_projects">web projects view</link> + </entry> + </row> + + <row> + <entry>OpenOn</entry> + <entry>Easy navigation between views and other parts of your projects.</entry> + <entry> + <link linkend="OpenOnSelection4Hyperlinknavigation">openOn</link> + </entry> + </row> + + <row> + <entry>Content Assist</entry> + <entry>Code completion proposals while working with html, java, JavaScript , xml, jsp, xhtml, xhtml, seam project + and jsf configuration files. Content assist based on project data (dynamic code assist); with + graphical editor. Code completion for values from property files, beans attributes and + methods, navigation rule outcomes and jsf variables.</entry> + <entry> + <link linkend="CodeAssistAndDynamicCodeAssist42BasedOnProjectData">content assist</link> + </entry> + </row> + + <row> + <entry>Drag-and-Drop</entry> + <entry>Possibility of inserting any tag onto the page you are editing by just drag-and-droping + it from the palette to this page. Adding any properties, managed bean attributes, navigation + rules, tag library file declarations, jsp files from web projects view by clicking them and + draging to source code.</entry> + <entry> + <link linkend="visual_page">visual page editor</link> + <link linkend="DragAndDrop">drag-and-drop</link> + </entry> + </row> + + <row> + <entry>RichFaces Support</entry> + <entry>Tight integration between JBDS and <ulink url="http://www.jboss.org/jbossrichfaces">RichFaces</ulin... frameworks. Easy managing RichFaces + components in any web application. Support for RichFaces and Ajax4jsf libraries in JBoss + Tools Palette. Rendering RichFaces components in Visual Page Editor.</entry> + <entry> + <link linkend="RichFacesSupport"> RichFaces support</link> + </entry> + </row> + </tbody> + </tgroup> + </table> + </section> + +<section> + <title>Other relevant resources on the topic</title> + <para>All JBoss Developer Studio/JBoss Tools documentation you can find <ulink url="http://www.jboss.com/products/devstudio/docs">here</... + <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">her... +</section> + +</chapter> + + +<chapter id="springTools" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/userguide/en/modules/spring_tools.xml"> + <?dbhtml filename="springTools.html"?> + <title>Spring Tools</title> + + <para>JBoss Developer Studio is bundled with <ulink url="http://springide.org/project">Spring IDE</ulink> for Eclipse. + Visit Spring IDE site for the latest versions and documentation.</para> + + + <section> + <title><ulink url="http://springide.org/project/wiki/SpringideGuide">Spring IDE guide</ulink></title> + + <para><ulink url="http://springide.org/project">Spring IDE</ulink> is a graphical user interface for the configuration files used by the <ulink url="http://www.springframework.org/">Spring Framework</ulink>. It's built as a set of plugins for the Eclipse platform.</para> + + <section><title><ulink url="http://springide.org/project/wiki/SpringideGuide#AddProjectNatu... Spring Project Nature</ulink></title><para></para></section> + <section><title><ulink url="http://springide.org/project/wiki/SpringideGuide#CreateNewProje... New Spring Project</ulink></title><para></para></section> + <section><title><ulink url="http://springide.org/project/wiki/SpringideGuide#AddProjectRefe... References To Other Spring Projects</ulink></title><para></para></section> + <section><title><ulink url="http://springide.org/project/wiki/SpringideGuide#AddBeansConfig... Spring Beans Config Files</ulink></title><para></para></section> + <section><title><ulink url="http://springide.org/project/wiki/SpringideGuide#CreateBeansCon... Spring Beans Config Sets</ulink></title><para></para></section> + <section><title><ulink url="http://springide.org/project/wiki/SpringideGuide#OpenSpringExpl... Spring Explorer</ulink></title><para></para></section> + <section><title><ulink url="http://springide.org/project/wiki/SpringideGuide#ValidateBeansC... Spring Beans Config</ulink></title><para></para></section> + <section><title><ulink url="http://springide.org/project/wiki/SpringideGuide#OpenBeansGraph... Spring Beans Graph</ulink></title><para></para></section> + <section><title><ulink url="http://springide.org/project/wiki/SpringideGuide#SearchBeans&qu... Spring Beans</ulink></title><para></para></section> + + </section> + + </chapter> + + +<chapter id="jbds_editors" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/userguide/en/modules/editors.xml" xreflabel="jbds_editors"> + <?dbhtml filename="editors.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>JBDS</keyword> + <keyword>Editor</keyword> + </keywordset> + </chapterinfo> + + <title>Editors</title> + + <para>In the <ulink url="../../jsf_tools_ref_guide/html_single/index.html">JSF Tools Reference Guide</ulink> and <ulink url="../../struts_tools_ref_guide/html_single/index.html">Struts Tools Reference Guide</ulink> you had possibility to + read about Graphical Editor for <ulink url="../../jsf_tools_ref_guide/html_single/index.html#jsf_config_file">JSF</ulink> + and <ulink url="../../struts_tools_ref_guide/html_single/index.html#struts_config_editor">Struts</ulink> configuration + files, <ulink url="../../struts_tools_ref_guide/html_single/index.html#GraphicalEditorForTilesFiles132">Graphical Editor for + Tiles Files</ulink>, <ulink url="../../struts_tools_ref_guide/html_single/index.html#GraphicalEditorForStrutsValidationFiles86">Graphical Editor for + Struts Validation Files</ulink>. All these editors have <link linkend="OpenOnSelection4Hyperlinknavigation"> + <property moreinfo="none">OpenOn</property> + </link> and <link linkend="CodeAssistAndDynamicCodeAssist42BasedOnProjectData"> + <property moreinfo="none">Content Assist</property> + </link> features, which are described in more details in this document. In addition you get + to know a <link linkend="visual_page">Visual Page Editor</link> for combined visual and + source editing of Web pages and many <link linkend="more_editors">other editors</link> for + different types of files.</para> + + <section id="editors_features"> + + <title>Editors Features</title> + <para>JBoss Developer Studio has powerful editor features that help you easily navigate + within your application and make use of content and code assist no matter what project + file (jsp, xhtml, xml, css, etc...) you are working on.</para> + + <section id="OpenOnSelection4Hyperlinknavigation"> + + <title>OpenOn</title> + + <para><property moreinfo="none">OpenOn</property> lets you easily link directly from one resource to + another in your project without using the Package Explorer view (project tree). With + OpenOn, you can simply use <emphasis> + <property moreinfo="none">F3</property> + </emphasis> or <emphasis> + <property moreinfo="none">Ctrl+Click</property> + </emphasis> on a reference to another file and the file will be opened.</para> + + <para>OpenOn is available for the following files:</para> + <itemizedlist> + <listitem> + <para> + <link linkend="XMLFiles232">XML files</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="JSPPages223">JSP/XHTML Pages</link> + </para> + </listitem> + <listitem> + <para>Java files</para> + </listitem> + </itemizedlist> + <section id="XMLFiles232"> + + <title>XML Files</title> + + <para>Press and hold down the Ctrl key. As you move the mouse cursor over different + file references in the file, they display an underline. When you hover the name + of the file you want to open, click and the file will open in its own editor. In + this example the managed bean NameBean will open.</para> + <figure float="0"> + <title>NameBean Managed Bean</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>This is the result of using OpenOn.</para> + <figure float="0"> + <title>NameBean Java Class</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>You can also use OpenOn with defined attributes.</para> + <figure float="0"> + <title>OpenOn With Defined Attributes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>You can also open any JSP pages.</para> + <figure float="0"> + <title>JSP Page OpenOn</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="JSPPages223"> + + <title>JSP Pages</title> + + <para><property moreinfo="none">OpenOn</property> is also very useful in JSP pages. It will allow + you to quickly jump to the reference instead of having to hunt around in the + project structure.</para> + + <para>You can easily open the imported property files.</para> + <figure float="0"> + <title>OpenOn With Imported Property Files</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Use OpenOn to open a CSS file used with a JSP page:</para> + <figure float="0"> + <title>OpenOn With CSS File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Open managed beans:</para> + <figure float="0"> + <title>OpenOn With Managed Beans</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>For JSP files in a JSF project, you can also easily open the navigation rules + by applying <property moreinfo="none">OpenOn</property> to the JSF tag for the navigation + outcome:</para> + <figure float="0"> + <title>OpenOn With JSF Tag</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + </section> + + <section id="CodeAssistAndDynamicCodeAssist42BasedOnProjectData"> + + <title>Content Assist</title> + <para><property moreinfo="none">Content assist</property> is available when working with</para> + + <itemizedlist> + <listitem> + <para> + <ulink url="../../seam/html_single/index.html#ContentAssist">Seam project files</ulink> + </para> + + </listitem> + <listitem> + <para> + <link linkend="JSFProjectFiles3087">JSF project files</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="StrutsProjectFile46s3">Struts project files</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="JSPPages434">JSP files</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="ContentAssistForRF">RichFaces components</link> + </para> + </listitem> + <listitem> + <para> + <ulink url="../../esb_ref_guide/html_single/index.html#ESBContentAssist">ESB XML files</ulink> + </para> + </listitem> + </itemizedlist> + + <para>Notice, that code completion for EL variables has icons illustrating what they are + from. Currently it's performed for resource bundles, JSF and Seam + components.</para> + + <figure float="0"> + <title>JSF Content Assist</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_8d.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <figure float="0"> + <title>Seam Content Assist</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_8c.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Also, as you can see, the ranking and sorting are available in EL code + completions.</para> + + <section id="JSFProjectFiles3087"> + + <title>JSF Project Files</title> + + <para>When working with JSF project in JBoss Developer Studio, you can use various + <property moreinfo="none">Content Assist features</property> while developing:</para> + <itemizedlist> + <listitem> + <para>Content Assist for XML, JSP and JSF configuration files</para> + </listitem> + <listitem> + <para>Content Assist based on project data</para> + </listitem> + <listitem> + <para>Content Assist with graphical JSF editor</para> + </listitem> + </itemizedlist> + <section id="ContentAssistForXMLJSPAndJSFConfigurationFiles865"> + + <title>Content Assist for XML, JSP and JSF configuration files</title> + + <para>At any point when working with any XML, JSP and JSF configuration files + Content Assist is available to help you. Simply type <emphasis> + <property moreinfo="none">Ctrl-Space</property> + </emphasis> to see what is available.</para> + + <para>Content Assist for JSF configuration file:</para> + <figure float="0"> + <title>Content Assist in JSF Configuration File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_9.png" scale="85"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Content Assist for JSF JSP file:</para> + <figure float="0"> + <title>Content Assist in JSP File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_10.png" scale="85"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Content Assist for other JSF XML project files (web.xml shown):</para> + <figure float="0"> + <title>Content Assist in web.xml File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_11.png" scale="85"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="ContentAssistBasedOnProjectData86"> + + <title>Content Assist Based on Project Data</title> + + <para>JBoss Developer Studio takes Content Assist to the next level. Studio will + constantly scan your project and you will be able to insert code into the + JSP page from your project that includes:</para> + <itemizedlist> + <listitem> + <para>Values from Property files</para> + </listitem> + <listitem> + <para><emphasis role="italic"> + <property moreinfo="none">"Managed beans"</property> + </emphasis> attributes and methods</para> + </listitem> + <listitem> + <para>Navigation Rule Outcomes</para> + </listitem> + <listitem> + <para>JSF variables (context, request etc...)</para> + </listitem> + </itemizedlist> + <para>The figure below shows how to insert message from a Properties files. You + simply put the cursor inside the <emphasis role="italic"> + <property moreinfo="none">"value"</property> + </emphasis> attribute and press <emphasis> + <property moreinfo="none">Ctrl-Space</property>. </emphasis> JBoss Developer Studio will + scan your project and show a list of possible values to insert.</para> + <figure float="0"> + <title>Inserting Message</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_12.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>In the following screenshot we are inserting a <emphasis role="italic"> + <property moreinfo="none">"Managed bean"</property> + </emphasis> attribute value. Again, by simply clicking + <emphasis><property moreinfo="none">Ctrl-Space</property>,</emphasis> JBoss + Developer Studio will show a list of all possible values that you can + insert.</para> + + <para>Once you select a Managed bean, it will show you a list of all available + attributes for the selected Managed bean (userBean).</para> + <figure float="0"> + <title>Attributes List</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_13.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Code Assist based on project data will also prompt you for navigation + rules that exist in your JSF configuration file.</para> + <figure float="0"> + <title>Code Assist</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_14.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Code Assist can also provide you with access to the beans located in jar archives.</para> + + <figure float="0"> + <title>Code Assist: accessing beans in jar archives</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_14_a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + <section id="ContentAssistWithinJSFGraphicalEditor44"> + + <title>Content Assist within Tree JSF Editor</title> + + <para>JBoss Developer Studio also provides Content Assist when working within + the Tree JSF configuration editor. Just click <emphasis> + <property moreinfo="none">Ctrl-Space</property>. </emphasis></para> + <figure float="0"> + <title>Content Assist in Tree JSF Configuration Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_15.png" scale="85"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <!-- + + <para>If a field contains right class name and you click a link near the + field you will come to the file with this class otherwise a new Java + Class dialog will be shown:</para> + <figure> + <title>New Java Class</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/editors_features/editors_features_16.png"/> + </imageobject> + </mediaobject> + </figure> + <para>If you entered an incorrect name in the field error markers will be + shown for field labels and tree items:</para> + <figure> + <title>Error Markers</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/editors_features/editors_features_17.png"/> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>To add a new property to a managed bean expand <emphasis> + <property>Managed Beans</property> + </emphasis> and select <emphasis role="bold"> + <property>&lt;name_of_bean&gt;</property> + </emphasis></para> + </listitem> + <listitem> + <para>Click <emphasis> + <property>Add</property> + </emphasis> button in the Properties panel</para> + </listitem> + <listitem> + <para>In the dialog Add Property define a new property. From here + also you can generate setters and getters methods:</para> + </listitem> + </itemizedlist> + <figure> + <title>Create New Property</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/editors_features/editors_features_18.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Here you can also add an additional navigation rule to the + faces-config.xml file.</para> + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property>Navigation Rules</property> + </emphasis></para> + </listitem> + <listitem> + <para>Click <emphasis> + <property>Add</property> + </emphasis> button</para> + </listitem> + <listitem> + <para>In the dialog <emphasis> + <property>Add Rule</property> + </emphasis> define a view and give a name to the rule. Click + Finish:</para> + </listitem> + </itemizedlist> + <figure> + <title>Add New Navigation Rule</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/editors_features/editors_features_19.png"/> + </imageobject> + </mediaobject> + </figure> + + --> + </section> + </section> + + <section id="StrutsProjectFile46s3"> + <title>Struts Project Files</title> + <para>Content Assist features are available when you work with Struts + projects.</para> + + + <section id="ContentAssistForStrutsConfigurationFile75"> + + + <title>Content Assist for Struts Configuration File</title> + + <para>Content Assist helps you in Struts Configuration file.</para> + + <figure float="0"> + <title>Struts Content Assist</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_20.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="ContentAssistForStrutsJSPFile07"> + + <title>Content Assist for Struts JSP File</title> + + <para>Using Code Assist in Struts JSP file is shown below.</para> + + <figure float="0"> + <title>Struts JSP Content Assist</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_21.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + <section id="JSPPages434"> + + <title>JSP Pages</title> + + + <section id="ContentAssistForJSFTags96"> + + <title>Content Assist for JSF Tags</title> + <para>JBDS provides full code completion for JSF tags:</para> + + <figure float="0"> + <title>JSF Tags Content Assist</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_22.png" scale="85"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>When the tag is selected the required attributes, if there any, are + already inserted and the cursor is located to the first attribute. At this + point you can ask for attribute proposals.</para> + <figure float="0"> + <title>Attributes Content Assist</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_23.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + <section id="ContentAssistForJSTLTags6332"> + + <title>Content Assist for JSTL Tags</title> + <figure float="0"> + <title>JSTL Tags Content Assist</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_24.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="ContentAssistForHTMLTags7454"> + + <title>Content Assist for HTML Tags</title> + <para>Content assist for HTML tags has the same mechanism as for JSF + tags:</para> + <figure float="0"> + <title>HTML Tags Content Assist</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_25.png" scale="60"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>You can use as well attributes proposals for HTML tags:</para> + <figure float="0"> + <title>HTML Tags Content Assist</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_26.png" scale="60"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="ContentAssistForJavaScriptTags67433"> + + <title>Content Assist for JavaScript Tags</title> + <figure float="0"> + <title>JavaScript Tags Content Assist</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_27.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + + <section id="AddingDynamicCodeAssistToCustomComponents8745"> + + <title>Adding dynamic code assist to custom components that were added to JBoss + Tools Palette</title> + <para>Here is what you need to do to add project based code assist to a custom + component added in <property moreinfo="none">JBoss Developer Studio</property>:</para> + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>Create a new xml file in <emphasis> + <property moreinfo="none">&lt;JBDS_home&gt;studio/eclipse/plugins/org.jboss.tools.common.kb_***/schemas/tld/</property>. + </emphasis>For example call it <emphasis> + <property moreinfo="none"> JeniaFaces.xml</property> + </emphasis>. The file should be written according to <emphasis> + <property moreinfo="none">&lt;JBDS_home&gt;/studio/eclipse/plugins/org.jboss.tools.common.kb/kb.jar/org/jboss/tools/common/kb/kb-schema_1.0.dtd</property> + </emphasis></para> + </listitem> + </orderedlist> + <para>Follow these steps to set what is available for code assist:</para> + <itemizedlist> + <listitem> + <para>Adds code assist for JSF pre-defined objects, such as + <![CDATA[value=]]><emphasis role="italic"> + <property moreinfo="none">"#{param}"</property> + </emphasis>:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="XML"><![CDATA[<AttributeType ...> + <proposal type="jsfVariables"/> +</AttributeType> +]]></programlisting> + <itemizedlist> + <listitem> + <para>Add bundle resource (property file) <property moreinfo="none">code + assist</property>:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="XML"><![CDATA[<AttributeType ...> + <proposal type="bundleProperty"/> +</AttributeType> +]]></programlisting> + <itemizedlist> + <listitem> + <para>Add managed bean property <property moreinfo="none">code assist</property>:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="XML"><![CDATA[<AttributeType ...> + <proposal type="beanProperty"/> +</AttributeType> +]]></programlisting> + <itemizedlist> + <listitem> + <para>Add managed bean property but of a specified type:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="XML"><![CDATA[<AttributeType ...> + <proposal type="beanProperty"> + <param name="type" value="java.lang.Boolean"/> + </proposal> +</AttributeType> +]]></programlisting> + <itemizedlist> + <listitem> + <para>Add managed bean method with a signature:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="XML"><![CDATA[<AttributeType ...> + <proposal type="beanMethodBySignature"> + <param name="paramType" value="javax.faces.context.FacesContext"/> + <param name="paramType" value="javax.faces.component.UIComponent"/> + <param name="paramType" value="java.lang.Object"/> + <param name="returnType" value="void"/> + </proposal> +</AttributeType> +]]></programlisting> + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>Add information on your xml file in <emphasis> + <property moreinfo="none">&lt;JBDS_home&gt;/studio/eclipse/plugins/org.jboss.common.kb_***/plugin.xml</property> + </emphasis></para> + <programlisting format="linespecific" role="XML"><![CDATA[ + <tld + jsf="true" + name="Jenia Faces" + schema-location="schemas/tld/myJSF.xml" + uri="http://www.jenia.org/jsf/dataTools"/>]]> + </programlisting> + </listitem> + + <listitem> + <para>Restart Eclipse. You should now have code assist for the + component.</para> + </listitem> + </orderedlist> + + </section> + </section> + <section id="FullControlOverSourceFiles-SynchronizedSourcAndVisualEditing74"> + + <title>Synchronized Source and Visual Editing</title> + + <para><property moreinfo="none">JBoss Developer Studio</property> offers the flexibility to edit any + files in either source or extra visual modes at the same time.</para> + + <para>The project is yours and so is the source. <property moreinfo="none">JBoss Developer + Studio</property> provides you many different graphical editors to speed your + application development. At the same time, you always have a full control over all + project source files. Any changes you make in the source view immediately appear in + the graphical view.</para> + + <para>The JSF configuration file editor has three views: <property moreinfo="none">Diagram</property>, + <property moreinfo="none">Tree</property> and <property moreinfo="none">Source</property>. All views are + synchronized, you can edit the file in any view.</para> + <figure float="0"> + <title>Three Views are Synchronized</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_32.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The same is relevant to all other <property moreinfo="none">JBoss Developer Studio</property> + editors.</para> + + <para>Web XML editor is shown. Web XML editor has a graphical view (Tree) and source + (Source).</para> + + <figure float="0"> + <title>Two Views are Synchronized</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_35.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para><property moreinfo="none">JBoss Developer Studio</property> TLD file editor is shown in Tree view. + At any point you can edit the source by switching to Source view.</para> + <figure float="0"> + <title>Two Views are Synchronized</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_37.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + </section> + <section id="visual_page" role="updated"> + + <title>Visual Page Editor</title> + + <para><property moreinfo="none">JBoss Developer Studio</property> comes with a powerful and customizable + <property moreinfo="none">Visual Page Editor</property> (VPE). You can use the Visual Page Editor to + develop an application using any technology: JSF, Struts, JSP, HTML and others. Double-click on the necessary file in the Package Explorer view to open it in the Visual Editor or just drag-and-drop it into perspective (the drag-and-drop feature can be also applied to JSP, XHTML or HTML files created locally).</para> + + <para>Current VPE version has three tabs: <property moreinfo="none">Visual/Source</property>, + <property moreinfo="none">Source</property> and <property moreinfo="none">Preview</property>. To switch between the + views you can use tabs at the bottom of the VPE or the shortcuts <emphasis> + <property moreinfo="none">Ctrl + PageUp/Ctrl + PageDown</property> + </emphasis>.</para> + + <figure float="0"> + <title>Visual Page Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_1.png" scale="95"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <section id="visual_source"> + <title>Visual/Source View</title> + + <para>Using the <property moreinfo="none">Visual/Source view</property> you can edit your pages in the + Source and Visual modes simultaneously having an instant synchronization between + them:</para> + <figure float="0"> + <title>Visual/Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_2.png" scale="95"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The view is designed in the form of a split pane with toggle buttons for quickly + moving between Source, Visual or Source/Visual modes as shown on the figure + above.</para> + + <para>One more way to toggle between the various states of the split pane is using the + shortcuts <emphasis> + <property moreinfo="none">Shift + F6</property> + </emphasis> for maximizing/restoring the Source part and <emphasis> + <property moreinfo="none">Shift + Alt + F6</property> + </emphasis> for maximizing/restoring the Visual part.</para> + <tip> + <title>Tip:</title> + <para>When editing large documents hiding the Visual part will speed up the + editing.</para> + </tip> + + <para>It should be pointed out that, no matter in what mode you are working, you get a + full integration with <property moreinfo="none">Properties</property> and <property moreinfo="none">Outline + views</property>:</para> + <figure float="0"> + <title>Integration with Properties and Outline Views</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_3.png" scale="55"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>It's also possible to use the <link linkend="palette">JBoss Tools + Palette</link> to insert any tag from the list of tag libraries to the page you + are editing with just a click or drag-and-drop.</para> + <figure float="0"> + <title>Inserting Tag From the Palette</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para> You can insert a tag/component from the palette into either the Source or the + Visual part by calling a context menu and selecting <property moreinfo="none">Insert + around</property>, <property moreinfo="none">Insert before</property>, <property moreinfo="none">Insert + after</property> or <property moreinfo="none">Replace With</property>, pointing to + <property moreinfo="none">From Palette</property>, picking the type of the tag and finally + choosing the tag you want to insert. </para> + + <para>The image below illustrates how you can insert a tag into the Source part.</para> + <figure float="0"> + <title>Inserting a tag into the Source part </title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_23a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>And this is how a tag is inserted using a context menu in the Visual part.</para> + + <figure float="0"> + <title>Inserting a tag into the Visual part</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_23b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para><property moreinfo="none">Visual Page Editor</property> provides the option for displaying + non-visual tags in Visual mode of the editor. To enable this option expand the + submenu in the top left corner of the Visual part and select <emphasis> + <property moreinfo="none">Show Non-visual tags</property>.</emphasis></para> + + <figure float="0"> + <title>Enabling the Option for Showing Non-visual Tags</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_4a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>On the figure you can see non-visual elements with gray dashed borders.</para> + + <figure float="0"> + <title>Non-visual Tag in the VPE</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_4b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>To disable this option again expand the same submenu and select <emphasis> + <property moreinfo="none">Hide Non-visual tags</property>.</emphasis></para> + + <figure float="0"> + <title>Non-visual Tag in the VPE</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_4c.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <section id="comments"> + <title>Commenting out Code</title> + + <para><property moreinfo="none">VPE</property> supports possibility to add comments in files you are + working with (JSP, XHTML, etc.):</para> + + <itemizedlist> + <listitem> + <para>HTML comments (<emphasis> + <property moreinfo="none">&lt;!-- --&gt;</property> + </emphasis>) which are output to the client </para> + </listitem> + <listitem> + <para>JSP comments (<emphasis> + <property moreinfo="none">&lt;%-- --%&gt;</property> + </emphasis>) which are not output to the client as part of the JSP page + output</para> + </listitem> + </itemizedlist> + </section> + + <section id="codefolding"> + <title>Using Code Folding</title> + <para> + <property moreinfo="none">Visual Page Editor</property> lets you collapse (hide) and expand + (show) sections of your code to make it easier to navigate and read. </para> + <para>Code folding can be enabled by right-clicking on the left margin on the Source + part of Visual Page Editor, selecting <property moreinfo="none">Folding</property> and checking + the <property moreinfo="none">Enable Folding</property> checkbox or using the <emphasis> + <property moreinfo="none">Ctrl+Numpad_Divide</property> + </emphasis> shortcut.</para> + <para>When the code folding is enabled a minus sing ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_23c.png"></imagedata> + </imageobject> + </inlinemediaobject> ) will appear on the left margin of the editor next to each + opening block tag. </para> + + <figure float="0"> + <title>Enabled Code Folding </title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_24a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Click the minus sign to collapse a block tag.</para> + + <para>When the minus sing is clicked on the appropriate tag collapses and a plus + sing ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_23d.png"></imagedata> + </imageobject> + </inlinemediaobject> ) is displayed on the left margin as well as a gray + rectangle two dots ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_23e.png"></imagedata> + </imageobject> + </inlinemediaobject> ) appears after opening and closing tags. </para> + + <figure float="0"> + <title>Collapsed Code</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_24b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="JSPsyntaxvalidation84"> + + <title>JSP Syntax Validation</title> + <para>When working in JBoss Tools JSP editor you are constantly provided with + feedback and contextual error checking as you type.</para> + </section> + + <section id="taglib_versions_support"> + <title>Support for Taglib versions</title> + + <para>VPE templates now support various versions of tag libraries. It means that the + <property moreinfo="none">VPE</property> takes control over those components which have + different parameters or preview according to the framework version (like seam + 1.2 and seam 2.0, or JSF 1.1 and JSF 1.2).</para> + + <para>For example, <emphasis> + <property moreinfo="none">&lt;s:decorate&gt;</property> + </emphasis> element in seam has different parameters in versions 1.2 and 2.0 as + well as <emphasis> + <property moreinfo="none">&lt;h:outputLink&gt;</property> + </emphasis> JSF element has different preview in versions 1.1 and 1.2.</para> + </section> + </section> + + <section id="pages_styling"> + <title>Pages Styling</title> + + <para>Most web pages use the cascading style sheets (CSS) to control the way they look. + With <property moreinfo="none">Visual Page Editor</property> you can easily stylise your pages. In + this section we are going to introduce you to a powerful mechanism that + <property moreinfo="none">VPE</property> provides for a complete control over pages styling. </para> + + <section id="inline_styling"> + <title>Inline Style Editing</title> + + <para>In the Visual part of the <property moreinfo="none">VPE</property> there is a graphical + toolbar, use it to add inline styling to JSF and Struts tags on your page. The + toolbar can be hidden by clicking on arrow sign in the upper left corner.</para> + + <figure float="0"> + <title>Text Formatting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>For editing inline styles for DOM elements <property moreinfo="none">VPE</property> also + provides <property moreinfo="none">CSS Dialog</property>. It can be called from <emphasis> + <property moreinfo="none">style</property> + </emphasis> line in the <property moreinfo="none">Properties view</property> for a currently + selected element.</para> + + <figure float="0"> + <title>Call the CSS Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para id="css_dialog"><property moreinfo="none">CSS Dialog</property> has four tabs where css + properties for text, background, borders and others can be specified. A simple + preview which is generated at the top of the <property moreinfo="none">CSS Dialog</property> + allows you to see the changes before you apply them.</para> + + <figure float="0"> + <title>CSS Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="external_stylesheets"> + <title>External Stylesheets</title> + <para>The pages you are working with in <property moreinfo="none">VPE</property> can use external + stylesheets. <property moreinfo="none">VPE</property> allows you to create new style classes in + existing stylesheets and/or edit them as well. For these purposes <property moreinfo="none">CSS + Style Class Dialog</property> is provided (hot keys - <emphasis> + <property moreinfo="none">CTRL+SHIT+C</property>).</emphasis></para> + <para>Select the element for which you need to create or edit style class and press + button next to <emphasis> + <property moreinfo="none">styleClass</property> + </emphasis> field in <property moreinfo="none">Properties view</property>.</para> + + <figure float="0"> + <title>Calling the CSS Style Class Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_17.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>It'll pick up the <property moreinfo="none">CSS Style Class Dialog</property> which + looks like on the figure below.</para> + <figure float="0"> + <title>CSS Style Class Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_18.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>First, you should specify the CSS file where you are going to put your style + class. Do this by pressing the button next to the <emphasis> + <property moreinfo="none">CSS file</property> + </emphasis> field.</para> + <figure float="0"> + <title>CSS File Selection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_19.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>To create new CSS class write its name in the <emphasis> + <property moreinfo="none">Style class</property> + </emphasis> field and then configure style settings switching between the tabs: <emphasis> + <property moreinfo="none">Text/Font</property>, </emphasis> + <emphasis> + <property moreinfo="none">Background</property>, </emphasis> + <emphasis> + <property moreinfo="none">Boxes</property>, </emphasis> + <emphasis> + <property moreinfo="none">Property Sheet</property>. </emphasis>The list of already exisiting classes with names begining with the symbols printed will be displayed on standard "Ctrl+Space" key combination. To add existing styling to + the chosen element just point to the + necessary one. Each time you select any class it is displayed in the Preview tab. Click on the <emphasis><property moreinfo="none">Apply</property></emphasis> button will apply the changes without closing the window.</para> + + <figure float="0"> + <title>Style Class Selection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_20.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The <emphasis> + <property moreinfo="none">Edited properties</property> + </emphasis> tab gives a preview of the properties which are set for the existing + style class. You can easily modify them with the help of this wizard.</para> + + <figure float="0"> + <title>Edited Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_21.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>If the style class isn't chosen, the tab doesn't show any properties.</para> + + <figure float="0"> + <title>Edited Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/edited_properties.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The <emphasis> + <property moreinfo="none">Preview tab</property> + </emphasis> is for observing the content of the chosen CSS file. This tab is hidden if no CSS file is chosen.</para> + + <figure float="0"> + <title>Preview Tab</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/preview_tab.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>At the top of the <property moreinfo="none">CSS Style Class Dialog</property> + you can see a preview box which visualizes the result. To edit the preview you should double click in the box. To leave the focus, use <emphasis> + <property moreinfo="none">Ctrl + Tab</property>.</emphasis></para> + + <figure float="0"> + <title>Editing the Preview</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/preview_box.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The dialog for creating a new CSS class, which is called from <emphasis> + <property moreinfo="none">New &gt; Other... &gt; JBoss Tools Web &gt; CSS Class</property>, + </emphasis> looks the same.</para> + + <figure float="0"> + <title>New CSS Class Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_22.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + + <section id="vpe_templating"> + <title>Templating</title> + + <para>The VPE also makes it possible to create templates for unknown tags.</para> + + <para>To call the <property moreinfo="none">Template dialog</property> for a tag, right-click on it in + Visual mode and select <emphasis> + <property moreinfo="none">Setup Template for &lt;tag name&gt;</property> + </emphasis> option.</para> + + <figure float="0"> + <title>Calling Template Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_7a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para id="template_dialog">Here is what the <property moreinfo="none">Template dialog</property> looks + like.</para> + + <figure float="0"> + <title>Template Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_7b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para><emphasis> + <property moreinfo="none">Tag for Display</property> + </emphasis> field in the <property moreinfo="none">Template dialog</property> requires specifying a + type of tag. It can be SPAN, DIV, TABLE or any other html element. Check <emphasis> + <property moreinfo="none">Children</property> + </emphasis>, if you want to mark a tag as a child element.</para> + + <para>The <emphasis> + <property moreinfo="none">Value</property> + </emphasis> field is for setting a tag value.</para> + <para>As for the <emphasis> + <property moreinfo="none">Style</property> + </emphasis> field, you can fill it out manually or make use of the button next to + the field to bring the <link linkend="css_dialog">CSS Dialog</link> for editing + styles.</para> + + <para>You can observe all defined templates in the <link linkend="VisualPageEditor2">VPE + Preferences</link> on the Templates tab which you can quickly access by pressing + <link linkend="AdvancedSettings954">Preferences button</link>.</para> + + <figure float="0"> + <title>Templates Tab of the VPE Preferences Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_7c.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Here it's possible to edit or remove any listed in the table + template.</para> + + </section> + + <section id="AdvancedSettings954"> + + <title>Advanced Settings</title> + + <para>In the left vertical pane of the Visual part there are three buttons: <emphasis> + <property moreinfo="none">Preferences</property></emphasis> + ( + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/visual_page/icon_1.png"></imagedata> + </imageobject> + </inlinemediaobject> + ), + + + + + <emphasis> + <property moreinfo="none">Refresh</property> + </emphasis> + ( + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/visual_page/icon_2.png"></imagedata> + </imageobject> + </inlinemediaobject> + ) + and <emphasis> + <property moreinfo="none">Page Design Options</property> </emphasis>( + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/visual_page/icon_3.png"></imagedata> + </imageobject> + </inlinemediaobject> + ) + + .</para> + + <figure float="0"> + <title>Buttons on the Visual Part of VPE</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem id="vpe_preferences"> + <para><emphasis> + <property moreinfo="none">Preferences</property> + </emphasis> button + ( + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/visual_page/icon_1.png"></imagedata> + </imageobject> + </inlinemediaobject> + ) + + + + + + provides a quick access to <property moreinfo="none">Visual Page + Editor</property> preferences.</para> + + <figure float="0"> + <title>Visual Page Editor Preferences Window</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>Clicking on <emphasis> + <property moreinfo="none">Refresh</property> + </emphasis> button + + + ( + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/visual_page/icon_2.png"></imagedata> + </imageobject> + </inlinemediaobject> + ) + + + + + + + + you refresh the displayed information.</para> + </listitem> + + <listitem> + <para><emphasis> + <property moreinfo="none">Page Design Options</property> + </emphasis> button + ( + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/visual_page/icon_3.png"></imagedata> + </imageobject> + </inlinemediaobject> + ) + + + leads to a window which helps you specify necessary + references of the resources. It is represented by a window with 4 tabs. The + first one, <emphasis> + <property moreinfo="none">Actual Run-Time folders</property>, + </emphasis> is used to replace absolute and relative path values when + generating a preview: </para> + <figure float="0"> + <title>Page Design Options: Actual Run-Time folders</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_10.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para>The second tab, <emphasis> + <property moreinfo="none">Included CSS files</property> + </emphasis>, is used to add CSS files to be linked by Visual Page Editor + when generating a preview:</para> + + <figure float="0"> + <title>Page Design Options: Included CSS files</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_10_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + + + <para>The third one, <emphasis> + <property moreinfo="none">Included tag libs</property></emphasis>, can be used to add Taglibs that can be used by the editor for + getting appropriate templates to generate a preview:</para> + + <figure float="0"> + <title>Page Design Options: Included tag libs</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_10_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>And finally, the <emphasis> + <property moreinfo="none">Substituted El expressions</property> + </emphasis> tab is used to add El expressions that will be substituted by + the editor when generating a preview:</para> + + <figure float="0"> + <title>Page Design Options: Substituted El expressions</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_10_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para>The first two tabs of the window let you define actual runtime folders. + The example below will help you understand how this can be done.</para> + + <para>Suppose you have the following project structure:</para> + + <programlisting format="linespecific" role="XML"><![CDATA[WebContent/ + pages/ + img/ + a.gif + header.jsp + main.jsp + ]]></programlisting> + + <para>The content of the <emphasis> + <property moreinfo="none">header.jsp</property> + </emphasis> is:</para> + <programlisting format="linespecific" role="XML"><![CDATA[My Header +<img src="img/a.gif"/> +]]></programlisting> + <para>and <emphasis> + <property moreinfo="none">main.jsp</property> + </emphasis> content is:</para> + <programlisting format="linespecific" role="XML"><![CDATA[<jsp:include page="pages/header.jsp" /> +]]></programlisting> + <para> When you open <emphasis> + <property moreinfo="none">main.jsp</property> + </emphasis> in <property moreinfo="none">Visual Page Editor</property>, it will not be able + to resolve the image from the header, however, it will work fine in runtime. + To fix this in design time, click the <emphasis> + <property moreinfo="none">Page Design Options</property> + </emphasis> button and set <emphasis> + <property moreinfo="none">Actual Run-Time Relative Folder</property> + </emphasis> to <emphasis>'projectName &gt; WebContent &gt; + pages'</emphasis> and you will see the image appeared.</para> + <para></para> + + <para>Let' consider an example for other tabs. For instance, the + definition of your CSS on the page is the next:</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<link rel="stylesheet" type="text/css" + href="#{facesContext.externalContext.requestContextPath}/style.css"/> +]]></programlisting> + + <para>This will work fine in runtime, but the <property moreinfo="none">Visual Page + Editor</property> doesn't know what + <emphasis>requestContextPath</emphasis> in design time is. In order to + see the necessary styles applied in design time your should add a path to + your stylesheet in the <property moreinfo="none">CSS File Path</property> section.</para> + + <para>The next <property moreinfo="none">URI</property> section lets you add URI taglibs so that + the editor knows where to find the tag libraries.</para> + + <para>And the last <property moreinfo="none">Substituted EL expressions</property> section is + provided to specify the values for specific EL variables. It can be useful + for a preview generation.</para> + <para>As an example look at the figure below:</para> + <figure float="0"> + <title>EL Expression</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_12.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Here bath in Source and Visual modes you see the EL expression + <emphasis>#{user.name}</emphasis>. When you switch to <property moreinfo="none">Preview + view</property>, you'll also see this expression. Now press <emphasis> + <property moreinfo="none">Page Design Options</property> + </emphasis> button and set the value for the + <emphasis>"user.name"</emphasis> as + <emphasis><property moreinfo="none">World</property>.</emphasis></para> + + <figure float="0"> + <title>Setting the Value for the EL Expression</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_13.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>As a result in Visual mode and Preview view the word <emphasis> + <property moreinfo="none">World</property> + </emphasis> is displayed.</para> + <figure float="0"> + <title>The EL Expression Value</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_14.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + </itemizedlist> + + <para>You can find useful one more functionality provided by VPE. At the bottom of the + <property moreinfo="none">Visual/Source view</property> there is a <property moreinfo="none">Selection Tag + Bar</property>. It allows to see tags tree for a current component selected in + Visual or Source mode.</para> + + <figure float="0"> + <title>Selection Tag Bar</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_15.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>If you want to hide the <property moreinfo="none">Selection Tag Bar</property>, use the button in + the form of a red cross on the lower right side. To reset it again you should check + the proper option in the <link linkend="vpe_preferences">VPE + Preferences</link>.</para> + </section> + + <section id="page_preview"> + <title>Page Preview</title> + + <para><property moreinfo="none">VPE</property> comes with design-time preview feature which is available + for:</para> + + <itemizedlist> + <listitem> + <para>Struts Pages</para> + </listitem> + <listitem> + <para>JSF Pages</para> + </listitem> + </itemizedlist> + + <para><property moreinfo="none">Preview view</property> is read-only, it shows how the page will look + like in a browser.</para> + <figure float="0"> + <title>Preview View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/visual_page/visual_page_16.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <!--para>You can even + attach your stylesheet to the preview.</para--> + </section> + + <section id="SetupnotesforLinu895x"> + + <title>Setup notes for Linux</title> + + <para>Linux users may need to do the following to get the <property moreinfo="none">Visual Page + Editor</property> to work correctly on their machines.</para> + + <para> The Visual Page Editor requires the library libstdc++.so.5. This library is + contained in the compat-libstdc++-33.i386 package.</para> + + <itemizedlist> + <listitem> + <para>To install this package on Fedora Core or Red Hat Enterprise Linux run the + following command:</para> + <programlisting format="linespecific" role="JAVA"><![CDATA[yum install compat-libstdc++-33.i386 +]]></programlisting> + </listitem> + + + <listitem> + <para>On any other rpm based distributions download libstdc++.so.5 and run the + following command:</para> + <programlisting format="linespecific" role="JAVA"><![CDATA[rpm -Uvh compat-libstdc++-33.i386 +]]></programlisting> + </listitem> + + + <listitem> + <para>On Debian based distributives run the following command: </para> + <programlisting format="linespecific" role="JAVA"><![CDATA[apt-get install compat-libstdc++-33.i386 +]]></programlisting> + </listitem> + + </itemizedlist> + + <para> In case you have the library installed and you still have issue with starting the + visual page editor then close all browser views/editors and leave one visual page + editor open and restart eclipse. This should force a load of the right XULRunner + viewer.</para> + + </section> + + <!-- <section id="CreateLookAndFeel(Design-timeMetadate)ForAnyCustomJSFComponents41"> +<?dbhtml filename="CreateLookAndFeel(Design-timeMetadate)ForAnyCustomJSFComponents.html"?> +<title>JSP Visual Page Editor - Design Time Look and Feel for Custom Components</title> + +<itemizedlist> +<listitem><ulink url="http://www.jboss.org/404.html">Template definition for design-time representation of custom tags</ulink> (pdf) +<para></para> + <note> + <title>Note:</title> + <para>The templates files are now saved in <emphasis>&lt;RedHatDeveloperStudio&gt;\eclipse\plugins\com.exadel.vpe_1.1.1\plugin.xml</emphasis>. The PDF files show the old location.</para> + </note> +<para></para></listitem> + +<listitem><ulink url="http://www.jboss.org/404.html">Steps to Create Plug-in</ulink> (pdf)</listitem> +<listitem><ulink url="index.html">How to use create(..) method</ulink> (pdf)</listitem> +<listitem>API +<itemizedlist> +<listitem><ulink url="http://www.jboss.org/404.html">VpeAbstractTemplate</... +<listitem><ulink url="http://www.jboss.org/404.html">VpeTemplate</ulink>... +<listitem><ulink url="http://www.jboss.org/404.html">Download</ulink> examples. The examples.zip file contains two + applications. The first application transforms the JSP source tag into visual tag (HTML). This application + is an Eclipse plug-in. Import as an Eclipse project. The second application is a Web applications which + uses the custom component (project with JSF Nature).</listitem> +</itemizedlist> +<para>Please send us an email to <ulink url="mailto:support@exadel.com">support@exadel.com</ulink> if you have + questions about this feature.</para> +</section> + + +<section id="HTML401Suppor421t"> +<?dbhtml filename="HTML4.01Support.html"?> +<title>HTML 4.01 Support</title> +</section> + +<section id="JSP2.0JSTL1.0And1.1Suppor52t"> +<?dbhtml filename="JSP2.0JSTL1.0And1.1Support.html"?> +<title>JSP 2.0, JSTL 1.0/1.1 support</title> +</section> +--> + + </section> + + <section id="more_editors"> + + <title>More Editors</title> + + <para>Besides Visual Page Editor JBDS is supplied with a huge range of various editors for + different file types: properties, TLD, web.xml, tiles, and so on.</para> + <section id="GraphicalPropertiesEditor"> + + <title>Graphical Properties Editor</title> + + <para><property moreinfo="none">The Properties editor</property> allows you to work in two different + modes and also supports unicode characters.</para> + + <para>To create a new properties file, in the Package Explorer view, select<emphasis> + <property moreinfo="none"> New &gt; Properties File</property> + </emphasis> from the right-click context menu on the folder where you want to create + the file.</para> + <figure float="0"> + <title>Selecting Properties File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>You can edit the file using a table-oriented "Properties" + viewer:</para> + + <figure float="0"> + <title>"Properties" Viewer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>You can also use a Source viewer for editing the file:</para> + <figure float="0"> + <title>Source Viewer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="GraphicalTLDEditor"> + + <title>Graphical TLD Editor</title> + + <para><property moreinfo="none">The TLD editor</property> comes with same features you will find in all + other JBoss Developer Studio editors:</para> + + <itemizedlist> + <listitem> + <para>Graphical and source edit modes</para> + </listitem> + <listitem> + <para>Validation and error checking</para> + </listitem> + </itemizedlist> + <section id="TreeView2"> + + <title>Tree view</title> + + <figure float="0"> + <title>Tree View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="SourceView1"> + + <title>Source view</title> + + <para>You can easily switch from Tree to Source by selecting the Source tab at the + bottom of the editor.</para> + + <figure float="0"> + <title>Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>You can easily add a <property moreinfo="none">new tag</property>:</para> + + <figure float="0"> + <title>Adding a New Tag</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_6.png" scale="85"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>You can also easily add a <property moreinfo="none">new attribute</property> to an existing + tag:</para> + <figure float="0"> + <title>Adding a New Attribute</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_7.png" scale="85"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Content assist is available when editing the file using the Source + viewer:</para> + + <figure float="0"> + <title>Content Assist</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_8.png" scale="65"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In the Source viewer, if at any point a tag is incorrect or incomplete, an + error will be indicated next to the line and also in the Problems view + below.</para> + + <figure float="0"> + <title>Error Reporting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + + + <section id="GraphicalWebApplicationFileEditor"> + + <title>Graphical Web Application File (web.xml) Editor</title> + + <para>The Web Application File editor comes with the same features you will find in all + other JBoss Developer Studio editors:</para> + + <itemizedlist> + <listitem> + <para>Graphical and source edit modes</para> + </listitem> + <listitem> + <para>Validation and error checking</para> + </listitem> + </itemizedlist> + <section id="TreeView1"> + <title>Tree View</title> + + <figure float="0"> + <title>Tree View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_10.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>You can add any new elements right in the <property moreinfo="none">Tree + viewer</property>:</para> + + <figure float="0"> + <title>Adding New Elements</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_11.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="SourceView2"> + + <title>Source View</title> + + <para>Switch to the <property moreinfo="none">Source viewer </property>to edit the web.xml file by + hand at any time:</para> + + <figure float="0"> + <title>Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_12.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="ContentAssist"> + + <title>Content Assist</title> + + <para>Content assist is available in the Source viewer. Simply click <emphasis> + <property moreinfo="none">CTRL-Space</property> + </emphasis> anywhere in the file.</para> + + <figure float="0"> + <title>Content Assist</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_13.png" scale="85"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="ErrorCheckingAndValidation"> + + <title>Errors Checking and Validation</title> + + <para>If errors occur anywhere in the file, small red dots will appear next to the + lines where the errors occurred. Also, note that the file is marked by a small x + in the Package Explorer view.</para> + + <figure float="0"> + <title>Errors Reporting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_14.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + + <section id="CSSEditor"> + + <title>CSS Editor</title> + + <para>The <property moreinfo="none">CSS editor</property> comes with the same features you will find in + all other JBoss Developer Studio editors.</para> + + <itemizedlist> + <listitem> + <para>Content assist</para> + </listitem> + <listitem> + <para>Validation and error checking</para> + </listitem> + </itemizedlist> + + <para>With the CSS (Cascading Style Sheet) editor, you can take advantage of code + prompting:</para> + + <figure float="0"> + <title>CSS Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_41.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <!-- <para>You can also use the Outline view next to the editor to navigate through the CSS + file:</para> + + <figure> + <title>Outline View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_42.png"/> + </imageobject> + </mediaobject> + </figure> + --> + + <para>And you can also use the Properties view next to the editor to edit existing + stylesheet declaration properties:</para> + + <figure float="0"> + <title>Properties View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_43.png" scale="85"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + <section id="JavaScriptEditor"> + + <title>JavaScript Editor</title> + + <para>The <property moreinfo="none">JavaScript editor</property> includes a Preview viewer and a Source + viewer. In the Source viewer, you can use code assist:</para> + + <figure float="0"> + <title>JavaScript Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_44.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>You can also use the Source viewer with the Outline view to navigate around the + file:</para> + + <figure float="0"> + <title>Source Viewer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_45.png" scale="85"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + <!-- <section id="ImageViewer"> + + <title>Image Viewer</title> + <para>This simple image viewer allows you to view GIF and JPEG files individually in a + separate window:</para> + + <figure> + <title>Image Viewer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_46.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> --> + <section id="XSDEditor"> + + <title>XSD Editor</title> + + <para>JBoss Developer Studio comes with an <property moreinfo="none">XSD Editor</property> for XML + Schema files. This editor comes from the Web Tools Project (WTP) (see <ulink url="http://www.eclipse.org/webtools/testtutorials/gettingstarted/Ge... Getting Started</ulink>).</para> + + <para>To create a new XSD file, right-click a folder in the Package Explorer view, + select <emphasis> + <property moreinfo="none">New &gt; Other...</property> + </emphasis> from the context menu and then select <emphasis> + <property moreinfo="none">XML &gt; XML Schema</property> + </emphasis> in the dialog box.</para> + + <figure float="0"> + <title>Creating New XSD file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_47.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The XSD Editor includes two viewers for working on the file, a Design viewer and a + Source viewer:</para> + + <figure float="0"> + <title>Source Viewer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_48.png" scale="85"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In the Design viewer, you can drill down on an element by double-clicking on + it:</para> + + <figure float="0"> + <title>Design Viewer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_49.png" scale="85"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Various edit options are available when you right-click an element in the + diagram:</para> + + <figure float="0"> + <title>Edit Options</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_50.png" scale="85"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>You can also use the Properties view to edit a selected element:</para> + + <figure float="0"> + <title>Properties View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_51.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>You can also use a Source viewer for the file. In this viewer, along with direct + editing of the source code, you can also edit the file by using the Properties view + on the right:</para> + + <figure float="0"> + <title>Source Viewer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_52.png" scale="85"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + <section id="SupportforXMLSchema"> + + <title>Support for XML Schema</title> + + <para>JBoss Developer Studio fully supports XML files based on schemas as well as + DTDs:</para> + <figure float="0"> + <title>XML File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/more_editors/more_editors_53.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + </section> + +</chapter> + + +<chapter id="palette" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/userguide/en/modules/palette.xml" xreflabel="palette"> + <?dbhtml filename="palette.html"?> + <chapterinfo> + <keywordset> + <keyword>Jboss Tools palette</keyword> + <keyword>tags</keyword> + <keyword>JSP page</keyword> + </keywordset> + </chapterinfo> + <title>JBoss Tools Palette</title> + <para>This chapter will introduce you to the functionality provided by <property moreinfo="none">JBoss Tools + Palette</property>. The Palette allows you to quickly and easily create your JSP or JSF + pages. Now you can do it more faster without additional knowledge.</para> + <para>The <property moreinfo="none">JBoss Tools Palette</property> allows you to:</para> + <itemizedlist> + <listitem> + <para>Insert tags into a JSP or JSF page with one click</para> + </listitem> + <listitem> + <para>Add custom and 3rd party tags</para> + </listitem> + </itemizedlist> + <para>The JBoss Tools Palette contains a developer's project tag libraries and provides + possibility to add any tag libraries to it. Also you can choose a necessary one from the + list of already existed tag libraries:</para> + <itemizedlist> + <listitem> + <para>HTML</para> + </listitem> + <listitem> + <para>JBoss</para> + </listitem> + <listitem> + <para>JSF</para> + </listitem> + <listitem> + <para>JSTL</para> + </listitem> + <listitem> + <para>MyFaces</para> + </listitem> + <listitem> + <para>Oracle ADF Faces</para> + </listitem> + <listitem> + <para>Struts</para> + </listitem> + <listitem> + <para>XHTML</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Default View of The JBoss Tools Palette</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/palette/palette_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>By default the Palette is represented in Web Development Perspective with five groups. If + you can't see it, select <emphasis> + <property moreinfo="none">Window &gt; Show View Other... &gt; JBoss Tools Web &gt; JBoss + Tools Palette</property> + </emphasis> from the menu bar.</para> + + <section id="PaletteOptions"> + <?dbhtml filename="PaletteOptions.html"?> + <title>Palette Options</title> + <para>To facilitate your work, you can configure the Palette in your own way, by selecting + the corresponding icon on the Palette toolbar.</para> + <para>There is a possibility to configure the JBoss Tools Palette:</para> + <itemizedlist> + <listitem> + <para> to <property moreinfo="none">edit the palette</property> content by adding, removing or + changing the palette elements</para> + </listitem> + <listitem> + <para> to <property moreinfo="none">show/hide groups</property>, subgroups</para> + </listitem> + <listitem> + <para>to <property moreinfo="none">import groups</property>, subgroups</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Palette Buttons</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/palette/palette_9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <section id="PaletteEditor"> + <?dbhtml filename="PaletteEditor.html"?> + <title>Palette Editor</title> + <para>JBoss Tools Palette contains existing libraries of tags, thus the + <property moreinfo="none">Palette editor</property> is intended to work with them or create your + new one, as well.</para> + <para>To open the editor, click on the <emphasis> + <property moreinfo="none">Palette Editor</property> + </emphasis> icon: <figure float="0"> + <title>Palette Editor Icon</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/palette/palette_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </para> + <para>The window has two parts. There is a reflected grouped list of components on the + left side of the palette editor. Each group is divided into multiple groups, every + of which is a tag library. The right side of the palette editor is an editing window + where it's possible to change values of group or tag library attributes + that you've chosen on the left part of the window. </para> + <para>It can also be done by right click and using <emphasis> + <property moreinfo="none">Edit…</property> + </emphasis> option.</para> + <literallayout class="normal" format="linespecific"></literallayout> + <para> For example, <property moreinfo="none">JSF</property> group consists of + <property moreinfo="none">Core</property>, <property moreinfo="none">Facelets</property>, <property moreinfo="none">HTML</property> + tag libraries and the attributes as <property moreinfo="none">name</property>, + <property moreinfo="none">description</property> and <property moreinfo="none">hidden</property> which are available + for editing: </para> + <figure float="0"> + <title>Tag Libraries of the JSF Group</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/palette/palette_24.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The Palette Editor provides the following possibilities when working with existing + tags or icons:</para> + <itemizedlist> + <listitem> + <para>to work with a set of icons</para> + <para><emphasis> + <property moreinfo="none">Icons</property> + </emphasis> is the root folder for the icon sets. The first step is creating + the icon set. Right click on the <emphasis> + <property moreinfo="none">Icons</property> + </emphasis> folder and select <emphasis> + <property moreinfo="none">Create &gt; Create Set...</property> + </emphasis></para> + <para>Set the value of the name in the <emphasis> + <property moreinfo="none">Add Icons</property> + </emphasis> window and click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button. A new element will appear in the list.</para> + <figure float="0"> + <title>Creating a Set of Icons</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/palette/palette_17.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Also you can delete the set. Right click on the set of icons that you wish + to remove and chose the <emphasis> + <property moreinfo="none">Delete Set</property> + </emphasis> option from the pop-up menu or click the <emphasis> + <property moreinfo="none">Delete</property> + </emphasis> keyboard button.</para> + </listitem> + <listitem> + <para>to edit icons in the chosen set</para> + <para>When the set of icons is created, new icons can be imported to it. Choose + the required set and select the option <emphasis> + <property moreinfo="none">Create &gt; Import Icon... </property> + </emphasis> from the pop-up menu that appears after you right-click on a + folder.</para> + <figure float="0"> + <title>Creating Icons</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/palette/palette_18.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Set the name of the icon and the path and click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button.</para> + </listitem> + <listitem> + <para>to work with a group of tag libraries</para> + <para>The first step in work with the editor is creating a group of libraries. + It's very easy to do, right mouse button click on the <emphasis> + <property moreinfo="none">Palette</property> + </emphasis> folder and select <emphasis> + <property moreinfo="none">Create &gt; Create Group…</property> + </emphasis></para> + <para>Set a name of a group in the <property moreinfo="none">Create Group</property> window and + click <emphasis> + <property moreinfo="none">OK</property> + </emphasis> button. A new element will appear at the end of the list.</para> + <figure float="0"> + <title>Creating a Group of Tag Libraries</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/palette/palette_19.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>You are allowed to edit or delete a group, as well. If you'd like + to change attributes of a group, use the right editing window of the palette + editor or the <emphasis> + <property moreinfo="none">Edit...</property> + </emphasis> option, like it was mentioned before. In order to remove the + group, right click on the group that you wish to remove and choose the <emphasis> + <property moreinfo="none">Delete</property> + </emphasis> option or click the <emphasis> + <property moreinfo="none">Delete</property> + </emphasis> keyboard button.</para> + <important> + <title>Important:</title> + <para>The removal option is enabled only for custom folders.</para> + </important> + </listitem> + <listitem> + <para>to work with a tag library</para> + <para>The group maintains a list of tag libraries. If you'd like to + create your own library, click right mouse button on the group and choose <emphasis> + <property moreinfo="none">Create Group…</property> + </emphasis> option.</para> + <figure float="0"> + <title>Creating a tag library</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/palette/palette_20.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>After setting the attribute name and the path of the icon, click <emphasis> + <property moreinfo="none">Ok</property> + </emphasis> button.</para> + <note> + <title>Note:</title> + <para>If you do not choose an icon the default one will be assigned.</para> + </note> + <para>You are allowed to edit or delete the tag library, as well. If + you'd like to change attributes of the library or choose another + icon, use the right editing window of the palette editor or the <emphasis> + <property moreinfo="none">Edit...</property> + </emphasis> option. In order to remove the tag library, right click on the + library that you wish to remove and chose the <emphasis> + <property moreinfo="none">Delete</property> + </emphasis> option or click the <emphasis> + <property moreinfo="none">Delete</property> + </emphasis> keyboard button.</para> + <important> + <title>Important:</title> + <para>The removal option is enabled only for custom tag libraries.</para> + </important> + </listitem> + <listitem> + <para>to work with a tag element</para> + <para>When the library folder is created, new tags can be added to it. Choose + the required library and select the option <emphasis> + <property moreinfo="none">Create &gt; Create Macro…</property> + </emphasis> from the pop-up menu that appears after you right-click on a + folder.</para> + <figure float="0"> + <title>Creating a tag element</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/palette/palette_21.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>In the <property moreinfo="none">Add Palette Macro</property> window, you can configure + the tag element. Attribute <emphasis> + <property moreinfo="none">Name</property> + </emphasis> is mandatory to fill and it will be the name of the tag element. + Other settings are optional. You can choose the icon and set the <emphasis> + <property moreinfo="none">Start Text</property> + </emphasis> and the <emphasis> + <property moreinfo="none">End Text</property> + </emphasis> for your tag element. If your tag text is too long, use the <emphasis> + <property moreinfo="none">Change...</property> + </emphasis> button to see it all. For <emphasis> + <property moreinfo="none">start text</property> + </emphasis> and <emphasis> + <property moreinfo="none">end text</property> + </emphasis> there is a possibility to control the cursor position by using + "|" symbol.</para> + <figure float="0"> + <title>Parameters of the Palette element</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/palette/palette_23.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>After all the attributes are set, click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button.</para> + <note> + <title>Note:</title> + <para>If you do not choose an icon the default one will be assigned.</para> + </note> + <para>You are also allowed to edit or delete the tag. If you'd like to + change the attributes of the tag or choose another icon for it, use the + right editing window of the palette editor or the <emphasis> + <property moreinfo="none">Edit...</property> + </emphasis> option from the pop-up menu. In order to remove the tag, right + click on the tag that you wish to remove and chose the <emphasis> + <property moreinfo="none">Delete</property> + </emphasis> option or click the <emphasis> + <property moreinfo="none">Delete</property> + </emphasis> keyboard button.</para> + <important> + <title>Important:</title> + <para>The removal option is enabled only for custom tags. JBoss Palette tags + can not be removed but can be modified.</para> + </important> + </listitem> + + </itemizedlist> + + <para>If you have changed any abject in the tree view and you don't like the final result you can always use the <emphasis><property moreinfo="none">Restore Defaults</property></emphasis> button. Click on it will restore defaults for the object selected and for its children elements. Please remember that the button will only restore data for objects defined in the default palette. If selected object is created by you, the button will be disabled. Child objects added by you will not be removed.</para> + <para>When updating JBoss Tools the palette content is not updated.</para> + </section> + <section id="show_hide"> + <?dbhtml filename="Show/Hide.html"?> + <title>Show/Hide</title> + <para><emphasis> + <property moreinfo="none">Show/Hide</property> + </emphasis> is a very useful feature that allows you to control the number of tag + groups that are shown on the palette.</para> + <itemizedlist> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Show/Hide</property> + </emphasis> button, at the top right side of the JBoss Tools Palette.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Show/Hide Button</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/palette/palette_10.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>In the dialog Show/Hide Drawers check the groups the libraries of which + you want to be shown on the palette:</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Show/Hide Drawers</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/palette/palette_11.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>If libraries are not displayed in the palette, check whether they are selected. + Click the plus sign to expand the libraries of the group and make sure that a tick + is put next to the wanted libraries.</para> + <!-- <para>(When you deactivate the group(s), the JBoss Palette remembers your last chose. + The libraries… )</para> + --> + <itemizedlist> + <listitem> + <para>Click <emphasis><property moreinfo="none">OK</property>.</emphasis> The new groups will + now be shown on the palette:</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>New Added Groups</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/palette/palette_12.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The names of the elements are compound. The first part is the group name and the + second is the library name.</para> + </section> + <section id="Import"> + <?dbhtml filename="Import.html"?> + <title>Import</title> + <para>The Import button lets you add a custom or 3rd party tag library to JBoss Tools + Palette. Find out more information on how to add particular tags see the <link linkend="ImportButton521">Adding Custom JSF Tags</link> section. + <!--<link linkend="CreatingAndWorkingCustomCapability">Learn how to import</link>. --></para> + </section> + </section> + <section id="UsingThePaletteIncludingOneClickTagInsertion"> + <?dbhtml filename="UsingThePaletteIncludingOneClickTagInsertion.html"?> + <title>Using the Palette</title> + <section id="InsertingTagsIntoAJSPFile"> + <?dbhtml filename="InsertingTagsIntoAJSPFile.html"?> + <title>Inserting Tags into a JSP File</title> + <para>A new tag can be added into any text file including jsp, htm, html and xhtml.</para> + <para>Let's do it. Open your JSP file and place the cursor in a place where + you'd like to add a tag and then click that tag in the palette. In the + <property moreinfo="none">Insert Tag</property> window, that appears, you can set the value of<emphasis> + <property moreinfo="none">general</property> + </emphasis> and <emphasis> + <property moreinfo="none">advanced</property> + </emphasis> attributes of the tag that you chose.</para> + <figure float="0"> + <title>Inserting Tag</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/palette/palette_25.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>In the example below, the <emphasis> + <property moreinfo="none">commandButton</property> + </emphasis> tag has been inserted.</para> + <figure float="0"> + <title>Inserting Tag</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/palette/palette_2.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>if you place the cursor over any tag, a balloon hint is shown with all the + <emphasis role="italic"> + <property moreinfo="none">"tag"</property> + </emphasis> attributes.</para> + </tip> + <para>The cursor position after adding a tag into a file is specified by + "|" symbol in the tag template on the right in the Palette Editor + window. </para> + <figure float="0"> + <title>Palette Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/palette/palette_15.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para> Above you can see where the cursor position for <emphasis> + <property moreinfo="none">HTML &gt; Form &gt; input</property> + </emphasis> is set. Thus, after adding this tag into your file the cursor will be in + the attribute "type". Then, you can straight use the combination + of buttons <property moreinfo="none">Ctrl + Space</property> to inquire about a prompting. </para> + <figure float="0"> + <title>Cursor position</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/palette/palette_16.png" scale="50"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="AddingCustomJSFTagsToTheRedHatPalette7433"> + <?dbhtml filename="AddingCustomJSFTagsToTheJBossToolsPalette.html"?> + <title>Adding Custom JSF Tags to the JBoss Tools Palette</title> + + <para>There are two ways to add any custom or 3rd party tag library to the + <property moreinfo="none">JBoss Tools Palette</property>:</para> + <itemizedlist> + <listitem> + <para>Drag-and-drop from the Web Projects view</para> + </listitem> + <listitem> + <para>The Import button on the JBoss Tools Palette</para> + </listitem> + </itemizedlist> + <para>Before you can add your custom component library, you need to make sure it is + included in your project. Either place the <emphasis role="italic"> + <property moreinfo="none">".tld"</property> + </emphasis> file or the <emphasis role="italic"> + <property moreinfo="none">".jar"</property> + </emphasis> that includes your tag library under the lib folder in your project. </para> + <section id="Drag_and_Drop65332"> + <?dbhtml filename="DragAndDrop.html"?> + <title>Drag-and-Drop</title> + <para>Switch to the Web Projects view and expand the Tag Libraries folder. If the + view is not active, select <emphasis> + <property moreinfo="none">Window &gt; Show View &gt; Web Projects</property> + </emphasis> from the menu bar.</para> + <figure float="0"> + <title>Web Projects View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/palette/palette_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Also make sure that the JBoss Tools Palette is open. Select the tag library + that you want to add and simply drag-and-drop it on to the JBoss Tools Palette.</para> + <para>You will see the following dialog window. As you can see JBoss Developer + Studio takes care of all the details. Chosen <emphasis> + <property moreinfo="none">TLD file</property> + </emphasis>, <emphasis> + <property moreinfo="none">name</property> + </emphasis> and <emphasis> + <property moreinfo="none">prefix</property> + </emphasis> of the library and <emphasis> + <property moreinfo="none">Library URL</property> + </emphasis> are detected, thus just need to set the <emphasis> + <property moreinfo="none">Group</property> + </emphasis> name to which you wish to place this tag library. You can either add + this tag library to an existing Group or just create a new one.</para> + <figure float="0"> + <title>Import Tags From TLD File Form</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/palette/palette_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Once you are finished, you will see the new tag library added to the JBoss + Tools Palette.</para> + <figure float="0"> + <title>JBoss Tools Palette with New Tag Library</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/palette/palette_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="ImportButton521"> + <?dbhtml filename="ImportButton.html"?> + <title>Import Button</title> + <para>The same you can do with <emphasis> + <property moreinfo="none">Import</property> + </emphasis> button. You can see this button at the top right side of the JBoss + Tools Palette.</para> + <figure float="0"> + <title>Import Button</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/palette/palette_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>By clicking on the <emphasis> + <property moreinfo="none">Import button</property> + </emphasis> you will see the Import Tag window a similar like in the <link linkend="Drag_and_Drop65332"> Drag-and-Drop</link> method. Set the name and + prefix of the library and Library URL. Also you need to set the Group name to + which you'd like to add your tag library. And like in the previous + method you can add it to an existing Group or create a new one. On this Import + Tag form you can use <emphasis> + <property moreinfo="none">Browse...</property> + </emphasis>button to locate the tag library that you want to add:</para> + <figure float="0"> + <title>Select TLD File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/palette/palette_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + </section> + +</chapter> + + +<chapter id="richfaces_support" role="new" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/userguide/en/modules/richfaces_support.xml" xreflabel="richfaces_support"> + <?dbhtml filename="editors.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>JBDS</keyword> + <keyword>RichFaces</keyword> + </keywordset> + </chapterinfo> + + <title>RichFaces Support</title> + + <para><property moreinfo="none">JBoss Developer Studio</property> comes with a tight integration with <ulink url="http://labs.jboss.com/jbossrichfaces/">RichFaces component framework</ulink>.</para> + + <note> + <title>Note:</title> + <para><ulink url="http://www.jboss.org/jbossrichfaces/downloads/">RichFaces + 3.3</ulink> is fully supported in the current version of <property moreinfo="none">JBoss Developer Studio</property> (i. e. 2.0.0.GA) and <property moreinfo="none">JBoss Tools 3.0.0.GA</property>.</para> + </note> + + <para>The following features are implemented and fully supported for the current version of the RichFaces components:</para> + + <itemizedlist> + <listitem><para><link linkend="ContentAssistForRF">Content Assist</link></para></listitem> + <listitem><para><link linkend="RF_openOn">OpenOn</link></para></listitem> + <listitem><para><link linkend="RF_in_palette">Representing in JBoss Tools Palette</link></para></listitem> + </itemizedlist> + + <para>All you have to do is to <ulink url="http://www.jboss.org/jbossrichfaces/downloads/">downloa... and install RichFaces libraries into your + project, i. e. just put <emphasis> + <property moreinfo="none">richfaces-*.jar</property> + </emphasis> files into the <emphasis> + <property moreinfo="none">/lib</property> + </emphasis> project folder. Also how to get started with <property moreinfo="none">RichFaces</property> you can find in <ulink url="http://jboss.org/file-access/default/members/jbossrichfaces/fre... documentation</ulink>.</para> + + <section id="ContentAssistForRF"> + <title>Code Assist for RichFaces</title> + + <para><property moreinfo="none">JBDS/JBoss Tools</property> indeed provide code completion for <ulink url="http://www.jboss.org/jbossrichfaces">RichFaces</ulin... framework + components.</para> + + <tip> + <title>Tip:</title> + + <para>RichFaces 3.3 is now fully supported in code completion.</para> + </tip> + + <figure float="0"> + <title>Content Assist for RichFaces Components</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_29.png" scale="65"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="RF_openOn"> + <title>OpenOn for RichFaces</title> + + <para>Working with <emphasis> + <property moreinfo="none">.jsp/.xhtml</property></emphasis> pages in <property moreinfo="none">VPE</property> you can also take the advantage of <emphasis> + <property moreinfo="none">OpenOn</property></emphasis> feature for the <property moreinfo="none">RichFaces</property> components.</para> + + <para>For example, <property moreinfo="none">Richfaces</property> tags <emphasis> + <property moreinfo="none">&lt;rich:insert&gt;</property> + </emphasis> and <emphasis> + <property moreinfo="none">&lt;a4j:include&gt;</property> + </emphasis> has <property moreinfo="none">OpenOn</property> support.</para> + + <figure float="0"> + <title>OpenOn With Richfaces Tag</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_8a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <figure float="0"> + <title>OpenOn With A4j Tag</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_8b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="RF_in_palette"> + <title>RichFaces in the JBoss Tools Palette</title> + + <para>RichFaces and Ajax4jsf tag libraries always exist in <link linkend="palette">JBoss Tools + Palette</link>.</para> + + <figure float="0"> + <title>RichFaces Components</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/palette/palette_13.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>To insert a <property moreinfo="none">RichFaces</property> component on a page:</para> + <itemizedlist> + <listitem> + <para>expand <emphasis> + <property moreinfo="none">JBoss RichFaces</property> + </emphasis> group on the palette</para> + </listitem> + + <listitem> + <para>click on some component</para> + </listitem> + + <listitem> + <para>put the needed attributes in the <emphasis> + <property moreinfo="none">Insert Tag</property> + </emphasis> dialog and click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button + </para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Inserting Tag</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_30.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The <property moreinfo="none">RichFaces</property> component will be inserted on your page and displayed in source and visual + modes:</para> + + <figure float="0"> + <title>RichFaces Component</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors_features/editors_features_31.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section> + <title>Relevant Resources Links</title> + + <para>To get more in-depth information on <property moreinfo="none">RichFaces</property> framework refer to <ulink url="http://jboss.org/file-access/default/members/jbossrichfaces/fre... Developer Guide</ulink>.</para> + <para>It may be also helpful for you to look through the <ulink url="http://docs.jboss.org/tools/movies/">movies</ulink> where there are ones that demonstrate the usage of RichFaces components.</para> + </section> +</chapter> + +<chapter id="web_projects" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/userguide/en/modules/web_projects.xml" xreflabel="web_projects"> + <?dbhtml filename="web_projects.html"?> +<title>Web Projects View</title> +<para><property moreinfo="none">Web Projects</property> is a special view that comes with JBoss Developer Studio.</para> +<para>If the Web Projects view's tab is not visible next to the Package Explorer tab, select <emphasis><property moreinfo="none">Window &gt; Show View &gt; Other &gt; JBoss Tools Web &gt; Web Projects</property></emphasis> from the menu bar.</para> +<para>With the Web Projects view, you can:</para> + +<itemizedlist> +<listitem><para>Visualize the project better because the project artifacts for JSF and Struts projects are organized and displayed by function.</para></listitem> +<listitem> + <para>Select these kinds of items to drag and drop into JSP pages:</para> + <itemizedlist> + <listitem><para>JSF managed bean attributes</para></listitem> +<listitem><para>JSF navigation rules outcomes</para></listitem> +<listitem><para>Property file values</para></listitem> +<listitem><para>Tag library files</para></listitem> +<listitem><para>Tags from tag libraries</para></listitem> +<listitem><para>JSP page links</para></listitem> +</itemizedlist> +</listitem> +<listitem><para>Use context menus to develop the application (all create and edit functions are available)</para></listitem> +<listitem><para>Use icon shortcuts to create and import JSF and Struts projects</para></listitem> +<listitem><para>Expand and inspect tag library files</para></listitem> +<listitem><para><link linkend="AddingCustomJSFTagsToTheRedHatPalette7433">Select custom and third-party tag libraries to drag and drop onto +the JBoss Tools Palette</link></para></listitem> +</itemizedlist> + +<section id="ProjectOrganization"> + +<title>Project Organization</title> +<para>The Web Projects view organizes your project in a different way. The physical structure of course stays the same. The new organization combines common project artifacts together which makes it simpler to +locate what you are looking for and develop.</para> + +<para>The screen shot below shows a JSF project and a Struts project in Web Projects view.</para> +<figure float="0"> + <title>Web Projects View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/web_projects/web_projects_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> +</section> +<section id="DragAndDrop"> + +<title>Drag and Drop</title> + <para>Web Projects View has a drag and drop option that can be used for property, managed bean attributes, navigation rules, tag library file declaration and JSP Pages.</para> +<section id="ForAProperty"> + +<title>For a Property</title> + <para>Expand the <property moreinfo="none">Resources Bundles</property> folder that holds all the Property files in your project. Select the file from which you want to add the property and then select the property.</para> +<para>We will be dragging and dropping a property file value inside the outputText tag for the <emphasis role="italic"><property moreinfo="none">"value"</property></emphasis> attribute.</para> +<figure float="0"> +<title>OutputText Tag</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/web_projects/web_projects_2.png"></imagedata> + </imageobject> +</mediaobject> +</figure> +<para>Select the property:</para> +<figure float="0"> +<title>Selecting Property</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/web_projects/web_projects_3.png"></imagedata> + </imageobject> +</mediaobject> +</figure> + <para>Drag the property and drop it between the quotes for the value attribute in the JSP file. Notice that JBoss Developer Studio added the correctly formatted expression for referring to the property value <emphasis><property moreinfo="none">#{Message.header}</property></emphasis> automatically.</para> + <figure float="0"> +<title>Inserted Property</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/web_projects/web_projects_4.png"></imagedata> + </imageobject> +</mediaobject> +</figure> +<para>You can actually place the tag anywhere in the page, not just inside an existing tag. In this case, + JBoss Developer Studio will place the complete tag <emphasis><property moreinfo="none">&lt;h:outputText value="#{Message.header}"/&gt;</property></emphasis> in the page.</para> + </section> +<section id="ForManagedBeanAttributes"> + +<title>For Managed Bean Attributes</title> + +<para>Select a <emphasis role="italic"><property moreinfo="none">"managed bean"</property></emphasis> attribute and then drag and drop it onto the JSP page. We are going to place it inside the <emphasis role="italic"><property moreinfo="none">"value"</property></emphasis> attribute of the inputText tag.</para> +<figure float="0"> +<title>Selecting Managed Bean Attribute</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/web_projects/web_projects_5.png"></imagedata> + </imageobject> +</mediaobject> +</figure> +<para>Once again, JBoss Developer Studio adds the correct expression, <emphasis>#{user.name}</emphasis>.</para> +<figure float="0"> +<title>Added Expression</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/web_projects/web_projects_6.png"></imagedata> + </imageobject> +</mediaobject> +</figure> +</section> +<section id="NavigationRules"> + +<title>Navigation Rules</title> + +<para>Select the navigation rule under <emphasis><property moreinfo="none">Configuration &gt; faces-config.xml &gt; Navigation Rules</property></emphasis>:</para> +<figure float="0"> +<title>Selecting Navigation Rule</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/web_projects/web_projects_7.png"></imagedata> + </imageobject> +</mediaobject> +</figure> +<para>Drag and drop it inside the commandButton tag:</para> +<figure float="0"> +<title>Naviagation Rule in CommandButton Tag</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/web_projects/web_projects_8.png"></imagedata> + </imageobject> +</mediaobject> +</figure> +<para>You could do the same if the navigation rule was defined inside an action method:</para> +<figure float="0"> +<title>Navigation Rule in Action Method</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/web_projects/web_projects_9.png"></imagedata> + </imageobject> +</mediaobject> +</figure> +<para>Here is how it would look after drag and drop:</para> +<figure float="0"> +<title>Inserted Navigation Rule</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/web_projects/web_projects_10.png"></imagedata> + </imageobject> +</mediaobject> +</figure> +</section> +<section id="ForATagLibraryFileDeclaration"> + +<title>For a Tag Library File Declaration</title> + +<para>Select a TLD file:</para> +<figure float="0"> +<title>Selecting TLD File</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/web_projects/web_projects_11.png"></imagedata> + </imageobject> +</mediaobject> +</figure> +<para>Then drag and drop it onto the JSP page to add a declaration at the top of the page:</para> +<figure float="0"> +<title>Inserted TLD File</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/web_projects/web_projects_12.png"></imagedata> + </imageobject> +</mediaobject> +</figure> +</section> +<section id="ForJSPPages"> + +<title>For JSP Pages</title> + +<para>You can also drag and drop a JSP page path to a JSP page to create a forward as shown:</para> +<figure float="0"> +<title>Creating JSP Forward</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/web_projects/web_projects_13.png" scale="80"></imagedata> + </imageobject> +</mediaobject> +</figure> +</section> +</section> +<section id="DevelopingTheApplication"> + +<title>Developing the Application</title> + +<para>It is also possible to develop your application right from the Web Projects view. +Simply right-click any node in the tree and select an appropriate action from the context menu. For instance, this screen capture shows creating a new navigation rule.</para> +<figure float="0"> +<title>Creating New Navigation Rule</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/web_projects/web_projects_14.png" scale="90"></imagedata> + </imageobject> +</mediaobject> +</figure> +</section> +<section id="ExpandingTagLibraryFiles"> + +<title>Expanding Tag Library Files</title> + +<para>You can easily expand any TLD file in the project. Browse to the Tag Libraries folder. Right-click a TLD file and select <emphasis><property moreinfo="none">Expand</property></emphasis>. The TLD file will now be expanded.</para> + +<para>You can then select any tag and drag it onto a JSP page.</para> +<figure float="0"> +<title>Expanding Tag Library File</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/web_projects/web_projects_15.png"></imagedata> + </imageobject> +</mediaobject> +</figure> +</section> +<section id="DragAndDropTagLibrariesOnToRedHatPalette"> + +<title>Drag and Drop Tag Libraries on to JBoss Tools Palette</title> + + <para>Read <link linkend="AddingCustomJSFTagsToTheRedHatPalette7433">Adding Tag Libraries</link> to learn about this.</para> +</section> +<section id="CreateAndImportJSFAndStrutsProjects"> +<title>Create and Import JSF and Struts Projects</title> + +<para>You can also create and import JSF and Struts project from Web Projects view by selecting the +buttons below.</para> + +<para>From left to right:</para> + +<orderedlist continuation="restarts" inheritnum="ignore"> +<listitem><para>Create New JSF Project</para></listitem> +<listitem><para>Import JSF Project</para></listitem> +<listitem><para>Create New Struts Project</para></listitem> +<listitem><para>Import Struts Project</para></listitem> +</orderedlist> +<figure float="0"> +<title>Web Projects View Buttons</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/web_projects/web_projects_16.png"></imagedata> + </imageobject> +</mediaobject> +</figure> +</section> + +</chapter> + +<chapter id="preferences" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/userguide/en/modules/preferences.xml" xreflabel="preferences"> + <?dbhtml filename="preferences.html"?> + <title>JBoss Tools Preferences</title> + + <para>Configuring the various <property moreinfo="none">JBoss Developer Studio</property> features is done via + the <property moreinfo="none">Preferences</property> screen by selecting <emphasis> + <property moreinfo="none">Window &gt; Preferences &gt; JBoss Tools</property> + </emphasis> from the menu bar.</para> + <figure float="0"> + <title>Preferences are included in this dialog.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>From this screen, you can select these more specific sets of <property moreinfo="none">JBoss Tools + preferences</property>:</para> + + <itemizedlist> + <listitem> + <para> + <link linkend="PackagingArchives">Packaging Archives</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="Editors">Editors</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="VisualPageEditor2">Visual Page Editor</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="el_variables">El Variables</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="JSF">JSF</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="JSFPage">JSF Page</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="JSFPropject">JSF Propject</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="JSFFlowDiagram">JSF Flow Diagram</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="Seam">Seam</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="SeamValidator">Seam Validator</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="Struts">Struts</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="struts_automation">Struts Automatic</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="Plug-inInsets">Plug-in Insets</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="ResourceInsets">Resource Insets</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="StrutsCustomization">Struts Customization</link> + </para> + </listitem> + + + <listitem> + <para> + <link linkend="StrutsProject">Struts Project</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="StrutsSupport">Struts Support</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="StrutsPages">Struts Pages</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="StrutsFlowDiagram">Struts Flow Diagram</link> + </para> + </listitem> + + + <listitem> + <para> + <link linkend="tiles_diagram">Tiles Diagram</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="Verification">Verification</link> + </para> + </listitem> + </itemizedlist> + + <para>The <property moreinfo="none">Preferences</property> dialog <emphasis>( <property moreinfo="none">Window &gt; + Preferences</property>) </emphasis> also allows to adjust settings for <link linkend="JBossServerPreferences">JBoss Server</link> and <link linkend="XDoclet">XDoclet</link> module.</para> + + <section id="PackagingArchives"> + <?dbhtml filename="PackagingArchives.html"?> + <title>Packaging Archives</title> + + <para>Fallow to <emphasis> + <property moreinfo="none">JBoss Tools &gt; Packaging Archives</property> + </emphasis> to open the page for changing Packaging Archives preferences.</para> + <para>Here you can determine settings for Project Packages view and core preferences.</para> + + <figure float="0"> + <title>Packaging Archives</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The next table lists all available preferences for Packaging Archives and their + description.</para> + + <table> + <title>Packaging Archives Preferences</title> + + <tgroup cols="3"> + + <colspec align="left" colnum="1" colwidth="2*"></colspec> + <colspec colnum="2" colwidth="4*"></colspec> + <colspec colnum="3" colwidth="2*"></colspec> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + + <tbody> + <row> + <entry>Enable incremental builder</entry> + <entry>Uncheck this option if you don't want to enable incremental + builder for your resources</entry> + <entry>On</entry> + </row> + + <row> + <entry>Show full output path next to packages</entry> + <entry>This option allows you to show or hide an output path next to + packages + <!--(<link linkend="full_outputpath_for_packages">See the + figure</link>)-->.</entry> + <entry>On</entry> + </row> + + <row> + <entry>Show the full root directory of filesets</entry> + <entry>If on, the full root directory is displayed next to filesets. + Otherwise, it's hidden + <!--(<link + linkend="full_rootdir_for_filesets">See the figure</link>)-->.</entry> + <entry>On</entry> + </row> + + <row> + <entry>Show project at the root</entry> + <entry>This option allows you to choose whether to display a project name at + the root of the packages or not. When checked, 'Show all + projects that contain packages' is enabled + <!--(<link + linkend="project_at_the_root">See the figure</link>)-->.</entry> + <entry>On</entry> + </row> + + <row> + <entry>Show all projects that contain packages</entry> + <entry>Selecting this setting enables the Projects Archiving view to show or + hide all projects that contain packages. The option is available when + the previous one is checked.</entry> + <entry>Off</entry> + </row> + </tbody> + </tgroup> + </table> + <!-- + <figure id="full_outputpath_for_packages"> + <title>Show Full Output Path next to Packages</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_3.png"/> + </imageobject> + </mediaobject> + </figure> + + <figure id="full_rootdir_for_filesets"> + <title>Show the Full Root Directory of Filesets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_4.png"/> + </imageobject> + </mediaobject> + </figure> + + <figure id="project_at_the_root"> + <title>Show Project at the root</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_5.png"/> + </imageobject> + </mediaobject> + </figure> +--> + + </section> + + <!--section id="CodeAssist"> + <?dbhtml filename="CodeAssist.html"?> + <title>CodeAssist</title> + <para>Select <emphasis> + <property>JBoss Tools > XDoclet > Code Assist</property> + </emphasis> to see Code Assist preference page.</para> + <para>Here is what the Code Assist preference page looks like: </para> + <figure> + <title>CodeAssist</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_2.png"/> + </imageobject> + </mediaobject> + </figure> + </section--> + + <section id="Editors"> + <?dbhtml filename="Editors.html"?> + <title>Editors</title> + <para>To adjust settings common for all editors supplied with <property moreinfo="none">JBoss Developer + Studio</property> you should select <emphasis> + <property moreinfo="none">JBoss Tools &gt; Web &gt; Editors</property>.</emphasis></para> + + <figure float="0"> + <title>Editors</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>On the Editors page the following preferences are available:</para> + + <table> + + <title>Editors Preferences</title> + <tgroup cols="3"> + + <colspec align="left" colnum="1" colwidth="2*"></colspec> + <colspec colnum="2" colwidth="4*"></colspec> + <colspec colnum="3" colwidth="2*"></colspec> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + + <tbody> + <row> + <entry>Always use JBoss Tools editors with Open option</entry> + <entry></entry> + <entry>On</entry> + </row> + + <row> + <entry>Show warning when project has no JBoss Tools capabilities</entry> + <entry>Check this option to be sure that any JBoss Tools editor fully + available for a particular type of file. If no, you'll be + warned about this.</entry> + <entry>On</entry> + </row> + + <row> + <entry>Use Source tab as a default for multi-tab editors</entry> + <entry>If on, an editor will open the files in the Source view by + default</entry> + <entry>Off</entry> + </row> + </tbody> + </tgroup> + </table> + + </section> + + <section id="VisualPageEditor2"> + <?dbhtml filename="VisualPageEditor.html"?> + <title>Visual Page Editor</title> + <para><emphasis> + <property moreinfo="none">JBoss Tools &gt; Web &gt; Editors &gt; Visual Page + Editor</property> + </emphasis> screen allows you to control some aspects of the behavior of the + <property moreinfo="none">Visual Page Editor</property> (VPE) for JSF/HTML files.</para> + <figure float="0"> + <title>Visual Page Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The next table lists the possible settings that you can adjust on the + <property moreinfo="none">General tab</property> of the VPE Preferences page.</para> + + + <table> + + <title>VPE Preferences</title> + <tgroup cols="3"> + + <colspec align="left" colnum="1" colwidth="2*"></colspec> + <colspec colnum="2" colwidth="4*"></colspec> + <colspec colnum="3" colwidth="2*"></colspec> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + + <tbody> + <row> + <entry>Show Border for Unknown Tags</entry> + <entry>The option allows to place the border around unknown tags or undo + this</entry> + <entry>On</entry> + </row> + + <row> + <entry>Show Non-Visual Tags</entry> + <entry>Check this box, if you want the editor shows non-visual elements on + the page you're editing</entry> + <entry>Off</entry> + </row> + + <row> + <entry>Show Resource Bundles Usage as EL Expressions </entry> + <entry>If the option is checked, the editor will show EL expressions instead + of the resource values</entry> + <entry>Off</entry> + </row> + + <row> + <entry>Always Prompts for Tag Attributes During Tag Insert </entry> + <entry>Having this option off, the dialog with possible attributes for + inserting tag won't appear if all its attributes are optional</entry> + <entry>On</entry> + </row> + + <row> + <entry>Show Selection Tag Bar</entry> + <entry>This option allows to show or hide the Selection Bar</entry> + <entry>On</entry> + </row> + + <row> + <entry>Always Hide Selection Bar Without Prompt</entry> + <entry>Check this box if you don't want the confirmation window + appears when closing the Selection Bar</entry> + <entry>Off</entry> + </row> + + <row> + <entry>Default Editor Tab</entry> + <entry>The option provides with a possibility to choose one of the following + views - Visual/Source, Source or Preview, as default when opening the + editor</entry> + <entry>Visual/Source</entry> + </row> + + <row> + <entry>Size of Visual Editor Pane 0 – 100% </entry> + <entry>With the help of this scroll bar you can adjust the percentage rating + between the Source and Visual modes of the Visual/Source view</entry> + <entry>50%</entry> + </row> + </tbody> + </tgroup> + </table> + + <para>On the <property moreinfo="none">Templates tab</property> you can edit or remove <link linkend="vpe_templating">VPE templates</link>.</para> + <figure float="0"> + <title>Visual Page Editor Templates</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Select a template for editing from the available list and press <emphasis> + <property moreinfo="none">Edit</property> + </emphasis> button. It will pick up the <link linkend="template_dialog">Template + dialog</link> where you can adjust new settings.</para> + </section> + + <section id="el_variables"> + <?dbhtml filename="el_variables.html"?> + <title>El Variables</title> + <para>To specify necessary EL variables globally, i. e. for all projects and resources in + your workspace, you should go to <emphasis> + <property moreinfo="none">JBoss Tools &gt; Web &gt; El Variables</property>. </emphasis></para> + + <figure float="0"> + <title>El Variables</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Click <emphasis> + <property moreinfo="none">Add...</property> + </emphasis> to set value for a new EL variable. In the appeared wizard you should + specify the global values and press <emphasis> + <property moreinfo="none">Finish</property> + </emphasis>.</para> + + <figure float="0"> + <title>Adding a Global El Variable</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_10.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>If you specify an equal variable in <link linkend="el_exp_para">VPE EL + dialog</link> and in Preference EL dialog, variable from preference dialog will + have priority.</para> + </tip> + </section> + <!--section id="JBossServers"> + <?dbhtml filename="JBossServers.html"?> + <title>JBoss Servers</title> + <para>The following preferences can be changed on the <emphasis> + <property>JBoss Tools > JBoss Servers</property> + </emphasis> preference page.</para> + <para>Here is what the JBoss Servers preference page looks like:</para> + <figure> + <title>JBoss Servers</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_4.png"/> + </imageobject> + </mediaobject> + </figure> + </section--> + + <section id="JSF"> + <?dbhtml filename="JSF.html"?> + <title>JSF</title> + <para>Select <emphasis> + <property moreinfo="none">JBoss Tools &gt; Web &gt; JSF</property> + </emphasis> to get to the JSF Project specific preferences.</para> + <figure float="0"> + <title>JSF</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_11.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="JSFPage"> + <?dbhtml filename="JSF Page.html"?> + <title>JSF Pages</title> + <para>By selecting <emphasis> + <property moreinfo="none">JBoss Tools &gt; Web &gt; JSF &gt; JSF Pages</property> + </emphasis> you can add jsf pages or remove existing ones.</para> + <figure float="0"> + <title>JSF Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_12.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="JSFPropject"> + <?dbhtml filename="JSFPropject.html"?> + <title>JSF Project</title> + <para>Select <emphasis> + <property moreinfo="none">JBoss Tools &gt; Web &gt; JSF &gt; Project</property> + </emphasis> to see JSF Project preferences page.</para> + <para>On the <emphasis> + <property moreinfo="none">New Project</property> + </emphasis> tab you can set default values for <ulink url=" ../../jsf_tools_ref_guide/html_single/index.html#new_jsf_project">New JSF Project</ulink> wizard:</para> + + <itemizedlist> + <listitem> + <para><emphasis> + <property moreinfo="none">Version</property> + </emphasis> for setting the default JSF Environment</para> + </listitem> + + <listitem> + <para><emphasis> + <property moreinfo="none">Project Template</property> + </emphasis> so as <property moreinfo="none">New JSF Project wizard</property> shows this + template as default for the chosen JSF Environment</para> + </listitem> + + <listitem> + <para><emphasis> + <property moreinfo="none">Project Root</property> + </emphasis> for specifying default location for a new JSF project</para> + <para>If you check <emphasis> + <property moreinfo="none">Use Default Path</property> + </emphasis> here, this box will be also checked in the <property moreinfo="none">New JSF Project + wizard</property>.</para> + </listitem> + + <listitem> + <para><emphasis> + <property moreinfo="none">Servlet Version</property> + </emphasis> for setting the default Servlet version of a new JSF project</para> + <para>Here it's also possible to define whether to register Web Context in <emphasis> + <property moreinfo="none">server.xml</property> + </emphasis> while organizing a new project or not. Check the proper box in order + to do that.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>New JSF Propject Preferences</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_13.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>On the <emphasis> + <property moreinfo="none">Import Project</property> + </emphasis> tab in the JSF Project screen you can determine the default Servlet version + for the <ulink url=" ../../Exadel-migration/html_single/index.html#import_jsf_screen">Import JSF Project</ulink> + wizard and also whether to register Web Context in <emphasis> + <property moreinfo="none">server.xml</property> + </emphasis> or not.</para> + + <figure float="0"> + <title>Import JSF Propject Preferences</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_14.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="JSFFlowDiagram"> + <?dbhtml filename="JSFFlowDiagram.html"?> + <title>JSF Flow Diagram</title> + <para>Selecting <emphasis> + <property moreinfo="none">JBoss Tools &gt; Web &gt; Editors &gt; JSF Flow Diagram</property> + </emphasis> allows you to specify some aspects of the Diagram mode of the JSF + configuration file editor.</para> + + <figure float="0"> + <title>JSF Flow Diagram</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_15.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The first two items control the background grid for the diagram. The next two items + allow you to control the appearance of the labels for views (pages) and the transitions + between views. For these two items, clicking the <emphasis> + <property moreinfo="none">Change... </property> + </emphasis>button allows you to assign a font with a dialog box.</para> + + <para>The first check box determines whether a view in the diagram that doesn't have a + transition connecting it to another view yet should be written to the source code as a + partial navigation rule. The next check box determines whether the diagram cursor + reverts immediately to the standard selection mode after it's used in the + transition-drawing mode to draw a transition. Finally, the last two check boxes concern + shortcuts. A shortcut is a transition that is there but isn't actually displayed in the + diagram as going all the way to the target view it's connected to, in order to make the + diagram clearer. With the check boxes, you can decide whether to display a small + shortcut icon as part of the shortcut and also whether to display the target view as a + label or not.</para> + <figure float="0"> + <title>Add View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_16.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Selecting the Add Page tab in the JSF Flow Diagram screen allows you to determine the + default template and file extension for views (pages) you add directly into the diagram + using a context menu or the view-adding mode of the diagram cursor.</para> + </section> + + <section id="label_decorations"> + <title>Label Decorations</title> + + <para>The Label Decorations page is opened from <emphasis> + <property moreinfo="none">JBoss Tools &gt; Web &gt; Label Decorations</property>. </emphasis></para> + + <figure float="0"> + <title>Label Decorations</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_17.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>On this page you can determine the format for a text output near the decoration label + for different Web resources. To change the value for selected element, click <emphasis> + <property moreinfo="none">Add Variable...</property> + </emphasis> button next to <emphasis> + <property moreinfo="none">Format</property> + </emphasis> field. Appeared wizard will prompt you to select one from the available + list.</para> + + <figure float="0"> + <title>Label Decoration for Validator</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_18.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="Seam"> + <?dbhtml filename="Seam.html"?> + <title>Seam</title> + <para>The following preferences can be changed on the <emphasis> + <property moreinfo="none">JBoss Tools &gt; Web &gt; Seam</property> + </emphasis> page.</para> + <para>On <emphasis> + <property moreinfo="none">Seam</property> + </emphasis> screen you can add and remove Seam runtimes.</para> + <para>Here is what Seam preference page looks like:</para> + <figure float="0"> + <title>Seam</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_19.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="SeamValidator"> + <?dbhtml filename="SeamValidator.html"?> + <title>Seam Validator</title> + <para>The following preferences can be changed on the <emphasis> + <property moreinfo="none">JBoss Tools &gt; Web &gt; Seam &gt; Validator</property> + </emphasis> page.</para> + <para>In <emphasis> + <property moreinfo="none">Validator</property> + </emphasis> panel you configure seam problems that will be processed by + validator.</para> + <figure float="0"> + <title>Seam Validator</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_20.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="Struts"> + <?dbhtml filename="Struts.html"?> + <title>Struts</title> + <para>By selecting <emphasis> + <property moreinfo="none">JBoss Tools &gt; Web &gt; Struts</property> + </emphasis> you can configure Struts projects specific preferences.</para> + <figure float="0"> + <title>Struts</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_21.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="struts_automation"> + <?dbhtml filename="struts_automation.html"?> + <title>Struts Automation</title> + <para>On <emphasis> + <property moreinfo="none">Automation</property> + </emphasis> panel you can modify default text for the Tilel Struts plug-in element, the + Validator Struts plug-in element, and error message resource files.</para> + <figure float="0"> + <title>Struts Automatic</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_22.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="Plug-inInsets"> + <?dbhtml filename="Plug-inInsets.html"?> + <title>Plug-in Insets</title> + <para>By selecting <emphasis> + <property moreinfo="none">Web &gt; Struts &gt; Automation &gt; Plug-in Insets</property> + </emphasis> on tab Tiles you can define a default text for tiles plugin.</para> + <figure float="0"> + <title>Plug-in Insets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_23.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The same is done but for validator plugin on the tab Validators.</para> + <figure float="0"> + <title>Plug-in Insets of Validators</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_24.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="ResourceInsets"> + <?dbhtml filename="ResourceInsets.html"?> + <title>Resource Insets</title> + <para>To see Resource Insets preference page select <emphasis> + <property moreinfo="none">JBoss Tools &gt; Web &gt; Strats &gt; Automation &gt; Resource Insets</property> + </emphasis>.</para> + <para>On <emphasis> + <property moreinfo="none">Resource Insets</property> + </emphasis> panel you determine default error messages for error resource files.</para> + <figure float="0"> + <title>Resource Insets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_25.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="StrutsCustomization"> + <?dbhtml filename="StrutsCustomization"?> + <title>Struts Customization</title> + <para>The following preferences can be changed on the <emphasis> + <property moreinfo="none">JBoss Tools &gt; Web &gt; Struts &gt; Customization</property> + </emphasis> page.</para> + <para>In the<emphasis> + <property moreinfo="none">Customization</property> + </emphasis> screen you configure Link Recognizer for Struts tags.</para> + <figure float="0"> + <title>Struts Customization</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_26.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="StrutsProject"> + <?dbhtml filename="StrutsProject.html"?> + <title>Struts Project</title> + <para>You can change the following preferences on the <emphasis> + <property moreinfo="none">JBoss Tools &gt; Web &gt; Struts &gt; Project</property> + </emphasis> preference page:</para> + <para>On <emphasis> + <property moreinfo="none">Project</property> + </emphasis> panel you define a template for a new Struts created project: servlet + version, page template and so on.</para> + <figure float="0"> + <title>Struts Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_27.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Selecting the Import Project tab in the Struts Project screen allows you to determine + the default servlet version and whether to register Web Context in server.xml.</para> + <figure float="0"> + <title>Import Struts Pages</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_28.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="StrutsSupport"> + <?dbhtml filename="StrutsSupport.html"?> + <title>Struts Support</title> + <para>The following preferences can be changed on the <emphasis> + <property moreinfo="none">JBoss Tools &gt; Web &gt; Struts &gt; Project &gt; Struts Support</property> + </emphasis> page.</para> + <para>Select <emphasis> + <property moreinfo="none">Struts Support</property> + </emphasis> screen if you want to configure Struts versions support settings.</para> + <figure float="0"> + <title>Struts Support</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_29.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="StrutsPages"> + <?dbhtml filename="StrutsPages.html"?> + <title>Struts Pages</title> + <para>You can change the following preferences on the JBoss Tools &gt; Web &gt; Struts &gt; Struts + Pages preference page.</para> + <para>On <emphasis> + <property moreinfo="none">Struts Pages</property> + </emphasis> panel you can add or remove Struts pages.</para> + <figure float="0"> + <title>Struts Pages</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_30.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="StrutsFlowDiagram"> + <?dbhtml filename="StrutsFlowDiagram.html"?> + <title>Struts Flow Diagram</title> + <para>Similarly to the JSF Flow Diagram screen, selecting <emphasis> + <property moreinfo="none">JBoss Tools &gt; Web &gt; Editor &gt; Struts Flow Diagram</property> + </emphasis> page allows you to specify aspects of the Diagram mode of the Struts + configuration file editor. The Struts Flow Diagram screen adds an option to hide the + Diagram tab and labeling settings for additional artifacts. </para> + <figure float="0"> + <title>Struts Flow Diagram</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_31.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Selecting the Add Page tab in the Struts Flow Diagram screen allows you to determine + the default template and file extension for views (pages) you add directly into the + diagram using a context menu or the view-adding mode of the diagram cursor.</para> + <figure float="0"> + <title>Adding Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_32.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="tiles_diagram"> + <?dbhtml filename="titles_diagram.html"?> + <title>Tiles Diagram</title> + <para><emphasis> + <property moreinfo="none">JBoss Tools &gt; Web &gt; Editors &gt; Title Diagram</property> + </emphasis> screen allows you control some settings for the placement of Tiles + definitions in the Diagram mode of the JBoss Tools Tiles editor.</para> + <figure float="0"> + <title>Title Diagram</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_33.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="Verification"> + <?dbhtml filename="Verification.html"?> + <title>Verification</title> + <para>The following preferences can be changed on the <emphasis> + <property moreinfo="none">JBoss Tools &gt; Web &gt; Verification</property> + </emphasis> page.</para> + <para>On Rules Configuration tab of <emphasis> + <property moreinfo="none">Verifcation</property> + </emphasis> panel you can determine JSF and Struts rules.</para> + <figure float="0"> + <title>Verification</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_34.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>On Options tab you can define a limit for the reported errors number.</para> + <figure float="0"> + <title>Options of Verification</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_35.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="JBossServerPreferences"> + <?dbhtml filename="View.html"?> + <title>Server Preferences</title> + <para>Preferences for <property moreinfo="none">JBoss Server</property> and other servers can be changed on + the <emphasis> + <property moreinfo="none">Server</property> + </emphasis> page.</para> + + <figure float="0"> + <title>Server Preferences</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_36.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>On the <emphasis> + <property moreinfo="none">Server &gt; Runtime Environments</property> + </emphasis> page you can add new or modify already defined Server Runtime.</para> + + <figure float="0"> + <title>Runtime Environments</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_37.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Server Launching preferences can be configured on the <emphasis> + <property moreinfo="none">Server &gt; Launching</property> + </emphasis> page.</para> + + <figure float="0"> + <title>Server Launching Preferences</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_38.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Going to <emphasis> + <property moreinfo="none">Server &gt; Audio</property> + </emphasis> you can enable/disable the sound notification for different Server states + and actions and set the sound volume as well.</para> + + <figure float="0"> + <title>Sound Notification Adjustment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_40.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="XDoclet"> + <?dbhtml filename="XDoclet.html"?> + <title>XDoclet</title> + <para>The preferences for XDoclet can be changed if you click <emphasis> + <property moreinfo="none">XDoclet</property> + </emphasis> on the left navigation bar.</para> + <para>On the <emphasis> + <property moreinfo="none">XDoclet</property> + </emphasis> screen it's possible to enable/disable XDoclet builder by checking + proper box, specify XDoclet home and determine XDoclet module version as well.</para> + + <figure float="0"> + <title>XDoclet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_41.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Switch to <emphasis> + <property moreinfo="none">XDoclet &gt; ejbdoclet</property> + </emphasis> page in order to adjust settings for EJB-specific sub-tasks.</para> + + <figure float="0"> + <title>ejbdoclet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_42.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>To configure settings for various web-specific XDoclet sub-tasks, follow to <emphasis> + <property moreinfo="none">XDoclet &gt; webdoclet</property> + </emphasis> page.</para> + + <figure float="0"> + <title>webdoclet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_43.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>On the whole, this document should guide you to those parts of <property moreinfo="none">JBoss + Tools</property> which you specifically need to develop Web Applications. It covers + different aspects of visual components such as editors, views, etc. for browsing, + representing and editing web resources you are working with.</para> + + <para>If there's anything we didn't cover or you can't figure + out, please feel free to visit our <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... Developer Studio Users Forum</ulink> or <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... Tools Users Forum</ulink> to ask questions. There we are also looking for + your suggestions and comments.</para> + </section> + + <!--section id="XDocletTemplates"> + <?dbhtml filename="XDocletTemplates.html"?> + <title>XDoclet Templates</title> + <para>To see what XDoclet tags templates available for completion select <emphasis> + <property>JBoss Tools > XDoclet > Code Assist > Templates</property> + </emphasis>.</para> + <figure> + <title>XDoclet Templates</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_32.png"/> + </imageobject> + </mediaobject> + </figure> + <para>By right clicking on any tree element you can add a new template, remove or rename it + and also add a new tree.</para> + <para>Select, for example, <emphasis> + <property>Add</property> + </emphasis> and you&apos;ll be prompted by a list of available elements to + add.</para> + <figure> + <title>Add New XDoclet Template</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_33.png"/> + </imageobject> + </mediaobject> + </figure> + <para>By double-clicking some element a new list will be shown: now for available + methods.</para> + <figure> + <title>Select New Element</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_34.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Choose any element from the list, then select an attribute.</para> + <figure> + <title>Select New Element</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_35.png"/> + </imageobject> + </mediaobject> + </figure> + <para>It will be added to the available templates.</para> + <figure> + <title>Select New Element</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_36.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="XDocletsVariables"> + <?dbhtml filename="XDocletsVariables.html"?> + <title>XDoclets Variables</title> + <para>By selecting <emphasis> + <property>JBoss Tools &gt; XDoclet &gt; Variables</property> + </emphasis> you define variables used in templates.</para> + <figure> + <title>XDoclets Variables</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_37.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="ChangingDefaultEnvironmentDuringProjectCreation"> + <?dbhtml filename="ChangingDefaultEnvironmentDuringProjectCreation.html"?> + <title>Changing Default Environment During Project Creation</title> + + <para>To change the default environment and project template for either JSF or Struts new + project creation:</para> + + <orderedlist> + <listitem> + <para>Select<emphasis> + <property> Window &gt; Preferences &gt; JBoss Tools &gt; Web + &gt; {JSF or Struts} &gt; Project</property> + </emphasis></para> + </listitem> + <listitem> + <para>For Version set the environment you want to be the default one</para> + </listitem> + <listitem> + <para>For Project Template set the template you want to be the default one</para> + </listitem> + </orderedlist> + + <figure> + <title>Changing Enviroment Template</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_36.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="ChangingDefaultProjectTemplateDuringProjectCreatio8n"> + <?dbhtml filename="ChangingDefaultEnvironmentDuringProjectCreation.html"?> + <title>Changing Default Project Template During Project Creation</title> + + <para>To change the default project template for either JSF or Struts new project + creation:</para> + + <orderedlist> + <listitem> + <para>Select<emphasis> + <property> Window > Preferences > JBoss Tools > Web > {JSF or Struts} > + Project</property> + </emphasis></para> + </listitem> + <listitem> + <para>For Project Template set the template you want to be the default one</para> + </listitem> + </orderedlist> + + <figure> + <title>Changing Project Template</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preferences/preferences_37.png"/> + </imageobject> + </mediaobject> + </figure> + </section> +--> +</chapter> + +</book>