March 2010 - jbosstools-commits - Jboss List Archives

JBoss Tools SVN: r20599 - in branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide: en and 1 other directory.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2010-03-03 07:09:12 -0500 (Wed, 03 Mar 2010) New Revision: 20599 Modified: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en/master.xml branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en/master_output.xml branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/pom.xml Log: <html><head><meta name="qrichtext" content="1" /></head><body style="font-size:9pt;font-family:Sans Serif"> <p>https://jira.jboss.org/jira/browse/JBDS-1107 -Updated docs source files here with the ones for JBDS 3.0.0 GA release. </p> <p></p> </body></html> Modified: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en/master.xml =================================================================== --- branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en/master.xml 2010-03-03 12:06:57 UTC (rev 20598) +++ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en/master.xml 2010-03-03 12:09:12 UTC (rev 20599) @@ -45,14 +45,14 @@ <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author> <copyright> - <year>2007</year> + <year>2007</year> <year>2008</year> - <year>2009</year> + <year>2009</year> <year>2010</year> <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo> - Version: 3.1.0.CR1 + Version: 3.1.0.GA </releaseinfo> <abstract> @@ -74,4 +74,4 @@ &managed_beans; &creation_and_registration; &jsf_project_verification; -</book> +</book> Modified: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en/master_output.xml =================================================================== --- branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en/master_output.xml 2010-03-03 12:06:57 UTC (rev 20598) +++ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en/master_output.xml 2010-03-03 12:09:12 UTC (rev 20599) @@ -26,1960 +26,1962 @@ <!ENTITY migrationlink "../../Exadel-migration/html_single/index.html"> -]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> - <bookinfo> - <title>JSF Tools Reference Guide</title> - <corpauthor> - <inlinemediaobject> - <imageobject role="fo"> - <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata> - </imageobject> - <imageobject role="html"> - <imagedata></imagedata> - </imageobject> - </inlinemediaobject> - </corpauthor> - <author><firstname>Anatoly</firstname><surname>Fedosik</surname></author> - <author><firstname>Olga</firstname><surname>Chikvina</surname></author> - <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author> - - <pubdate>April 2008</pubdate> - <copyright> - <year>2007</year> - <year>2009</year> - <holder>JBoss by Red Hat</holder> - </copyright> - <releaseinfo><diffmk:wrapper diffmk:change="changed"> - Version: 3.1.0.CR1 - </diffmk:wrapper></releaseinfo> - -<abstract> - <title></title> - <para> - <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf_tools_ref_guide/...">PDF version</ulink> - </para> -</abstract> - - </bookinfo> - - <toc></toc> - - -<chapter id="introduction" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/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 release documentation you can find at<ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para> - <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs</ulink>.</para> - </section> -</chapter> - - -<chapter id="jsf_support" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/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> - -  - <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> - -  -  - </section> - -  - </section> - - - - - - - - - - -  -</chapter> - - -<chapter id="projects" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/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 > New > Project > JBoos Tools - Web > JSF > 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>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 > 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 > 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> - <section> - <title>Relevant Resources Links</title> - - <para>You can find more in-depth explanation on how to work with special wizards, editors and views that can - be used in various scenarios while developing JSF applications in our <ulink url="../../jsf/html_single/index.html">Visual Web Tools guide</ulink>.</para> - </section> -</chapter> - - -<chapter id="webxml_editor" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/jsf/docs/jsf_tools_ref_guide/en/modules/webxml_editor.xml" xreflabel="webxml_editor"> - <?dbhtml filename="webxml_editor.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>JSF Tools</keyword> - </keywordset> - </chapterinfo> - - <title>Web.xml Editor</title> - - <para>The <emphasis> - <property moreinfo="none">web.xml</property></emphasis> file inside the <emphasis> - <property moreinfo="none">WEB-INF</property></emphasis> folder is a deployment descriptor file for a Web Application. It - describes the servlets and other components and deployment properties that make up your application.</para> - - <para><property moreinfo="none">JBoss Tools</property> add the <emphasis> - <property moreinfo="none">web.xml</property></emphasis> file to created JSF project automatically and provides a special editor for its editing. - See the Visual Web Tools guide that gives a descriptive information on the <ulink url="../../jsf/html_single/index.html#GraphicalWebApplicationFileEditor">web.xml editor</ulink>.</para> -</chapter> - -<chapter id="jsf_config_file" role="updated" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/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" role="updated"> - - <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 > 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/jbosstools-3.1.0.CR1/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 > 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/jbosstools-3.1.0.CR1/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/jbosstools-3.1.0.CR1/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> -  - <para>Many different rules are checked for a JSF project that can be configured by selecting <emphasis> - <property moreinfo="none">Window > Preferences</property> - </emphasis> from the menu bar, selecting <emphasis> - <property moreinfo="none">JBoss Tools > Web > 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&op=viewforum&f=201">JBoss - Tools Forum</ulink>.</para> -</chapter> - -</book> +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + <bookinfo> + <title>JSF Tools Reference Guide</title> + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata> + </imageobject> + <imageobject role="html"> + <imagedata></imagedata> + </imageobject> + </inlinemediaobject> + </corpauthor> + <author><firstname>Anatoly</firstname><surname>Fedosik</surname></author> + <author><firstname>Olga</firstname><surname>Chikvina</surname></author> + <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author> + + <copyright> + <year>2007</year> + <year>2008</year> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo><diffmk:wrapper diffmk:change="changed"> + Version: 3.1.0.GA + </diffmk:wrapper></releaseinfo> + +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf_tools_ref_guide/...">PDF version</ulink> + </para> +</abstract> + + </bookinfo> + + <toc></toc> + + +<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/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 release documentation you can find at<ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para> + <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs</ulink>.</para> + </section> +</chapter> + + +<chapter id="jsf_support" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/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> + +  + <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> + +  +  + </section> + +  + </section> + + + + + + + + + + +  +</chapter> + + +<chapter id="projects" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/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 > New > Project > JBoos Tools + Web > JSF > 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>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 > 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 > 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> + <section> + <title>Relevant Resources Links</title> + + <para>You can find more in-depth explanation on how to work with special wizards, editors and views that can + be used in various scenarios while developing JSF applications in our <ulink url="../../jsf/html_single/index.html">Visual Web Tools guide</ulink>.</para> + </section> +</chapter> + + +<chapter id="webxml_editor" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_ref_guide/en/modules/webxml_editor.xml" xreflabel="webxml_editor"> + <?dbhtml filename="webxml_editor.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>JSF Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Web.xml Editor</title> + + <para>The <emphasis> + <property moreinfo="none">web.xml</property></emphasis> file inside the <emphasis> + <property moreinfo="none">WEB-INF</property></emphasis> folder is a deployment descriptor file for a Web Application. It + describes the servlets and other components and deployment properties that make up your application.</para> + + <para><property moreinfo="none">JBoss Tools</property> add the <emphasis> + <property moreinfo="none">web.xml</property></emphasis> file to created JSF project automatically and provides a special editor for its editing. + See the Visual Web Tools guide that gives a descriptive information on the <ulink url="../../jsf/html_single/index.html#GraphicalWebApplicationFileEditor">web.xml editor</ulink>.</para> +</chapter> + +<chapter id="jsf_config_file" role="updated" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/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" role="updated"> + + <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 > 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/vchukhutsina/repos/ochik_jboss/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 > 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/vchukhutsina/repos/ochik_jboss/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/vchukhutsina/repos/ochik_jboss/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> +  + <para>Many different rules are checked for a JSF project that can be configured by selecting <emphasis> + <property moreinfo="none">Window > Preferences</property> + </emphasis> from the menu bar, selecting <emphasis> + <property moreinfo="none">JBoss Tools > Web > 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&op=viewforum&f=201">JBoss + Tools Forum</ulink>.</para> +</chapter> + +</book> Modified: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/pom.xml =================================================================== --- branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/pom.xml 2010-03-03 12:06:57 UTC (rev 20598) +++ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/pom.xml 2010-03-03 12:09:12 UTC (rev 20599) @@ -23,7 +23,7 @@ <profile> <id>releaseJBDS</id> <properties> - <master>master_output.xml</master> + <master>master.xml</master> <xsl-single>classpath:/xslt/com/jboss/tools/xhtml-single-release.xsl</xsl-single> <xsl-chunked>classpath:/xslt/com/jboss/tools/xhtml-release.xsl</xsl-chunked> <xsl-pdf>classpath:/xslt/com/jboss/tools/pdf.xsl</xsl-pdf>

14 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r20598 - in branches/jbosstools-3.1.x/jsf/docs/jsf_tools_tutorial: en and 1 other directory.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2010-03-03 07:06:57 -0500 (Wed, 03 Mar 2010) New Revision: 20598 Modified: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_tutorial/en/master.xml branches/jbosstools-3.1.x/jsf/docs/jsf_tools_tutorial/en/master_output.xml branches/jbosstools-3.1.x/jsf/docs/jsf_tools_tutorial/pom.xml Log: <html><head><meta name="qrichtext" content="1" /></head><body style="font-size:9pt;font-family:Sans Serif"> <p>https://jira.jboss.org/jira/browse/JBDS-1107 -Updated docs source files here with the ones for JBDS 3.0.0 GA release. </p> <p></p> </body></html> Modified: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_tutorial/en/master.xml =================================================================== --- branches/jbosstools-3.1.x/jsf/docs/jsf_tools_tutorial/en/master.xml 2010-03-03 12:06:03 UTC (rev 20597) +++ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_tutorial/en/master.xml 2010-03-03 12:06:57 UTC (rev 20598) @@ -44,22 +44,22 @@ <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author> <copyright> - <year>2007</year> + <year>2007</year> <year>2008</year> - <year>2009</year> + <year>2009</year> <year>2010</year> <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo> - Version: 3.1.0.CR1 + Version: 3.1.0.GA </releaseinfo> <abstract> <title/> <para> - <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/struts_tools_tutoria...">PDF version</ulink> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf_tools_tutorial/p...">PDF version</ulink> </para> </abstract> Modified: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_tutorial/en/master_output.xml =================================================================== --- branches/jbosstools-3.1.x/jsf/docs/jsf_tools_tutorial/en/master_output.xml 2010-03-03 12:06:03 UTC (rev 20597) +++ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_tutorial/en/master_output.xml 2010-03-03 12:06:57 UTC (rev 20598) @@ -23,847 +23,850 @@ <!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> - <corpauthor> - <inlinemediaobject> - <imageobject role="fo"> - <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata> - </imageobject> - <imageobject role="html"> - <imagedata></imagedata> - </imageobject> - </inlinemediaobject> - </corpauthor> - <author><firstname>Anatoly</firstname><surname>Fedosik</surname></author> - <author><firstname>Olga</firstname><surname>Chikvina</surname></author> - <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author> - - <pubdate>April 2008</pubdate> - <copyright> - <year>2007</year> - <year>2009</year> - <holder>JBoss by Red Hat</holder> - </copyright> - - <releaseinfo><diffmk:wrapper diffmk:change="changed"> - Version: 3.1.0.CR1 - </diffmk:wrapper></releaseinfo> - - -<abstract> - <title></title> - <para> - <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/struts_tools_tutoria...">PDF version</ulink> - </para> -</abstract> - - - </bookinfo> - - <toc></toc> - - - -<chapter id="introduction" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/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 <name>!" 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>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="2"> - - <colspec align="left" colnum="1" colwidth="2*"></colspec> - <colspec colnum="2" colwidth="4*"></colspec> - - - <thead> - <row> - <entry>Feature</entry> - <entry>Benefit</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> - - </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> - - </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> - - </row> - - <row> - <entry>Support for Managed Beans</entry> - <entry>Adding new managed beans, generating code for attributes, properties - and getter/setter methods.</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> - - </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> - - </row> - </tbody> - </tgroup> - </table> - - </section> - - - <section> - <title>Other relevant resources on the topic</title> - <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at <ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para> - <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs</ulink>.</para> - </section> - -</chapter> - - -<chapter id="jsf_application" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/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 > Open Perspective > Web Development</property> - </emphasis> from the menu bar or by selecting <emphasis> - <property moreinfo="none">Window > Open Perspective > 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 > New > Project...</property> - </emphasis></para> - </listitem> - <listitem> - <para>Select <emphasis> - <property moreinfo="none">JBoss Tools Web > JSF > 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/jbosstools-3.1.0.CR1/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 (<inlinemediaobject> - <imageobject> - <imagedata fileref="images/jsf_application/jsf_application_3.png"></imagedata> - </imageobject> - </inlinemediaobject>) to get an arrow cursor with a two-pronged plug at the arrow's bottom.</para> - </listitem> - </itemizedlist> - - <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 > 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/jbosstools-3.1.0.CR1/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 > 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/jbosstools-3.1.0.CR1/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"><h:form></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 > personBean > 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 > 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"> -Please enter name: -<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 > 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 > personBean > 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/jbosstools-3.1.0.CR1/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 > WebContent</property> - </emphasis> and select <emphasis> - <property moreinfo="none">New > 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 > Save</property> - </emphasis> from the menu bar</para> - </listitem> - </itemizedlist> - </chapter> - -<chapter id="running_application" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/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(<inlinemediaobject> - <imageobject> - <imagedata fileref="images/jsf_application/jsf_application_10.png"></imagedata> - </imageobject> - </inlinemediaobject>) or right click your project folder and select <emphasis> - <property moreinfo="none">Run As > Run on Server</property> - </emphasis>:</para> - </listitem> - </itemizedlist> - - <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/jbosstools-3.1.0.CR1/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.html">JSF - 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">JSF - FAQ</ulink></para> - <para>Download: <ulink url="http://java.sun.com/javaee/javaserverfaces/download.html">JavaServer - 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&op=viewforum&f=201">JBoss - Tools Forum</ulink>.</para> -</chapter> - -</book> +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + + <bookinfo> + <title>JSF Tools Tutorial</title> + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata> + </imageobject> + <imageobject role="html"> + <imagedata></imagedata> + </imageobject> + </inlinemediaobject> + </corpauthor> + <author><firstname>Anatoly</firstname><surname>Fedosik</surname></author> + <author><firstname>Olga</firstname><surname>Chikvina</surname></author> + <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author> + + <copyright> + <year>2007</year> + <year>2008</year> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + + <releaseinfo><diffmk:wrapper diffmk:change="changed"> + Version: 3.1.0.GA + </diffmk:wrapper></releaseinfo> + + +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf_tools_tutorial/p...">PDF version</ulink> + </para> +</abstract> + + + </bookinfo> + + <toc></toc> + + + +<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/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 <name>!" 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>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="2"> + + <colspec align="left" colnum="1" colwidth="2*"></colspec> + <colspec colnum="2" colwidth="4*"></colspec> + + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</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> + + </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> + + </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> + + </row> + + <row> + <entry>Support for Managed Beans</entry> + <entry>Adding new managed beans, generating code for attributes, properties + and getter/setter methods.</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> + + </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> + + </row> + </tbody> + </tgroup> + </table> + + </section> + + + <section> + <title>Other relevant resources on the topic</title> + <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at <ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para> + <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs</ulink>.</para> + </section> + +</chapter> + + +<chapter id="jsf_application" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/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 > Open Perspective > Web Development</property> + </emphasis> from the menu bar or by selecting <emphasis> + <property moreinfo="none">Window > Open Perspective > 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 > New > Project...</property> + </emphasis></para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">JBoss Tools Web > JSF > 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/vchukhutsina/repos/ochik_jboss/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 (<inlinemediaobject> + <imageobject> + <imagedata fileref="images/jsf_application/jsf_application_3.png"></imagedata> + </imageobject> + </inlinemediaobject>) to get an arrow cursor with a two-pronged plug at the arrow's bottom.</para> + </listitem> + </itemizedlist> + + <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 > Save</property> + </emphasis> from the menu bar</para> + </listitem> + </itemizedlist> + </section> + +</chapter> + +<chapter id="adding_managed_bean" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/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 > 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/vchukhutsina/repos/ochik_jboss/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"><h:form></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 > personBean > 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 > 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"> +Please enter name: +<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 > 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 > personBean > 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/vchukhutsina/repos/ochik_jboss/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 > WebContent</property> + </emphasis> and select <emphasis> + <property moreinfo="none">New > 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 > Save</property> + </emphasis> from the menu bar</para> + </listitem> + </itemizedlist> + </chapter> + +<chapter id="running_application" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/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(<inlinemediaobject> + <imageobject> + <imagedata fileref="images/jsf_application/jsf_application_10.png"></imagedata> + </imageobject> + </inlinemediaobject>) or right click your project folder and select <emphasis> + <property moreinfo="none">Run As > Run on Server</property> + </emphasis>:</para> + </listitem> + </itemizedlist> + + <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/vchukhutsina/repos/ochik_jboss/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.html">JSF + 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">JSF + FAQ</ulink></para> + <para>Download: <ulink url="http://java.sun.com/javaee/javaserverfaces/download.html">JavaServer + 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&op=viewforum&f=201">JBoss + Tools Forum</ulink>.</para> +</chapter> + +</book> Modified: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_tutorial/pom.xml =================================================================== --- branches/jbosstools-3.1.x/jsf/docs/jsf_tools_tutorial/pom.xml 2010-03-03 12:06:03 UTC (rev 20597) +++ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_tutorial/pom.xml 2010-03-03 12:06:57 UTC (rev 20598) @@ -23,7 +23,7 @@ <profile> <id>releaseJBDS</id> <properties> - <master>master_output.xml</master> + <master>master.xml</master> <xsl-single>classpath:/xslt/com/jboss/tools/xhtml-single-release.xsl</xsl-single> <xsl-chunked>classpath:/xslt/com/jboss/tools/xhtml-release.xsl</xsl-chunked> <xsl-pdf>classpath:/xslt/com/jboss/tools/pdf.xsl</xsl-pdf>

14 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r20597 - branches/jbosstools-3.1.x/jsf/docs/userguide/en/images/visual_page.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2010-03-03 07:06:03 -0500 (Wed, 03 Mar 2010) New Revision: 20597 Added: branches/jbosstools-3.1.x/jsf/docs/userguide/en/images/visual_page/editors_features_27a.png branches/jbosstools-3.1.x/jsf/docs/userguide/en/images/visual_page/message.png Log: <html><head><meta name="qrichtext" content="1" /></head><body style="font-size:9pt;font-family:Sans Serif"> <p>https://jira.jboss.org/jira/browse/JBDS-1107 -Updated docs source files here with the ones for JBDS 3.0.0 GA release. </p> <p></p> </body></html> Added: branches/jbosstools-3.1.x/jsf/docs/userguide/en/images/visual_page/editors_features_27a.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/userguide/en/images/visual_page/editors_features_27a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/userguide/en/images/visual_page/message.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/userguide/en/images/visual_page/message.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream

14 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r20595 - branches/jbosstools-3.1.x/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern.

by jbosstools-commits＠lists.jboss.org

Author: scabanovich Date: 2010-03-03 06:59:59 -0500 (Wed, 03 Mar 2010) New Revision: 20595 Modified: branches/jbosstools-3.1.x/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern/CompoundPattern.java branches/jbosstools-3.1.x/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern/PatternLoader.java branches/jbosstools-3.1.x/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern/PrefixUrlPattern.java Log: https://jira.jboss.org/jira/browse/JBIDE-5920 Modified: branches/jbosstools-3.1.x/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern/CompoundPattern.java =================================================================== --- branches/jbosstools-3.1.x/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern/CompoundPattern.java 2010-03-03 11:50:38 UTC (rev 20594) +++ branches/jbosstools-3.1.x/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern/CompoundPattern.java 2010-03-03 11:59:59 UTC (rev 20595) @@ -57,7 +57,11 @@ * @see org.jboss.tools.jsf.web.pattern.JSFUrlPattern#getJSFPaths(java.lang.String) */ public List<String> getJSFPaths(String url) { - return new ArrayList<String>(); + List<String> result = new ArrayList<String>(); + for (JSFUrlPattern pattern: patterns) { + result.addAll(pattern.getJSFPaths(url)); + } + return result; } } Modified: branches/jbosstools-3.1.x/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern/PatternLoader.java =================================================================== --- branches/jbosstools-3.1.x/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern/PatternLoader.java 2010-03-03 11:50:38 UTC (rev 20594) +++ branches/jbosstools-3.1.x/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern/PatternLoader.java 2010-03-03 11:59:59 UTC (rev 20595) @@ -83,7 +83,6 @@ String n = p.substring(2); for (int i = 0; i < n.length(); i++) if(!Character.isJavaIdentifierPart(n.charAt(i))) return null; - if(n.equals("jsf")) return null; //default pattern PostfixUrlPattern up = new PostfixUrlPattern(); up.setPostfix(p.substring(1)); return up; Modified: branches/jbosstools-3.1.x/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern/PrefixUrlPattern.java =================================================================== --- branches/jbosstools-3.1.x/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern/PrefixUrlPattern.java 2010-03-03 11:50:38 UTC (rev 20594) +++ branches/jbosstools-3.1.x/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern/PrefixUrlPattern.java 2010-03-03 11:59:59 UTC (rev 20595) @@ -45,7 +45,10 @@ * @see org.jboss.tools.jsf.web.pattern.JSFUrlPattern#getJSFPaths(java.lang.String) */ public List<String> getJSFPaths(String url) { - return new ArrayList<String>(); + List<String> result = new ArrayList<String>(); + String path = getJSFPath(url); + if(path != null && path.length() > 0) result.add(path); + return result; } public String toString() {

14 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r20594 - trunk/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern.

by jbosstools-commits＠lists.jboss.org

Author: scabanovich Date: 2010-03-03 06:50:38 -0500 (Wed, 03 Mar 2010) New Revision: 20594 Modified: trunk/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern/CompoundPattern.java trunk/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern/PatternLoader.java trunk/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern/PrefixUrlPattern.java Log: https://jira.jboss.org/jira/browse/JBIDE-5920 Modified: trunk/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern/CompoundPattern.java =================================================================== --- trunk/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern/CompoundPattern.java 2010-03-03 11:26:38 UTC (rev 20593) +++ trunk/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern/CompoundPattern.java 2010-03-03 11:50:38 UTC (rev 20594) @@ -57,7 +57,11 @@ * @see org.jboss.tools.jsf.web.pattern.JSFUrlPattern#getJSFPaths(java.lang.String) */ public List<String> getJSFPaths(String url) { - return new ArrayList<String>(); + List<String> result = new ArrayList<String>(); + for (JSFUrlPattern pattern: patterns) { + result.addAll(pattern.getJSFPaths(url)); + } + return result; } } Modified: trunk/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern/PatternLoader.java =================================================================== --- trunk/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern/PatternLoader.java 2010-03-03 11:26:38 UTC (rev 20593) +++ trunk/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern/PatternLoader.java 2010-03-03 11:50:38 UTC (rev 20594) @@ -83,7 +83,6 @@ String n = p.substring(2); for (int i = 0; i < n.length(); i++) if(!Character.isJavaIdentifierPart(n.charAt(i))) return null; - if(n.equals("jsf")) return null; //default pattern PostfixUrlPattern up = new PostfixUrlPattern(); up.setPostfix(p.substring(1)); return up; Modified: trunk/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern/PrefixUrlPattern.java =================================================================== --- trunk/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern/PrefixUrlPattern.java 2010-03-03 11:26:38 UTC (rev 20593) +++ trunk/jsf/plugins/org.jboss.tools.jsf/src/org/jboss/tools/jsf/web/pattern/PrefixUrlPattern.java 2010-03-03 11:50:38 UTC (rev 20594) @@ -45,7 +45,10 @@ * @see org.jboss.tools.jsf.web.pattern.JSFUrlPattern#getJSFPaths(java.lang.String) */ public List<String> getJSFPaths(String url) { - return new ArrayList<String>(); + List<String> result = new ArrayList<String>(); + String path = getJSFPath(url); + if(path != null && path.length() > 0) result.add(path); + return result; } public String toString() {

14 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r20593 - trunk/seam/plugins/org.jboss.tools.seam.core/src/org/jboss/tools/seam/internal/core/validation.

by jbosstools-commits＠lists.jboss.org

Author: akazakov Date: 2010-03-03 06:26:38 -0500 (Wed, 03 Mar 2010) New Revision: 20593 Modified: trunk/seam/plugins/org.jboss.tools.seam.core/src/org/jboss/tools/seam/internal/core/validation/SeamCoreValidator.java Log: https://jira.jboss.org/jira/browse/JBIDE-5892 Modified: trunk/seam/plugins/org.jboss.tools.seam.core/src/org/jboss/tools/seam/internal/core/validation/SeamCoreValidator.java =================================================================== --- trunk/seam/plugins/org.jboss.tools.seam.core/src/org/jboss/tools/seam/internal/core/validation/SeamCoreValidator.java 2010-03-03 11:25:26 UTC (rev 20592) +++ trunk/seam/plugins/org.jboss.tools.seam.core/src/org/jboss/tools/seam/internal/core/validation/SeamCoreValidator.java 2010-03-03 11:26:38 UTC (rev 20593) @@ -158,8 +158,10 @@ SeamProjectsSet set = new SeamProjectsSet(project); IProject warProject = set.getWarProject(); - seamProject = SeamCorePlugin.getSeamProject(warProject, false); - projectName = seamProject.getProject().getName(); + if(warProject.isAccessible()) { + seamProject = SeamCorePlugin.getSeamProject(warProject, false); + projectName = seamProject.getProject().getName(); + } } private boolean isPreferencesEnabled(IProject project) { @@ -172,6 +174,9 @@ */ public IStatus validate(Set<IFile> changedFiles, IProject project, ContextValidationHelper validationHelper, ValidatorManager manager, IReporter reporter) throws ValidationException { init(project, validationHelper, manager, reporter); + if(seamProject==null) { + return OK_STATUS; + } displaySubtask(SeamValidationMessages.SEARCHING_RESOURCES, new String[]{projectName}); IWorkspaceRoot root = ResourcesPlugin.getWorkspace().getRoot(); @@ -269,6 +274,9 @@ */ public IStatus validateAll(IProject project, ContextValidationHelper validationHelper, ValidatorManager manager, IReporter reporter) throws ValidationException { init(project, validationHelper, manager, reporter); + if(seamProject==null) { + return OK_STATUS; + } removeAllMessagesFromResource(seamProject.getProject()); ISeamComponent[] components = seamProject.getComponents(); for (ISeamComponent component : components) {

14 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r20592 - trunk/seam/plugins/org.jboss.tools.seam.core/templates/ejb.

by jbosstools-commits＠lists.jboss.org

Author: akazakov Date: 2010-03-03 06:25:26 -0500 (Wed, 03 Mar 2010) New Revision: 20592 Modified: trunk/seam/plugins/org.jboss.tools.seam.core/templates/ejb/.project Log: https://jira.jboss.org/jira/browse/JBIDE-5982 Modified: trunk/seam/plugins/org.jboss.tools.seam.core/templates/ejb/.project =================================================================== --- trunk/seam/plugins/org.jboss.tools.seam.core/templates/ejb/.project 2010-03-03 11:18:52 UTC (rev 20591) +++ trunk/seam/plugins/org.jboss.tools.seam.core/templates/ejb/.project 2010-03-03 11:25:26 UTC (rev 20592) @@ -25,6 +25,11 @@ <arguments> </arguments> </buildCommand> + <buildCommand> + <name>org.jboss.tools.jst.web.kb.kbbuilder</name> + <arguments> + </arguments> + </buildCommand> </buildSpec> <natures> <nature>org.eclipse.wst.common.project.facet.core.nature</nature> @@ -32,5 +37,6 @@ <nature>org.eclipse.wst.common.modulecore.ModuleCoreNature</nature> <nature>org.eclipse.jem.workbench.JavaEMFNature</nature> <nature>org.jboss.tools.seam.core.seamnature</nature> + <nature>org.jboss.tools.jst.web.kb.kbnature</nature> </natures> </projectDescription>

14 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r20591 - in branches/jbosstools-3.1.x/bpel/docs/reference: en and 1 other directory.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2010-03-03 06:18:52 -0500 (Wed, 03 Mar 2010) New Revision: 20591 Modified: branches/jbosstools-3.1.x/bpel/docs/reference/en/master.xml branches/jbosstools-3.1.x/bpel/docs/reference/en/master_output.xml branches/jbosstools-3.1.x/bpel/docs/reference/pom.xml Log: <html><head><meta name="qrichtext" content="1" /></head><body style="font-size:9pt;font-family:Sans Serif"> <p>https://jira.jboss.org/jira/browse/JBDS-1107 -Updated docs source files here with the ones for JBDS 3.0.0 GA release. </p> <p></p> </body></html> Modified: branches/jbosstools-3.1.x/bpel/docs/reference/en/master.xml =================================================================== --- branches/jbosstools-3.1.x/bpel/docs/reference/en/master.xml 2010-03-03 11:14:36 UTC (rev 20590) +++ branches/jbosstools-3.1.x/bpel/docs/reference/en/master.xml 2010-03-03 11:18:52 UTC (rev 20591) @@ -28,12 +28,12 @@ <author><firstname>Denny</firstname><surname>Xu</surname><email>dxu(a)redhat.com</email></author> <author><firstname>Grid</firstname><surname>Qian</surname><email>fqian(a)redhat.com</email></author> <copyright> - <year>2009</year> + <year>2009</year> <year>2010</year> <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo> - Version: 1.0.0.CR1 + Version: 1.0.0.trunk </releaseinfo> <abstract> <title/> Modified: branches/jbosstools-3.1.x/bpel/docs/reference/en/master_output.xml =================================================================== --- branches/jbosstools-3.1.x/bpel/docs/reference/en/master_output.xml 2010-03-03 11:14:36 UTC (rev 20590) +++ branches/jbosstools-3.1.x/bpel/docs/reference/en/master_output.xml 2010-03-03 11:18:52 UTC (rev 20591) @@ -8,503 +8,507 @@ <!ENTITY deploy SYSTEM "modules/deploy.xml"> -]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> - - <bookinfo> - <title>JBoss BPEL User Guide</title> - - <corpauthor> - <inlinemediaobject> - <imageobject role="fo"> - <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata> - </imageobject> - <imageobject role="html"> - <imagedata></imagedata> - </imageobject> - </inlinemediaobject> - </corpauthor> - <author><firstname>Denny</firstname><surname>Xu</surname><email>dxu(a)redhat.com</email></author> - <author><firstname>Grid</firstname><surname>Qian</surname><email>fqian(a)redhat.com</email></author> - <pubdate>August 2009</pubdate> - <copyright> - <year>2009</year> - <holder>JBoss by Red Hat</holder> - </copyright> - <releaseinfo><diffmk:wrapper diffmk:change="changed"> - Version: 1.0.0.CR1 - </diffmk:wrapper></releaseinfo> -<abstract> - <title></title> - <para> - <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/bpel_ref_guide/pdf/B...">PDF version</ulink> - </para> -</abstract> - - - </bookinfo> - - <toc></toc> - -<chapter id="overview" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/bpel/docs/reference/en/modules/overview.xml"> - <title>JBoss BPEL project Overview</title> - - <para>JBoss BPEL project is a WS-BPEL 2.0 project that gives a way to create, edit, validate and deploy BPEL files to JBoss BPEL runtime. It is based on Eclipse - <ulink url="http://www.eclipse.org/bpel/">BPEL - project </ulink>. </para> - - <para>It improves the Eclipse BPEL project in the following way: </para> - <itemizedlist> - <listitem><para> Implements close integration with JBoss BPEL runtime. Adds a new project type for the deployment to JBoss BPEL runtime.</para></listitem> - <listitem><para> Supports two ways of deployment: one way is to deploy a bpel project directly to JBoss BPEL runtime. The other way is to deploy bpel files in JBoss ESB project to JBoss BPEL runtime. </para></listitem> - <listitem><para> Improves the BPEL validator and increases Eclipse BPEL editor's quality. </para></listitem> - </itemizedlist> - - <para> - <ulink url="http://docs.oasis-open.org/wsbpel/2.0/OS/wsbpel-v2.0-OS.html">WS-BPEL 2.0</ulink> - stands for Web Service Business Process Execution Language. Like EAI, BPEL is an XML-based language, - but BPEL is more specific and targeted. A programmer uses BPEL to join sometimes - disparate functions into an integrated process, resulting in a seamless use of the Internet to - conduct business transactions ranging from simple money exchanges to complex calculations and - asset reallocation. - </para> - -<section> - <title>Key Features of JBoss BPEL project</title> - <para>Let's start with looking through the table of the main features of JBoss BPEL editor project: </para> - - <table> - - <title>Key Functionality for JBoss BPEL editor project</title> - <tgroup cols="2"> - <colspec align="left" colnum="1" colwidth="2*"></colspec> - <colspec colnum="2" colwidth="4*"></colspec> - <thead> - <row> - <entry>Feature</entry> - <entry>Benefit</entry> - - </row> - </thead> - <tbody> - <row> - <entry><para>WS-BPEL 2.0 support</para></entry> - <entry><para>JBoss BPEL project supports the newest WS-BPEL 2.0 specifications. </para></entry> - </row> - <row> - <entry><para>Close integration with JBoss BPEL runtime</para></entry> - <entry><para>There are two ways to deploy BPEL files to JBoss BPEL runtime. - The user can deploy a BPEL project as a whole and can deploy BPEL files in - JBoss ESB project to JBoss BPEL runtime. </para></entry> - </row> - <row> - <entry><para>BPEL file editor</para></entry> - <entry><para>The user can use the editor separately to edit a BPEL file. </para></entry> - </row> - <row> - <entry><para>BPEL file validator</para></entry> - <entry><para>The validator can give the error messages about BPEL files to the user. </para></entry> - </row> - </tbody> - </tgroup> - </table> - -</section> - -</chapter> - -<chapter id="install" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/bpel/docs/reference/en/modules/install.xml"> - <title>Installation JBoss BPEL Tools</title> - <section id="installeclipse"> - <title>Installation JBoss BPEL editor</title> - <para>At first, you need Eclipse 3.5. You can get it from <ulink url="http://www.eclipse.org/downloads/download.php?file=/technology/epp/downlo...">Eclipse Web Site</ulink>. - </para> - <para>The JBoss BPEL editor is included into JBoss Tools. - You have some methods to install JBoss Tools. - See <ulink url="http://www.jboss.org/tools/download/installation.html">Installing JBoss Tools</ulink> for more information.</para> - <para>If you want to install only the JBoss BPEL editor, you can install it from <ulink url="http://jboss.org/tools/download/dev.html">JBoss Tools</ulink> page separately. - Please, note, that only JBoss Tools 3.1 or higher version includes JBoss BPEL editor. - </para> - </section> - <section id="installRuntime"> - <title>Installation JBoss BPEL Runtime</title> - <para>If you want to deploy a BPEL project to JBoss server, - you should download JBoss BPEL Runtime by yourself. The JBoss BPEL Runtime - is named RiftSaw. You can get it from <ulink url="http://jboss.org/riftsaw">JBoss RiftSaw page </ulink>. - </para> - </section> -</chapter> - -<chapter id="detail" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/bpel/docs/reference/en/modules/detail.xml"> - <title>Creating and editing a BPEL project</title> - <para>In the chapter we describe the necessary steps to create a new BPEL project and edit the BPEL files. - First of all, you should create a BPEL project. - </para> - <section id="createproject"> - <title>Creating a BPEL project</title> - <para>Create the project by selecting - <emphasis><property moreinfo="none">New > Project... > BPEL 2.0 > BPEL Project</property></emphasis> from the menu bar. - Then click the <property moreinfo="none">Next</property> button. - </para> - <figure float="0"> - <title>New BPEL Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/detail_createproject_1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>On this page of the <property moreinfo="none">New BPEL Project Wizard</property> enter a project name in the <property moreinfo="none">Project Name</property> - field,e.g enter <property moreinfo="none">HelloWorld</property>.</para> - - <figure float="0"> - <title>New BPEL Project Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/detail_createproject_2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>Click the <property moreinfo="none">Finish</property> button. So you have created the BPEL project named <property moreinfo="none">HelloWorld</property>. Its structure is like this: </para> - <figure float="0"> - <title>The BPEL Project structure</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/detail_createproject_3.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </section> - <section id="createprocess"> - <title>Creating a BPEL process</title> - <para>Now you should create a BPEL process. You can create it by selecting - <emphasis><property moreinfo="none">New > Others... > BPEL 2.0 > New BPEL Process File</property></emphasis>. - </para> - <figure float="0"> - <title>New BPEL Process File</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/detail_createprocess_1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>Click the <property moreinfo="none">Next</property> button. Enter the following information:</para> - <table> - - <title>Fields and values</title> - <tgroup cols="2"> - <colspec align="left" colnum="1" colwidth="2*"></colspec> - <colspec colnum="2" colwidth="4*"></colspec> - <thead> - <row> - <entry>Field</entry> - <entry>Value</entry> - - </row> - </thead> - <tbody> - <row> - <entry><para>BPEL Process Name</para></entry> - <entry><para>enter a process name. For example, <property moreinfo="none">HelloWorld</property>.</para></entry> - </row> - <row> - <entry><para>Namespace</para></entry> - <entry><para>enter or select a namespace for the BPEL process.</para></entry> - </row> - <row> - <entry><para>Template</para></entry> - <entry><para>select a template for the BPEL process. When you select the template, you will see the information about the template below on the page.</para></entry> - </row> - - </tbody> - </tgroup> - </table> - - <figure float="0"> - <title>New BPEL Process File Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/detail_createprocess_2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>Click the <property moreinfo="none">Next</property> button. On the second page make sure that the folder <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">HelloWorld/bpelContent</diffmk:wrapper></property> is selected. - Click <property moreinfo="none">Finish</property>. - </para> - <note> - <para>All of your files that are used in your BPEL project must be under the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">bpelContent</diffmk:wrapper></property> folder. Only in this case - these files can be deployed to JBoss server. - </para> - </note> - - <para>Up to now, you have got a simple BPEL process as on the screen below.</para> - <figure float="0"> - <title>A simple BPEL Process File</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/detail_createprocess_3.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>The next step, you can do is to edit the BPEL process file and then deploy it to JBoss server. </para> - </section> - <section id="editprocess"> - <title>Editing a BPEL process file</title> - <para>If the <emphasis><property moreinfo="none">Properties view</property></emphasis> and <emphasis><property moreinfo="none">Palette view</property></emphasis> are not opened, you can open the views by right-clicking the BPEL editor and selecting - <property moreinfo="none">Show in Properties</property>, <property moreinfo="none">Show Palette in Palette view</property>. Then you should have the view like this: - </para> - <figure float="0"> - <title>The BPEL editor view</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/detail_editprocess_1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>In the <emphasis><property moreinfo="none">Palette view</property></emphasis>, you can drag a BPEL element to the BPEL editor and drop it in the place you want.</para> - <para>In the <emphasis><property moreinfo="none">Properties view</property></emphasis>, you can get the information about every element of the BPEL process. - In the BPEL editor select any element you want,and then - the element's properties will be shown in the Properties view.The table below describes the tabs of the Properties view: - </para> - <table> - - <title>Tabs of the Property view</title> - <tgroup cols="2"> - <colspec align="left" colnum="1" colwidth="2*"></colspec> - <colspec colnum="2" colwidth="4*"></colspec> - <thead> - <row> - <entry>Tab</entry> - <entry>Description</entry> - - </row> - </thead> - <tbody> - <row> - <entry><para>Description</para></entry> - <entry><para>Shows the descriptive information about the element,e.g. <property moreinfo="none">Name</property> of the element.</para></entry> - </row> - <row> - <entry><para>Details</para></entry> - <entry><para>Shows the detailed and important information about the element. - It is the most important section of an element. - Most of the properties of an element are set in this section.</para></entry> - </row> - <row> - <entry><para>Join Behavior</para></entry> - <entry><para>Shows the <property moreinfo="none">Join Failure</property> property of the element.</para></entry> - </row> - <row> - <entry><para>Documentation</para></entry> - <entry><para>Shows the <property moreinfo="none">documentation</property> sub-element of an element.</para></entry> - </row> - <row> - <entry><para>Other</para></entry> - <entry><para>Every BPEL element has its own sections: Correlation section, Message Exchange section, and so on. We will - introduce them while using them.</para></entry> - </row> - </tbody> - </tgroup> - </table> - <para>In order to see how a simple BPEL process works in action, you should do some steps as below: </para> - <itemizedlist> - <listitem> - <para>Add an <property moreinfo="none">Assign</property> element between the <property moreinfo="none">receiveInput</property> element and <property moreinfo="none">replyOutput</property> element.</para> - </listitem> - <listitem> - <para>Click the <property moreinfo="none">Assign</property> element in the BPEL editor in order to get the properties information of it in the Properties view. - </para> - </listitem> - <listitem> - <para>In the <property moreinfo="none">Details</property> section of Properties view, you should click the <property moreinfo="none">New</property> button to add a <property moreinfo="none">copy</property> sub-element to the element. - Assign "input->payload->input" to "output->payload->result". At this time, an "<property moreinfo="none">initializer</property>" popup dialog appears. Click on the <property moreinfo="none">Yes</property> button in the dialog. - </para> - <figure float="0"> - <title>Add <property moreinfo="none">Assign</property> to the process</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/detail_editprocess_2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>Open the file "<property moreinfo="none">HelloWorldArtifacts.wsdl</property>" in the "<property moreinfo="none">HelloWorld</property>" project by double-clicking the file. Right-click the WSDL editor and select - <property moreinfo="none">Add Service</property>. A new service should appear in the editor. Name it <property moreinfo="none">HelloWorldProcessService</property>. It has the Port - named <property moreinfo="none">NewPort</property>. Select it, right-click on it and rename it to <property moreinfo="none">HelloWorldProcessPort</property> in the Properties - view. - </para> - <figure float="0"> - <title>Add <property moreinfo="none">Service</property> to the WSDL file</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/detail_editprocess_3.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>Right-click somewhere in the whitespace of the WSDL editor and select - <property moreinfo="none">Add Binding</property>. A new Binding component will appear in the editor. Name it <property moreinfo="none">HelloWorldSOAPBinding</property>. Select it, in the - General tab of the Properties view and select <property moreinfo="none">HelloWorld</property> as a port type in the <property moreinfo="none">PortType</property>. Then click on the - <property moreinfo="none">Generate Binding Content...</property> button to open the <property moreinfo="none">Binding Wizard</property>. In the wizard, select <property moreinfo="none">SOAP </property> - as the <property moreinfo="none">Protocol</property>. Finally, click the <property moreinfo="none">Finish</property> button to close the wizard. - </para> - <figure float="0"> - <title>Add a <property moreinfo="none">Binding</property> to the WSDL file</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/detail_editprocess_4.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>Click the <property moreinfo="none">HelloWorldProcessPort</property> property in the General section of the Properties view, select <property moreinfo="none">HelloWorldSOAPBinding</property> in - the <property moreinfo="none">Binding</property> combobox. In the <property moreinfo="none">Address</property> field input <ulink url="http://localhost:8080/bpel/processes/HelloWorld?wsdl">http://localhost:8080/bpel/processes/HelloWorld?wsdl</ulink>. - </para> - <figure float="0"> - <title>Add the <property moreinfo="none">HelloWorldSOAPBinding</property> to the <property moreinfo="none">HelloWorldProcessPort</property></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/detail_editprocess_5.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - <para>Now you have finished creating a simple BPEL process.As a next step, you can deploy the BPEL project to JBoss BPEL Runtime.</para> - - </section> -</chapter> - - -<chapter id="deploy" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/bpel/docs/reference/en/modules/deploy.xml"> - <title>Deploy a JBoss BPEL project to JBoss BPEL Runtime</title> - <section id="createdeploy"> - <title>Creating a bpel-deploy.xml file</title> - <para>If you want to deploy a BPEL project to JBoss BPEL Runtime, you should create a bpel-deploy.xml file. - JBoss tools can help you to create it: - </para> - <itemizedlist> - <listitem> - <para>Create the bpel-deploy.xml by selecting - <emphasis><property moreinfo="none">New > Other... > BPEL 2.0 > Apache ODE Deployment Descriptor</property></emphasis>. Click the <property moreinfo="none">Next</property> button. - </para> - <figure float="0"> - <title>New BPEL Deploy file</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/deploy_createdeploy_1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>On the next wizard page you should enter the following information:</para> - <para><emphasis><property moreinfo="none">BPEL Project</property></emphasis>: Click the <property moreinfo="none">Browse...</property> button to select the BPEL project in your workspace which you want to deploy to the runtime. - Please note, that you should select the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">bpelContent</diffmk:wrapper></property> folder in your new BPEL project as a value of <property moreinfo="none">BPEL Project</property> field because the bpel-deploy.xml should be created in this place. - </para> - <para><emphasis><property moreinfo="none">File name</property></emphasis>: The default value is bpel-deploy.xml. Please, don't change it.</para> - <para>Click on <property moreinfo="none">Finish</property> button to close the wizard and a new bpel-deploy.xml file will be created.</para> - <figure float="0"> - <title>New BPEL Deploy file Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/deploy_createdeploy_2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>Double-click the bpel-deploy.xml file to open it in ODE Descriptor Deployment Editor. - In the <property moreinfo="none">Inbound Interfaces</property> section, click the - <property moreinfo="none">Associated Port</property> column and select <property moreinfo="none">HelloWorldProcessPort</property> - in the dropdown box.The <property moreinfo="none">Related Service</property> and <property moreinfo="none">Binding Used</property> - columns should be automatically filled in. Save the <emphasis><property moreinfo="none">bpel-deploy.xml</property></emphasis>. - </para> - <figure float="0"> - <title>bpel-deploy.xml file editor</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/deploy_createdeploy_3.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - </section> - <section id="createruntime"> - <title>Creating JBoss BPEL Server</title> - <para>Suppose you have installed the <property moreinfo="none">JBoss BPEL Runtime-RiftSaw</property>, now you can create a server for JBoss BPEL runtime.</para> - <itemizedlist> - <listitem> - <para>Open the <property moreinfo="none">JBoss Server view</property> by selecting - <emphasis><property moreinfo="none">Windows > Show View > Other... > Server > JBoss Server view</property></emphasis>. - </para> - </listitem> - <listitem> - <para>Right-click the JBoss Server view and select - <emphasis><property moreinfo="none">New > Server</property></emphasis> to open the New Server Wizard: - </para> - <figure float="0"> - <title>New Server Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/deploy_createdeploy_4.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>Select <property moreinfo="none">JBoss AS 5.1 </property>as a server type. </para> - <note> - <para>Please note, that only JBoss As 5.1 or higher version supports BPEL.</para> - </note> - </listitem> - <listitem> - - <para>Click the <property moreinfo="none">Next</property> button. On the next page, you should input your <emphasis><property moreinfo="none">JBoss As</property></emphasis> location. Then click the <property moreinfo="none">Next</property> button and - you will get the page like this: - </para> - <figure float="0"> - <title>Add resource to the server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/deploy_createdeploy_5.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>Select <property moreinfo="none">HelloWorld</property>, then click the <property moreinfo="none">Add </property> button to add the project to the server. - Then click on the <property moreinfo="none">Finish</property> button. - </para> - <para>Start the server by right-clicking on the server and selecting the <property moreinfo="none">Start</property> item. </para> - - <figure float="0"> - <title>The started server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/deploy_createdeploy_6.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>If some aspects of server creation is not clear, please, read <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/as/html_single/index...">JBoss Server Manager Reference Guide</ulink> for more details.</para> - </listitem> - <listitem> - <para>You can enter the link <ulink url="http://localhost:8080/bpel/processes.html">http://localhost:8080/bpel/processes.html</ulink> to the browser to get the deployed processes.</para> - <figure float="0"> - <title>The BPEL console</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/deploy_createdeploy_7.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - <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&op=viewforum&f=201">JBoss Tools Users Forum</ulink> to ask questions. - There we are also waiting for your suggestions and comments.</para> - </section> -</chapter> -</book> +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + + <bookinfo> + <title>JBoss BPEL User Guide</title> + + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata> + </imageobject> + <imageobject role="html"> + <imagedata></imagedata> + </imageobject> + </inlinemediaobject> + </corpauthor> + <author><firstname>Denny</firstname><surname>Xu</surname><email>dxu(a)redhat.com</email></author> + <author><firstname>Grid</firstname><surname>Qian</surname><email>fqian(a)redhat.com</email></author> + <copyright> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo><diffmk:wrapper diffmk:change="changed"> + Version: 1.0.0.trunk + </diffmk:wrapper></releaseinfo> +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/bpel_ref_guide/pdf/B...">PDF version</ulink> + </para> +</abstract> + + + </bookinfo> + + <toc></toc> + +<chapter id="overview" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/bpel/docs/reference/en/modules/overview.xml"> + <title>JBoss BPEL project Overview</title> + + <para>JBoss BPEL project is a WS-BPEL 2.0 project that gives a way to create, edit, validate and deploy BPEL files to JBoss BPEL runtime. It is based on Eclipse + <ulink url="http://www.eclipse.org/bpel/">BPEL + project </ulink>. </para> + + <para>It improves the Eclipse BPEL project in the following way: </para> + <itemizedlist> + <listitem><para> Implements close integration with JBoss BPEL runtime. Adds a new project type for the deployment to JBoss BPEL runtime.</para></listitem> + <listitem><para> Supports two ways of deployment: one way is to deploy a bpel project directly to JBoss BPEL runtime. The other way is to deploy bpel files in JBoss ESB project to JBoss BPEL runtime. </para></listitem> + <listitem><para> Improves the BPEL validator and increases Eclipse BPEL editor's quality. </para></listitem> + </itemizedlist> + + <para> + <ulink url="http://docs.oasis-open.org/wsbpel/2.0/OS/wsbpel-v2.0-OS.html">WS-BPEL 2.0</ulink> + stands for Web Service Business Process Execution Language. Like EAI, BPEL is an XML-based language, + but BPEL is more specific and targeted. A programmer uses BPEL to join sometimes + disparate functions into an integrated process, resulting in a seamless use of the Internet to + conduct business transactions ranging from simple money exchanges to complex calculations and + asset reallocation. + </para> + +<section> + <title>Key Features of JBoss BPEL project</title> + <para>Let's start with looking through the table of the main features of JBoss BPEL editor project: </para> + + <table> + + <title>Key Functionality for JBoss BPEL editor project</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="2*"></colspec> + <colspec colnum="2" colwidth="4*"></colspec> + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + + </row> + </thead> + <tbody> + <row> + <entry><para>WS-BPEL 2.0 support</para></entry> + <entry><para>JBoss BPEL project supports the newest WS-BPEL 2.0 specifications. </para></entry> + </row> + <row> + <entry><para>Close integration with JBoss BPEL runtime</para></entry> + <entry><para>There are two ways to deploy BPEL files to JBoss BPEL runtime. + The user can deploy a BPEL project as a whole and can deploy BPEL files in + JBoss ESB project to JBoss BPEL runtime. </para></entry> + </row> + <row> + <entry><para>BPEL file editor</para></entry> + <entry><para>The user can use the editor separately to edit a BPEL file. </para></entry> + </row> + <row> + <entry><para>BPEL file validator</para></entry> + <entry><para>The validator can give the error messages about BPEL files to the user. </para></entry> + </row> + </tbody> + </tgroup> + </table> + +</section> + +</chapter> + +<chapter id="install" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/bpel/docs/reference/en/modules/install.xml"> + <title>Installation JBoss BPEL Tools</title> + <section id="installeclipse"> + <title>Installation JBoss BPEL editor</title> + <para>At first, you need Eclipse 3.5. You can get it from <ulink url="http://www.eclipse.org/downloads/download.php?file=/technology/epp/downlo...">Eclipse Web Site</ulink>. + </para> + <para>The JBoss BPEL editor is included into JBoss Tools. + You have some methods to install JBoss Tools. + See <ulink url="http://www.jboss.org/tools/download/installation.html">Installing JBoss Tools</ulink> for more information.</para> + <para>If you want to install only the JBoss BPEL editor, you can install it from <ulink url="http://jboss.org/tools/download/dev.html">JBoss Tools</ulink> page separately. + Please, note, that only JBoss Tools 3.1 or higher version includes JBoss BPEL editor. + </para> + </section> + <section id="installRuntime"> + <title>Installation JBoss BPEL Runtime</title> + <para>If you want to deploy a BPEL project to JBoss server, + you should download JBoss BPEL Runtime by yourself. The JBoss BPEL Runtime + is named RiftSaw. You can get it from <ulink url="http://jboss.org/riftsaw">JBoss RiftSaw page </ulink>. + </para> + </section> +</chapter> + +<chapter id="detail" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/bpel/docs/reference/en/modules/detail.xml"> + <title>Creating and editing a BPEL project</title> + <para>In the chapter we describe the necessary steps to create a new BPEL project and edit the BPEL files. + First of all, you should create a BPEL project. + </para> + <section id="createproject"> + <title>Creating a BPEL project</title> + <para>Create the project by selecting + <emphasis><property moreinfo="none">New > Project... > BPEL 2.0 > BPEL Project</property></emphasis> from the menu bar. + Then click the <property moreinfo="none">Next</property> button. + </para> + <figure float="0"> + <title>New BPEL Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/detail_createproject_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>On this page of the <property moreinfo="none">New BPEL Project Wizard</property> enter a project name in the <property moreinfo="none">Project Name</property> + field,e.g enter <property moreinfo="none">HelloWorld</property>.</para> + + <figure float="0"> + <title>New BPEL Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/detail_createproject_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click the <property moreinfo="none">Finish</property> button. So you have created the BPEL project named <property moreinfo="none">HelloWorld</property>. Its structure is like this: </para> + <figure float="0"> + <title>The BPEL Project structure</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/detail_createproject_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="createprocess"> + <title>Creating a BPEL process</title> + <para>Now you should create a BPEL process. You can create it by selecting + <emphasis><property moreinfo="none">New > Others... > BPEL 2.0 > New BPEL Process File</property></emphasis>. + </para> + <figure float="0"> + <title>New BPEL Process File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/detail_createprocess_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click the <property moreinfo="none">Next</property> button. Enter the following information:</para> + <table> + + <title>Fields and values</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="2*"></colspec> + <colspec colnum="2" colwidth="4*"></colspec> + <thead> + <row> + <entry>Field</entry> + <entry>Value</entry> + + </row> + </thead> + <tbody> + <row> + <entry><para>BPEL Process Name</para></entry> + <entry><para>enter a process name. For example, <property moreinfo="none">HelloWorld</property>.</para></entry> + </row> + <row> + <entry><para>Namespace</para></entry> + <entry><para>enter or select a namespace for the BPEL process.</para></entry> + </row> + <row> + <entry><para>Template</para></entry> + <entry><para>select a template for the BPEL process. When you select the template, you will see the information about the template below on the page.</para></entry> + </row> + + </tbody> + </tgroup> + </table> + + <figure float="0"> + <title>New BPEL Process File Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/detail_createprocess_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click the <property moreinfo="none">Next</property> button. On the second page make sure that the folder <property moreinfo="none">HelloWorld/bpelContent</property> is selected. + Click <property moreinfo="none">Finish</property>. + </para> + <note> + <para>All of your files that are used in your BPEL project must be under the <property moreinfo="none">bpelContent</property> folder. Only in this case + these files can be deployed to JBoss server. + </para> + </note> + + <para>Up to now, you have got a simple BPEL process as on the screen below.</para> + <figure float="0"> + <title>A simple BPEL Process File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/detail_createprocess_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The next step, you can do is to edit the BPEL process file and then deploy it to JBoss server. </para> + </section> + <section id="editprocess"> + <title>Editing a BPEL process file</title> + <para>If the <emphasis><property moreinfo="none">Properties view</property></emphasis> and <emphasis><property moreinfo="none">Palette view</property></emphasis> are not opened, you can open the views by right-clicking the BPEL editor and selecting + <property moreinfo="none">Show in Properties</property>, <property moreinfo="none">Show Palette in Palette view</property>. Then you should have the view like this: + </para> + <figure float="0"> + <title>The BPEL editor view</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/detail_editprocess_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>In the <emphasis><property moreinfo="none">Palette view</property></emphasis>, you can drag a BPEL element to the BPEL editor and drop it in the place you want.</para> + <para>In the <emphasis><property moreinfo="none">Properties view</property></emphasis>, you can get the information about every element of the BPEL process. + In the BPEL editor select any element you want,and then + the element's properties will be shown in the Properties view.The table below describes the tabs of the Properties view: + </para> + <table> + + <title>Tabs of the Property view</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="2*"></colspec> + <colspec colnum="2" colwidth="4*"></colspec> + <thead> + <row> + <entry>Tab</entry> + <entry>Description</entry> + + </row> + </thead> + <tbody> + <row> + <entry><para>Description</para></entry> + <entry><para>Shows the descriptive information about the element,e.g. <property moreinfo="none">Name</property> of the element.</para></entry> + </row> + <row> + <entry><para>Details</para></entry> + <entry><para>Shows the detailed and important information about the element. + It is the most important section of an element. + Most of the properties of an element are set in this section.</para></entry> + </row> + <row> + <entry><para>Join Behavior</para></entry> + <entry><para>Shows the <property moreinfo="none">Join Failure</property> property of the element.</para></entry> + </row> + <row> + <entry><para>Documentation</para></entry> + <entry><para>Shows the <property moreinfo="none">documentation</property> sub-element of an element.</para></entry> + </row> + <row> + <entry><para>Other</para></entry> + <entry><para>Every BPEL element has its own sections: Correlation section, Message Exchange section, and so on. We will + introduce them while using them.</para></entry> + </row> + </tbody> + </tgroup> + </table> + <para>In order to see how a simple BPEL process works in action, you should do some steps as below: </para> + <itemizedlist> + <listitem> + <para>Add an <property moreinfo="none">Assign</property> element between the <property moreinfo="none">receiveInput</property> element and <property moreinfo="none">replyOutput</property> element.</para> + </listitem> + <listitem> + <para>Click the <property moreinfo="none">Assign</property> element in the BPEL editor in order to get the properties information of it in the Properties view. + </para> + </listitem> + <listitem> + <para>In the <property moreinfo="none">Details</property> section of Properties view, you should click the <property moreinfo="none">New</property> button to add a <property moreinfo="none">copy</property> sub-element to the element. + Assign "input->payload->input" to "output->payload->result". At this time, an "<property moreinfo="none">initializer</property>" popup dialog appears. Click on the <property moreinfo="none">Yes</property> button in the dialog. + </para> + <figure float="0"> + <title>Add <property moreinfo="none">Assign</property> to the process</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/detail_editprocess_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Open the file "<property moreinfo="none">HelloWorldArtifacts.wsdl</property>" in the "<property moreinfo="none">HelloWorld</property>" project by double-clicking the file. Right-click the WSDL editor and select + <property moreinfo="none">Add Service</property>. A new service should appear in the editor. Name it <property moreinfo="none">HelloWorldProcessService</property>. It has the Port + named <property moreinfo="none">NewPort</property>. Select it, right-click on it and rename it to <property moreinfo="none">HelloWorldProcessPort</property> in the Properties + view. + </para> + <figure float="0"> + <title>Add <property moreinfo="none">Service</property> to the WSDL file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/detail_editprocess_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Right-click somewhere in the whitespace of the WSDL editor and select + <property moreinfo="none">Add Binding</property>. A new Binding component will appear in the editor. Name it <property moreinfo="none">HelloWorldSOAPBinding</property>. Select it, in the + General tab of the Properties view and select <property moreinfo="none">HelloWorld</property> as a port type in the <property moreinfo="none">PortType</property>. Then click on the + <property moreinfo="none">Generate Binding Content...</property> button to open the <property moreinfo="none">Binding Wizard</property>. In the wizard, select <property moreinfo="none">SOAP </property> + as the <property moreinfo="none">Protocol</property>. Finally, click the <property moreinfo="none">Finish</property> button to close the wizard. + </para> + <figure float="0"> + <title>Add a <property moreinfo="none">Binding</property> to the WSDL file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/detail_editprocess_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Click the <property moreinfo="none">HelloWorldProcessPort</property> property in the General section of the Properties view, select <property moreinfo="none">HelloWorldSOAPBinding</property> in + the <property moreinfo="none">Binding</property> combobox. In the <property moreinfo="none">Address</property> field input <ulink url="http://localhost:8080/bpel/processes/HelloWorld?wsdl">http://localhost:8080/bpel/processes/HelloWorld?wsdl</ulink>. + </para> + <figure float="0"> + <title>Add the <property moreinfo="none">HelloWorldSOAPBinding</property> to the <property moreinfo="none">HelloWorldProcessPort</property></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/detail_editprocess_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <para>Now you have finished creating a simple BPEL process.As a next step, you can deploy the BPEL project to JBoss BPEL Runtime.</para> + + </section> +</chapter> + + +<chapter id="deploy" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/bpel/docs/reference/en/modules/deploy.xml"> + <title>Deploy a JBoss BPEL project to JBoss BPEL Runtime</title> + <section id="createdeploy"> + <title>Creating a bpel-deploy.xml file</title> + <para>If you want to deploy a BPEL project to JBoss BPEL Runtime, you should create a bpel-deploy.xml file. + JBoss tools can help you to create it: + </para> + <itemizedlist> + <listitem> + <para>Create the bpel-deploy.xml by selecting + <emphasis><property moreinfo="none">New > Other... > BPEL 2.0 > Apache ODE Deployment Descriptor</property></emphasis>. Click the <property moreinfo="none">Next</property> button. + </para> + <figure float="0"> + <title>New BPEL Deploy file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/deploy_createdeploy_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>On the next wizard page you should enter the following information:</para> + <para><emphasis><property moreinfo="none">BPEL Project</property></emphasis>: Click the <property moreinfo="none">Browse...</property> button to select the BPEL project in your workspace which you want to deploy to the runtime. + Please note, that you should select the <property moreinfo="none">bpelContent</property> folder in your new BPEL project as a value of <property moreinfo="none">BPEL Project</property> field because the bpel-deploy.xml should be created in this place. + </para> + <para><emphasis><property moreinfo="none">File name</property></emphasis>: The default value is bpel-deploy.xml. Please, don't change it.</para> + <para>Click on <property moreinfo="none">Finish</property> button to close the wizard and a new bpel-deploy.xml file will be created.</para> + <figure float="0"> + <title>New BPEL Deploy file Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/deploy_createdeploy_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Double-click the bpel-deploy.xml file to open it in ODE Descriptor Deployment Editor. + In the <property moreinfo="none">Inbound Interfaces</property> section, click the + <property moreinfo="none">Associated Port</property> column and select <property moreinfo="none">HelloWorldProcessPort</property> + in the dropdown box.The <property moreinfo="none">Related Service</property> and <property moreinfo="none">Binding Used</property> + columns should be automatically filled in. Save the <emphasis><property moreinfo="none">bpel-deploy.xml</property></emphasis>. + </para> + <figure float="0"> + <title>bpel-deploy.xml file editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/deploy_createdeploy_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + </section> + <section id="createruntime"> + <title>Creating JBoss BPEL Server</title> + <para>Suppose you have installed the <property moreinfo="none">JBoss BPEL Runtime-RiftSaw</property>, now you can create a server for JBoss BPEL runtime.</para> + <itemizedlist> + <listitem> + <para>Open the <property moreinfo="none">JBoss Server view</property> by selecting + <emphasis><property moreinfo="none">Windows > Show View > Other... > Server > JBoss Server view</property></emphasis>. + </para> + </listitem> + <listitem> + <para>Right-click the JBoss Server view and select + <emphasis><property moreinfo="none">New > Server</property></emphasis> to open the New Server Wizard: + </para> + <figure float="0"> + <title>New Server Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/deploy_createdeploy_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Select <property moreinfo="none">JBoss AS 5.1 </property>as a server type. </para> + <note> + <para>Please note, that only JBoss As 5.1 or higher version supports BPEL.</para> + </note> + </listitem> + <listitem> + + <para>Click the <property moreinfo="none">Next</property> button. On the next page, you should input your <emphasis><property moreinfo="none">JBoss As</property></emphasis> location. Then click the <property moreinfo="none">Next</property> button and + you will get the page like this: + </para> + <figure float="0"> + <title>Add resource to the server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/deploy_createdeploy_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Select <property moreinfo="none">HelloWorld</property>, then click the <property moreinfo="none">Add </property> button to add the project to the server. + Then click on the <property moreinfo="none">Finish</property> button. + </para> + <para>Start the server by right-clicking on the server and selecting the <property moreinfo="none">Start</property> item. </para> + + <figure float="0"> + <title>The started server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/deploy_createdeploy_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>If some aspects of server creation is not clear, please, read <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/as/html_single/index...">JBoss Server Manager Reference Guide</ulink> for more details.</para> + </listitem> + <listitem> + <para>You can enter the link <ulink url="http://localhost:8080/bpel/processes.html">http://localhost:8080/bpel/processes.html</ulink> to the browser to get the deployed processes.</para> + <figure float="0"> + <title>The BPEL console</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/deploy_createdeploy_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <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&op=viewforum&f=201" + >JBoss Tools Users Forum</ulink> to ask questions. + There we are also waiting for your suggestions and comments.</para> + </section> +</chapter> +</book> Modified: branches/jbosstools-3.1.x/bpel/docs/reference/pom.xml =================================================================== --- branches/jbosstools-3.1.x/bpel/docs/reference/pom.xml 2010-03-03 11:14:36 UTC (rev 20590) +++ branches/jbosstools-3.1.x/bpel/docs/reference/pom.xml 2010-03-03 11:18:52 UTC (rev 20591) @@ -22,7 +22,7 @@ <profile> <id>releaseJBDS</id> <properties> - <master>master_output.xml</master> + <master>master.xml</master> <xsl-single>classpath:/xslt/com/jboss/tools/xhtml-single-release-nomarker.xsl</xsl-single> <xsl-chunked>classpath:/xslt/com/jboss/tools/xhtml-release-nomarker.xsl</xsl-chunked> <xsl-pdf>classpath:/xslt/com/jboss/tools/pdf.xsl</xsl-pdf>

14 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r20590 - branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2010-03-03 06:14:36 -0500 (Wed, 03 Mar 2010) New Revision: 20590 Added: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/annotations1_a.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/dali_integration10.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/dali_integration11.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/dali_integration7.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/dali_integration8.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/dali_integration9.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/diagramToolbar.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_0_b.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_19_d.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_4_d.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/sticky_but.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/toolbarAutolayout.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/toolbarExpandCollapse.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/toolbarRefresh.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/toolbarShowHideConnections.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/toolbarShowHideShapes.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/toolbarZoom.png Log: <html><head><meta name="qrichtext" content="1" /></head><body style="font-size:9pt;font-family:Sans Serif"> <p>https://jira.jboss.org/jira/browse/JBDS-1107 -Updated docs source files here with the ones for JBDS 3.0.0 GA release. </p> <p></p> </body></html> Added: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/annotations1_a.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/annotations1_a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/dali_integration10.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/dali_integration10.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/dali_integration11.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/dali_integration11.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/dali_integration7.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/dali_integration7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/dali_integration8.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/dali_integration8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/dali_integration9.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/dali_integration9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/diagramToolbar.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/diagramToolbar.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_0_b.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_0_b.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_19_d.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_19_d.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_4_d.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_4_d.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/sticky_but.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/sticky_but.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/toolbarAutolayout.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/toolbarAutolayout.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/toolbarExpandCollapse.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/toolbarExpandCollapse.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/toolbarRefresh.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/toolbarRefresh.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/toolbarShowHideConnections.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/toolbarShowHideConnections.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/toolbarShowHideShapes.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/toolbarShowHideShapes.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/toolbarZoom.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/toolbarZoom.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream

14 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r20589 - in branches/jbosstools-3.1.x/hibernatetools/docs/reference/en: modules and 1 other directory.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2010-03-03 06:10:34 -0500 (Wed, 03 Mar 2010) New Revision: 20589 Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/annotations1.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/diagram1.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/diagram2.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/map_diagram1.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/map_diagram2.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/map_diagram3.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_0.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_0_a.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_12_a.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_12_b.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_16.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_17.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_17_a.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_18.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_18_a.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_18_b.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_18_g.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_2.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_20.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_21_a.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_21_b.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_2_a.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_3.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_4.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_4_a.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_5.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_7.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_8.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_8a.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_9.png branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/modules/plugins.xml Log: <html><head><meta name="qrichtext" content="1" /></head><body style="font-size:9pt;font-family:Sans Serif"> <p>https://jira.jboss.org/jira/browse/JBDS-1107 -Updated docs source files here with the ones for JBDS 3.0.0 GA release. </p> <p></p> </body></html> Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/annotations1.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/diagram1.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/diagram2.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/map_diagram1.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/map_diagram2.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/map_diagram3.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_0.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_0_a.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_12_a.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_12_b.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_16.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_17.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_17_a.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_18.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_18_a.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_18_b.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_18_g.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_2.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_20.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_21_a.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_21_b.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_2_a.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_3.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_4.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_4_a.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_5.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_7.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_8.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_8a.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/images/plugins/plugins_9.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/modules/plugins.xml =================================================================== --- branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/modules/plugins.xml 2010-03-03 11:03:27 UTC (rev 20588) +++ branches/jbosstools-3.1.x/hibernatetools/docs/reference/en/modules/plugins.xml 2010-03-03 11:10:34 UTC (rev 20589) @@ -1,72 +1,87 @@ <?xml version="1.0" encoding="UTF-8"?> <chapter id="plugins" role="updated"> <title>Eclipse Plugins</title> - <para>This chapter will introduce you to the functionality that <property>Hibernate Tools</property> provide within Eclipse. That is a set of wizards and editors for simplifying the work with <property>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>Hibernate</property>. The tools make working with <property>Hibernate</property> - easier, but you are still encouraged/required to read the <ulink + <para>Please note that these tools do not try to hide any functionality of <property + >Hibernate</property>. The tools make working with <property>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>Hibernate Tools</property> and especially <property>Hibernate</property> it self.</para> </note> + <section id="download_base_project"> + <title>Download base project</title> + <para>You can download example projects which are used as base for this chapter.</para> + <para><property>JPA base project</property> is available <ulink url="http://anonsvn.jboss.org/repos/jbosstools/trunk//hibernatetools/docs/refe...">here</ulink> + and base <property>Java project</property> is situated <ulink url="http://anonsvn.jboss.org/repos/jbosstools/trunk//hibernatetools/docs/refe...">here</ulink>.</para> + <para>Also you need start <ulink url="http://anonsvn.jboss.org/repos/jbosstools/trunk//hibernatetools/docs/refe...">database</ulink>.</para> + <note> + <title>Note:</title> + <para>How to run database you can know in <ulink url="http://docs.jboss.org/tools/3.0.1.GA/en/GettingStartedGuide/html/first_se...">Getting Started Guide</ulink>.</para> + </note> + </section> + </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>To create basic mappings for properties and associations, i. e. generate <emphasis> + <para>To create basic mappings for properties and associations, i. e. generate <emphasis> <property>.hbm.xml</property> - </emphasis> files, Hibernate Tools provide a basic wizard which you can bring up by navigating <emphasis> + </emphasis> files, Hibernate Tools provide a basic wizard which you can bring up by navigating + <emphasis> <property>New > Hibernate XML mapping file</property>.</emphasis></para> - <para>At first you'll be asked to select a package or multiple individual classes to map. It's also possible to create an empty file, don't select any packages or classes and an empty .hbm will be created in the specified location</para> + <para>At first you'll be asked to select a package or multiple individual classes to map. + It's also possible to create an empty file, don't select any packages or classes and an + empty .hbm will be created in the specified location</para> + <para id="depth_control">With <property>depth control</property> option you can define dependences depth for + choosing classes (it means to set level of references which is used to collect linked classes + to the selection). </para> <figure> <title>Hibernate XML Mapping File Wizard</title> - <mediaobject> <imageobject> <imagedata fileref="images/plugins/plugins_0.png"/> </imageobject> </mediaobject> </figure> - - <para>Next wizard page lists the mappings to be generated.</para> + <para>The next wizard page lists the mappings to be generated. As you see <property>Customers</property>, <property>Orders</property>, <property>Productlines</property> and <property>Products</property> classes added under <property>depth control</property> driving. </para> <figure> - <title>Mappings to be generated</title> - + <title>Mappings to be generated</title> <mediaobject> <imageobject> <imagedata fileref="images/plugins/plugins_0_a.png"/> </imageobject> </mediaobject> </figure> - <para>Pressing finish creates the files.</para> - + + <para>This wizard page outputs a generated .hbm files preview.</para> + <figure> + <title>Preview Generated Mapping Files</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_0_b.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Pressing <property>Finish</property> creates the files.</para> </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>Hibernate Core</property> a <emphasis> + <para>To be able to reverse engineer, prototype queries, and of course to simply use <property + >Hibernate Core</property> a <emphasis> <property>hibernate.properties</property> </emphasis> or <emphasis> <property>hibernate.cfg.xml</property> @@ -74,43 +89,37 @@ generating the <emphasis> <property>hibernate.cfg.xml</property> </emphasis> file if you do not already have such one.</para> - <para>Start the wizard by clicking <emphasis> - <property>New > Other (Ctrl+N)</property></emphasis>, then <emphasis> + <property>New > Other (Ctrl+N)</property> + </emphasis>, then <emphasis> <property>Hibernate > Hibernate Configuration File (cfg.xml)</property> </emphasis> and press <emphasis> <property>Next</property> - </emphasis> - or on a web Seam project in the <property>Web Projects</property> view - <emphasis><property> WebContent -> New -> File -> Hibernate Configuration 3.0</property> + </emphasis> or on a web Seam project in the <property>Web Projects</property> view <emphasis> + <property> WebContent -> New -> File -> Hibernate Configuration 3.0</property> </emphasis>. After selecting the wanted location for the <emphasis> <property>hibernate.cfg.xml</property> </emphasis> file, you will see the following page:</para> - <figure> <title>Hibernate Configuration File Wizard</title> <mediaobject> <imageobject role="fo"> <imagedata align="center" fileref="images/plugins/plugins_1.png" format="PNG"/> </imageobject> - <imageobject role="html"> <imagedata align="center" fileref="images/plugins/plugins_1.png" format="PNG"/> </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/html_single">Hibernate Reference Documentation</ulink>.</para> - <para>Press <emphasis> <property>Finish</property> </emphasis> to create the configuration file, after optionally creating a Console @@ -122,715 +131,600 @@ <property>hibernate.cfg.xml</property> </emphasis> for the basis of a Console configuration.</para> </section> - <section id="console_conf"> <title>Hibernate Console Configuration</title> - <para>A Console configuration describes how the <property>Hibernate plugin</property> should configure <property>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> - <section id="creat_console_conf"> - <title>Creating a Hibernate Console Configuration</title> - - - <para>You create a console configuration by running the <property>Console Configuration - Wizard</property>, shown in the following screenshot. The same wizard will also be used if - you are coming from the <emphasis> - <property>hibernate.cfg.xml</property> - </emphasis> wizard and had enabled <emphasis> - <property>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>The dialog consists of five tabs: </para> - - <itemizedlist> - <listitem> - <para><emphasis> - <property>Main</property> - </emphasis> for the basic/required settings</para> - </listitem> - </itemizedlist> - - <figure> - <title> Creating Hibernate Console Configuration</title> - <mediaobject> - <imageobject role="fo"> - <imagedata align="center" fileref="images/plugins/plugins_2.png" format="PNG"/> - </imageobject> - - <imageobject role="html"> - <imagedata align="center" fileref="images/plugins/plugins_2.png" format="PNG"/> - </imageobject> - </mediaobject> - </figure> - - <para>The following table describes the available settings on the <emphasis> - <property>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 colnum="1" align="left" colwidth="1*"/> - - <colspec colnum="2" colwidth="3*"/> - - <colspec colnum="3" align="left" colwidth="1*"/> - - <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 either already configured hibernate or - JPA 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 or it can be defined manually using Browse button)</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> - <literal> /hibernate.cfg.xml </literal> - </property> - </emphasis> or <emphasis> - <property> - <literal>/META-INF/persistence.xml</literal> - </property> - </emphasis> in its project classpath.</para> - </tip> - - - <itemizedlist> - <listitem> - <para> + <section id="creat_console_conf"> + <title>Creating a Hibernate Console Configuration</title> + <para>You can create a console configuration by running the <property>Console Configuration + Wizard</property>, shown in the following screenshot. The same wizard will also be used if + you are coming from the <emphasis> + <property>hibernate.cfg.xml</property> + </emphasis> wizard and had enabled <emphasis> + <property>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>The dialog consists of five tabs: </para> + <itemizedlist> + <listitem> + <para><emphasis> + <property>Main</property> + </emphasis> for the basic/required settings</para> + </listitem> + </itemizedlist> + <figure> + <title> Creating Hibernate Console Configuration</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_2.png" format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_2.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>The following table describes the available settings on the <emphasis> + <property>Main</property> + </emphasis> tab. The wizard can automatically detect the default values for most of them 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 colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + <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 either already configured hibernate or + JPA 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 (let Hibernate Entity Manager find the persistence unit or + it can be defined manually using Browse button)</para> + </entry> + </row> + </tbody> + </tgroup> + </table> + <tip> + <title>Tip:</title> + <para>The two latter settings are usually not required if you specify a project and it has + <emphasis> + <property> + <literal> /hibernate.cfg.xml </literal> + </property> + </emphasis> or <emphasis> + <property> + <literal>/META-INF/persistence.xml</literal> + </property> + </emphasis> in its project classpath.</para> + </tip> + <itemizedlist> + <listitem> + <para> + <emphasis> + <property>Options</property> + </emphasis> for the additional/optional settings</para> + </listitem> + </itemizedlist> + <figure> + <title>Options Tab of the Console Configuration Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_2_a.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The next table describes Hibernate Console Configuration options available on the <emphasis> - <property>Options</property> - </emphasis> for the additional/optional settings</para> - </listitem> - </itemizedlist> - - <figure> - <title>Options Tab of the Console Configuration Wizard</title> - - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/plugins_2_a.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The next table describes Hibernate Console Configuration options available on the <emphasis> - <property>Options</property> - </emphasis> tab.</para> - - <table> - <title>Hibernate Console Configuration Options</title> - - <tgroup cols="3"> - <colspec colnum="1" align="left" colwidth="1*"/> - - <colspec colnum="2" colwidth="3*"/> - - <colspec colnum="3" align="left" colwidth="1*"/> - - <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>Classpath</property> - </emphasis> for classpath</para> - </listitem> - </itemizedlist> - - <figure> - <title>Specifying Classpath in Hibernate Console Configuration</title> - <mediaobject> - <imageobject role="fo"> - <imagedata align="center" fileref="images/plugins/plugins_3.png" format="PNG"/> - </imageobject> - - <imageobject role="html"> - <imagedata align="center" fileref="images/plugins/plugins_3.png" format="PNG"/> - </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 colnum="1" align="left" colwidth="1*"/> - - <colspec colnum="2" colwidth="3*"/> - - <colspec colnum="3" colwidth="1*"/> - - <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>Mappings</property> - </emphasis> for additional mappings</para> - </listitem> - </itemizedlist> - - <figure> - <title>Specifying additional Mappings in Hibernate Console Configuration</title> - <mediaobject> - <imageobject role="fo"> - <imagedata align="center" fileref="images/plugins/plugins_4.png" format="PNG"/> - </imageobject> - - <imageobject role="html"> - <imagedata align="center" fileref="images/plugins/plugins_4.png" format="PNG"/> - </imageobject> - </mediaobject> - </figure> - - <para>Parameters of the Mappings tab of the <property>Hibernate Console Configuration - wizard</property> are explained below:</para> - <table> - <title>Hibernate Console Configuration Mappings</title> - - <tgroup cols="3"> - <colspec colnum="1" align="left" colwidth="1*"/> - - <colspec colnum="2" colwidth="3*"/> - - <colspec colnum="3" colwidth="1*"/> - - <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>Common</property> - </emphasis></para> - </listitem> - </itemizedlist> - - <figure> - <title>Common Tab of the Console Configuration Wizard</title> - - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/plugins_4_a.png"/> - </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>Finish</property> - </emphasis> creates the configuration and shows it in the <property>Hibernate Configurations - view</property>.</para> - - <figure> - <title>Console Overview</title> - <mediaobject> - <imageobject role="fo"> - <imagedata align="center" fileref="images/plugins/plugins_5.png" format="PNG"/> - </imageobject> - - <imageobject role="html"> - <imagedata align="center" fileref="images/plugins/plugins_5.png" format="PNG"/> - </imageobject> - - </mediaobject> - </figure> - </section> + <property>Options</property> + </emphasis> tab.</para> + <table> + <title>Hibernate Console Configuration Options</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + <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>Database dialect</para> + </entry> + <entry> + <para>Define a database dialect. It's possible either to write your value or choose + from list. </para> + </entry> + <entry> + <para>No default value</para> + </entry> + </row> + <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>Classpath</property> + </emphasis> for classpath</para> + </listitem> + </itemizedlist> + <figure> + <title>Specifying Classpath in Hibernate Console Configuration</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_3.png" format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_3.png" format="PNG"/> + </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 colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <colspec colnum="3" colwidth="1*"/> + <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>Mappings</property> + </emphasis> for additional mappings</para> + </listitem> + </itemizedlist> + <figure> + <title>Specifying additional Mappings in Hibernate Console Configuration</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_4.png" format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_4.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>Parameters of the Mappings tab of the <property>Hibernate Console Configuration + wizard</property> are explained below:</para> + <table> + <title>Hibernate Console Configuration Mappings</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <colspec colnum="3" colwidth="1*"/> + <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 + duplications 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>Common</property> + </emphasis></para> + </listitem> + </itemizedlist> + <figure> + <title>Common Tab of the Console Configuration Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_4_a.png"/> + </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>Finish</property> + </emphasis> creates the configuration and shows it in the <property>Hibernate Configurations + view</property>.</para> + <figure> + <title>Console Overview</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" fileref="images/plugins/plugins_5.png" format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_5.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + </section> <section id="modif_console_conf"> - <title>Modifying a Hibernate Console Configuration - </title> - <para>When you created a hibernate console configuration you can modify it in 2 ways: - </para> - + <title>Modifying a Hibernate Console Configuration </title> + <para>When you created a hibernate console configuration you can modify it in 2 ways: </para> <itemizedlist> <listitem> - <para>right click on the configuration in - <emphasis> - <property>Hibernate Configurations View->Edit Configuration - </property> - </emphasis>.</para> - - <figure> - <title>Opening Edit Configuration Wizard</title> - - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/plugins_4_c.png"/> - </imageobject> - </mediaobject> - </figure> - <para> After clicking you will see the Edit Configuration Wizard that is similar to <emphasis> + <para>right-click on the configuration in <emphasis> + <property>Hibernate Configurations View->Edit Configuration </property> + </emphasis> or just double-click on <property>Console Configuration</property> item.</para> + <figure> + <title>Opening Edit Configuration Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_4_c.png"/> + </imageobject> + </mediaobject> + </figure> + <para> After clicking you will see the Edit Configuration Wizard that is similar to + <emphasis> <property>Create Console Configuration</property> - </emphasis>,described in <link - linkend="creat_console_conf">Creating a Hibernate Console Configuration section</link>. - </para> + </emphasis>,described in <link linkend="creat_console_conf">Creating a Hibernate Console + Configuration section</link>. </para> </listitem> - <listitem><para>use Properties view for modifying some of Console Configuration properties.</para> + <listitem> + <para>use Properties view for modifying some of Console Configuration properties.</para> <figure> <title>Properties View</title> - <mediaobject> <imageobject> <imagedata fileref="images/plugins/plugins_4_b.png"/> </imageobject> </mediaobject> </figure> - <para>The following table describes the available settings in the Properties view. Most properties are changeable by left click but some are not. - - <table> - <title>Properties</title> - - <tgroup cols="3"> - <colspec colnum="1" align="left" colwidth="1*"/> - - <colspec colnum="2" colwidth="3*"/> - - <colspec colnum="3" align="left" colwidth="1*"/> - - <thead> - <row> - <entry align="center"> - <para>Property</para> - </entry> - - <entry align="center"> - <para>Description</para> - </entry> - - <entry align="center"> - <para>Is Changeable</para> - </entry> - </row> - </thead> - - <tbody> - <row> - <entry> - <para>Additional mapping files </para> - </entry> - - <entry> - <para>List of additional mapping files that should be loaded. - </para> - </entry> - - <entry> - <para>False</para> - </entry> - </row> - <row> - <entry> - <para>Configuration file</para> - </entry> - - <entry> - <para>Path to a hibernate.cfg.xml file</para> - </entry> - - <entry> - <para>False</para> - </entry> - </row> - <row> - <entry> - <para>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 either already configured hibernate or - JPA connection or specify a new one here.</para> - </entry> - - <entry> - <para>True</para> - </entry> - </row> - <row> - <entry> - <para>Name</para> - </entry> - - <entry> - <para>The unique name of the console configuration</para> - </entry> - - <entry> - <para>True</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>True</para> - </entry> - </row> - <row> - <entry> - <para>Properties file</para> - </entry> - - <entry> - <para>Path to a hibernate.properties file</para> - </entry> - - <entry> - <para>False</para> - </entry> - </row> - <row> - <entry> - <para>Type</para> - </entry> - - <entry> - <para>Choose between "CORE", "ANNOTATIONS" and - "JPA" according to the method of relational mapping you want to use. 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>True</para> - </entry> - </row> - - </tbody> - </tgroup> - </table> - - </para> + <para>The following table describes the available settings in the Properties view. Most + properties are changeable by left click but some are not. <table> + <title>Properties</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + <thead> + <row> + <entry align="center"> + <para>Property</para> + </entry> + <entry align="center"> + <para>Description</para> + </entry> + <entry align="center"> + <para>Is Changeable</para> + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <para>Additional mapping files </para> + </entry> + <entry> + <para>List of additional mapping files that should be loaded. </para> + </entry> + <entry> + <para>False</para> + </entry> + </row> + <row> + <entry> + <para>Configuration file</para> + </entry> + <entry> + <para>Path to a hibernate.cfg.xml file</para> + </entry> + <entry> + <para>False</para> + </entry> + </row> + <row> + <entry> + <para>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 either already configured + hibernate or JPA connection or specify a new one here.</para> + </entry> + <entry> + <para>True</para> + </entry> + </row> + <row> + <entry> + <para>Name</para> + </entry> + <entry> + <para>The unique name of the console configuration</para> + </entry> + <entry> + <para>True</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>True</para> + </entry> + </row> + <row> + <entry> + <para>Properties file</para> + </entry> + <entry> + <para>Path to a hibernate.properties file</para> + </entry> + <entry> + <para>False</para> + </entry> + </row> + <row> + <entry> + <para>Type</para> + </entry> + <entry> + <para>Choose between "CORE", "ANNOTATIONS" and + "JPA" according to the method of relational mapping you want to + use. Note, 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>True</para> + </entry> + </row> + </tbody> + </tgroup> + </table></para> </listitem> </itemizedlist> </section> - + <section id='closing_conf_config'> + <title>Closing Hibernate Console Configuration</title> + <para>To close <property>Hibernate Console Configuration</property> you need do right-click your configuration + and choose <property>Close Configuration</property> option </para> + <figure> + <title>Close Hibernate Console Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_4_d.png"/> + </imageobject> + </mediaobject> + </figure> + <para>While closing configuration the connection with database will be closed, jar libs will + be unlock (for Windows) and other resources will set as free. </para> </section> - - - + </section> <section id="refeng_codegen" role="updated"> <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> + <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>.hbm.xml</property> </emphasis>, <emphasis> <property>hibernate.cfg.xml</property> </emphasis> generation and schema documentation.</para> - <para>To start working with this process, start the <property>Hibernate Code - Generation</property> which is available in the toolbar via the - <property>Hibernate</property> icon or via the <emphasis> + Generation</property> which is available in the toolbar via the <property + >Hibernate</property> icon or via the <emphasis> <property>Run > Hibernate Code Generation</property> </emphasis> menu item.</para> - <section id="code_gen"> <title>Code Generation Launcher</title> - <para>When you click on <emphasis> <property>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 id="hib_code_gen"> <title>Getting Hibernate Code Generation Wizard</title> <mediaobject> <imageobject role="fo"> <imagedata fileref="images/plugins/plugins_6.png" format="PNG"/> </imageobject> - <imageobject role="html"> <imagedata align="center" fileref="images/plugins/plugins_6.png" format="PNG"/> </imageobject> </mediaobject> </figure> - <para/> - <figure> <title>Hibernate Code Generation Wizard</title> <mediaobject> @@ -838,25 +732,21 @@ <imagedata align="center" scale="80" fileref="images/plugins/plugins_7.png" format="PNG" /> </imageobject> - <imageobject role="html"> <imagedata align="center" fileref="images/plugins/plugins_7.png" format="PNG"/> </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>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> + <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>Refresh</property> </emphasis> and <emphasis> @@ -864,62 +754,49 @@ </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>Main</property> </emphasis> tab you see the following fields:</para> - <table> <title>Code generation "Main" tab fields</title> - <tgroup cols="2"> <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" colwidth="3*"/> - <colspec colnum="3" colwidth="0.5*"/> - <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> + <para>Path to a directory where all output will be written by default. It's possible + to enter absolute directory path, for example - "d:/temp". 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 @@ -928,23 +805,19 @@ 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 @@ -954,12 +827,10 @@ linkend="reverseengineering"/>.</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 @@ -968,50 +839,42 @@ 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-column primary key a <composite-id> - mapping will always be created. If this option is enabled and there are matching + <para>A table that has a multi-column primary key a <composite-id> 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 - <code><key-many-to-one></code> instead. Note: a <code><many-to-one></code> - property is still created, but is simply marked as non-updatable and - non-insertable.</para> + <code><key-many-to-one></code> instead. Note: a + <code><many-to-one></code> 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> @@ -1020,27 +883,20 @@ 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> @@ -1049,16 +905,13 @@ </tgroup> </table> </section> - <section id="exportes"> <title>Exporters</title> - <para>The <emphasis> <property>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> <title>Selecting Exporters</title> <mediaobject> @@ -1066,318 +919,254 @@ <imagedata align="center" scale="80" fileref="images/plugins/plugins_8.png" format="PNG" /> </imageobject> - <imageobject role="html"> <imagedata align="center" fileref="images/plugins/plugins_8.png" format="PNG"/> </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 colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" colwidth="3*"/> - <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>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 colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" colwidth="3*"/> - <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> @@ -1386,32 +1175,25 @@ </tgroup> </table> </para> - <para>To add a property to the chosen Exporter click the <emphasis> <property>Add</property> </emphasis> button in the <property>Properties</property> section. In the appeared dialog you should select the property from the proposed list and the value for it.</para> - <figure> <title>Adding the Property for Schema Export (.ddl)</title> - <mediaobject> <imageobject> <imagedata fileref="images/plugins/plugins_8a.png"/> </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> <title>Specifying the Property Value</title> - <mediaobject> <imageobject> <imagedata fileref="images/plugins/plugins_8b.png"/> @@ -1420,10 +1202,8 @@ </figure> </section> </section> - <section id="map_config_editor"> <title>Hibernate Mapping and Configuration File Editor</title> - <para>The <property>Hibernate Mapping File editor</property> provides XML editing functionality for the <emphasis> <property>hbm.xml </property> @@ -1431,53 +1211,42 @@ <property>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> <title>XML Editing Functionality</title> <mediaobject> <imageobject role="fo"> <imagedata align="center" scale="80" fileref="images/plugins/plugins_9.png" format="PNG"/> </imageobject> - <imageobject role="html"> <imagedata align="center" fileref="images/plugins/plugins_9.png" format="PNG"/> </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. <code><property></code> and only shows the properties/fields available in the enclosing - <code><class></code> - , - <code><subclass></code> - etc. It is also possible to navigate from the <emphasis> + auto-completion detects its context and limits the completion for e.g. + <code><property></code> and only shows the properties/fields available in the + enclosing <code><class></code> , <code><subclass></code> etc. It is also + possible to navigate from the <emphasis> <property>hbm.xml</property> </emphasis> files to the relevant class/field in java code.</para> - <figure> <title>Navigation Functionality</title> - <mediaobject> <imageobject role="fo"> <imagedata align="center" fileref="images/plugins/plugins_10.png" format="PNG" scale="80"/> </imageobject> - <imageobject role="html"> <imagedata align="center" fileref="images/plugins/plugins_10.png" format="PNG"/> </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>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> @@ -1485,12 +1254,9 @@ <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> <title>Table and Column Completion</title> <mediaobject> @@ -1498,13 +1264,11 @@ <imagedata align="center" scale="80" fileref="images/plugins/plugins_11.png" format="PNG"/> </imageobject> - <imageobject role="html"> <imagedata align="center" fileref="images/plugins/plugins_11.png" format="PNG"/> </imageobject> </mediaobject> </figure> - <important> <title>Important:</title> <para>Table/Column completion requires a proper configured hibernate console configuration @@ -1512,28 +1276,23 @@ <property>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>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>cfg.xml</property> - </emphasis> code completion for the value of <code><property> name</code> attributes is available.</para> - - + </emphasis> code completion for the value of <code><property> name</code> attributes + is available.</para> <figure> <title>Property Completion</title> <mediaobject> @@ -1541,41 +1300,33 @@ <imagedata align="center" scale="80" fileref="images/plugins/plugins_12.png" format="PNG"/> </imageobject> - <imageobject role="html"> <imagedata align="center" fileref="images/plugins/plugins_12.png" format="PNG"/> </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>Open With > Hibernate 3.0 XML Editor</property> </emphasis> option from the context menu of the file. The editor should look as follows:</para> - <figure> <title>Structured hbm.xml Editor</title> - <mediaobject> <imageobject> <imagedata fileref="images/plugins/plugins_12_a.png"/> </imageobject> </mediaobject> </figure> - <para>For the configuration file you should choose <emphasis> <property>Open With > Hibernate Configuration 3.0 XML Editor</property> </emphasis>option.</para> - <figure> <title>Structured cfg.xml Editor</title> <mediaobject> @@ -1584,98 +1335,85 @@ </imageobject> </mediaobject> </figure> - </section> - - <section id="properties_editor"> - <title>JBoss Tools Properties Editor</title> - - <para>The editor is meant for editing <literal>.properties</literal> files. It contains two tabs: the - <property>Properties</property> (UI) tab and the - <property>Source</property> tab for manual editing.</para> - - <para>For <literal>hibernate.properties</literal> file <property>JBoss Tools Properties Editor</property> - provides content assist which is available both for hibernate properties and property values. You can make use of - the content assist while editing the file in the Source view and in the Properties view of the editor.</para> - - - <para>To add the property in the - <property>Properties</property> view, click the <emphasis> - <property>Add</property></emphasis> button.</para> - - <figure> - <title>Adding the Property</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/add_property1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>In the <emphasis> - <property>Name</property></emphasis> field press <emphasis> - <property>Ctrl+Space</property></emphasis> to invoke the content assist. - It will suggest <emphasis> - <property>'hibernate.'</property></emphasis> which is the prefix for all hibernate properties. After - selecting <emphasis> - <property>'hibernate.'</property></emphasis> and invoking the content assist again, - other prefixes and properties are displayed as the proposals with a description of each one.</para> - - <figure> - <title>Content Assist for Properties Names</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/add_property2.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>When invoking the content assist in the <emphasis> - <property>Value</property></emphasis> field, it also provides a list of proposals.</para> - - <figure> - <title>Content Assist for Properties Values</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/add_property3.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>In the <property>Source</property> view of the editor, content assist also could be invoked both for properties names and values:</para> - - <figure> - <title>Content Assist in the Source view</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/add_property4.png"/> - </imageobject> - </mediaobject> - </figure> - - <figure> - <title>Content Assist in the Source view</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/add_property5.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - + <section id="properties_editor"> + <title>JBoss Tools Properties Editor</title> + <para>The editor is meant for editing <literal>.properties</literal> files. It contains two + tabs: the <property>Properties</property> (UI) tab and the <property>Source</property> tab for + manual editing.</para> + <para>For <literal>hibernate.properties</literal> file <property>JBoss Tools Properties + Editor</property> provides content assist which is available both for hibernate properties + and property values. You can make use of the content assist while editing the file in the + Source view and in the Properties view of the editor.</para> + <para>To add the property in the <property>Properties</property> view, click the <emphasis> + <property>Add</property> + </emphasis> button.</para> + <figure> + <title>Adding the Property</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/add_property1.png"/> + </imageobject> + </mediaobject> + </figure> + <para>In the <emphasis> + <property>Name</property> + </emphasis> field press <emphasis> + <property>Ctrl+Space</property> + </emphasis> to invoke the content assist. It will suggest <emphasis> + <property>'hibernate.'</property> + </emphasis> which is the prefix for all hibernate properties. After selecting <emphasis> + <property>'hibernate.'</property> + </emphasis> and invoking the content assist again, other prefixes and properties are displayed + as the proposals with a description of each one.</para> + <figure> + <title>Content Assist for Properties Names</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/add_property2.png"/> + </imageobject> + </mediaobject> + </figure> + <para>When invoking the content assist in the <emphasis> + <property>Value</property> + </emphasis> field, it also provides a list of proposals.</para> + <figure> + <title>Content Assist for Properties Values</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/add_property3.png"/> + </imageobject> + </mediaobject> + </figure> + <para>In the <property>Source</property> view of the editor, content assist also could be + invoked both for properties names and values:</para> + <figure> + <title>Content Assist in the Source view</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/add_property4.png"/> + </imageobject> + </mediaobject> + </figure> + <figure> + <title>Content Assist in the Source view</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/add_property5.png"/> + </imageobject> + </mediaobject> + </figure> + </section> <section id="rev_xml_editor"> <title>Reveng.xml Editor</title> - <para>A <emphasis> <property>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> @@ -1686,17 +1424,16 @@ </emphasis>, please see <xref linkend="hibernaterevengxmlfile"/> </para> </note> - <para>The editor is activated as soon as an <emphasis> <property>.reveng.xml </property> </emphasis> file is opened. To get an initial <emphasis> <property>reveng.xml </property> - </emphasis> file the <property>Reverse Engineering File Wizard</property> can be started via <emphasis> + </emphasis> file the <property>Reverse Engineering File Wizard</property> can be started via + <emphasis> <property>Ctrl+N</property> </emphasis> and <emphasis> <property>Hibernate > Hibernate Reverse Engineering File (reveng.xml)</property> </emphasis> then.</para> - <figure> <title>ChooseReverse Engineering File Wizard </title> <mediaobject> @@ -1704,24 +1441,20 @@ <imagedata align="center" scale="80" fileref="images/plugins/plugins_22.png" format="PNG" /> </imageobject> - <imageobject role="html"> <imagedata align="center" fileref="images/plugins/plugins_22.png" format="PNG"/> </imageobject> </mediaobject> </figure> - <para>Or you can get it via the <property>Code Generation Launcher</property> by checking the proper section in the <emphasis> <property>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>Overview</property> </emphasis> page where the wanted console configuration is selected (auto-detected if Hibernate 3 support is enabled for the project)</para> - <figure> <title>Overview Page</title> <mediaobject> @@ -1729,19 +1462,17 @@ <imagedata align="center" scale="80" fileref="images/plugins/plugins_13.png" format="PNG" /> </imageobject> - <imageobject role="html"> <imagedata align="center" fileref="images/plugins/plugins_13.png" format="PNG"/> </imageobject> </mediaobject> </figure> - <para>The <emphasis> <property>Table Filter</property> - </emphasis> page allows you to specify which tables to include and exclude. Pressing <emphasis> + </emphasis> page allows you to specify which tables to include and exclude. Pressing + <emphasis> <property>Refresh</property> </emphasis> shows the tables from the database that have not yet been excluded.</para> - <figure> <title>Table Filters Page</title> <mediaobject> @@ -1749,13 +1480,11 @@ <imagedata align="center" scale="80" fileref="images/plugins/plugins_14.png" format="PNG" /> </imageobject> - <imageobject role="html"> <imagedata align="center" fileref="images/plugins/plugins_14.png" format="PNG"/> </imageobject> </mediaobject> </figure> - <para>The <emphasis> <property>Type Mappings</property> </emphasis> page is used for specifying type mappings from JBDC types to any Hibernate type @@ -1764,7 +1493,6 @@ <property>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> <title>Type Mappings Page</title> <mediaobject> @@ -1772,20 +1500,17 @@ <imagedata align="center" scale="80" fileref="images/plugins/plugins_15.png" format="PNG" /> </imageobject> - <imageobject role="html"> <imagedata align="center" fileref="images/plugins/plugins_15.png" format="PNG"/> </imageobject> </mediaobject> </figure> - <para>The <emphasis> <property>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> <title>Table and Columns Page</title> <mediaobject> @@ -1793,52 +1518,41 @@ <imagedata align="center" scale="80" fileref="images/plugins/plugins_16.png" format="PNG" /> </imageobject> - <imageobject role="html"> <imagedata align="center" fileref="images/plugins/plugins_16.png" format="PNG"/> </imageobject> </mediaobject> </figure> - - <para>Now that you have configured all necessary parts, you can learn how to work with - <property>Hibernate Console Perspective</property>.</para> + <para>Now that you have configured all necessary parts, you can learn how to work with <property + >Hibernate Console Perspective</property>.</para> </section> - <section id="hib_console"> <title>Hibernate Console Perspective</title> - <para>The <property>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>Hibernate Configurations View</property>. Expanding the tree allows you to browse the class/entity structure and see the relationships.</para> - <figure> <title>Hibernate Console Perspective</title> <mediaobject> <imageobject role="fo"> <imagedata align="center" scale="80" fileref="images/plugins/plugins_17.png"/> </imageobject> - <imageobject role="html"> <imagedata align="center" fileref="images/plugins/plugins_17.png"/> </imageobject> </mediaobject> - </figure> - <para>The <property>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>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>Hibernate Configurations View</property>. Just bring up the context menu for a necessary object and select <emphasis> @@ -1847,43 +1561,38 @@ <property>Open Mapping File</property> </emphasis> to open a proper <emphasis> <property>.hbm.xml</property>.</emphasis></para> - <figure> <title>Opening Source for Objects</title> - <mediaobject> <imageobject> <imagedata fileref="images/plugins/plugins_17_a.png"/> </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>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>Mapping Diagram</property>.</emphasis></para> - <figure> <title>Mapping Diagram</title> <mediaobject> <imageobject role="fo"> <imagedata align="center" scale="80" fileref="images/plugins/plugins_18.png"/> </imageobject> - <imageobject role="html"> <imagedata align="center" fileref="images/plugins/plugins_18.png"/> </imageobject> </mediaobject> </figure> - <para>To make <property>Mapping Diagram</property> usage easier you can use <property>Rules</property>, - <property>Grid</property>,<property>Snap to Geometry</property> checkboxes in the <emphasis> - <property>View</property></emphasis> menu. </para> + <para>To make <property>Mapping Diagram</property> usage easier you can use <property + >Rules</property>, <property>Grid</property>,<property>Snap to Geometry</property> + checkboxes in the <emphasis> + <property>View</property> + </emphasis> menu. </para> <figure> <title>View menu</title> - <mediaobject> <imageobject> <imagedata fileref="images/plugins/map_diagram1.png"/> @@ -1891,14 +1600,15 @@ </mediaobject> </figure> <para>If you will select <emphasis> - <property>Rules</property></emphasis> checkbox, the view print page scale will be added to the page. - The numbers on the scale show its size in inches.If you click on the scale a <emphasis> - <property>Ruler Guide</property></emphasis> will appear on the diagram. - You can connect any diagram item to it.To connect the items you should move their tops - to the Ruler Guide. And while moving the ruler guide, the items will be moved together with it as a whole.</para> + <property>Rules</property> + </emphasis> checkbox, the view print page scale will be added to the page. The numbers on + the scale show its size in inches.If you click on the scale a <emphasis> + <property>Ruler Guide</property> + </emphasis> will appear on the diagram. You can connect any diagram item to it.To connect + the items you should move their tops to the Ruler Guide. And while moving the ruler guide, + the items will be moved together with it as a whole.</para> <figure> <title>Moving the Ruler guide</title> - <mediaobject> <imageobject> <imagedata fileref="images/plugins/map_diagram2.png"/> @@ -1906,10 +1616,10 @@ </mediaobject> </figure> <para>If you'll select <emphasis> - <property>Grid</property></emphasis> checkbox, the grid will appear on the diagram.</para> + <property>Grid</property> + </emphasis> checkbox, the grid will appear on the diagram.</para> <figure> <title>Grid on Mapping diagram</title> - <mediaobject> <imageobject> <imagedata fileref="images/plugins/map_diagram3.png"/> @@ -1917,489 +1627,602 @@ </mediaobject> </figure> <para>The checkbox <emphasis> - <property>Snap to Geometry</property></emphasis> helps to put the items of the diagram into allineation with the grid.</para> - <para>For better navigating through the diagram use <property>Outline view</property> which is - available in the structural and graphical modes.</para> + <property>Snap to Geometry</property> + </emphasis> helps to put the items of the diagram into allineation with the grid.</para> + <para>For better navigating through the diagram use <property>Outline view</property> which + is available in the structural and graphical modes.</para> <figure> <title>Navigating in the Structural Mode</title> - <mediaobject> <imageobject> <imagedata fileref="images/plugins/plugins_18_a.png"/> </imageobject> </mediaobject> </figure> - <para>To switch over between the modes use the buttons in the top-right corner of the <property>Outline view</property>.</para> - <figure> <title>Navigating in the Graphical Mode</title> - <mediaobject> <imageobject> <imagedata fileref="images/plugins/plugins_18_b.png"/> </imageobject> </mediaobject> </figure> - - <para>The options in the context menu of the mapping diagram are listed in the next table.</para> - - <table> - <title>Context Menu Options of the Mapping Diagram</title> - - <tgroup cols="3"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" align="left" colwidth="1*"/> - <colspec colnum="3" align="left" colwidth="3*"/> - - <thead> - <row> - <entry align="center"> - <para>Icon</para> - </entry> - - <entry align="center"> - <para>Command</para> - </entry> - - <entry align="center"> - <para>Description</para> - </entry> - </row> - </thead> - - <tbody> - <row> - <entry> - <para><inlinemediaobject><imageobject> - <imagedata fileref="images/plugins/toggleConnections.png"/> - </imageobject></inlinemediaobject> - </para> - </entry> - <entry> - <para>Show|Hide connections</para> - </entry> - <entry> - <para>Allows to select what types of connections should be shown on the diagram: - <itemizedlist> - <listitem><para>Property Mappings</para></listitem> - <listitem><para>Class Mappings</para></listitem> - <listitem><para>Associations</para></listitem> - <listitem><para>Foreign key constraints</para></listitem> - </itemizedlist> - and choose the type of the connection router: - <itemizedlist> - <listitem><para>Manhattan Connection Router</para></listitem> - <listitem><para>Fan Connection Router</para></listitem> - </itemizedlist> - </para> - </entry> - </row> - - <row> - <entry> - <para><inlinemediaobject><imageobject> - <imagedata fileref="images/plugins/autoLayout.png"/> - </imageobject></inlinemediaobject> - </para> - </entry> - <entry> - <para>Auto layout</para> - </entry> - <entry> - <para>Used to dispose all the items of the diagram in a standard manner</para> - </entry> - </row> - - <row> - <entry> - <para></para> - </entry> - <entry> - <para>Collapse All</para> - </entry> - <entry> - <para>Collapses all the diagram elements</para> - </entry> - </row> - - <row> - <entry> - <para></para> - </entry> - <entry> - <para>Expand All</para> - </entry> - <entry> - <para>Expands all the diagram elements</para> - </entry> - </row> - - <row> - <entry> - <para></para> - </entry> - <entry> - <para>Select All</para> - </entry> - <entry> - <para>Makes all the diagram elements selected</para> - </entry> - </row> - - <row> - <entry> - <para><inlinemediaobject><imageobject> - <imagedata fileref="images/plugins/exportAsImage.png"/> - </imageobject></inlinemediaobject> - </para> - </entry> - <entry> - <para>Export as Image</para> - </entry> - <entry> - <para>Allows to export a diagram as <emphasis><property>.png - </property>,</emphasis> - <emphasis> - <property>.jpeg</property> - </emphasis> or <emphasis><property>.bmp </property></emphasis></para> - </entry> - </row> - </tbody> - </tgroup> - </table> - - <para>When you open the context menu while clicking an item on the diagram, it quite differs from the one described before.</para> + <para>The options in the context menu of the mapping diagram are listed in the next + table.</para> + <table> + <title>Context Menu Options of the Mapping Diagram</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="1*"/> + <colspec colnum="3" align="left" colwidth="3*"/> + <thead> + <row> + <entry align="center"> + <para>Icon</para> + </entry> + <entry align="center"> + <para>Command</para> + </entry> + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/toggleConnections.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Show|Hide connections</para> + </entry> + <entry>Allows to select what types of connections should be shown on the diagram: <itemizedlist> + <listitem> + <para>Property Mappings</para> + </listitem> + <listitem> + <para>Class Mappings</para> + </listitem> + <listitem> + <para>Associations</para> + </listitem> + <listitem> + <para>Foreign key constraints</para> + </listitem> + </itemizedlist></entry> + </row> + <row> + <entry> + <para/> + </entry> + <entry> + <para>Select All</para> + </entry> + <entry> + <para>Makes all the diagram elements selected</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/autoLayout.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Auto layout</para> + </entry> + <entry> + <para>Used to dispose all the items of the diagram in a standard manner</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/exportAsImage.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Export as Image</para> + </entry> + <entry> + <para>Allows to export a diagram as <emphasis><property>.png + </property>,</emphasis> + <emphasis> + <property>.jpeg</property> + </emphasis> or <emphasis> + <property>.bmp </property> + </emphasis></para> + </entry> + </row> + </tbody> + </tgroup> + </table> + <para>When you open the context menu while clicking an item on the diagram, it quite differs + from the one described before.</para> <figure> <title>Context Menu in Mapping Item</title> - <mediaobject> <imageobject> <imagedata fileref="images/plugins/plugins_18_g.png"/> </imageobject> </mediaobject> </figure> - - <para>The next table describes all the extra options in the menu of mapping items:</para> - - <table> - <title>Extra Options in the Context Menu of Mapping Item</title> - - <tgroup cols="3"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" align="left" colwidth="1*"/> - <colspec colnum="3" align="left" colwidth="3*"/> - - <thead> - <row> - <entry align="center"> - <para>Icon</para> - </entry> - - <entry align="center"> - <para>Command</para> - </entry> - - <entry align="center"> - <para>Description</para> - </entry> - </row> - </thead> - - <tbody> - <row> - <entry> - <para><inlinemediaobject><imageobject> - <imagedata fileref="images/plugins/visibleState.png"/> - </imageobject></inlinemediaobject> - </para> - </entry> - <entry> - <para>Toggle Visible State</para> - </entry> - <entry> - <para>Used to hide/show an item on the mapping diagram</para> - </entry> - </row> - - <row> - <entry> - <para><inlinemediaobject><imageobject> - <imagedata fileref="images/plugins/expandState.png"/> - </imageobject></inlinemediaobject> - </para> - </entry> - <entry> - <para>Expand|Collapse</para> - </entry> - <entry> - <para>Used for expanding/collapsing fields of the item</para> - </entry> - </row> - - <row> - <entry> - <para><inlinemediaobject><imageobject> - <imagedata fileref="images/plugins/openSourceFile_but.png"/> - </imageobject></inlinemediaobject> - </para> - </entry> - <entry> - <para>Open Source File</para> - </entry> - <entry> - <para>Makes it possible to open a source file for a chosen - object/element. The selected element will be highlighted in the open file.</para> - </entry> - </row> - - <row> - <entry> - <para><inlinemediaobject><imageobject> - <imagedata fileref="images/plugins/openMappingFile_but.png"/> - </imageobject></inlinemediaobject> - </para> - </entry> - <entry> - <para>Open Mapping File</para> - </entry> - <entry> - <para>Makes it possible to open a mapping file for a chosen - object/element. The selected element will be highlighted in the open file.</para> - </entry> - </row> - </tbody> - </tgroup> - </table> - - <tip> - <title>Tip:</title> - <para>All the described types of the context menu are also available in the <property>Outline</property> view.</para> - </tip> - - <para>The below table lists the actions that could be performed using the keyboard keys (or keys combinations).</para> - - <table> - <title>Hibernate Mapping Diagram Shortcut Keys</title> - - <tgroup cols="2"> - <colspec colnum="1" align="left" colwidth="3*"/> - <colspec colnum="2" align="left" colwidth="1*"/> - - <thead> - <row> - <entry align="center"> - <para>Command</para> - </entry> - - <entry align="center"> - <para>Binding</para> - </entry> - </row> - </thead> - - <tbody> - <row> - <entry> - <para>Scroll the diagram content</para> - </entry> - <entry> - <para>Ctrl + Shift + arrows</para> - </entry> - </row> - - <row> - <entry> - <para>Collapse/Expand selected item(s)</para> - </entry> - <entry> - <para> Enter </para> - </entry> - </row> - - <row> - <entry> - <para>Show/Hide selected item(s)</para> - </entry> - <entry> - <para> + </para> - </entry> - </row> - - <row> - <entry> - <para>Sort items in alphabetical order or return the initial state</para> - </entry> - <entry> - <para>Space</para> - </entry> - </row> - - <row> - <entry> - <para>Navigate between the items</para> - </entry> - <entry> - <para>Arrows</para> - </entry> - </row> - </tbody> - </tgroup> - </table> - - <para>It's possible to save the diagram in the eclipse workspace. Click the usual <emphasis> - <property>File > Save As</property></emphasis> option, the wizard will ask you to set the location within you project - where to save the file and give the name for the diagram. The item's names concatenated with the ampersand - symbols are set as the default name for a diagram. The file is saved with the <literal>.hibernate</literal> extension.</para> - - <figure> - <title>The Diagram saved in the Workspace</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/saveDiagram.png"/> - </imageobject> - </mediaobject> - </figure> - - <tip> - <title>Note:</title> - <para>If you restart the Eclipse with the mapping diagram opened, the mapping diagram will be restored with the - message like on the figure below. To view the diagram content, you should perform the refreshing.</para> - </tip> - - <figure> - <title>The Diagram after Restarting the Eclipse</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/diagram1.png"/> - </imageobject> - </mediaobject> - </figure> - - <figure> - <title>The Diagram after Refreshing</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/diagram2.png"/> - </imageobject> - </mediaobject> - </figure> + <para>The next table describes all the extra options in the menu of mapping items:</para> + <table> + <title>Extra Options in the Context Menu of Mapping Item</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="1*"/> + <colspec colnum="3" align="left" colwidth="3*"/> + <thead> + <row> + <entry align="center"> + <para>Icon</para> + </entry> + <entry align="center"> + <para>Command</para> + </entry> + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/openSourceFile_but.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Open Source File</para> + </entry> + <entry> + <para>Makes it possible to open a source file for a chosen object/element. The + selected element will be highlighted in the open file.</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/openMappingFile_but.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Open Mapping File</para> + </entry> + <entry> + <para>Makes it possible to open a mapping file for a chosen object/element. The + selected element will be highlighted in the open file.</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/visibleState.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Show|Hide shape(s)</para> + </entry> + <entry> + <para>Used to hide/show an item on the mapping diagram</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/expandState.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Expand|Collapse shape(s)</para> + </entry> + <entry> + <para>Used for expanding/collapsing fields of the item</para> + </entry> + </row> + </tbody> + </tgroup> + </table> + <tip> + <title>Tip:</title> + <para>All the described types of the context menu are also available in the <property + >Outline</property> view.</para> + </tip> + <para>The below table lists the actions that could be performed using the keyboard keys (or + keys combinations).</para> + <table> + <title>Hibernate Mapping Diagram Shortcut Keys</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="3*"/> + <colspec colnum="2" align="left" colwidth="1*"/> + <thead> + <row> + <entry align="center"> + <para>Command</para> + </entry> + <entry align="center"> + <para>Binding</para> + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <para>Scroll the diagram content</para> + </entry> + <entry> + <para>Ctrl + Shift + arrows</para> + </entry> + </row> + <row> + <entry> + <para>Collapse/Expand selected item(s)</para> + </entry> + <entry> + <para> Enter </para> + </entry> + </row> + <row> + <entry> + <para>Show/Hide selected item(s)</para> + </entry> + <entry> + <para> + </para> + </entry> + </row> + <row> + <entry> + <para>Sort items in alphabetical order or return the initial state</para> + </entry> + <entry> + <para>Space</para> + </entry> + </row> + <row> + <entry> + <para>Navigate between the items</para> + </entry> + <entry> + <para>Arrows</para> + </entry> + </row> + </tbody> + </tgroup> + </table> + <para>It's possible to save the diagram in the eclipse workspace. Click the usual + <emphasis> + <property>File > Save As</property> + </emphasis> option, the wizard will ask you to set the location within you project where + to save the file and give the name for the diagram. The item's names concatenated + with the ampersand symbols are set as the default name for a diagram. The file is saved + with the <literal>.hibernate</literal> extension.</para> + <figure> + <title>The Diagram saved in the Workspace</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/saveDiagram.png"/> + </imageobject> + </mediaobject> + </figure> + <tip> + <title>Note:</title> + <para>If you restart the Eclipse with the mapping diagram opened, the mapping diagram will + be restored with the message like on the figure below. To view the diagram content, you + should perform the refreshing.</para> + </tip> + <figure> + <title>The Diagram after Restarting the Eclipse</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/diagram1.png"/> + </imageobject> + </mediaobject> + </figure> + <figure> + <title>The Diagram after Refreshing</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/diagram2.png"/> + </imageobject> + </mediaobject> + </figure> + <para>There are some useful commands in the toolbar.</para> + <figure> + <title>The Diagram View Toolbar</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/diagramToolbar.png"/> + </imageobject> + </mediaobject> + </figure> + <para>They are described in the table below.</para> + <table> + <title>Command in Diagram View Toolbar </title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="1*"/> + <colspec colnum="3" align="left" colwidth="3*"/> + <thead> + <row> + <entry align="center"> + <para>Icon</para> + </entry> + <entry align="center"> + <para>Command</para> + </entry> + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + <tbody> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/toolbarRefresh.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Refresh Visual Mapping</para> + </entry> + <entry> + <para>It update <property>Mapping Diagram</property> if <property>Console + Configuration</property> was changed. </para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/toolbarZoom.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Zoom Box</para> + </entry> + <entry> + <para>Used to define scale of the diagram. Also it's used for <property>Mapping + Diagram</property> printing. If you want to put the whole <property + >diagram</property> to one print page, you need select <property + >Page</property> option in the <property>Zoom Box</property>.</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/toolbarAutolayout.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Auto layout</para> + </entry> + <entry> + <para>Used to arrange all diagram items in a standard manner.</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/toolbarShowHideConnections.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Show|Hide connections</para> + </entry> + <entry> + <para>Used to show or hide connection on the diagram. Moreover you can choose what + type of connections must be present on the diagram (<property>Property + Mappings</property>, <property>Class Mappings</property>, <property + >Associations</property> or <property>Foreign key constraints</property>) + .</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/toolbarExpandCollapse.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para>Expand|Collapse</para> + </entry> + <entry> + <para>Used for expanding/collapsing fields of the item.</para> + </entry> + </row> + <row> + <entry> + <para> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/toolbarShowHideShapes.png"/> + </imageobject> + </inlinemediaobject> + </para> + </entry> + <entry> + <para> Show|Hide shape(s)</para> + </entry> + <entry> + <para>Used to hide/show an item on the mapping diagram.</para> + </entry> + </row> + </tbody> + </tgroup> + </table> </section> </section> - <section> <title>Prototyping Queries</title> - <para>Queries can be prototyped by entering them into the <property>HQL</property> or - <property>Criteria Editor</property>. To execute a query you should click the green run button in the editor toolbar or press <emphasis> + <property>Criteria Editor</property>. To execute a query you should click the green run + button in the editor toolbar or press <emphasis> <property>Ctrl+Enter</property> </emphasis>.</para> - - <section id="hql_and_criteria_editors"> - <title>HQL Editor and Hibernate Criteria Editor</title> - <para>To open the query editors right-click your project - <property>Console Configuration</property> and select <property>HQL - Editor</property> (or <property>Hibernate Criteria Editor</property>).</para> - - <figure> - <title>Opening HQL Editor</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/prototypingQueries.png"/> - </imageobject> - </mediaobject> - </figure> - - <tip><title>Tip:</title> - <para>If the context menu items are disabled then you need at first to create a <property>Session - Factory</property>. That is done by simply expanding the <property>Session - Factory</property> node.</para> - </tip> - <para>When open the editors they should automatically detect the chosen Console Configuration.</para> - - <para>To get a prefill query for any entity (or any entity child node) listed in the - <emphasis> - <property>Session Factory</property></emphasis> you should double-click it. This will open the - <property>HQL Editor</property> with the associated query.</para> - - <para>Choosing <emphasis> - <property>HQL Editor</property> - </emphasis> in the context menu for any entity (or any entity child node) will also open the HQL editor - with the associated query. If you choose <emphasis> - <property>Hibernate Criteria Editor</property> - </emphasis> in the context menu, it will open <property>Hibernate Criteria Editor</property> with the associated criteria.</para> - - <figure> - <title>Generating Simple Queries</title> - <mediaobject> - <imageobject role="fo"> - <imagedata align="center" scale="80" fileref="images/plugins/plugins_19.png" - format="PNG"/> - </imageobject> - - <imageobject role="html"> - <imagedata align="center" fileref="images/plugins/plugins_19.png" format="PNG"/> - </imageobject> - </mediaobject> - </figure> - - <para>It's also possible to copy a portion of code from <emphasis> - <property>.java</property></emphasis> file into the <property>HQL</property> or - <property>Criteria editor</property>. To do this make use of the - Quick Fix option (<emphasis> - <property>Ctrl + 1</property>)</emphasis>.</para> - - <figure> - <title>Quick Fix Option Demonstration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/plugins_19_b.png"/> - </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> - <title>Updating Java Code</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/plugins_19_c.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - - <section> - <title>Error Handling</title> - <para>Errors during creation of the <property>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>Error Log View</property> on the right pane.</para> - - <para>Results of a query will be shown in the <property>Hibernate Query Result View</property> - and details of possible errors (syntax errors, database errors, etc.) can be seen in the - <property>Error Log View</property>.</para> - - - <note> - <title>Note:</title> - <para>HQL queries are executed by default using <literal>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> + <section id="hql_and_criteria_editors"> + <title>HQL Editor and Hibernate Criteria Editor</title> + <para>To open the query editors right-click your project <property>Console + Configuration</property> and select <property>HQL Editor</property> (or <property + >Hibernate Criteria Editor</property>).</para> + <figure> + <title>Opening HQL Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/prototypingQueries.png"/> + </imageobject> + </mediaobject> + </figure> + <tip> + <title>Tip:</title> + <para>If the context menu items are disabled then you need at first to create a <property + >Session Factory</property>. That is done by simply expanding the <property>Session + Factory</property> node.</para> + </tip> + <para>When open the editors they should automatically detect the chosen Console + Configuration.</para> + <para>To get a prefill query for any entity (or any entity child node) listed in the + <emphasis> + <property>Session Factory</property> + </emphasis> you should double-click it. This will open the <property>HQL Editor</property> + with the associated query.</para> + <para>Choosing <emphasis> + <property>HQL Editor</property> + </emphasis> in the context menu for any entity (or any entity child node) will also open + the HQL editor with the associated query. If you choose <emphasis> + <property>Hibernate Criteria Editor</property> + </emphasis> in the context menu, it will open <property>Hibernate Criteria + Editor</property> with the associated criteria.</para> + <figure> + <title>Generating Simple Queries</title> + <mediaobject> + <imageobject role="fo"> + <imagedata align="center" scale="80" fileref="images/plugins/plugins_19.png" + format="PNG"/> + </imageobject> + <imageobject role="html"> + <imagedata align="center" fileref="images/plugins/plugins_19.png" format="PNG"/> + </imageobject> + </mediaobject> + </figure> + <para>It's also possible to copy a portion of code from <emphasis> + <property>.java</property> + </emphasis> file into the <property>HQL</property> or <property>Criteria + editor</property>. To do this make use of the Quick Fix option (<emphasis> + <property>Ctrl + 1</property>)</emphasis>.</para> + <figure> + <title>Quick Fix Option Demonstration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_19_b.png"/> + </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> + <title>Updating Java Code</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_19_c.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Also you can pin <property>HQL editor</property> and <property>Criteria + editor</property> for one tab in <property>Hibernate Query Result</property> view. For + that you need click on <property>Stick result to one tab</property> + button(<inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/sticky_but.png"/> + </imageobject> + </inlinemediaobject> ). In the issue query executions results will be shown in one tab (no + more will be opened). </para> + <para> Moreover you are able to rename tab in <property>Hibernate Query Result</property>. + Click the tab, and type a new name in <property>Property View->Tab name field</property>. </para> + <figure> + <title>Tab Renaming</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/plugins_19_d.png"/> + </imageobject> + </mediaobject> + </figure> + </section> <section> + <title>Error Handling</title> + <para>Errors during creation of the <property>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>Error Log View</property> on the right pane.</para> + <para>Results of a query will be shown in the <property>Hibernate Query Result + View</property> and details of possible errors (syntax errors, database errors, etc.) + can be seen in the <property>Error Log View</property>.</para> + <note> + <title>Note:</title> + <para>HQL queries are executed by default using <literal>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> + <section> <title>Dynamic Query Translator</title> - <para>If the <property>Hibernate Dynamic Query Translator View</property> is visible while writing in the <property>HQL Editor</property> it will show the generated SQL for a HQL query.</para> - <figure> <title>Hibernate Dynamic Query Translator View</title> <mediaobject> @@ -2407,24 +2230,19 @@ <imagedata align="center" scale="80" fileref="images/plugins/plugins_20.png" format="PNG"/> </imageobject> - <imageobject role="html"> <imagedata align="center" fileref="images/plugins/plugins_20.png" format="PNG"/> </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,when clicking on class/entity <property>Properties view</property> shows the number of - query results as well as the time of executing.</para> - + <para>As you can see on the figure,when clicking on class/entity <property>Properties + view</property> shows the number of query results as well as the time of executing.</para> <figure> <title>Properties View</title> <mediaobject> @@ -2432,16 +2250,13 @@ <imagedata align="center" scale="80" fileref="images/plugins/plugins_21_a.png" format="PNG"/> </imageobject> - <imageobject role="html"> <imagedata align="center" fileref="images/plugins/plugins_21_a.png" format="PNG"/> </imageobject> </mediaobject> </figure> - - <para>It also displays the structure of any persistent object selected in the - <property>Hibernate Query Results View</property>. Editing is not yet supported.</para> - + <para>It also displays the structure of any persistent object selected in the <property + >Hibernate Query Results View</property>. Editing is not yet supported.</para> <figure> <title>Properties View for Selected Object</title> <mediaobject> @@ -2449,142 +2264,203 @@ <imagedata align="center" scale="80" fileref="images/plugins/plugins_21_b.png" format="PNG"/> </imageobject> - <imageobject role="html"> <imagedata align="center" fileref="images/plugins/plugins_21_b.png" format="PNG"/> </imageobject> </mediaobject> </figure> - <para>You can also use <property>Properties view</property> when clicking on the configuration - itself in Hibernate Configuration View( <link - linkend="modif_console_conf">Modifying a Hibernate Console Configuration section</link>). </para> + <para>You can also use <property>Properties view</property> when clicking on the configuration + itself in Hibernate Configuration View( <link linkend="modif_console_conf">Modifying a + Hibernate Console Configuration section</link>). </para> </section> </section> <section id="jpa_annotations"> - <title>Hibernate:add JPA annotations view - </title> - <para>Using this wizard you can add the next Hibernate annotations to the class: - <emphasis> - <property>@Column</property></emphasis>,<emphasis> - <property>@Entity</property></emphasis>,<emphasis> - <property>@ManyToOne</property></emphasis>,<emphasis> - <property>@OneToMany</property></emphasis>,<emphasis> - <property>@OneToOne</property></emphasis>,<emphasis> - <property>@ManyToMany</property></emphasis>,<emphasis> - <property>@MappedSuperclass</property></emphasis>,<emphasis> - <property>@Id</property></emphasis>,<emphasis> - <property>@GeneratedValue</property></emphasis> ,<emphasis> - <property>@Version </property></emphasis> + <title>Hibernate:add JPA annotations refactoring </title> + <para>Using this wizard you can add the next Hibernate annotations to the class: <emphasis> + <property>@Column</property> + </emphasis>,<emphasis> + <property>@Entity</property> + </emphasis>,<emphasis> + <property>@ManyToOne</property> + </emphasis>,<emphasis> + <property>@OneToMany</property> + </emphasis>,<emphasis> + <property>@OneToOne</property> + </emphasis>,<emphasis> + <property>@ManyToMany</property> + </emphasis>,<emphasis> + <property>@MappedSuperclass</property> + </emphasis>,<emphasis> + <property>@Id</property> + </emphasis>,<emphasis> + <property>@GeneratedValue</property> + </emphasis> ,<emphasis> + <property>@Version </property> + </emphasis> </para> - <itemizedlist> + <itemizedlist> <listitem> <para><emphasis> - <property>@Column</property></emphasis> is added to all String properties.</para> + <property>@Column</property> + </emphasis> is added to all String properties.</para> </listitem> - <listitem> - <para><emphasis> - <property>@Entity</property></emphasis> is always declared before any class where it doesn't present.</para> - </listitem> - <listitem> - <para><emphasis> - <property>@ManyToOne</property></emphasis>,<emphasis> - <property>@OneToMany</property></emphasis>,<emphasis> - <property>@OneToOne</property></emphasis>,<emphasis> - <property>@ManyToMany</property></emphasis> - this annotations are declared according to the classes hierarchy.</para> - </listitem> - <listitem> - <para><emphasis> - <property>@MappedSuperclass</property></emphasis> is added to abstract superclasses.</para> - </listitem> - <listitem> - <para><emphasis> - <property>@Id</property></emphasis>,<emphasis> - <property>@GeneratedValue</property></emphasis> are added automatically only to the properties under the name "Id",where they don't present.</para> - </listitem> - - <listitem> - <para><emphasis> - <property>@Version</property></emphasis> is declared in case you select <link linkend="optim_lock">Enable optimistic locking</link>.</para> - </listitem> - </itemizedlist> + <listitem> + <para><emphasis> + <property>@Entity</property> + </emphasis> is always declared before any class where it doesn't present.</para> + </listitem> + <listitem> + <para><emphasis> + <property>@ManyToOne</property> + </emphasis>,<emphasis> + <property>@OneToMany</property> + </emphasis>,<emphasis> + <property>@OneToOne</property> + </emphasis>,<emphasis> + <property>@ManyToMany</property> + </emphasis> - this annotations are declared according to the classes hierarchy.</para> + </listitem> + <listitem> + <para><emphasis> + <property>@MappedSuperclass</property> + </emphasis> is added to abstract superclasses.</para> + </listitem> + <listitem> + <para><emphasis> + <property>@Id</property> + </emphasis>,<emphasis> + <property>@GeneratedValue</property> + </emphasis> are added automatically only to the properties under the name "Id",where they + don't present.</para> + </listitem> + <listitem> + <para><emphasis> + <property>@Version</property> + </emphasis> is declared in case you select <link linkend="optim_lock">Enable optimistic + locking</link>.</para> + </listitem> + </itemizedlist> <note> <title>Note:</title> - <para>This section doesn't cover the meaning of the <property>Hibernate annotations</property> + <para>This section doesn't cover the meaning of the <property>Hibernate annotations</property> , for more information read <ulink - url="http://docs.jboss.org/hibernate/stable/annotations/reference/en/html/">Hibernate Annotations Documentation</ulink> .</para> + url="http://docs.jboss.org/hibernate/stable/annotations/reference/en/html/">Hibernate + Annotations Documentation</ulink> .</para> </note> - - <para>To open this wizard you should right click the class you want to enrich with annotations <emphasis> - <property>>Source>Generate Hibernate/JPA annotations</property></emphasis>. You will see the Hibernate:add JPA annotations dialog. - </para> + <para>To open this wizard you should right click the class you want to enrich with annotations + <emphasis> + <property>>Source>Generate Hibernate/JPA annotations</property> + </emphasis>. You will see the Hibernate:add JPA annotations dialog. </para> <figure> - <title>Starting Hibernate:add JPA annotations view</title> + <title>Starting Hibernate:add JPA annotations dialog</title> <mediaobject> <imageobject> <imagedata fileref="images/plugins/annotations1.png"/> </imageobject> </mediaobject> </figure> - <para> In the top of it you can see the list of all classes that will be passed through refactoring. - Besides the class you have selected in this list you can also find its superclasses and the classes that objects present in the current class as properties. - </para> - <para>By default the tags are added to the fields of selected classes. But you can change this option to <emphasis><property>Getters</property></emphasis>in <emphasis><property> Preferred location of Annotations</property></emphasis> dropdownlist - and then all the annotations will be added to the getter methods. If you choose <emphasis><property>Auto select from class preference</property></emphasis> then the annotations are added according to the majority of the already existed ones positions. - </para> - <para> If it's nessecary to map your String properties to the columns that length differ from the default value(255) ,change <emphasis><property>Default string length field</property></emphasis> and <code>@Column(length = your length)</code> will be created before every String property. - </para> - <para id="optim_lock">You can add optimistic locking capability to an entity bean by selecting <emphasis><property>Enable optimistic locking</property></emphasis> checkbox. - This operation will add version property to all the selected classes. The property will be also annotated with @Version ,getter and setter will be created. If the property is already exists,it won't be created ,but the getters,setters will be generated. - If there is already @MappedSuperclass with version in the base class of the current class - <emphasis><property>"version"</property></emphasis> is not inserted into the current class. - </para> - <para>After defining all necessary settings in the current step press <emphasis><property>Next</property></emphasis> and follow the next wizard steps. - </para> + <para> In the top of it you can see the list of all classes that will be passed through + refactoring. Besides the class you have selected in this list you can also find its + superclasses and the classes that objects present in the current class as properties. If you + want to add new classes or package to the list of classes, you should click the <property + >Back</property> button. In result you will see <property>Add classes and + packages</property> page.</para> <figure> + <title>Add classes and packages page </title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/annotations1_a.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Here you can add one more classes or whole package, moreover you can limit dependencies + depth by selecting <property>depth control</property> option (more about this option you will + find in <link linkend="depth_control">Creating a Hibernate Mapping File</link>). When finished + just press the <property>Next</property> button and you will be returned to <property>The + following classes will be changed</property> page and will be able to continue work with + it.</para> + <para>By default the tags are added to the fields of selected classes. But you can change this + option to <emphasis> + <property>Getters</property> + </emphasis>in <emphasis> + <property> Preferred location of Annotations</property> + </emphasis> dropdownlist and then all the annotations will be added to the getter methods. If + you choose <emphasis> + <property>Auto select from class preference</property> + </emphasis> then the annotations are added according to the majority of the already existed + ones positions. </para> + <para> If it's nessecary to map your String properties to the columns that length differ from + the default value(255) ,change <emphasis> + <property>Default string length field</property> + </emphasis> and <code>@Column(length = your length)</code> will be created before every String + property. </para> + <para id="optim_lock">You can add optimistic locking capability to an entity bean by selecting + <emphasis> + <property>Enable optimistic locking</property> + </emphasis> checkbox. This operation will add version property to all the selected classes. + The property will be also annotated with @Version ,getter and setter will be created. If the + property is already exists,it won't be created ,but the getters,setters will be generated. If + there is already @MappedSuperclass with version in the base class of the current class - + <emphasis> + <property>"version"</property> + </emphasis> is not inserted into the current class. </para> + <para>After defining all necessary settings in the current step press <emphasis> + <property>Next</property> + </emphasis> and follow the next wizard steps. </para> + <figure> <title>Hibernate:add JPA annotations view</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/annotations2.png"/> - </imageobject> - </mediaobject> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/annotations2.png"/> + </imageobject> + </mediaobject> </figure> - <para>The view represents two windows: one with the source code and and the second with refactored one. - With the help of <inlinemediaobject><imageobject> - <imagedata fileref="images/plugins/butt1.png"/> - </imageobject></inlinemediaobject> ,<inlinemediaobject><imageobject> - <imagedata fileref="images/plugins/butt2.png"/> - </imageobject></inlinemediaobject> ,<inlinemediaobject><imageobject> - <imagedata fileref="images/plugins/butt3.png"/> - </imageobject></inlinemediaobject> ,<inlinemediaobject><imageobject> - <imagedata fileref="images/plugins/butt4.png"/> - </imageobject></inlinemediaobject> buttons you can quickly navigate between the differences in the code. If you don't agree with some changes you can't undo them but you can remove the class from the list of classes that need refactoring. - </para> + <para>The view represents two windows: one with the source code and and the second with + refactored one. With the help of <inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/butt1.png"/> + </imageobject> + </inlinemediaobject> ,<inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/butt2.png"/> + </imageobject> + </inlinemediaobject> ,<inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/butt3.png"/> + </imageobject> + </inlinemediaobject> ,<inlinemediaobject> + <imageobject> + <imagedata fileref="images/plugins/butt4.png"/> + </imageobject> + </inlinemediaobject> buttons you can quickly navigate between the differences in the code. If + you don't agree with some changes you can't undo them but you can remove the class from the + list of classes that need refactoring. </para> <figure> <title>List of classes that need refactoring</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/annotations3.png"/> - </imageobject> - </mediaobject> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/annotations3.png"/> + </imageobject> + </mediaobject> </figure> <para>To apply the changes click <emphasis> - <property>Finish</property></emphasis>.</para> - - </section> + <property>Finish</property> + </emphasis>.</para> + </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>Error Log View</property> in Eclipse.</para> - + <para><property>Error Log View</property> is very useful tool to solve any problem which appears in Hibernate Tools Plugins. + You can use if there are troubles with setting up <property>Hibernate Console Configuration</property>.</para> <para>This is done by editing the <emphasis> - <property>hibernate-log4j.properties</property> + <property>hibernate-log4j.properties</property> </emphasis> in <emphasis> <property>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 @@ -2592,21 +2468,19 @@ >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>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> - + <section id="jpa_project_with_hibernate"> + <title>Creating JPA project with Hibernate support</title> <para>When starting a new JPA project from <emphasis> <property>New > Other > JPA > JPA Project</property> </emphasis> (or simply <emphasis> <property>New > JPA Project</property> </emphasis> in <property>JPA Perspective</property>), the first wizard page looks as follows.</para> - <figure> <title>Starting JPA Project</title> <mediaobject> @@ -2615,19 +2489,15 @@ </imageobject> </mediaobject> </figure> - - <para>It's possible here to select a target runtime and change the project - configuration, or you can leave everything as it is.</para> - + <para>It's possible here to select a target runtime and change the project configuration, + or you can leave everything as it is.</para> <para>On the JPA Facet page you should choose Hibernate as a target platform. Also select the proper database connection, if it is defined, or add a new one by clicking the <emphasis> <property>Add connection</property> </emphasis> link.</para> - <para>Hitting <emphasis> <property>Finish</property> </emphasis> will generate the project.</para> - <figure> <title>Targeting at Hibernate Platform</title> <mediaobject> @@ -2636,21 +2506,20 @@ </imageobject> </mediaobject> </figure> - <note> <title>Note:</title> - <para>Please note, if you choose Hibernate as a platform while creating a JPA/Dali project, a - Hibernate Console Configuration for the project is created automatically when the - wizard finishes its work. It allows a full usage of <property>Hibernate Tools</property> - features without additional setup.</para> + Hibernate Console Configuration for the project is created automatically when the wizard + finishes its work. It allows a full usage of <property>Hibernate Tools</property> features + without additional setup.</para> </note> - - <para>By enabling Hibernate platform specific features you can now generate DDL and Entities. + </section> + <section id="generate_ddl_entities_with_hibernate"> + <title>Generating DDL and Entities</title> + <para>By enabling Hibernate platform specific features you can now generate DDL and Entities. For that find <emphasis> <property>JPA Tools > Generate Tables from Entities/Generate Entities from Tables</property> - </emphasis> options in the context menu of your JPA project.</para> - + </emphasis> options in the context menu of your JPA project.</para> <figure> <title>Generate DDL/Entities</title> <mediaobject> @@ -2659,17 +2528,13 @@ </imageobject> </mediaobject> </figure> - <note> <title>Note:</title> - <para>Please, remember to put the proper database driver to the classpath of your project.</para> </note> - - <para>The <property>Generate Entities wizard</property> first will ask you to choose the directory where all - output will be written.</para> - + <para>The <property>Generate Entities wizard</property> first will ask you to choose the + directory where all output will be written.</para> <figure> <title>Generate Entities Wizard</title> <mediaobject> @@ -2678,18 +2543,15 @@ </imageobject> </mediaobject> </figure> - <para>To generate entities you can use:</para> - <itemizedlist> <listitem> <para>a Hibernate Console Configuration (proposed by default)</para> <para>Just make sure that the <emphasis> - <property>Use Console Configuration</property> + <property>Use Console Configuration</property> </emphasis> checkbox is selected and choose a needed configuration from the <emphasis> - <property>Console - configurations</property></emphasis> list box.</para> - + <property>Console configurations</property> + </emphasis> list box.</para> <figure> <title>Generate Entities Wizard</title> <mediaobject> @@ -2700,25 +2562,100 @@ </figure> </listitem> </itemizedlist> - <itemizedlist> <listitem> <para>or a DTP connection directly</para> <para>Just uncheck <emphasis> - <property>Use Console Configuration</property> - </emphasis> and adjust database settings.</para> + <property>Use Console Configuration</property> + </emphasis> and adjust database settings.</para> </listitem> </itemizedlist> - -<para>All the same you do with Generate Entities Wizard you can do with Generate DDL wizard. Special feature for Generate DDL wizard is possible automatic execution of Generation DDL in the database. </para> - <figure> - <title>Generate DDL Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/plugins/dali_integration6.png"/> - </imageobject> - </mediaobject> - </figure> + <para>All the same you do with Generate Entities Wizard you can do with Generate DDL wizard. + Special feature for Generate DDL wizard is possible automatic execution of Generation DDL in + the database. </para> + <figure> + <title>Generate DDL Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration6.png"/> + </imageobject> + </mediaobject> + </figure> <para>Thus, you can now have the Hibernate runtime support in Eclipse JPA projects.</para> + </section> + <section id="hibernate_annotations_support"> + <title>Hibernate Annotations Support</title> + <para>Also Hibernate Annotations are supported in <property>Dali Java Persistence Tools</property>. + The next annotations are integrated with <property>JPA Details</property> view:</para> + <itemizedlist> + <listitem> + <para>Id Generator annotations - <property>@GenericGenerator</property> and <property>@GeneratedValue</property></para> + <figure> + <title>@GenericGenerator support in Dali</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration7.png"/> + + </imageobject> + + </mediaobject> + </figure> + <figure> + <title>@GeneratedValue support in Dali</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration8.png"/> + </imageobject> + + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Property annotations- <property>@DiscriminatorFormula</property>, <property>@Generated Annotation</property>, <property>@Index annotation</property></para> + <figure> + <title>@Index support in Dali</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration9.png"/> + </imageobject> + + </mediaobject> + </figure> + + </listitem> + <listitem> + <para>Mapping Queries annotations - <property>@NamedQuery</property> and <property>@NamedNativeQuery</property></para> + <figure> + <title>Add New Named Query Dialog with Hibernate Support</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration10.png"/> + </imageobject> + + </mediaobject> + </figure> + + + + <figure> + <title>@NamedQuery support in Dali</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/plugins/dali_integration11.png"/> + </imageobject> + + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <para>More information about Hibernate Annotation you can find in <ulink url="http://docs.jboss.org/hibernate/stable/annotations/reference/en/html/">Hibernate Annotations Reference Guide</ulink>. </para> + + </section> + <section> + <title>Relevant Resources Links</title> + <para>There is full information about native Dali plugin features on <ulink url="http://help.eclipse.org/galileo/index.jsp?nav=/8">Eclipse Documentation page</ulink>.</para> + </section> + </section> + </chapter>

14 years, 10 months

1
0
0 / 0

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

jbosstools-commits March 2010