Author: irooskov(a)redhat.com Date: 2011-07-17 22:42:15 -0400 (Sun, 17 Jul 2011) New Revision: 32984 Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/Book_Info.xml branches/jbosstools-3.2.x/seam/docs/reference/en-US/Feedback.xml branches/jbosstools-3.2.x/seam/docs/reference/en-US/Preface.xml branches/jbosstools-3.2.x/seam/docs/reference/en-US/Seam_Developer_Tools_Reference_Guide.ent branches/jbosstools-3.2.x/seam/docs/reference/en-US/Seam_Developer_Tools_Reference_Guide.xml branches/jbosstools-3.2.x/seam/docs/reference/en-US/adding_seam_support_to_ear_project.xml branches/jbosstools-3.2.x/seam/docs/reference/en-US/creating_mavenized_seam.xml branches/jbosstools-3.2.x/seam/docs/reference/en-US/creating_new_seam.xml branches/jbosstools-3.2.x/seam/docs/reference/en-US/crud_application_walkthrough.xml branches/jbosstools-3.2.x/seam/docs/reference/en-US/crud_database_application.xml branches/jbosstools-3.2.x/seam/docs/reference/en-US/directory_structure.xml branches/jbosstools-3.2.x/seam/docs/reference/en-US/generate_entities.xml branches/jbosstools-3.2.x/seam/docs/reference/en-US/intro.xml branches/jbosstools-3.2.x/seam/docs/reference/en-US/master.xml branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_editors.xml branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_faq.xml branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_menus_and_actions.xml branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_preferences.xml branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_refactoring.xml branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_view.xml branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_wizards.xml branches/jbosstools-3.2.x/seam/docs/reference/en-US/testng.xml branches/jbosstools-3.2.x/seam/docs/reference/pom.xml branches/jbosstools-3.2.x/seam/docs/reference/publican.cfg Log: updated for GA Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/Book_Info.xml =================================================================== --- branches/jbosstools-3.2.x/seam/docs/reference/en-US/Book_Info.xml 2011-07-18 02:37:17 UTC (rev 32983) +++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/Book_Info.xml 2011-07-18 02:42:15 UTC (rev 32984) @@ -5,9 +5,9 @@ <title>Seam Developer Tools Reference Guide</title> <subtitle>Provides information relating to the Seam Developer Tools module.</subtitle> <productname>JBoss Developer Studio</productname> - <productnumber>4.0</productnumber> - <edition>4.0.0</edition> - <pubsnumber>4</pubsnumber> + <productnumber>4.1</productnumber> + <edition>4.1.0</edition> + <pubsnumber>1</pubsnumber> <abstract> <para>The Seam Developer Tools Reference Guide explains how to use the Seam Developer Tools module to create Seam projects for deployment.</para> </abstract> Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/Feedback.xml =================================================================== --- branches/jbosstools-3.2.x/seam/docs/reference/en-US/Feedback.xml 2011-07-18 02:37:17 UTC (rev 32983) +++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/Feedback.xml 2011-07-18 02:42:15 UTC (rev 32984) @@ -1,20 +1,92 @@ <?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "../Document_Conventions.ent"> +%BOOK_ENTITIES; +]> +<appendix id="sect_JBoss-Getting_Help_and_Giving_Feedback" lang="en-US"> + <title>Getting Help and Giving Feedback</title> + <section id="sect_JBoss-Do_You_Need_Help"> + <title>Do You Need Help?</title> + <indexterm> + <primary>help</primary> + <secondary>getting help</secondary> -<section id="sect-Beginners_Guide-We_Need_Feedback" lang="en-US"> - <title>We Need Feedback!</title> - <indexterm> - <primary>feedback</primary> - <secondary>contact information for this manual</secondary> - </indexterm> - <para> - If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in JIRA against JBoss Developer Studio: <ulink url="https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=1231050... - </para> - <para> - When submitting a bug report, be sure to mention the manual's name and to select the "documentation" component. - </para> - <para> - If you have a suggestion for improving the documentation, try to be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily. - </para> -</section> + </indexterm> + <para> + If you experience difficulty with a procedure described in this documentation, visit the Red Hat Customer Portal at <ulink url="http://access.redhat.com" />. Through the customer portal, you can: + </para> + <itemizedlist> + <listitem> + <para> + search or browse through a knowledgebase of technical support articles about Red Hat products. + </para> + </listitem> + <listitem> + <para> + submit a support case to Red Hat Global Support Services (GSS). + </para> + </listitem> + <listitem> + <para> + access other product documentation. + </para> + + </listitem> + + </itemizedlist> + <para> + Red Hat also hosts a large number of electronic mailing lists for discussion of Red Hat software and technology. You can find a list of publicly available mailing lists at <ulink url="https://www.redhat.com/mailman/listinfo" />. Click on the name of any mailing list to subscribe to that list or to access the list archives. + </para> + + </section> + + <section id="jboss-feedback"> + <title>Give us Feedback</title> + <!-- NOTE: You will need the following entities defined in your .ent file. + You will need to replace _YOUR_PRODUCT_HERE_, _YOUR_COMPONENT_ + and _YOUR_SUMMARY_ - entities are not replaced in URLs. + <!ENTITY PRODUCT "JBoss Product Name"> + <!ENTITY BZCOMPONENT "doc-triage"> + <!ENTITY BZURL "<ulink url='https://bugzilla.example.com/enter_bug.cgi?product=_YOUR_PRODUCT... + + These entities should not affect translated documents, since Bugzilla is not localised. + --> <indexterm> + <primary>feedback</primary> + <secondary>contact information for this manual</secondary> + + </indexterm> + <para> + If you find a typographical error, or know how this guide can be improved, we would love to hear from you. Submit a report in Bugzilla against the product <literal>&BZPRODUCT;</literal> and the component <literal>&BZCOMPONENT;</literal>. The following link will take you to a pre-filled bug report for this product: &BZURL;. + </para> + <para> + Fill out the following template in Bugzilla's <literal>Description</literal> field. Be as specific as possible when describing the issue; this will help ensure that we can fix it quickly. + </para> + +<screen>Document URL: + + +Section Number and Name: + + +Describe the issue: + + +Suggestions for improvement: + + +Additional information: + + +</screen> + <para> + Be sure to give us your name so that you can receive full credit for reporting the issue. + </para> + + </section> + + +</appendix> + + Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/Preface.xml =================================================================== --- branches/jbosstools-3.2.x/seam/docs/reference/en-US/Preface.xml 2011-07-18 02:37:17 UTC (rev 32983) +++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/Preface.xml 2011-07-18 02:42:15 UTC (rev 32984) @@ -8,9 +8,5 @@ <para> This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information. To get more information on these conventions please refer to the <guilabel>Document Conventions</guilabel> manual, which can be found on the <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Developer_Studio/index.... Hat Documentation</ulink> website under the <guilabel>JBoss Developer Studio</guilabel> section. </para> - <!--<xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - </xi:fallback> - </xi:include>--> </preface> Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/Seam_Developer_Tools_Reference_Guide.ent =================================================================== --- branches/jbosstools-3.2.x/seam/docs/reference/en-US/Seam_Developer_Tools_Reference_Guide.ent 2011-07-18 02:37:17 UTC (rev 32983) +++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/Seam_Developer_Tools_Reference_Guide.ent 2011-07-18 02:42:15 UTC (rev 32984) @@ -1,4 +1,7 @@ <!ENTITY PRODUCT "JBoss"> <!ENTITY BOOKID "Seam_Developer_Tools_Reference_Guide"> -<!ENTITY YEAR "2010"> +<!ENTITY YEAR "2011"> <!ENTITY HOLDER "Red Hat"> +<!ENTITY BZPRODUCT "JBoss Developer Studio"> +<!ENTITY BZCOMPONENT "Seam Developer Tools Reference Guide"> +<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss&perc... Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/Seam_Developer_Tools_Reference_Guide.xml =================================================================== --- branches/jbosstools-3.2.x/seam/docs/reference/en-US/Seam_Developer_Tools_Reference_Guide.xml 2011-07-18 02:37:17 UTC (rev 32983) +++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/Seam_Developer_Tools_Reference_Guide.xml 2011-07-18 02:42:15 UTC (rev 32984) @@ -21,5 +21,6 @@ <xi:include href="testng.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <xi:include href="seam_faq.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <!--<xi:include href="business_application.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... +<xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> </book> Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/adding_seam_support_to_ear_project.xml =================================================================== --- branches/jbosstools-3.2.x/seam/docs/reference/en-US/adding_seam_support_to_ear_project.xml 2011-07-18 02:37:17 UTC (rev 32983) +++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/adding_seam_support_to_ear_project.xml 2011-07-18 02:42:15 UTC (rev 32984) @@ -15,9 +15,9 @@ <para>For example you have several WTP projects:</para> <itemizedlist> - <listitem><para> seamproject-ear (You can create WTP EAR project using New -> Project -> Java EE -> Enterprise Application Project wizard)</para></listitem> - <listitem><para> seamproject-ejb (You can create WTP EJB project using New -> Project -> EJB -> EJB Project wizard)</para></listitem> - <listitem><para> seamproject-war (You can create WTP WEB project using New -> Project -> Web -> Dynamic Web Project wizard)</para></listitem> + <listitem><para> seamproject-ear (You can create WTP EAR project using <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Project</guimenuitem><guimenuitem>Java EE</guimenuitem><guimenuitem>Enterprise Application Project wizard</guimenuitem></menuchoice>)</para></listitem> + <listitem><para> seamproject-ejb (You can create WTP EJB project using <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Project</guimenuitem><guimenuitem>EJB</guimenuitem><guimenuitem>EJB Project wizard</guimenuitem></menuchoice>)</para></listitem> + <listitem><para> seamproject-war (You can create WTP WEB project using <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Project</guimenuitem><guimenuitem>Web</guimenuitem><guimenuitem>Dynamic Web Project wizard</guimenuitem></menuchoice>)</para></listitem> </itemizedlist> <note><title>Tip</title> @@ -32,7 +32,7 @@ </mediaobject> </figure> - <para>Make sure EJB and WAR are included in EAR as modules (Properties for seamproject-ear -> Java EE Module Dependencies)</para> + <para>Make sure EJB and WAR are included in EAR as modules (Properties for <menuchoice><guimenuitem>seamproject-ear</guimenuitem><guimenuitem>Java EE Module Dependencies</guimenuitem></menuchoice>)</para> <figure> <title>Java EE Module Dependencies</title> @@ -55,7 +55,7 @@ </figure> - <para>Then include libs from EAR to EJB Manifest Class-Path (Properties for seamproject-ejb -> Java EE Module Dependencies)</para> + <para>Then include libs from EAR to EJB Manifest Class-Path (Properties for <menuchoice><guimenuitem>seamproject-ejb</guimenuitem><guimenuitem>Java EE Module Dependencies</guimenuitem></menuchoice>)</para> <figure> <title>Including Libs from EAR to EJB Manifest Class-Path</title> @@ -66,7 +66,7 @@ </mediaobject> </figure> - <para>Include libs from EAR and seamproject-ejb.jar to WAR Manifest Class-Path (Properties for seamproject-war -> Java EE Module Dependencies)</para> + <para>Include libs from EAR and seamproject-ejb.jar to WAR Manifest Class-Path (Properties for <menuchoice><guimenuitem>seamproject-war</guimenuitem><guimenuitem>Java EE Module Dependencies</guimenuitem></menuchoice>)</para> <figure> <title>Including Libs from EAR and seamproject-ejb.jar to WAR Manifest Class-Path</title> @@ -79,7 +79,7 @@ <para>Thus we have set our WTP EAR/EJB/WAR projects and now we are ready to add Seam support to them:</para> - <para>First you have to add Seam support to WAR project: Properties for seamproject-war -> Seam Settings</para> + <para>First you have to add Seam support to WAR project: Properties for <menuchoice><guimenuitem>seamproject-war</guimenuitem><guimenuitem>Seam Settings</guimenuitem></menuchoice></para> <figure> @@ -94,7 +94,7 @@ <para>Set seamproject-war as Main Seam project. All other settings mostly are used by New Seam Entity/Action/Form/Conversation/... Wizards. Thus you can set them as you wish.</para> - <para>Then you can add Seam support to EJB project: Properties for seamproject-war -> Seam Settings</para> + <para>Then you can add Seam support to EJB project: Properties for <menuchoice><guimenuitem>seamproject-war</guimenuitem><guimenuitem>Seam Settings</guimenuitem></menuchoice></para> <figure> <title>Adding Seam Support to EJB Project</title> Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/creating_mavenized_seam.xml =================================================================== --- branches/jbosstools-3.2.x/seam/docs/reference/en-US/creating_mavenized_seam.xml 2011-07-18 02:37:17 UTC (rev 32983) +++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/creating_mavenized_seam.xml 2011-07-18 02:42:15 UTC (rev 32984) @@ -1,181 +1,201 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="mavenized_seam"> - <?dbhtml filename="create_mavenized_seam.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Seam</keyword> - <keyword>JBDS</keyword> - </keywordset> - </chapterinfo> - <title>Maven Integration for Seam Projects</title> - <para>Starting from 3.1 M2 version <property>JBoss Tools</property> includes new Jboss Maven - Integration plug-in which for now allows to create mavenized Seam projects and enable Seam - tools support for imported Maven projects.</para> - <para>The Jboss Maven Integration requires <ulink url="http://m2eclipse.sonatype.org/" - >m2eclipse</ulink> to be installed.</para> - <note> - <title>Note:</title> - <para>For M2 release of <property>Jboss Tools</property> it is important to use m2eclipse - <ulink url="http://m2eclipse.sonatype.org/update/">stable updatesite</ulink> or the - <ulink url="http://m2eclipse.sonatype.org/releases/0.9.9.200906081351"... - integration build</ulink> that M2 was developed against. If you want to use the - latest development release of m2eclipse you need to use the <ulink - url="http://download.jboss.org/jbosstools/updates/nightly/trunk/&quo... - builds</ulink> of <property>JBoss Tools</property>.</para> - </note> - <section id="create_mavenized_project"> - <title>Creating Maven ready Seam project</title> - <para>Maven Integration makes the Seam Wizard capable of creating Maven ready projects to - let Maven get the libraries instead of using the Seam runtime.</para> - <para>To create a mavenized Seam project you should perform the following steps:</para> - <itemizedlist> - <listitem> - <para>Navigate to <emphasis> - <property>File &gt; New Seam Project</property>.</emphasis> Give the project - a meaningful name, specify a target runtime and server and select the proper - configuration for your Seam project:</para> - <figure> - <title>Starting the Mavenized Seam Project</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/create_mavenized_seam/createMavenizedSeamProject.png" - /> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>Click the <emphasis> - <property>Modify</property></emphasis> button to enable the <emphasis> - <property>Jboss Maven Integration</property></emphasis> facet:</para> - <figure> - <title>Enabling the Jboss Maven Integration Facet</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/create_mavenized_seam/jbossMavenIntegrationFacet.png" - /> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>On the <property>JBoss M2 capabilities</property> page you&apos;ll be prompted - to add the following maven properties: groupId, artifactId, version, packaging, - name and description. Here it&apos;s possible to set a maven version of Seam and - also decide whether to remove WTP classpath containers (where the path starts - with org.eclipse.jst). </para> - <figure> - <title>Adjusting JBoss M2 Capabilities</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/create_mavenized_seam/jbossM2capabilities.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para> On the <property>JSF Capabilities</property> page you can choose Maven as - libraries provider. This is possible when you use Maven JSF 1.2 Libraries as - type of JSF Implementing Library. Also it gives you capability to edit - Dependencies and Exclusions for the mavenized Seam project directly from the - wizard. </para> - <figure> - <title>Using JSF Implementation libraries provided by Maven</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/create_mavenized_seam/seamJSFImplementation.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>On the <property>Seam Facet</property> page configure the Seam Facet settings - and click <emphasis> - <property>Finish</property>:</emphasis></para> - <figure> - <title>Seam Facet Settings</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_mavenized_seam/seamFacetPage.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - <para>The organized Seam project contains five projects with the Maven nature, builder, - Maven classpath and the <emphasis> - <property>pom.xml</property></emphasis> files added: projectname, projectname-ear, - projectname-ejb, projectname-parent and projectname-test.</para> - <figure> - <title>Mavenized Seam Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_mavenized_seam/mavenizedProjectStructure.png" - /> - </imageobject> - </mediaobject> - </figure> - </section> - <section id="import_maven_project"> - <title>Existing Maven Projects Import</title> - <para>Maven Integration includes the Seam Maven configurator which is called when importing - a project, changing <emphasis> - <property>pom.xml</property></emphasis> and/or calling <emphasis> - <property>Maven &gt; Update Project Configuration</property>.</emphasis> When - importing a Maven Seam project, the Seam Maven configurator picks up the settings set up - in <emphasis> - <property>pom.xml</property></emphasis> and adds to the project the - following:</para> - <itemizedlist> - <listitem> - <para>Seam nature</para> - </listitem> - <listitem> - <para>Seam facet and dependent facets to the EJB, EAR and WAR projects</para> - </listitem> - <listitem> - <para>JBoss Maven Integration facet if the Maven project contains a dependency with - the org.jboss.seam groupId and an artifactId starting with 'jboss-seam'</para> - </listitem> - <listitem> - <para>other required facets (Web Module, Java, JSF, etc.)</para> - </listitem> - </itemizedlist> - <para>If the Seam version from <emphasis> - <property>pom.xml</property></emphasis> matches a version of a Seam runtime - configured in the workspace, Seam configurator will set that runtime, otherwise no Seam - runtime will be set and you&apos;ll have to set it manually under <xref - linkend="project_pref"/>.</para> - <para>Seam configurator recognizes the Seam artifacts in the following way: the view folder - is a web content folder from the WAR project, the source folder is the first Eclipse - source folder. If there is a folder containing &quot;hot&quot; in the name, it will be - chosen as the action source folder. Package is the first package that has children or - doesn&apos;t have any subpackage. </para> - <para>Configuring the Seam when importing a Maven project as well as a Seam Runtime, Seam - artifacts and some facets could be suspended in the JBoss Maven Integration preferences - (<emphasis> - <property>Window &gt; Preferences &gt; JBoss Tools &gt; JBoss Maven - Integration</property></emphasis>).</para> - <figure> - <title>JBoss Maven Integration Preferences</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/create_mavenized_seam/configure_maven_integration.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - <section> - <title>Relevant Resources Links</title> - <para>In the <ulink url="http://in.relation.to/Bloggers/UsingMavenWithJBossTools">Using - Maven with JBoss Tools</ulink> article written by Max Andersen you&apos;ll find - references to the screencasts on how to use the examples of mavenized Seam projects - provided by <property>JBoss Tools</property>.</para> - </section> -</chapter> +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="mavenized_seam"> +<?dbhtml filename="create_mavenized_seam.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + + <keyword>Seam</keyword> + + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + <title>Maven Integration for Seam Projects</title> + <para> + Starting from 3.1 M2 version <property>JBoss Tools</property> includes new Jboss Maven Integration plug-in which for now allows to create mavenized Seam projects and enable Seam tools support for imported Maven projects. + </para> + + <para> + The Jboss Maven Integration requires <ulink url="http://m2eclipse.sonatype.org/" + >m2eclipse</ulink> to be installed. + </para> + + <note> + <title>Note:</title> + <para> + For M2 release of <property>Jboss Tools</property> it is important to use m2eclipse <ulink url="http://m2eclipse.sonatype.org/update/">stable updatesite</ulink> or the <ulink url="http://m2eclipse.sonatype.org/releases/0.9.9.200906081351"... integration build</ulink> that M2 was developed against. If you want to use the latest development release of m2eclipse you need to use the <ulink + url="http://download.jboss.org/jbosstools/updates/nightly/trunk/&quo... builds</ulink> of <property>JBoss Tools</property>. + </para> + </note> + + <section id="create_mavenized_project"> + <title>Creating Maven ready Seam project</title> + <para> + Maven Integration makes the Seam Wizard capable of creating Maven ready projects to let Maven get the libraries instead of using the Seam runtime. + </para> + + <para> + To create a mavenized Seam project you should perform the following steps: + </para> + + <itemizedlist> + <listitem> + <para> + Navigate to <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New Seam Project.</guimenuitem></menuchoice> Give the project a meaningful name, specify a target runtime and server and select the proper configuration for your Seam project: + </para> + + <figure> + <title>Starting the Mavenized Seam Project</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/create_mavenized_seam/createMavenizedSeamProject.png" + /> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para> + Click the <emphasis> <property>Modify</property></emphasis> button to enable the <emphasis> <property>Jboss Maven Integration</property></emphasis> facet: + </para> + + <figure> + <title>Enabling the Jboss Maven Integration Facet</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/create_mavenized_seam/jbossMavenIntegrationFacet.png" + /> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para> + On the <property>JBoss M2 capabilities</property> page you&apos;ll be prompted to add the following maven properties: groupId, artifactId, version, packaging, name and description. Here it&apos;s possible to set a maven version of Seam and also decide whether to remove WTP classpath containers (where the path starts with org.eclipse.jst). + </para> + + <figure> + <title>Adjusting JBoss M2 Capabilities</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/create_mavenized_seam/jbossM2capabilities.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para> + On the <property>JSF Capabilities</property> page you can choose Maven as libraries provider. This is possible when you use Maven JSF 1.2 Libraries as type of JSF Implementing Library. Also it gives you capability to edit Dependencies and Exclusions for the mavenized Seam project directly from the wizard. + </para> + + <figure> + <title>Using JSF Implementation libraries provided by Maven</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/create_mavenized_seam/seamJSFImplementation.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para> + On the <property>Seam Facet</property> page configure the Seam Facet settings and click <emphasis> <property>Finish</property>:</emphasis> + </para> + + <figure> + <title>Seam Facet Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_mavenized_seam/seamFacetPage.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + + <para> + The organized Seam project contains five projects with the Maven nature, builder, Maven classpath and the <emphasis> <property>pom.xml</property></emphasis> files added: projectname, projectname-ear, projectname-ejb, projectname-parent and projectname-test. + </para> + + <figure> + <title>Mavenized Seam Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_mavenized_seam/mavenizedProjectStructure.png" + /> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="import_maven_project"> + <title>Existing Maven Projects Import</title> + <para> + Maven Integration includes the Seam Maven configurator which is called when importing a project, changing <emphasis> <property>pom.xml</property></emphasis> and/or calling <menuchoice><guimenuitem>Maven</guimenuitem><guimenuitem>Update Project Configuration.</guimenuitem></menuchoice> When importing a Maven Seam project, the Seam Maven configurator picks up the settings set up in <emphasis> <property>pom.xml</property></emphasis> and adds to the project the following: + </para> + + <itemizedlist> + <listitem> + <para> + Seam nature + </para> + </listitem> + + <listitem> + <para> + Seam facet and dependent facets to the EJB, EAR and WAR projects + </para> + </listitem> + + <listitem> + <para> + JBoss Maven Integration facet if the Maven project contains a dependency with the org.jboss.seam groupId and an artifactId starting with 'jboss-seam' + </para> + </listitem> + + <listitem> + <para> + other required facets (Web Module, Java, JSF, etc.) + </para> + </listitem> + </itemizedlist> + + <para> + If the Seam version from <emphasis> <property>pom.xml</property></emphasis> matches a version of a Seam runtime configured in the workspace, Seam configurator will set that runtime, otherwise no Seam runtime will be set and you&apos;ll have to set it manually under <xref + linkend="project_pref"/>. + </para> + + <para> + Seam configurator recognizes the Seam artifacts in the following way: the view folder is a web content folder from the WAR project, the source folder is the first Eclipse source folder. If there is a folder containing &quot;hot&quot; in the name, it will be chosen as the action source folder. Package is the first package that has children or doesn&apos;t have any subpackage. + </para> + + <para> + Configuring the Seam when importing a Maven project as well as a Seam Runtime, Seam artifacts and some facets could be suspended in the JBoss Maven Integration preferences (<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>JBoss Tools</guimenuitem><guimenuitem>JBoss Maven Integration</guimenuitem></menuchoice>). + </para> + + <figure> + <title>JBoss Maven Integration Preferences</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/create_mavenized_seam/configure_maven_integration.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section> + <title>Relevant Resources Links</title> + <para> + In the <ulink url="http://in.relation.to/Bloggers/UsingMavenWithJBossTools">Using Maven with JBoss Tools</ulink> article written by Max Andersen you&apos;ll find references to the screencasts on how to use the examples of mavenized Seam projects provided by <property>JBoss Tools</property>. + </para> + </section> +</chapter> Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/creating_new_seam.xml =================================================================== --- branches/jbosstools-3.2.x/seam/docs/reference/en-US/creating_new_seam.xml 2011-07-18 02:37:17 UTC (rev 32983) +++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/creating_new_seam.xml 2011-07-18 02:42:15 UTC (rev 32984) @@ -1,477 +1,556 @@ <?xml version="1.0" encoding="UTF-8"?> <chapter id="create_seam" role="updated"> - <?dbhtml filename="create_new_seam.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Seam</keyword> - <keyword>JBDS</keyword> - </keywordset> - </chapterinfo> - <title>Creating a New Seam Project via the New Seam Project wizard</title> - <para>In this chapter we provide you with the necessary steps to start working with Seam - Framework.</para> - <para>At first, we suggest to set the specific Seam perspective that combines a number of - different views and editors needed for work with resources concerned. For that select - <emphasis> - <property>Window > Open Perspective > Other > Seam</property> - </emphasis> or you can also access it through the button in the right top corner.</para> +<?dbhtml filename="create_new_seam.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + + <keyword>Seam</keyword> + + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + <title>Creating a New Seam Project via the New Seam Project wizard</title> + <para> + In this chapter we provide you with the necessary steps to start working with Seam Framework. + </para> + + <para> + At first, we suggest to set the specific Seam perspective that combines a number of different views and editors needed for work with resources concerned. For that select <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Open Perspective</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Seam</guimenuitem></menuchoice> or you can also access it through the button in the right top corner. + </para> + + <figure> + <title>Seam Perspective Icon</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_0.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Also the <emphasis> <property>Open Web Browser</property></emphasis> action is directly available in the <property>Seam perspective</property>. + </para> + + <figure> + <title>Embedded Web Browser Button</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_01.png"/> + </imageobject> + </mediaobject> + </figure> + + <section id="standaloneSeam" role="updated"> + <title>Create standalone Seam Web Project</title> + <para> + The best way to get started with Seam is to create a simple Seam Project and experiment with it. + </para> + + <para> + Thus, you should select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Seam Web Project</guimenuitem></menuchoice> to run the <property>New Seam Project</property> wizard. The wizard form allows you to create runtime and server instances in order to get started creating, running, and debugging J2EE (only) applications. + </para> + + <para> + Seam Web Project wizard has an option for selecting the actual Server (not just WTP runtime) that will be used for the project. This allows the wizard to identify correctly where the required datasource and driver libraries need to go. + </para> + + <para> + Let&apos;s get through the wizard step-by-step. First, you should enter a name and a location directory for your new project. + </para> + + <figure id="figure_create_seam1"> + <title>New Seam Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + On the figure above you can see the runtime and the server already created. + </para> + + <para> + If you need to create a new runtime, click on the <emphasis> <property>New...</property> </emphasis> button in the <property>Target Runtime</property> section. It brings up the wizard where you can specify a new JBoss Server Runtime environment or the other type of runtime appropriate for your project configuration. Let's create one more JBoss 4.2 Runtime. Hence, after choosing it click on <emphasis> <property>Next</property> </emphasis> button. + </para> + <figure> - <title>Seam Perspective Icon</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_0.png"/> - </imageobject> - </mediaobject> + <title>Specifying Target Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_2.png"/> + </imageobject> + </mediaobject> </figure> - <para>Also the <emphasis> - <property>Open Web Browser</property></emphasis> action is directly available in the - <property>Seam perspective</property>.</para> + + <para> + All what you need here is to name runtime, type the path to its install directory or locate it by using <emphasis> <property>Browse</property> </emphasis> button, select a Java Runtime Environment, and select which configuration you want. + </para> + <figure> - <title>Embedded Web Browser Button</title> + <title>Specifying Target Runtime Configurations</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_3.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Clicking on <emphasis> <property>Finish</property> </emphasis> returns you to the <xref linkend="figure_create_seam1"/>. + </para> + + <para> + The next step is to define a Server by clicking on <emphasis> <property>New...</property> </emphasis> button in the <property>Target Server</property> section. In appeared <property>New Server dialog</property> the last server which matches the runtime will be selected. + </para> + + <para> + All declared runtimes are listed in the combobox under the servers view. Here, you can indicate a server runtime that you need. Click <emphasis> <property>Add</property> </emphasis> if you want to add a new Server Runtime. + </para> + + <figure> + <title>Specifying Target Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_4.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Next page allows you to verify the information for a chosen server. Leave everything as it is and click on <emphasis> <property>Next</property> </emphasis>. + </para> + + <figure> + <title>JBoss Runtime Summary</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_5.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + On the last wizard step you can modify your projects to configure them on the Server. + </para> + + <figure> + <title>Project Modification for Configuring on the Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_6.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Once you have the Target Server defined click on <emphasis> <property>Finish</property> </emphasis> button to return to the first page of the <property>New Seam Project wizard</property>. + </para> + + <note> + <title>Tip:</title> + <para> + We suggest that you look through the Application Server Manager Guide to find out more about runtimes and servers. + </para> + </note> + + <figure> + <title>Completion of Runtime and Server Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + The last section on this wizard step is <property>Configuration</property>. Here, you can select one of the predefined project configurations either associated with Seam 1.2, Seam 2.0 or with Seam 2.1. Furthermore, you can create your own configuration by pressing the <guibutton>Modify...</guibutton> button. It will open the dialog which allows to configure your own set of facets for adding extra functionality to your project. + </para> + + <para> + Pass to the next section to find out more details on this dialog. + </para> + </section> + + <section id="projectFacets"> + <title>Selecting the Project Facets</title> + <para> + The <property>Project Facets wizard</property> allows you to enable or disable specific facets which define necessary features for the project. When you switch to this wizard form, all critical facets are already checked for the chosen Configuration. + </para> + + <para> + Notice that this page of the wizard also allows you to set the necessary version for any facet. + </para> + + <figure> + <title>Project Facets Selection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_8.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Moreover, here you can specify your own preset of selected facets by checking needed ones in project facets window and clicking on <emphasis> <property>Save</property> </emphasis> button. + </para> + + <figure> + <title>Specifying Custom Facet Preset</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_15.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + To see all available Server runtimes click on <property>Runtimes</property> tab on the left. You can create a new one using the <emphasis> <property>New</property> </emphasis> button. If more than one runtime is checked here, the <emphasis> <property>Make Primary</property> </emphasis> button won&apos;t be dimmed yet. Thus, you can make use of it to mark primary runtime. + </para> + + <figure> + <title>Setting Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_16.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Clicking the <guibutton>OT</guibutton> button will bring you to the <property>Web Module</property> wizard form again. + </para> + + <section id="seamWithJPA"> + <title>Seam project with JPA facets</title> + <para> + For creating Seam project with JPA support you need to select<property> Java Persistent</property> facet on <property>Project Facets</property> page and click <property>OK</property>. + </para> + + <para> + Then you should press <property>Next</property> and may leave the default value on <property>Java application building</property> page and <property>Web Module Settings</property> page. + </para> + + <para> + After that you will see <property>JPA facet</property> page. + </para> + + <figure> + <title>JPA Facet page</title> <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_01.png"/> - </imageobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_16b.png"/> + </imageobject> </mediaobject> - </figure> - <section id="standaloneSeam" role="updated"> - <title>Create standalone Seam Web Project</title> - <para>The best way to get started with Seam is to create a simple Seam Project and - experiment with it.</para> - <para>Thus, you should select <emphasis> - <property>File > New > Seam Web Project</property> - </emphasis> to run the <property>New Seam Project</property> wizard. The wizard form - allows you to create runtime and server instances in order to get started creating, - running, and debugging J2EE (only) applications.</para> - <para>Seam Web Project wizard has an option for selecting the actual Server (not just WTP - runtime) that will be used for the project. This allows the wizard to identify correctly - where the required datasource and driver libraries need to go.</para> - <para>Let&apos;s get through the wizard step-by-step. First, you should enter a name and a - location directory for your new project.</para> - <figure id="figure_create_seam1"> - <title>New Seam Project Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_1.png"/> - </imageobject> - </mediaobject> - </figure> - <para>On the figure above you can see the runtime and the server already created.</para> - <para>If you need to create a new runtime, click on the <emphasis> - <property>New...</property> - </emphasis> button in the <property>Target Runtime</property> section. It brings up the - wizard where you can specify a new JBoss Server Runtime environment or the other type of - runtime appropriate for your project configuration. Let's create one more JBoss 4.2 - Runtime. Hence, after choosing it click on <emphasis> - <property>Next</property> - </emphasis> button.</para> - <figure> - <title>Specifying Target Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_2.png"/> - </imageobject> - </mediaobject> - </figure> - <para>All what you need here is to name runtime, type the path to its install directory or - locate it by using <emphasis> - <property>Browse</property> - </emphasis> button, select a Java Runtime Environment, and select which configuration - you want.</para> - <figure> - <title>Specifying Target Runtime Configurations</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_3.png"/> - </imageobject> - </mediaobject> - </figure> - <para> Clicking on <emphasis> - <property>Finish</property> - </emphasis> returns you to the <xref linkend="figure_create_seam1"/>.</para> - <para>The next step is to define a Server by clicking on <emphasis> - <property>New...</property> - </emphasis> button in the <property>Target Server</property> section. In appeared - <property>New Server dialog</property> the last server which matches the runtime - will be selected.</para> - <para>All declared runtimes are listed in the combo-box under the servers view. Here, you - can indicate a server runtime that you need. Click <emphasis> - <property>Add</property> - </emphasis> if you want to add a new Server Runtime.</para> - <figure> - <title>Specifying Target Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_4.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Next page allows you to verify the information for a chosen server. Leave everything - as it is and click on <emphasis> - <property>Next</property> - </emphasis>.</para> - <figure> - <title>JBoss Runtime Summary</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_5.png"/> - </imageobject> - </mediaobject> - </figure> - <para>On the last wizard step you can modify your projects to configure them on the - Server.</para> - <figure> - <title>Project Modification for Configuring on the Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_6.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Once you have the Target Server defined click on <emphasis> - <property>Finish</property> - </emphasis> button to return to the first page of the <property>New Seam Project - wizard</property>.</para> - <note> - <title>Tip:</title> - <para>We suggest that you look through the Application Server Manager Guide to - find out more about runtimes and servers.</para> - </note> - <figure> - <title>Completion of Runtime and Server Configuration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_7.png"/> - </imageobject> - </mediaobject> - </figure> - <para>The last section on this wizard step is <property>Configuration</property>. Here, you - can select one of the pre-defined project configurations either associated with Seam - 1.2, Seam 2.0 or with Seam 2.1. Furthermore, you can create your own configuration by - pressing the <emphasis> - <property>Modify...</property> - </emphasis> button. It will open the dialog which allows to configure your own set of - facets for adding extra functionality to your project.</para> - <para>Pass to the next section to find out more details on this dialog.</para> - </section> - <section id="projectFacets"> - <title>Selecting the Project Facets</title> - <para>The <property>Project Facets wizard</property> allows you to enable or disable - specific facets which define necessary features for the project. When you switch to this - wizard form, all critical facets are already checked for the chosen - Configuration.</para> - <para>Notice that this page of the wizard also allows you to set the necessary version for - any facet. </para> - <figure> - <title>Project Facets Selection</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_8.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Moreover, here you can specify your own preset of selected facets by checking needed - ones in project facets window and clicking on <emphasis> - <property>Save</property> - </emphasis> button.</para> - <figure> - <title>Specifying Custom Facet Preset</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_15.png"/> - </imageobject> - </mediaobject> - </figure> - <para>To see all available Server runtimes click on <property>Runtimes</property> tab on the - left. You can create a new one using the <emphasis> - <property>New</property> - </emphasis> button. If more than one runtime is checked here, the <emphasis> - <property>Make Primary</property> - </emphasis> button won&apos;t be dimmed yet. Thus, you can make use of it to mark - primary runtime.</para> - <figure> - <title>Setting Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_16.png"/> - </imageobject> - </mediaobject> - </figure> - <para><emphasis> - <property>Ok</property> - </emphasis> button will bring you to the <property>Web Module</property> wizard form - again.</para> - <section id="seamWithJPA"> - <title>Seam project with JPA facets</title> - <para>For creating Seam project with JPA support you need to select<property> Java - Persistent</property> facet on <property>Project Facets</property> page and - click <property>OK</property>.</para> - <para>Then you should press <property>Next</property> and may leave the default value on - <property>Java application building</property> page and <property>Web Module - Settings</property> page.</para> - <para>After that you will see <property>JPA facet</property> page.</para> - <figure> - <title>JPA Facet page</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_16b.png"/> - </imageobject> - </mediaobject> - </figure> - <para>On this page you can choose <property>Platform</property> (vendor-specific JPA - implementation) for your project, type of JPA Implementation, and configure the - <property>Connection</property> to database in the <property - >Connection</property> area.</para> - <para>More about <property>JPA facet</property> page you can read in <ulink + </figure> + + <para> + On this page you can choose <property>Platform</property> (vendor-specific JPA implementation) for your project, type of JPA Implementation, and configure the <property>Connection</property> to database in the <property + >Connection</property> area. + </para> + + <para> + More about <property>JPA facet</property> page you can read in <ulink url="http://help.eclipse.org/galileo/index.jsp?topic=/org.eclipse.jp... - >Eclipse documentation</ulink>. </para> - <para>On the next step you will see <property>JSF Capabilities</property> and <property>Seam - facet</property> pages, which are mostly the same as in general Seam - project.</para> - </section> + >Eclipse documentation</ulink>. + </para> + + <para> + On the next step you will see <property>JSF Capabilities</property> and <property>Seam facet</property> pages, which are mostly the same as in general Seam project. + </para> </section> - <section id="configureJava"> - <title>Java application building configuration</title> - <para>With this wizard you can define Java source directories which will be generated on - build path. Also you can specify a default output folder. If you are agree with default - values, press <property>Next</property></para> - <figure> - <title>Java application building Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_16a.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - <section id="configureWebModule"> - <title>How to Configure Web Module Settings</title> - <para> As we deal with a Dynamic Web Application, we should at first specify the top level - directory of our application for deploying it to a server afterwards. You know, this - kind of application contains Web resources. Thus, it's important to indicate the content - directory. The wizard will put all those values itself, so you can leave everything as - is.</para> - <figure> - <title>Web Module Settings</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_9.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Choose <emphasis> - <property>Next</property> - </emphasis> to switch to the next wizard form.</para> - </section> - <section id="addJSFCapab"> - <title>Adding JSF Capabilities</title> - <para>This wizard helps you to add JSF capabilities to your project. </para> - <para>Choose <emphasis> - <property>Library provided by Target Runtime</property> - </emphasis> from Library Type list if you'd like to use a default JSF implementation - given by the present runtime.</para> - <figure> - <title>Adding JSF Capabilities to Web Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_10.png"/> - </imageobject> - </mediaobject> - </figure> - <para>In case if you prefer to use your custom JSF implementation, choose <property>User - Library</property> Item from Library Type list. In User Library list you can check - required library.</para> - <figure> - <title>Using Custom JSF implementation Library </title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_17.png"/> - </imageobject> - </mediaobject> - </figure> - <para> If a new library is required, click <property>Manage libraries...</property> ( - <inlinemediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_17a.png"/> - </imageobject> - </inlinemediaobject>) button. Then you should click <property>New</property>.</para> - <figure> - <title>Using Custom JSF implementation Library </title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_18.png"/> - </imageobject> - </mediaobject> - </figure> - <para> Here, it's necessary to type a <property>Library Name</property>. </para> - <figure> - <title>Entering New User Library Name</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_23.png"/> - </imageobject> - </mediaobject> - </figure> - <para>To add proper <property>Library JARs</property>, click <property>Add - JARs...</property> button and select the JARs on your hard drive. </para> - <figure> - <title>Selection Library JARs</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_25.png"/> - </imageobject> - </mediaobject> - </figure> - <para>You can download necessary JSF implementation libraries provided by Sun and Apache - Foundation as well. Click <property>Download...</property> (<inlinemediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_23a.png"/> - </imageobject> - </inlinemediaobject>) button and choose one of proposed libraries.</para> - <figure> - <title>Download JSF Implementation Library</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_24.png"/> - </imageobject> - </mediaobject> - </figure> - <para>The last wizard options allows to edit a path for <property>JSF Configuration - File</property>, a name for <property>JSF Servlet</property>, <property>JSF Servlet - Classname</property> and change <property>URL Mapping Patterns</property>.</para> - <figure> - <title>JSF Capabilities Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_19.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Since we are arranging the Seam Web project, the last step we should do is to adjust - project configurations associated with the Seam.</para> - </section> - <section id="seamFacet"> - <title>Configure Seam Facet Settings</title> - <para>The last wizard step is related to Seam facet and allows you to do the - following:</para> - <figure> - <title>Seam Facet Settings</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_11.png"/> - </imageobject> - </mediaobject> - </figure> - <itemizedlist> - <listitem> - <para>Create Seam runtime and define Seam home folder.</para> - </listitem> - </itemizedlist> - <para>For that click on <emphasis> - <property>Add</property> - </emphasis> button in the <property>General</property> section. Note, in the wizard - shown below you can create a Seam runtime only for the version that was selected in the - <xref linkend="projectFacets"/> wizard (version 1.2 in our - case).</para> - <figure> - <title>Seam Runtime Creation</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_12.png"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Select EAR or WAR deployment by checking a necessary radio button.</para> - </listitem> - <listitem> - <para>Enter EJB project name and EAR project name in case of EAR radio button is checked.</para> - </listitem> - </itemizedlist> - - <note> - <title>Tip:</title> - <para>If you want to name your web project "MyProject-war" note that the EJB project should not be "MyProject-war-ejb", - it should be "MyProject-ejb". The same for EAR and Test projects' names. They should be respectively "MyProject-ear" - and "MyProject-test".</para> - </note> - - <itemizedlist> - <listitem> - <para>Select a <emphasis> - <property>Database Type</property> - </emphasis></para> - </listitem> - </itemizedlist> - <figure> - <title>Database Type Selecting</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_20.png"/> - </imageobject> - </mediaobject> - </figure> - <itemizedlist> - <listitem> - <para>and then specify a <emphasis> - <property>Connection profile</property> - </emphasis> appropriate for your database.</para> - </listitem> - </itemizedlist> - <figure> - <title>Connection Profile Options</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_21.png"/> - </imageobject> - </mediaobject> - </figure> - <para>You can edit chosen profile by using <emphasis> - <property>Edit</property> - </emphasis> button or organise a new one by clicking on <emphasis> - <property>New</property> - </emphasis> button and selecting necessary for you type of connection profile.</para> - <figure> - <title>Connection Profile Selecting</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_13.png"/> - </imageobject> - </mediaobject> - </figure> - <para>On the dialog you&apos;ll be asked to enter its name and description. And then you - should select a proper driver and adjust connection details. Press <emphasis> - <property>Next</property> - </emphasis> to preview all the adjusted settings and complete the creation of the new - profile.</para> - <figure> - <title>Connection Details</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_22.png"/> - </imageobject> - </mediaobject> - </figure> - <para>The next block of settings in the Seam Facet wizard are describing a Database and a - connection to it.</para> - <para>In the <property>Code Generation</property> section the wizard has already provided - the names for your <property>Session Bean</property>, <property>Entity Bean</property> - and <property>Test</property> packages generation (optional). Of course, you can change - them on others of your choice.</para> - <figure> - <title>Code Generation Section</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_14.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Click on <emphasis> - <property>Finish</property> - </emphasis> to generate a project.</para> - <para/> - </section> -</chapter> \ No newline at end of file + </section> + + <section id="configureJava"> + <title>Java application building configuration</title> + <para> + With this wizard you can define Java source directories which will be generated on build path. Also you can specify a default output folder. If you are agree with default values, press <property>Next</property> + </para> + + <figure> + <title>Java application building Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_16a.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="configureWebModule"> + <title>How to Configure Web Module Settings</title> + <para> + As we deal with a Dynamic Web Application, we should at first specify the top level directory of our application for deploying it to a server afterwards. You know, this kind of application contains Web resources. Thus, it's important to indicate the content directory. The wizard will put all those values itself, so you can leave everything as is. + </para> + + <figure> + <title>Web Module Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_9.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Choose <emphasis> <property>Next</property> </emphasis> to switch to the next wizard form. + </para> + </section> + + <section id="addJSFCapab"> + <title>Adding JSF Capabilities</title> + <para> + This wizard helps you to add JSF capabilities to your project. + </para> + + <para> + Choose <emphasis> <property>Library provided by Target Runtime</property> </emphasis> from Library Type list if you'd like to use a default JSF implementation given by the present runtime. + </para> + + <figure> + <title>Adding JSF Capabilities to Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_10.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + In case if you prefer to use your custom JSF implementation, choose <property>User Library</property> Item from Library Type list. In User Library list you can check required library. + </para> + + <figure> + <title>Using Custom JSF implementation Library </title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_17.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + If a new library is required, click <property>Manage libraries...</property> ( + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_17a.png"/> + </imageobject> + </inlinemediaobject> + ) button. Then you should click <property>New</property>. + </para> + + <figure> + <title>Using Custom JSF implementation Library </title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_18.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Here, it's necessary to type a <property>Library Name</property>. + </para> + + <figure> + <title>Entering New User Library Name</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_23.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + To add proper <property>Library JARs</property>, click <property>Add JARs...</property> button and select the JARs on your hard drive. + </para> + + <figure> + <title>Selection Library JARs</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_25.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + You can download necessary JSF implementation libraries provided by Sun and Apache Foundation as well. Click <property>Download...</property> ( + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_23a.png"/> + </imageobject> + </inlinemediaobject> + ) button and choose one of proposed libraries. + </para> + + <figure> + <title>Download JSF Implementation Library</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_24.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + The last wizard options allows to edit a path for <property>JSF Configuration File</property>, a name for <property>JSF Servlet</property>, <property>JSF Servlet Classname</property> and change <property>URL Mapping Patterns</property>. + </para> + + <figure> + <title>JSF Capabilities Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_19.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Since we are arranging the Seam Web project, the last step we should do is to adjust project configurations associated with the Seam. + </para> + </section> + + <section id="seamFacet"> + <title>Configure Seam Facet Settings</title> + <para> + The last wizard step is related to Seam facet and allows you to do the following: + </para> + + <figure> + <title>Seam Facet Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_11.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + Create Seam runtime and define Seam home folder. + </para> + </listitem> + </itemizedlist> + + <para> + For that click on <emphasis> <property>Add</property> </emphasis> button in the <property>General</property> section. Note, in the wizard shown below you can create a Seam runtime only for the version that was selected in the <xref linkend="projectFacets"/> wizard (version 1.2 in our case). + </para> + + <figure> + <title>Seam Runtime Creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_12.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + Select EAR or WAR deployment by checking a necessary radio button. + </para> + </listitem> + + <listitem> + <para> + Enter EJB project name and EAR project name in case of EAR radio button is checked. + </para> + </listitem> + </itemizedlist> + + <note> + <title>Tip:</title> + <para> + If you want to name your web project "MyProject-war" note that the EJB project should not be "MyProject-war-ejb", it should be "MyProject-ejb". The same for EAR and Test projects' names. They should be respectively "MyProject-ear" and "MyProject-test". + </para> + </note> + + <itemizedlist> + <listitem> + <para> + Select a <emphasis> <property>Database Type</property> </emphasis> + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Database Type Selecting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_20.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + and then specify a <emphasis> <property>Connection profile</property> </emphasis> appropriate for your database. + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Connection Profile Options</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_21.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + You can edit chosen profile by using <emphasis> <property>Edit</property> </emphasis> button or organize a new one by clicking on <emphasis> <property>New</property> </emphasis> button and selecting necessary for you type of connection profile. + </para> + + <figure> + <title>Connection Profile Selecting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_13.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + On the dialog you&apos;ll be asked to enter its name and description. And then you should select a proper driver and adjust connection details. Press <emphasis> <property>Next</property> </emphasis> to preview all the adjusted settings and complete the creation of the new profile. + </para> + + <figure> + <title>Connection Details</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_22.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + The next block of settings in the Seam Facet wizard are describing a Database and a connection to it. + </para> + + <para> + In the <property>Code Generation</property> section the wizard has already provided the names for your <property>Session Bean</property>, <property>Entity Bean</property> and <property>Test</property> packages generation (optional). Of course, you can change them on others of your choice. + </para> + + <figure> + <title>Code Generation Section</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_14.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Click on <emphasis> <property>Finish</property> </emphasis> to generate a project. + </para> + + <para/> + </section> +</chapter> Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/crud_application_walkthrough.xml =================================================================== --- branches/jbosstools-3.2.x/seam/docs/reference/en-US/crud_application_walkthrough.xml 2011-07-18 02:37:17 UTC (rev 32983) +++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/crud_application_walkthrough.xml 2011-07-18 02:42:15 UTC (rev 32984) @@ -1,145 +1,162 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="crud_application_walkthrough"> - <?dbhtml filename="crud_application_walkthrough.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Developer Studio</keyword> - <keyword>Eclipse</keyword> - <keyword>Java</keyword> - <keyword>CRUD</keyword> - <keyword>JBoss AS</keyword> - </keywordset> - </chapterinfo> - <title>The CRUD Application Walkthrough</title> - <para>After you familiarized oneself with example of creating the CRUD Database Application with - Seam, you can read this charter.</para> - <section> - <title>Using CRUD Application</title> - <para>To run your CRUD Application you should do the following steps:</para> - - <itemizedlist> - <listitem> - <para>Run a project on the Server. </para> - </listitem> - </itemizedlist> - - <para>On <emphasis> - <property>Package Explorer View </property> - </emphasis> right click on the <emphasis> - <property>crudapp</property> - </emphasis> project, select <emphasis><property> Run As > Run on - Server</property>.</emphasis></para> - - <figure> - <title>Run Project on Server</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/crud_application_walkthrough/crud_application_walkthrough_1.png" - scale="70"/> - </imageobject> - </mediaobject> - </figure> - - <para>Select a Server and click <property>Finish</property></para> - - <figure> - <title>Select a Server</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/crud_application_walkthrough/crud_application_walkthrough_3.png" - /> - </imageobject> - </mediaobject> - </figure> - - <para>Home page of the <emphasis> - <property>crudapp</property> - </emphasis> project should appear in <emphasis> - <property>Web Browser</property> - </emphasis>.</para> - <figure> - <title>Home page</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/crud_application_walkthrough/crud_application_walkthrough_4.png" - scale="70"/> - </imageobject> - </mediaobject> - </figure> - - <para>After that you can use CRUD application with - <property>&quot;employee&quot;</property> database.</para> - - <para>You can use internal JBDS Web Browser or your external Web Browser with the same link - (<ulink url="http://localhost:8080/crudapp/home.seam" - >http://localhost:8080/crudapp/home.seam</ulink>). </para> - <para>Click on the <emphasis> - <property>Employees List</property> - </emphasis> link and observe that data from <emphasis> - <property>employee</property> - </emphasis> database is displayed.</para> - <figure> - <title>Employees List Page</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/crud_application_walkthrough/crud_application_walkthrough_5.png" - /> - </imageobject> - </mediaobject> - </figure> - - <para>Use <property>Employees search parameters</property> fields to filter the selected - list.</para> - - <para> Press <property>Select</property> opposite one of employees.</para> - <figure> - <title>Employee details Page</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/crud_application_walkthrough/crud_application_walkthrough_6.png" - /> - </imageobject> - </mediaobject> - </figure> - - - <para> Press <property>Edit</property> to edit employee fields.</para> - <para> Enter <emphasis> - <property>Login</property> - </emphasis> and <emphasis> - <property>Password</property> - </emphasis> to login. (Use - <emphasis>&quot;crudapp-user&quot;/&quot;secret&quot;</emphasis> for - example)</para> - - <figure> - <title>Login page</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/crud_application_walkthrough/crud_application_walkthrough_7.png" - /> - </imageobject> - </mediaobject> - </figure> - <figure> - <title>Edit Employee</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/crud_application_walkthrough/crud_application_walkthrough_8.png" - /> - </imageobject> - </mediaobject> - </figure> - <para> Fill in <emphasis> - <property>firstname</property> - </emphasis> and press <property>Save</property>.</para> - <para> Database will be updated.</para> - </section> -</chapter> +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="crud_application_walkthrough"> +<?dbhtml filename="crud_application_walkthrough.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + + <keyword>Eclipse</keyword> + + <keyword>Java</keyword> + + <keyword>CRUD</keyword> + + <keyword>JBoss AS</keyword> + </keywordset> + </chapterinfo> + <title>The CRUD Application Walkthrough</title> + <para> + After you familiarized oneself with example of creating the CRUD Database Application with Seam, you can read this charter. + </para> + + <section> + <title>Using CRUD Application</title> + <para> + To run your CRUD Application you should do the following steps: + </para> + + <itemizedlist> + <listitem> + <para> + Run a project on the Server. + </para> + </listitem> + </itemizedlist> + + <para> + On <emphasis> <property>Package Explorer View </property> </emphasis> right click on the <emphasis> <property>crudapp</property> </emphasis> project, select <menuchoice><guimenuitem>Run As</guimenuitem><guimenuitem>Run on Server.</guimenuitem></menuchoice> + </para> + + <figure> + <title>Run Project on Server</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/crud_application_walkthrough/crud_application_walkthrough_1.png" + scale="70"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Select a Server and click <property>Finish</property> + </para> + + <figure> + <title>Select a Server</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/crud_application_walkthrough/crud_application_walkthrough_3.png" + /> + </imageobject> + </mediaobject> + </figure> + + <para> + Home page of the <emphasis> <property>crudapp</property> </emphasis> project should appear in <emphasis> <property>Web Browser</property> </emphasis>. + </para> + + <figure> + <title>Home page</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/crud_application_walkthrough/crud_application_walkthrough_4.png" + scale="70"/> + </imageobject> + </mediaobject> + </figure> + + <para> + After that you can use CRUD application with <property>&quot;employee&quot;</property> database. + </para> + + <para> + You can use internal JBDS Web Browser or your external Web Browser with the same link (<ulink url="http://localhost:8080/crudapp/home.seam" + >http://localhost:8080/crudapp/home.seam</ulink>). + </para> + + <para> + Click on the <emphasis> <property>Employees List</property> </emphasis> link and observe that data from <emphasis> <property>employee</property> </emphasis> database is displayed. + </para> + + <figure> + <title>Employees List Page</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/crud_application_walkthrough/crud_application_walkthrough_5.png" + /> + </imageobject> + </mediaobject> + </figure> + + <para> + Use <property>Employees search parameters</property> fields to filter the selected list. + </para> + + <para> + Press <property>Select</property> opposite one of employees. + </para> + + <figure> + <title>Employee details Page</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/crud_application_walkthrough/crud_application_walkthrough_6.png" + /> + </imageobject> + </mediaobject> + </figure> + + <para> + Press <property>Edit</property> to edit employee fields. + </para> + + <para> + Enter <emphasis> <property>Login</property> </emphasis> and <emphasis> <property>Password</property> </emphasis> to login. (Use <emphasis>&quot;crudapp-user&quot;/&quot;secret&quot;</emphasis> for example) + </para> + + <figure> + <title>Login page</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/crud_application_walkthrough/crud_application_walkthrough_7.png" + /> + </imageobject> + </mediaobject> + </figure> + + <figure> + <title>Edit Employee</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/crud_application_walkthrough/crud_application_walkthrough_8.png" + /> + </imageobject> + </mediaobject> + </figure> + + <para> + Fill in <emphasis> <property>firstname</property> </emphasis> and press <property>Save</property>. + </para> + + <para> + Database will be updated. + </para> + </section> +</chapter> Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/crud_database_application.xml =================================================================== --- branches/jbosstools-3.2.x/seam/docs/reference/en-US/crud_database_application.xml 2011-07-18 02:37:17 UTC (rev 32983) +++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/crud_database_application.xml 2011-07-18 02:42:15 UTC (rev 32984) @@ -1,530 +1,486 @@ <?xml version="1.0" encoding="UTF-8"?> <chapter id="crud_database_application"> - <?dbhtml filename="crud_database_application.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Developer Studio</keyword> - <keyword>Eclipse</keyword> - <keyword>Java</keyword> - <keyword>CRUD</keyword> - <keyword>Database Application</keyword> - </keywordset> - </chapterinfo> - <title>Generate a CRUD Database Application</title> - <section> - <title>What is CRUD?</title> +<?dbhtml filename="crud_database_application.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + + <keyword>Eclipse</keyword> + + <keyword>Java</keyword> + + <keyword>CRUD</keyword> + + <keyword>Database Application</keyword> + </keywordset> + </chapterinfo> + <title>Generate a CRUD Database Application</title> + <section> + <title>What is CRUD?</title> + <para> + <property>CRUD</property> is an acronym for the four basic types of SQL commands: <emphasis> <property>Create</property> </emphasis>, <emphasis> <property>Read</property> </emphasis>, <emphasis> <property>Update</property> </emphasis>, <emphasis> <property>Delete</property> </emphasis>. Most applications have some kind of <property>CRUD</property> functionality, and we can assume that every programmer had to deal with <property>CRUD</property> at some point. A <property>CRUD</property> application is one that uses forms to get data into and out of a database. + </para> + + <para> + In the next section we will create a Seam Web application, connect it to the <ulink url="http://www.hsqldb.org/">HSQL</ulink> database and add <property>CRUD</property> support. + </para> + </section> + + <section> + <title>How to create the CRUD Database Application with Seam</title> + <itemizedlist> + <listitem> <para> - <property>CRUD</property> is an acronym for the four basic types of SQL commands: <emphasis> - <property>Create</property> - </emphasis>, <emphasis> - <property>Read</property> - </emphasis>, <emphasis> - <property>Update</property> - </emphasis>, <emphasis> - <property>Delete</property> - </emphasis>. Most applications have some kind of <property>CRUD</property> - functionality, and we can assume that every programmer had to deal with - <property>CRUD</property> at some point. A <property>CRUD</property> application is - one that uses forms to get data into and out of a database. </para> - <para> In the next section we will create <xref linkend="intro"/> Web application, - connect it to the <ulink url="http://www.hsqldb.org/">HSQL</ulink> database and add - <property>CRUD</property> support. </para> - </section> - - <section> - <title>How to create the CRUD Database Application with Seam</title> - - <itemizedlist> - <listitem> - <para>First, you should <ulink url="http://docs.jboss.org/tools/resources/" - >download</ulink> a database and start it by running <emphasis> - <property>./runDBServer.sh</property> - </emphasis> or <emphasis> - <property>runDBServer.bat</property> - </emphasis> from the database directory.</para> - </listitem> - <listitem> - <para>Create a new Seam Web Project using <property>New Seam Project - wizard</property> or main menu <emphasis><property>File > New > Seam Web - Project</property>.</emphasis></para> - </listitem> - </itemizedlist> - <figure> - <title>Seam Web Project Creation</title> - <mediaobject> - <imageobject> - <imagedata + First, you should <ulink url="http://docs.jboss.org/tools/resources/" + >download</ulink> a database and start it by running <emphasis> <property>./runDBServer.sh</property> </emphasis> or <emphasis> <property>runDBServer.bat</property> </emphasis> from the database directory. + </para> + </listitem> + + <listitem> + <para> + Create a new Seam Web Project using <property>New Seam Project wizard</property> or main menu <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Seam Web Project.</guimenuitem></menuchoice> + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Seam Web Project Creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/crud_database_application/crud_database_application_01.png" /> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Name your project as <emphasis> - <property>crudapp</property>, </emphasis> specify Target Runtime, Server and - Seam Runtime configuration. Then press <emphasis> - <property>Next</property> - </emphasis> and follow the next wizard steps keeping default settings.</para> - </listitem> - </itemizedlist> - <figure> - <title>New Seam Project Wizard</title> - <mediaobject> - <imageobject> - <imagedata + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + Name your project as <emphasis> <property>crudapp</property>, </emphasis> specify Target Runtime, Server and Seam Runtime configuration. Then press <emphasis> <property>Next</property> </emphasis> and follow the next wizard steps keeping default settings. + </para> + </listitem> + </itemizedlist> + + <figure> + <title>New Seam Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/crud_database_application/crud_database_application_02.png" /> - </imageobject> - </mediaobject> - </figure> - - <note> - <title>Tip:</title> - <para>Please have a look at <xref linkend="create_seam"/> how to create Target - Runtime and Seam Runtime in order to get started creating, running, and debugging - J2EE applications.</para> - </note> - - <itemizedlist> - <listitem> - <para>On <emphasis> - <property>Seam Facet</property> - </emphasis> page click <emphasis> - <property>New...</property> - </emphasis> next to the <property>Connection profile</property> section to - create a new <property>Connection profile</property>.</para> - </listitem> - </itemizedlist> - <figure> - <title>Seam Facet page</title> - <mediaobject> - <imageobject> - <imagedata + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Tip:</title> + <para> + Please have a look at <xref linkend="create_seam"/> how to create Target Runtime and Seam Runtime in order to get started creating, running, and debugging J2EE applications. + </para> + </note> + + <itemizedlist> + <listitem> + <para> + On <emphasis> <property>Seam Facet</property> </emphasis> page click <emphasis> <property>New...</property> </emphasis> next to the <property>Connection profile</property> section to create a new <property>Connection profile</property>. + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Seam Facet page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/crud_database_application/crud_database_application_03.png" /> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>On <property>New Connection Profile</property> dialog select the <emphasis> - <property>HSQLDB</property> - </emphasis> connection profile type, name it <emphasis> - <property>cruddb</property> - </emphasis> and click <emphasis> - <property>Next</property>. </emphasis></para> - </listitem> - </itemizedlist> - - <figure> - <title>New JDBC Connection Profile</title> - <mediaobject> - <imageobject> - <imagedata + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + On <property>New Connection Profile</property> dialog select the <emphasis> <property>HSQLDB</property> </emphasis> connection profile type, name it <emphasis> <property>cruddb</property> </emphasis> and click <emphasis> <property>Next</property>. </emphasis> + </para> + </listitem> + </itemizedlist> + + <figure> + <title>New JDBC Connection Profile</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/crud_database_application/crud_database_application_04.png" /> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>On the next page click the round icon next to the <emphasis> - <property>Drivers</property> - </emphasis> field to select a database driver.</para> - </listitem> - </itemizedlist> - <figure> - <title>New JDBC Connection Profile Database Driver</title> - <mediaobject> - <imageobject> - <imagedata + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + On the next page click the round icon next to the <emphasis> <property>Drivers</property> </emphasis> field to select a database driver. + </para> + </listitem> + </itemizedlist> + + <figure> + <title>New JDBC Connection Profile Database Driver</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/crud_database_application/crud_database_application_06.png" /> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Now you should see the <property>New Driver Definition</property> dialog. On - the first tab select the <emphasis> - <property>HSQLDB JBDC Driver</property>. </emphasis> Underneath in the <emphasis> - <property>Driver name</property> - </emphasis> field you can change its name if you need.</para> - </listitem> - </itemizedlist> - <figure> - <title>Database Driver Type</title> - <mediaobject> - <imageobject> - <imagedata + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + Now you should see the <property>New Driver Definition</property> dialog. On the first tab select the <emphasis> <property>HSQLDB JBDC Driver</property>. </emphasis> Underneath in the <emphasis> <property>Driver name</property> </emphasis> field you can change its name if you need. + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Database Driver Type</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/crud_database_application/crud_database_application_07.png" /> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>You may notice the note on the previous figure. It prompts that you should - specify the driver of the type you pointed. Set the location of the driver by - switching to the next tab and press <emphasis> - <property>Add JAR/Zip</property> - </emphasis> button.</para> - </listitem> - </itemizedlist> - <figure> - <title>Driver Definition</title> - <mediaobject> - <imageobject> - <imagedata + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + You may notice the note on the previous figure. It prompts that you should specify the driver of the type you pointed. Set the location of the driver by switching to the next tab and press <emphasis> <property>Add JAR/Zip</property> </emphasis> button. + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Driver Definition</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/crud_database_application/crud_database_application_09.png" /> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>On the <property>Properties</property> tab set the - <emphasis><property>Connection URL</property>,</emphasis> - <emphasis> - <property>Database Name</property> - </emphasis> and <emphasis> - <property>User ID</property> - </emphasis> and click <emphasis> - <property>OK</property>. </emphasis></para> - </listitem> - </itemizedlist> - - <figure> - <title>Driver Definitions Properties</title> - <mediaobject> - <imageobject> - <imagedata + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + On the <property>Properties</property> tab set the <emphasis><property>Connection URL</property>,</emphasis> <emphasis> <property>Database Name</property> </emphasis> and <emphasis> <property>User ID</property> </emphasis> and click <emphasis> <property>OK</property>. </emphasis> + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Driver Definitions Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/crud_database_application/crud_database_application_10.png" /> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>After clicking <emphasis> - <property>OK</property> - </emphasis> to submit the newly created driver you can observe and if you need - edit all specified connection details.</para> - </listitem> - </itemizedlist> - <figure> - <title>Driver and Connection Details</title> - <mediaobject> - <imageobject> - <imagedata + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + After clicking <emphasis> <property>OK</property> </emphasis> to submit the newly created driver you can observe and if you need edit all specified connection details. + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Driver and Connection Details</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/crud_database_application/crud_database_application_11.png" /> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Now click <emphasis> - <property>Test Connection</property> - </emphasis> to be sure that connection can be established.</para> - </listitem> - </itemizedlist> - - <figure> - <title>JDBC Connection is OK</title> - <mediaobject> - <imageobject> - <imagedata + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + Now click <emphasis> <property>Test Connection</property> </emphasis> to be sure that connection can be established. + </para> + </listitem> + </itemizedlist> + + <figure> + <title>JDBC Connection is OK</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/crud_database_application/crud_database_application_12.png" /> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Validate <emphasis> - <property>JDBC Connection profile</property> - </emphasis> settings and press <emphasis> - <property>Finish</property> - </emphasis> or <emphasis> - <property>Back</property> - </emphasis> if something is wrong.</para> - </listitem> - </itemizedlist> - <figure> - <title>Validate JDBC Connection settings</title> - <mediaobject> - <imageobject> - <imagedata + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + Validate <emphasis> <property>JDBC Connection profile</property> </emphasis> settings and press <emphasis> <property>Finish</property> </emphasis> or <emphasis> <property>Back</property> </emphasis> if something is wrong. + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Validate JDBC Connection settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/crud_database_application/crud_database_application_13.png" /> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>After clicking <emphasis> - <property>Finish</property> - </emphasis> two projects <emphasis> - <property>crudapp</property> - </emphasis> and <emphasis> - <property>crudapp-test</property> - </emphasis> will be created.</para> - </listitem> - </itemizedlist> - - <figure> - <title>CRUDAPP Seam Project</title> - <mediaobject> - <imageobject> - <imagedata + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + After clicking <emphasis> <property>Finish</property> </emphasis> two projects <emphasis> <property>crudapp</property> </emphasis> and <emphasis> <property>crudapp-test</property> </emphasis> will be created. + </para> + </listitem> + </itemizedlist> + + <figure> + <title>CRUDAPP Seam Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/crud_database_application/crud_database_application_14.png" /> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Have a look at the created projects. You can expand - <property>WEB_CONTENT</property> folder and open - <property>home.xhtml</property> or <property>login.xhtml</property> with - <property>JBoss Visual Editor</property>.</para> - </listitem> - </itemizedlist> - <figure> - <title>login.xhtml in VPE</title> - <mediaobject> - <imageobject> - <imagedata + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + Have a look at the created projects. You can expand <property>WEB_CONTENT</property> folder and open <property>home.xhtml</property> or <property>login.xhtml</property> with <property>JBoss Visual Editor</property>. + </para> + </listitem> + </itemizedlist> + + <figure> + <title>login.xhtml in VPE</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/crud_database_application/crud_database_application_15.png" /> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Switch to <property>Database Development</property> perspective with <emphasis> - <property>Window->Open Perspective->Other...</property> - </emphasis> and connect to the <emphasis> - <property>cruddb</property> - </emphasis> database.</para> - </listitem> - </itemizedlist> - <figure> - <title>Connecting to the CRUDDB database</title> - <mediaobject> - <imageobject> - <imagedata + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + Switch to <property>Database Development</property> perspective with <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Open Perspective</guimenuitem><guimenuitem>Other...</guimenuitem></menuchoice> and connect to the <emphasis> <property>cruddb</property> </emphasis> database. + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Connecting to the CRUDDB database</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/crud_database_application/crud_database_application_16.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Expand <emphasis> - <property>cruddb</property> - </emphasis> nodes to view its <emphasis> - <property>Schemas</property>, </emphasis> - <emphasis> - <property>Tables</property>, </emphasis> - <emphasis> - <property>Columns</property> - </emphasis> etc.</para> - </listitem> - </itemizedlist> - <figure> - <title>CRUDDB Database</title> - <mediaobject> - <imageobject> - <imagedata + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + Expand <emphasis> <property>cruddb</property> </emphasis> nodes to view its <emphasis> <property>Schemas</property>, </emphasis> <emphasis> <property>Tables</property>, </emphasis> <emphasis> <property>Columns</property> </emphasis> etc. + </para> + </listitem> + </itemizedlist> + + <figure> + <title>CRUDDB Database</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/crud_database_application/crud_database_application_17.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Switch back to the <property>Seam</property> perspective. From the toolbar - select <emphasis> - <property>New->Seam Generate Entities</property> - </emphasis> to create a set of <property>CRUD</property> Seam components and web - pages based on existing tables in the database. On the first page of <emphasis> - <property>Generate Seam Entities</property> - </emphasis> wizard keep everything by default and press <emphasis> - <property>Next</property>. </emphasis></para> - </listitem> - </itemizedlist> - - <figure> - <title>Generate Seam Entities</title> - <mediaobject> - <imageobject> - <imagedata + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + Switch back to the <property>Seam</property> perspective. From the toolbar select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Seam Generate Entities</guimenuitem></menuchoice> to create a set of <property>CRUD</property> Seam components and web pages based on existing tables in the database. On the first page of <emphasis> <property>Generate Seam Entities</property> </emphasis> wizard keep everything by default and press <emphasis> <property>Next</property>. </emphasis> + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Generate Seam Entities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/crud_database_application/crud_database_application_18.png" /> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Click <emphasis> - <property>Refresh</property></emphasis> to display all the tables from the - database.</para> - </listitem> - </itemizedlist> - - <figure> - <title>Dialog for Selecting Tables</title> - <mediaobject> - <imageobject> - <imagedata + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + Click <emphasis> <property>Refresh</property></emphasis> to display all the tables from the database. + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Dialog for Selecting Tables</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/crud_database_application/crud_database_application_18a.png" /> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Now you can filter the tables. Use the <emphasis> - <property>Include</property> - </emphasis> button to include only necessary ones.</para> - </listitem> - </itemizedlist> - - <figure> - <title>Selecting Tables</title> - <mediaobject> - <imageobject> - <imagedata + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + Now you can filter the tables. Use the <emphasis> <property>Include</property> </emphasis> button to include only necessary ones. + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Selecting Tables</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/crud_database_application/crud_database_application_18b.png" /> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Under <emphasis> - <property>WebContent</property> - </emphasis> folder you can find all generated <property>xhtml</property> - files:</para> - </listitem> - </itemizedlist> - - <figure> - <title>Entities Web Pages</title> - <mediaobject> - <imageobject> - <imagedata + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + Under <emphasis> <property>WebContent</property> </emphasis> folder you can find all generated <property>xhtml</property> files: + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Entities Web Pages</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/crud_database_application/crud_database_application_19.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>And under <emphasis> - <property>src</property> - </emphasis> folder java classes are created.</para> - </listitem> - </itemizedlist> - <figure> - <title>Entities Java Classes</title> - <mediaobject> - <imageobject> - <imagedata + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + And under <emphasis> <property>src</property> </emphasis> folder java classes are created. + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Entities Java Classes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/crud_database_application/crud_database_application_20.png" /> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Switch to <property>Hibernate</property> perspective with <emphasis> - <property>Window->Open Perspective->Other...</property>. - </emphasis> On <property>Hibernate Configurations</property> view expand the <emphasis> - <property>crudapp</property> - </emphasis> configuration. Right click on <property>Customers</property> and - select <emphasis> - <property>Open Mapping Diagram</property> - </emphasis> from the popup menu.</para> - </listitem> - </itemizedlist> - <figure> - <title>Hibernate Configurations View</title> - <mediaobject> - <imageobject> - <imagedata + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + Switch to <property>Hibernate</property> perspective with <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Open Perspective</guimenuitem><guimenuitem>Other....</guimenuitem></menuchoice> On <property>Hibernate Configurations</property> view expand the <emphasis> <property>crudapp</property> </emphasis> configuration. Right click on <property>Customers</property> and select <emphasis> <property>Open Mapping Diagram</property> </emphasis> from the popup menu. + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Hibernate Configurations View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/crud_database_application/crud_database_application_21.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Observe the <property>Mapping Diagram</property> opened in the editor. Here - you can see the relations between models and database tables. For better - navigating on the diagram use the <property>Outline view</property>.</para> - </listitem> - </itemizedlist> - - <figure> - <title>Mapping Diagram</title> - <mediaobject> - <imageobject> - <imagedata + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + Observe the <property>Mapping Diagram</property> opened in the editor. Here you can see the relations between models and database tables. For better navigating on the diagram use the <property>Outline view</property>. + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Mapping Diagram</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/crud_database_application/crud_database_application_22.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>For example, select <property>Customers</property> entity, right click and - select <emphasis> - <property>Open Source File</property>. - </emphasis> This will open the <property>Customers.java</property> file in the - java editor. You can also do this by right-clicking on the same entity on the - <property>Mapping Diagram</property>.</para> - </listitem> - </itemizedlist> - - <figure> - <title>Entity class from Mapping Diagram</title> - <mediaobject> - <imageobject> - <imagedata + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + For example, select <property>Customers</property> entity, right click and select <emphasis> <property>Open Source File</property>. </emphasis> This will open the <property>Customers.java</property> file in the java editor. You can also do this by right-clicking on the same entity on the <property>Mapping Diagram</property>. + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Entity class from Mapping Diagram</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/crud_database_application/crud_database_application_23.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> - - <para>So far, you are ready to deploy your application to JBoss Application Server. This - is described in the next chapter.</para> - - </section> - + </imageobject> + </mediaobject> + </figure> + + <para> + So far, you are ready to deploy your application to JBoss Application Server. This is described in the next chapter. + </para> + </section> </chapter> Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/directory_structure.xml =================================================================== --- branches/jbosstools-3.2.x/seam/docs/reference/en-US/directory_structure.xml 2011-07-18 02:37:17 UTC (rev 32983) +++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/directory_structure.xml 2011-07-18 02:42:15 UTC (rev 32984) @@ -1,230 +1,197 @@ <?xml version="1.0" encoding="UTF-8"?> <chapter id="directory_str"> - <?dbhtml filename="directory_structure.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Seam</keyword> - <keyword>Eclipse</keyword> - </keywordset> - </chapterinfo> - - <title>Directory Structure of the Generated Project</title> - - <para>In this chapter we describe where the Seam wizard puts the generated files for both EAR - and WAR deployments.</para> - <para>The Seam Project wizard generates projects like Eclipse WTP style in order to utilize - Eclipse WTP features and to have a correct classpath. To be more precise it generates one - project per artifact.</para> - - <section id="WAR"> - <title>WAR Deployment</title> - - <para>The project layout for WAR projects is:</para> - - <figure> - <title>Project Layout for WAR projects</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/directory_structure/directory_structure_1.png" +<?dbhtml filename="directory_structure.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + + <keyword>Seam</keyword> + + <keyword>Eclipse</keyword> + </keywordset> + </chapterinfo> + <title>Directory Structure of the Generated Project</title> + <para> + In this chapter we describe where the Seam wizard puts the generated files for both EAR and WAR deployments. + </para> + + <para> + The Seam Project wizard generates projects like Eclipse WTP style in order to utilize Eclipse WTP features and to have a correct classpath. To be more precise it generates one project per artifact. + </para> + + <section id="WAR"> + <title>WAR Deployment</title> + <para> + The project layout for WAR projects is: + </para> + + <figure> + <title>Project Layout for WAR projects</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/directory_structure/directory_structure_1.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> - - <para>A WAR project can only use Seam JavaBean and JPA Entity bean components; it cannot use - EJB3 Session beans etc.</para> - <para>WAR projects are generated to enable Seam war hotdeploy feature. Classes put - into <emphasis> - <property>src/action</property> - </emphasis> will be deployed to <emphasis> - <property>WEB-INF/dev</property> - </emphasis> from which Seam automatically will perform hotdeploy of new - components.</para> - <note> - <title>Note:</title> - <para>Because of Eclipse WTP limits the hot deployed classes also existed in <emphasis> - <property>WEB-INF/classes</property>, </emphasis> but since Seam gives <emphasis> - <property>WEB-INF/dev</property> - </emphasis> precedence it will work.</para> - </note> - - <para>Furthermore the Seam Project wizard generates a test project that is setup to run - <xref linkend="testNG"/> directly against the proper libraries and - server runtime libraries. When the TestNG plugin is installed you can just run your - tests via <emphasis><property>Run As > TestNG Test</property>.</emphasis></para> - <para>In order to deploy WAR project on server, right-click on the project and select <emphasis> - <property>Run As &gt; Run on Server</property>.</emphasis> Studio will deploy - WAR project into one web application on server to <property>deploy</property> - folder.</para> - - </section> - - <section id="EAR"> - <title>EAR Deployment</title> - <para>The project layout for EAR projects is:</para> - - <figure> - <title>Project Layout for EAR projects</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/directory_structure/directory_structure_2.png" + </imageobject> + </mediaobject> + </figure> + + <para> + A WAR project can only use Seam JavaBean and JPA Entity bean components; it cannot use EJB3 Session beans etc. + </para> + + <para> + WAR projects are generated to enable Seam war hotdeploy feature. Classes put into <emphasis> <property>src/action</property> </emphasis> will be deployed to <emphasis> <property>WEB-INF/dev</property> </emphasis> from which Seam automatically will perform hotdeploy of new components. + </para> + + <note> + <title>Note:</title> + <para> + Because of Eclipse WTP limits the hot deployed classes also existed in <emphasis> <property>WEB-INF/classes</property>, </emphasis> but since Seam gives <emphasis> <property>WEB-INF/dev</property> </emphasis> precedence it will work. + </para> + </note> + + <para> + Furthermore the Seam Project wizard generates a test project that is setup to run <xref linkend="testNG"/> directly against the proper libraries and server runtime libraries. When the TestNG plugin is installed you can just run your tests via <menuchoice><guimenuitem>Run As</guimenuitem><guimenuitem>TestNG Test.</guimenuitem></menuchoice> + </para> + + <para> + In order to deploy WAR project on server, right-click on the project and select <menuchoice><guimenuitem>Run As</guimenuitem><guimenuitem>Run on Server.</guimenuitem></menuchoice> Studio will deploy WAR project into one web application on server to <property>deploy</property> folder. + </para> + </section> + + <section id="EAR"> + <title>EAR Deployment</title> + <para> + The project layout for EAR projects is: + </para> + + <figure> + <title>Project Layout for EAR projects</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/directory_structure/directory_structure_2.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> - - <para>An EAR project can use the whole range of Seam components, including EJB3 Session - beans.</para> - <para>In order to deploy EAR project on server, right-click on the project with - <property>-ear</property> postfix and select <emphasis> - <property>Run As &gt; Run on Server</property>.</emphasis> Studio will take care - about all modules and deploy EAR project into one enterprise application on server to - <property>deploy</property> folder. EAR application keeps <property>ejb</property> - and <property>war</property> modules of the EAR project.</para> - - <note><title>Note:</title> - <para>The <property>WAR</property> generated for <property>EARs</property> is now configured to utilize Seam hot-deployment (<emphasis><property>WEB-INF/dev</property></emphasis>) similar to standalone <property>WAR</property> projects.</para> - - </note> - - </section> - - <section id="seam_version_changing"> - - <title>Changing the Seam Version</title> - - <para>To upgrade or downgrade your projects Seam version use the facet preferences. You - should right-click your project, open its <property>Properties</property> and choose <emphasis> - <property>Project Facets</property> - </emphasis> category. Next select <emphasis> - <property>Seam</property> - </emphasis> and change its version to needed one.</para> - - <figure> - <title>Changing the Seam Facet Version</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/directory_structure/directory_structure_3.png" + </imageobject> + </mediaobject> + </figure> + + <para> + An EAR project can use the whole range of Seam components, including EJB3 Session beans. + </para> + + <para> + In order to deploy EAR project on server, right-click on the project with <property>-ear</property> postfix and select <menuchoice><guimenuitem>Run As</guimenuitem><guimenuitem>Run on Server.</guimenuitem></menuchoice> Studio will take care about all modules and deploy EAR project into one enterprise application on server to <property>deploy</property> folder. EAR application keeps <property>ejb</property> and <property>war</property> modules of the EAR project. + </para> + + <note> + <title>Note:</title> + <para> + The <property>WAR</property> generated for <property>EARs</property> is now configured to utilize Seam hot-deployment (<emphasis><property>WEB-INF/dev</property></emphasis>) similar to standalone <property>WAR</property> projects. + </para> + </note> + </section> + + <section id="seam_version_changing"> + <title>Changing the Seam Version</title> + <para> + To upgrade or downgrade your projects Seam version use the facet preferences. You should right-click your project, open its <property>Properties</property> and choose <emphasis> <property>Project Facets</property> </emphasis> category. Next select <emphasis> <property>Seam</property> </emphasis> and change its version to needed one. + </para> + + <figure> + <title>Changing the Seam Facet Version</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/directory_structure/directory_structure_3.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> - - <para>After pressing <emphasis> - <property>Apply</property> - </emphasis> the wizard for adjusting new Seam runtime settings appears.</para> - - <figure> - <title>Changing the Seam Facet Version</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/directory_structure/directory_structure_4.png" + </imageobject> + </mediaobject> + </figure> + + <para> + After pressing <emphasis> <property>Apply</property> </emphasis> the wizard for adjusting new Seam runtime settings appears. + </para> + + <figure> + <title>Changing the Seam Facet Version</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/directory_structure/directory_structure_4.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> - - <para>If you need to update the libraries for you project, check the <emphasis> - <property>Update libraries</property> - </emphasis> option. All libraries you checked will be removed and the libraries from the - new Seam distribution will be added after clicking <emphasis> - <property>Ok</property>.</emphasis></para> - - <figure> - <title>Changing the Seam Facet Version</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/directory_structure/directory_structure_5.png" + </imageobject> + </mediaobject> + </figure> + + <para> + If you need to update the libraries for you project, check the <emphasis> <property>Update libraries</property> </emphasis> option. All libraries you checked will be removed and the libraries from the new Seam distribution will be added after clicking <emphasis> <property>Ok</property>.</emphasis> + </para> + + <figure> + <title>Changing the Seam Facet Version</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/directory_structure/directory_structure_5.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> - - <note> - <title>Note:</title> - - <para>The note "Seam configuration files and their XSDs won&apos;t be changed" is - meant that the libraries, Seam facet and runtime version will be changed, but - configuration files that refer to the old version will have to be manually - updated.</para> - </note> - </section> - - <section id="changing_seam_parent_project"> - <title>Changing Seam Parent Project</title> - - <para>Starting from the 2.0.0.CR2 version of <property>JBoss Tools</property> it is possible - to change the Seam parent project. In earlier versions this was only controllable at a - project creation time, now it can be changed for existing projects too.</para> - - <para>Go to your project preferences and select <emphasis> - <property>Seam Settings</property> - </emphasis> category on the left. Press the <emphasis> - <property>Browse</property> - </emphasis> button next to the <emphasis> - <property>Main Seam Project</property> - </emphasis> section to select the other Seam parent project.</para> - - <figure> - <title>Changing Seam Parent Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/directory_structure/directory_structure_6.png" + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para> + The note "Seam configuration files and their XSDs won&apos;t be changed" is meant that the libraries, Seam facet and runtime version will be changed, but configuration files that refer to the old version will have to be manually updated. + </para> + </note> + </section> + + <section id="changing_seam_parent_project"> + <title>Changing Seam Parent Project</title> + <para> + Starting from the 2.0.0.CR2 version of <property>JBoss Tools</property> it is possible to change the Seam parent project. In earlier versions this was only controllable at a project creation time, now it can be changed for existing projects too. + </para> + + <para> + Go to your project preferences and select <emphasis> <property>Seam Settings</property> </emphasis> category on the left. Press the <emphasis> <property>Browse</property> </emphasis> button next to the <emphasis> <property>Main Seam Project</property> </emphasis> section to select the other Seam parent project. + </para> + + <figure> + <title>Changing Seam Parent Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/directory_structure/directory_structure_6.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> - </section> - - <section id="renaming_projects_folders"> - <title>Renaming the Projects and Folders</title> - - <para>If you need to rename one of the Seam Project artifacts - (<emphasis>&lt;project_name&gt;</emphasis>, - <emphasis>&lt;project_name&gt;-ear</emphasis>, - <emphasis>&lt;project_name&gt;-ejb</emphasis> or - <emphasis>&lt;project_name&gt;-test</emphasis>) or any entire folder like - <emphasis>&lt;project_name&gt;/WebContent</emphasis>, - <emphasis>&lt;project_name&gt;/ejbModule</emphasis>, - <emphasis>&lt;project_name&gt;-test/test-src</emphasis>, or project name in - packages <emphasis>org.domain.&lt;project_name&gt;.session</emphasis>, - <emphasis>org.domain.&lt;project_name&gt;.entity</emphasis>, you can do this - by brining the context menu and navigating <emphasis> - <property>Refactor &gt; Rename...</property> - </emphasis> or just pressing <emphasis> - <property>Shift + Alt + R</property> - </emphasis> under the chosen resource.</para> - - <figure> - <title>Renaming the folder</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/directory_structure/directory_structure_7.png" + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="renaming_projects_folders"> + <title>Renaming the Projects and Folders</title> + <para> + If you need to rename one of the Seam Project artifacts (<emphasis>&lt;project_name&gt;</emphasis>, <emphasis>&lt;project_name&gt;-ear</emphasis>, <emphasis>&lt;project_name&gt;-ejb</emphasis> or <emphasis>&lt;project_name&gt;-test</emphasis>) or any entire folder like <emphasis>&lt;project_name&gt;/WebContent</emphasis>, <emphasis>&lt;project_name&gt;/ejbModule</emphasis>, <emphasis>&lt;project_name&gt;-test/test-src</emphasis>, or project name in packages <emphasis>org.domain.&lt;project_name&gt;.session</emphasis>, <emphasis>org.domain.&lt;project_name&gt;.entity</emphasis>, you can do this by brining the context menu and navigating <emphasis> <property>Refactor &gt; Rename...</property> </emphasis> or just pressing <emphasis> <property>Shift + Alt + R</property> </emphasis> under the chosen resource. + </para> + + <figure> + <title>Renaming the folder</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/directory_structure/directory_structure_7.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> - - <para>Use <emphasis> - <property>Refactor &gt; Move...</property> - </emphasis> (or <emphasis> - <property>Shift + Alt + V</property> - </emphasis>), if you need to move - <emphasis>&lt;project_name&gt;/WebContent</emphasis> folder, - <emphasis>&lt;project_name&gt;/ejbModule</emphasis> folder or - <emphasis>&lt;project_name&gt;/test-src</emphasis> folder in the other place - within the Project structure.</para> - - <figure> - <title>Moving the folder</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/directory_structure/directory_structure_8.png" + </imageobject> + </mediaobject> + </figure> + + <para> + Use <emphasis> <property>Refactor &gt; Move...</property> </emphasis> (or <emphasis> <property>Shift + Alt + V</property> </emphasis>), if you need to move <emphasis>&lt;project_name&gt;/WebContent</emphasis> folder, <emphasis>&lt;project_name&gt;/ejbModule</emphasis> folder or <emphasis>&lt;project_name&gt;/test-src</emphasis> folder in the other place within the Project structure. + </para> + + <figure> + <title>Moving the folder</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/directory_structure/directory_structure_8.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> - - </section> -</chapter> \ No newline at end of file + </imageobject> + </mediaobject> + </figure> + </section> +</chapter> Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/generate_entities.xml =================================================================== --- branches/jbosstools-3.2.x/seam/docs/reference/en-US/generate_entities.xml 2011-07-18 02:37:17 UTC (rev 32983) +++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/generate_entities.xml 2011-07-18 02:42:15 UTC (rev 32984) @@ -1,56 +1,79 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="generate_entities"> - <?dbhtml filename="generate_entities.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Seam</keyword> - <keyword>JBDS</keyword> - </keywordset> - </chapterinfo> - - <title>Seam Generate Entities</title> - - <para>The main purpose of this chapter is to tell you about Seam Generate Entities.</para> - <para>Generate Entities is available directly from Eclipse using Hibernate Tools plugin for the standard seam-gen generation.</para> - <para>The wizard generates a set of CRUD Seam components and web pages based on existing tables in a database or on existing entities in your application.</para> - - - <figure> - <title>Generate Seam Entities Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/generate_entities/generate_entities1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>By default, the generation mode is set to <emphasis><property>Reverse engineer from database</property>.</emphasis> - The reverse engineering from a database could be described in four steps:</para> - <orderedlist> - <listitem><para>The wizard gets in database, extracts the tables and - their connections</para></listitem> - <listitem><para>On basis of this metainfomation the Entity classes are generated into - <literal>org.domain.project.entity</literal> package</para></listitem> - <listitem><para>For the entities from step 2 the classes <property>EntityList</property> and <property>EntityHome</property> are generated - into <literal>org.domain.project.session</literal> package</para></listitem> - <listitem><para>The xhtml pages are generated.</para></listitem> - </orderedlist> - - <note> - <title>Note:</title> - <para>The entities are generated from a database based on the console configuration that is created automatically during a Seam project creation. - (Read more about the console configuration in the Hibernate guides). The created console configuration is based on the - connection profile set on the <xref linkend="seamFacet"/> while creating a project. - Configured connection profile settings are hold in the generated <literal>hibernate-console.properties</literal>. To change the connection - profile, double-click the console configuration. It could be found in the <property>Hibernate Configurations</property> view - (<emphasis><property>Window &gt; Show view &gt; Other &gt; Hibernate &gt; Hibernate Configurations</property></emphasis> - or just switch to the <property>Hibernate</property> perspective).</para> - </note> - <para> - Checking the <emphasis><property>Use existing entities</property></emphasis> mode the wizard executes only 3 and 4 steps. It generates missing classes and - xhtml pages. - </para> - - <para>Read the <xref linkend="crud_database_application"/> chapter in order to see how the <property>Generate Seam Entities</property> wizard can be used.</para> - </chapter> \ No newline at end of file +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="generate_entities"> +<?dbhtml filename="generate_entities.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + + <keyword>Seam</keyword> + + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + <title>Seam Generate Entities</title> + <para> + The main purpose of this chapter is to tell you about Seam Generate Entities. + </para> + + <para> + Generate Entities is available directly from Eclipse using Hibernate Tools plugin for the standard seam-gen generation. + </para> + + <para> + The wizard generates a set of CRUD Seam components and web pages based on existing tables in a database or on existing entities in your application. + </para> + + <figure> + <title>Generate Seam Entities Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/generate_entities/generate_entities1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + By default, the generation mode is set to <emphasis><property>Reverse engineer from database</property>.</emphasis> The reverse engineering from a database could be described in four steps: + </para> + + <orderedlist> + <listitem> + <para> + The wizard gets in database, extracts the tables and their connections + </para> + </listitem> + + <listitem> + <para> + On basis of this metainfomation the Entity classes are generated into <literal>org.domain.project.entity</literal> package + </para> + </listitem> + + <listitem> + <para> + For the entities from step 2 the classes <property>EntityList</property> and <property>EntityHome</property> are generated into <literal>org.domain.project.session</literal> package + </para> + </listitem> + + <listitem> + <para> + The xhtml pages are generated. + </para> + </listitem> + </orderedlist> + + <note> + <title>Note:</title> + <para> + The entities are generated from a database based on the console configuration that is created automatically during a Seam project creation. (Read more about the console configuration in the Hibernate guides). The created console configuration is based on the connection profile set on the <xref linkend="seamFacet"/> while creating a project. Configured connection profile settings are hold in the generated <literal>hibernate-console.properties</literal>. To change the connection profile, double-click the console configuration. It could be found in the <property>Hibernate Configurations</property> view (<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show view</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Hibernate</guimenuitem><guimenuitem>Hibernate Configurations</guimenuitem></menuchoice> or just switch to the <property>Hibernate</property> perspective). + </para> + </note> + + <para> + Checking the <emphasis><property>Use existing entities</property></emphasis> mode the wizard executes only 3 and 4 steps. It generates missing classes and xhtml pages. + </para> + + <para> + Read the <xref linkend="crud_database_application"/> chapter in order to see how the <property>Generate Seam Entities</property> wizard can be used. + </para> +</chapter> Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/intro.xml =================================================================== --- branches/jbosstools-3.2.x/seam/docs/reference/en-US/intro.xml 2011-07-18 02:37:17 UTC (rev 32983) +++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/intro.xml 2011-07-18 02:42:15 UTC (rev 32984) @@ -64,7 +64,7 @@ <row> <entry><para>New Seam Project wizard</para></entry> - <entry><para>An easy step-by-step wizard to create a standalone Seam Web Project with a form to create runtime and server instances in order to get started creating, running, and debugging J2EE (only) applications. You may also add JSF capabilities.</para></entry> + <entry><para>An easy step-by-step wizard to create a stand alone Seam Web Project with a form to create runtime and server instances in order to get started creating, running, and debugging J2EE (only) applications. You may also add JSF capabilities.</para></entry> <entry> <xref linkend="create_seam"/> </entry> Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/master.xml =================================================================== --- branches/jbosstools-3.2.x/seam/docs/reference/en-US/master.xml 2011-07-18 02:37:17 UTC (rev 32983) +++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/master.xml 2011-07-18 02:42:15 UTC (rev 32984) @@ -66,12 +66,12 @@ Version: 3.1.1.GA </releaseinfo> -<abstract> +<!--<abstract> <title/> <para> <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/seam/pdf/S... version</ulink> </para> -</abstract> +</abstract>--> </bookinfo> Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_editors.xml =================================================================== --- branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_editors.xml 2011-07-18 02:37:17 UTC (rev 32983) +++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_editors.xml 2011-07-18 02:42:15 UTC (rev 32984) @@ -1,697 +1,815 @@ <?xml version="1.0" encoding="UTF-8"?> <chapter id="seam_editors" role="updated"> - <?dbhtml filename="seam_editors.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Seam</keyword> - <keyword>JBDS</keyword> - </keywordset> - </chapterinfo> - - <title>Seam Editors</title> - - - <para>This chapter tells about Seam Editors and their features.</para> - +<?dbhtml filename="seam_editors.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + + <keyword>Seam</keyword> + + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + <title>Seam Editors</title> + <para> + This chapter tells about Seam Editors and their features. + </para> + + <section> + <title>Visual Page Editor</title> + <para> + Visual Page Editor fits perfectly for authoring view Seam pages. The major features of VPE are listed in <xref linkend="SeamEditors"/> + </para> + + <para> + You can also read more about Visual Page Editor in <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf/html/e... Page Editor</ulink> chapter of &quot;Visual Web Tools Reference Guide&quot;. + </para> + </section> + + <section> + <title>Seam Pages Editor</title> + <para> + <property>Seam Pages Editor</property> provides a handy way to edit the <property>pages.xml</property> file. + </para> + + <para> + You can edit the pages.xml file in three modes: Graphical, Tree and Source. + </para> + + <para> + Seam Pages Editor supports synchronization with Package Explorer.This means that while renaming files in the Package Explorer all the changes immediately affect the pages.xml file. + </para> + <section> - <title>Visual Page Editor</title> - <para>Visual Page Editor fits perfectly for authoring view Seam pages. The major features of VPE are listed in <xref linkend="SeamEditors"/></para> - <para>You can also read more about Visual Page Editor in <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf/html/e... Page Editor</ulink> chapter of &quot;Visual Web Tools Reference Guide&quot;.</para> - </section> - - - - - <section> - <title>Seam Pages Editor</title> - + <title>Graphical Mode</title> + <para> + Graphical mode provides you with a set of visual tools to organize your project pageflow, exception handling etc. + </para> - <para> - <property>Seam Pages Editor</property> provides a handy way to edit the <property>pages.xml</property> file. - - </para> - - <para> - You can edit the pages.xml file in three modes: Graphical, Tree and Source. - - </para> - <para> - Seam Pages Editor supports synchronization with Package Explorer.This means that while renaming files in the Package Explorer all the changes immediately affect the pages.xml file. - - </para> - <section> - <title>Graphical Mode</title> - - - <para>Graphical mode provides you with a set of visual tools to organize your project pageflow, exception handling etc.</para> - <figure> - <title>Seam Pages Editor: Graphical View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_7.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The Graphical part of the editor has some visual elements. The table below shows graphical representation of the elements and explains their meanings. </para> - -<table> - <title>Pages Editor: Graphical View. Visual elements</title> - <tgroup cols="2"> - <thead> + <figure> + <title>Seam Pages Editor: Graphical View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + The Graphical part of the editor has some visual elements. The table below shows graphical representation of the elements and explains their meanings. + </para> + + <table> + <title>Pages Editor: Graphical View. Visual elements</title> + <tgroup cols="2"> + <thead> <row> - <entry>Element</entry> - - <entry>Description</entry> + <entry> + Element + </entry> + + <entry> + Description + </entry> </row> - </thead> - <tbody> + </thead> + + <tbody> <row> - <entry> - <mediaobject> + <entry> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/element_page.png"/> + </imageobject> + </mediaobject> + </entry> + + <entry> + <para> + A yellow box with a solid border represents a <code> &lt;page&gt; </code> element. + </para> + </entry> + </row> + + <row> + <entry> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/element_param.png"/> + </imageobject> + </mediaobject> + </entry> + + <entry> + <para> + Pressing on the plus icon ( + <inlinemediaobject> <imageobject> - <imagedata fileref="images/seam_editors/element_page.png"/> + <imagedata fileref="images/seam_editors/icon_plus.png"/> </imageobject> - </mediaobject> - </entry> - <entry><para>A yellow box with a solid border represents a <code> - &lt;page&gt; - </code> element. - </para></entry> - </row> - <row> - <entry> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/element_param.png"/> - </imageobject> - </mediaobject></entry> - <entry> - <para>Pressing on the plus icon (<inlinemediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/icon_plus.png"/> - </imageobject> - </inlinemediaobject>) - - - on the <code> - &lt;page&gt; - </code> element reveals a box that lists the parameters for the page.</para> - </entry> - - </row> - - <row> - <entry> <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/element_page2.png"/> - </imageobject> - </mediaobject></entry> - <entry> - <para>A red cross in the upper left corner of the page box indicates that the view-id is not found in the project.</para> - </entry> - </row> - - <row> - <entry><mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/element_page1.png"/> - </imageobject> - </mediaobject></entry> - <entry> <para> - A gray box with a dashed border represents a page that has navigation - (navigation rule) to but the page is not defined in the page.xml file. - </para></entry> - </row> - - - <row> - <entry> <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/element_exception.png"/> - </imageobject> - </mediaobject></entry> - <entry> <para>An <code>&lt;exception&gt;</code> is represented by a blue box with a orange diamond.</para></entry> - </row> - - - - - - </tbody> - </tgroup> -</table> - + </inlinemediaobject> + ) on the <code> &lt;page&gt; </code> element reveals a box that lists the parameters for the page. + </para> + </entry> + </row> + + <row> + <entry> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/element_page2.png"/> + </imageobject> + </mediaobject> + </entry> - <para>Pageflow relations are shown with gray arrows, when you select a relationship the arrow is changed to orange. </para> - - - - <para>On the lefthand side of the Graphical view of <property>Seam Page Editor</property> you can find a toolbar with a set of icons for the most frequently used commands. </para> - + <entry> + <para> + A red cross in the upper left corner of the page box indicates that the view-id is not found in the project. + </para> + </entry> + </row> + + <row> + <entry> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/element_page1.png"/> + </imageobject> + </mediaobject> + </entry> + + <entry> + <para> + A gray box with a dashed border represents a page that has navigation (navigation rule) to but the page is not defined in the page.xml file. + </para> + </entry> + </row> + + <row> + <entry> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/element_exception.png"/> + </imageobject> + </mediaobject> + </entry> + + <entry> + <para> + An <code>&lt;exception&gt;</code> is represented by a blue box with a orange diamond. + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + Pageflow relations are shown with gray arrows, when you select a relationship the arrow is changed to orange. + </para> + + <para> + On the left hand side of the Graphical view of <property>Seam Page Editor</property> you can find a toolbar with a set of icons for the most frequently used commands. + </para> + <table> - <title>Pages Editor: Graphical View. Commands Icons</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Icon Image</entry> - - <entry>Command</entry> - </row> - </thead> - <tbody> - <row> - <entry> - <inlinemediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/icon_select.png"/> - </imageobject> - </inlinemediaobject> - - </entry> - <entry>Select a page element</entry> - - </row> - - <row> - <entry><inlinemediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/icon_marquee.png"/> - </imageobject> - </inlinemediaobject></entry> - <entry>Marquee a page item</entry> - </row> - - - <row> - <entry> - <inlinemediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/icon_new_link.png"/> - </imageobject> - </inlinemediaobject> - - </entry> - <entry>Add a page relationship</entry> - </row> - - - <row> - <entry> - <inlinemediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/icon_exception.png"/> - </imageobject> - </inlinemediaobject> - - </entry> - <entry>Add an exception rule</entry> - </row> - - </tbody> - </tgroup> - </table> - - <para>Context menus are also available when you click either on an item or a blank space.</para> - - - <para>A context menu called on a blank space of the diagram provides the following options:</para> - <itemizedlist> - <listitem><para><emphasis role="bold">Page</emphasis> creates a new page element on the diagram</para></listitem> - <listitem><para><emphasis role="bold">Exception</emphasis> creates a new exception element on the diagram</para></listitem> - <listitem><para><emphasis role="bold">Auto Layout</emphasis> formats the layout of the diagram automatically</para></listitem> - <listitem><para><emphasis role="bold">Select Element</emphasis> calls the <property>Select Element Wizard</property> with a filter to perform a quick search through the <property>pages.xml</property> file </para></listitem> - </itemizedlist> - <para>Rightclicking on a selected - <code>&lt;page&gt;</code> - element calls a context menu where you can choose the following options if you click on the <emphasis role="bold">New</emphasis> menu item: </para> - - - + <title>Pages Editor: Graphical View. Commands Icons</title> + <tgroup cols="2"> + <thead> + <row> + <entry> + Icon Image + </entry> + + <entry> + Command + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/icon_select.png"/> + </imageobject> + </inlinemediaobject> + </entry> + + <entry> + Select a page element + </entry> + </row> + + <row> + <entry> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/icon_marquee.png"/> + </imageobject> + </inlinemediaobject> + </entry> + + <entry> + Marquee a page item + </entry> + </row> + + <row> + <entry> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/icon_new_link.png"/> + </imageobject> + </inlinemediaobject> + </entry> + + <entry> + Add a page relationship + </entry> + </row> + + <row> + <entry> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/icon_exception.png"/> + </imageobject> + </inlinemediaobject> + </entry> + + <entry> + Add an exception rule + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + Context menus are also available when you click either on an item or a blank space. + </para> + + <para> + A context menu called on a blank space of the diagram provides the following options: + </para> + <itemizedlist> - <listitem><para><emphasis role="bold">Rule</emphasis> opens the <property>Add Navigation Rule</property> dialog in which you can browse your project for a view page to set the view-id in the navigation rule and specify <emphasis role="bold">render</emphasis> or <emphasis role="bold">redirect</emphasis> navigation options </para></listitem> - <listitem><para><emphasis role="bold">Param</emphasis> calls a dialog box where you can define a parameter (using the - <code>&lt;param&gt;</code> - tag) for the - <code>&lt;page&gt;</code> - element</para></listitem> + <listitem> + <para> + <emphasis role="bold">Page</emphasis> creates a new page element on the diagram + </para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">Exception</emphasis> creates a new exception element on the diagram + </para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">Auto Layout</emphasis> formats the layout of the diagram automatically + </para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">Select Element</emphasis> calls the <property>Select Element Wizard</property> with a filter to perform a quick search through the <property>pages.xml</property> file + </para> + </listitem> </itemizedlist> - - - <section> - <title>Seam Pages Diagram Preferences</title> - - - - <para>In order to customize the layout of Diagram you can go to - <property>Window > Preferences > JBoss Tools > Web > Seam > Editors > Seam Pages Diagram</property>. - </para> - - <figure> - <title>Preferences of Seam Pages Diagram</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_11.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - </section> - - - <section> - <title>Tree Mode</title> - - <para>Tree Mode provides a wider range of options and way to edit and modify the pages.xml file.</para> - - - + + <para> + Right clicking on a selected <code>&lt;page&gt;</code> element calls a context menu where you can choose the following options if you click on the <emphasis role="bold">New</emphasis> menu item: + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis role="bold">Rule</emphasis> opens the <property>Add Navigation Rule</property> dialog in which you can browse your project for a view page to set the view-id in the navigation rule and specify <emphasis role="bold">render</emphasis> or <emphasis role="bold">redirect</emphasis> navigation options + </para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">Param</emphasis> calls a dialog box where you can define a parameter (using the <code>&lt;param&gt;</code> tag) for the <code>&lt;page&gt;</code> element + </para> + </listitem> + </itemizedlist> + + <section> + <title>Seam Pages Diagram Preferences</title> + <para> + In order to customize the layout of Diagram you can go to <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>JBoss Tools</guimenuitem><guimenuitem>Web</guimenuitem><guimenuitem>Seam</guimenuitem><guimenuitem>Editors</guimenuitem><guimenuitem>Seam Pages Diagram</guimenuitem></menuchoice>. + </para> + <figure> - <title>Seam Pages Editor: Tree View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_8.png"/> - </imageobject> - </mediaobject> + <title>Preferences of Seam Pages Diagram</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_11.png"/> + </imageobject> + </mediaobject> </figure> - - <para> - In this mode all elements and attributes of the page.xml - file can be viewed and edited in a visual, user friendly way. - </para> - - </section> - - - <section> - <title>Outline Support for Seam Pages Editor</title> - - - <para>Seam Pages Editor provides <property>Outline</property> view support. - You can explore the pages.xml using Outline view in two modes: <property>Tree</property> ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/outline_tree.png"/> - </imageobject> - </inlinemediaobject> ) and <property>Diagram Navigation</property> ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/outline_navigation.png"/> - </imageobject> - </inlinemediaobject> ).</para> - - <para> - The Diagram Navigation mode of Outline view gives a birds-view of the layout to allow quick navigation for large-scale applications. - </para> - - <figure> - <title>Outline view: Diagram Navigation mode</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_9.png"/> - </imageobject> - </mediaobject> - </figure> - - - <para>The Tree mode shows a tree for every element in the pages.xml file. You can get a quick overview of the whole file. When selecting an element in the Outline view the related element is highlighted in the Graphical, Tree or Source page of Seam Pages Editor.</para> + </section> + </section> + <section> + <title>Tree Mode</title> + <para> + Tree Mode provides a wider range of options and way to edit and modify the pages.xml file. + </para> + + <figure> + <title>Seam Pages Editor: Tree View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_8.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + In this mode all elements and attributes of the page.xml file can be viewed and edited in a visual, user friendly way. + </para> + </section> + <section> + <title>Outline Support for Seam Pages Editor</title> + <para> + Seam Pages Editor provides <property>Outline</property> view support. You can explore the pages.xml using Outline view in two modes: <property>Tree</property> ( + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/outline_tree.png"/> + </imageobject> + </inlinemediaobject> + ) and <property>Diagram Navigation</property> ( + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/outline_navigation.png"/> + </imageobject> + </inlinemediaobject> + ). + </para> + + <para> + The Diagram Navigation mode of Outline view gives a birds-view of the layout to allow quick navigation for large-scale applications. + </para> + + <figure> + <title>Outline view: Diagram Navigation mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_9.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + The Tree mode shows a tree for every element in the pages.xml file. You can get a quick overview of the whole file. When selecting an element in the Outline view the related element is highlighted in the Graphical, Tree or Source page of Seam Pages Editor. + </para> + + <figure> + <title>Outline view: Tree mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_10.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + + <section> + <title>Seam Components Editor</title> + <para> + When editing <property>components.xml</property> a structured tree editor is available in addition to pure source editing. It has a graphical view (Tree tab) and source (Source tab). + </para> - <figure> - <title>Outline view: Tree mode</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_10.png"/> - </imageobject> - </mediaobject> - </figure> - - - - - </section> - - - - </section> - - - - - <section> - - - <title>Seam Components Editor</title> - - <para>When editing <property>components.xml</property> a structured tree editor is available - in addition to pure source editing. It has a graphical view (Tree tab) and source - (Source tab).</para> - + <figure> + <title>component.xml Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_4.png"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para> + You can view and edit <property>components.xml</property> and other xml files directly in the Project Explorer and Properties sheet without opening the components.xml editor. + </para> + </note> + + <figure> + <title>component.xml Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_5.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="SeamEditors"> + <title>Main Features of Seam Editors</title> + <para> + In this chapter you will know what Seam Editors features are and how to work with them. + </para> + + <section id="ContentAssist"> + <title>Content Assist</title> + <para> + <property>Content Assist</property> (Ctrl + Space) is available when using EL expressions in the following file formats: + </para> + + <itemizedlist> + <listitem> + <para> + JSP + </para> + </listitem> + + <listitem> + <para> + XHTML + </para> + </listitem> + + <listitem> + <para> + XML + </para> + </listitem> + + <listitem> + <para> + JAVA + </para> + </listitem> + </itemizedlist> + + <para> + Notice, the code completion for the Seam components shows the proposals marked with Seam icon. + </para> + + <figure> + <title>Content Assist</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_1.png" scale="70"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Content Assist is also available for the <emphasis + role="italic"> <property>&quot;jsfc &quot;</property> </emphasis> attribute, it lets you select from a list of possible attribute values. Whereas, JSF components appear above all other components in the list. + </para> + + <figure> + <title>Content Assist for the &quot;jsfc&quot; attribute</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_12.png" scale="70"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para> + To get Code Assist available for an externally generated and imported project, don&apos;t forget to enable Seam features and configure Seam Settings in <xref linkend="project_pref"/>. + </para> + </note> + + <section id="components_code_assist" role="new"> + <title>Content Assist for components.xml</title> + <para> + While you are editing a <emphasis> <property>components.xml</property> </emphasis> file you can make use of the Content Assist for inserting needed elements. + </para> + <figure> - <title>component.xml Editor</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_4.png"/> - </imageobject> - </mediaobject> + <title>Content Assist in the component.xml Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_1a.png"/> + </imageobject> + </mediaobject> </figure> - - <note> - <title>Note:</title> - - <para>You can view and edit <property>components.xml</property> and other xml files - directly in the Project Explorer and Properties sheet without opening the - components.xml editor.</para> - </note> + + <para> + The editor also makes code completion aware of methods/attributes for EntityQuery component. + </para> + <figure> - <title>component.xml Editor</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_5.png"/> - </imageobject> - </mediaobject> + <title>Content Assist for EntityQuery Component</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_1b.png"/> + </imageobject> + </mediaobject> </figure> - + </section> + + <section id="named_beans_code_assist" role="new"> + <title>Content assist for @Named beans</title> + <para> + To the nice code completion you can also use Content assist for all occurrences where @Named beans are used. + </para> + + <figure> + <title>Content assist for @Named beans</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_1c.png"/> + </imageobject> + </mediaobject> + </figure> + </section> </section> - - - <section id="SeamEditors"> - <title>Main Features of Seam Editors</title> - - <para>In this chapter you will know what Seam Editors features are and how to work with them. </para> - - <section id="ContentAssist"> - - <title>Content Assist</title> - - <para><property>Content Assist</property> (Ctrl + Space) is available when using EL expressions in the following file formats:</para> - <itemizedlist> + <section> + <title>Content Assist for Page Descriptors</title> + <para> + Content Assist ( CA ) is available for Page Descriptors, <property>.page.xml</property> and <property>page.xml</property> files. Content Assist lets you easily compose a Page Descriptor file by suggesting elements and attributes. The suggestions are context dependent, which means that CA provides only the elements, attributes and in some cases values for the attributes, suitable in a particular place of your Page Descriptor. + </para> + + <para> + Seam Pages Editor also supports code completion in EL-expressions suggesting you possible bean properties and methods. + </para> + </section> + + <section id="OpenOn"> + <title>OpenOn</title> + <para> + <property>OpenOn</property> lets you easily navigate through your project without using the Package Explorer or Project Explorer. After pressing <emphasis> <property>Ctrl + left click</property> </emphasis> (or just F3) you will see a corresponding method or class. + </para> + + <figure> + <title>OpenOn</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + OpenOn is available for the following files: + </para> + + <itemizedlist> + <listitem> + <para> + <xref linkend="xmlFiles"/> + </para> + </listitem> + + <listitem> + <para> + <xref linkend="xhtmlFiles"/> + </para> + </listitem> + + <listitem> + <para> + <xref linkend="javaFiles"/> + </para> + </listitem> + </itemizedlist> + + <note> + <title>Note:</title> + <para> + In this section were described only use cases special for Seam applications.For general information please read <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf/html/e... section in Visual Web Tools Reference Guide</ulink>. + </para> + </note> + + <itemizedlist> + <listitem id="xhtmlFiles"> + <para> + Using OpenOn in .xhtml files you can open: + </para> + + <itemizedlist> <listitem> - <para>JSP</para> + <para> + components or properties resolved using an EL expression; + </para> </listitem> + <listitem> - <para>XHTML</para> + <para> + all actions described in pages.xml; + </para> </listitem> + <listitem> - <para>XML</para> + <para> + other .xhtml files that paths are specified in a current file; + </para> </listitem> + <listitem> - <para>JAVA</para> + <para> + image files that paths are set in the <emphasis> <property>value</property></emphasis> property.The files will be opened in the default system graphical editor. + </para> </listitem> - </itemizedlist> - - <para>Notice, the code completion for the Seam components shows the proposals marked with Seam icon.</para> - - <figure> - <title>Content Assist</title> + </itemizedlist> + </listitem> + + <listitem id="xmlFiles"> + <para> + OpenOn is also supported in Page Descriptors (<property>.page.xml</property> and <property>pages.xml</property>). OpenOn allows you to navigate to Java beans as well as to view pages. You can <property>Ctrl + left click</property> on a bean or on view page file (e.g. XTML file) to navigate to the file you clicked on. + </para> + + <figure> + <title>OpenOn in .page.xml file</title> <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_1.png" scale="70"/> - </imageobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_2a.png"/> + </imageobject> </mediaobject> - </figure> - <para> Content Assist is also available for the <emphasis - role="italic"> - <property>&quot;jsfc &quot;</property> - </emphasis> attribute, it lets you select from a list of possible attribute values. Whereas, JSF components appear above all other components in the list.</para> - <figure> - <title>Content Assist for the &quot;jsfc&quot; attribute</title> + </figure> + + <para> + If you use Rule-based authorization with Drools in your Seam application you can apply OpenOn in <emphasis> <property>components.xml</property></emphasis> to open the files containing rule definitions in the <emphasis> <property>"rule-files"</property></emphasis> tag. + </para> + + <figure> + <title>OpenOn in components.xml file</title> <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_12.png" scale="70"/> - </imageobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_2c.png"/> + </imageobject> </mediaobject> - </figure> - <note> - <title>Note:</title> - - <para>To get Code Assist available for an externally generated and imported project, - don&apos;t forget to enable Seam features and configure Seam Settings in <xref linkend="project_pref"/>.</para> - </note> - - <section id="components_code_assist" role="new"> - <title>Content Assist for components.xml</title> - - <para>While you are editing a <emphasis> - <property>components.xml</property> - </emphasis> file you can make use of the Content Assist for inserting needed - elements.</para> - - <figure> - <title>Content Assist in the component.xml Editor</title> + </figure> + + <para> + You can also use OpenOn to open jBPM components that are described in Seam component descriptor. Two places where it works are available: + </para> + + <itemizedlist> + <listitem> + <para> + inside <emphasis> <property>&lt;component&gt;</property></emphasis> definition; + </para> + + <figure> + <title>OpenOn in components.xml file</title> <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_1a.png"/> - </imageobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_2d.png"/> + </imageobject> </mediaobject> - </figure> - - <para>The editor also makes code completion aware of methods/attributes for EntityQuery - component.</para> - - <figure> - <title>Content Assist for EntityQuery Component</title> + </figure> + </listitem> + + <listitem> + <para> + inside <emphasis> <property>jbpm</property></emphasis> tags; + </para> + + <figure> + <title>OpenOn in components.xml file</title> <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_1b.png"/> - </imageobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_2e.png"/> + </imageobject> </mediaobject> - </figure> - </section> - - <section id="named_beans_code_assist" role="new"> - <title>Content assist for @Named beans</title> - - <para>To the nice code completion you can also use Content assist for all occurrences where @Named beans are used. - </para> - - <figure> - <title>Content assist for @Named beans</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_1c.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - - </section> - <section> - <title>Content Assist for Page Descriptors</title> - - <para>Content Assist ( CA ) is available for Page Descriptors, - <property>.page.xml</property> and <property>page.xml</property> files. - Content Assist lets you easily compose a Page Descriptor file by suggesting elements and attributes. The suggestions are context dependent, which means that CA provides only the elements, attributes and in some cases values for the attributes, suitable in a particular place of your Page Descriptor. - - </para> - <para> - Seam Pages Editor also supports code completion in EL-expressions suggesting you possible bean properties and methods. - </para> - </section> - <section id="OpenOn"> - <title>OpenOn</title> - - <para><property>OpenOn</property> lets you easily navigate through your project without - using the Package Explorer or Project Explorer. After pressing <emphasis> - <property>Ctrl + left click</property> - </emphasis> (or just F3) you will see a corresponding method or class.</para> - - <figure> - <title>OpenOn</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_2.png"/> - </imageobject> - </mediaobject> - </figure> - <para>OpenOn is available for the following files:</para> - <itemizedlist> + </figure> + </listitem> + </itemizedlist> + </listitem> + + <listitem id="javaFiles"> + <para> + OpenOn is also supported in seam components where <property> In annotation</property> is presented. After pressing <property>Ctrl + left click</property> on the seam component specified in <code>@In </code> you will get the possibility to open the file where the component is declarated as well as all of the seam components where it is used in the next declarations: + </para> + + <itemizedlist> <listitem> - <para> - <xref linkend="xmlFiles"/> - </para> + <para> + @Out + </para> </listitem> + <listitem> - <para> - <xref linkend="xhtmlFiles"/> - </para> + <para> + @DataModel + </para> </listitem> + <listitem> - <para> <xref linkend="javaFiles"/></para> + <para> + @Role + </para> </listitem> - </itemizedlist> - <note> - <title>Note:</title> - - <para>In this section were described only use cases special for Seam applications.For general information please read - <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf/html/e... section in Visual Web Tools Reference Guide</ulink>.</para> - </note> - <itemizedlist> - <listitem id="xhtmlFiles"> <para>Using OpenOn in .xhtml files you can open:</para> - <itemizedlist> - <listitem><para>components or properties resolved using an EL expression;</para></listitem> - <listitem><para>all actions described in pages.xml;</para></listitem> - <listitem><para>other .xhtml files that paths are specified in a current file;</para></listitem> - <listitem><para>image files that paths are set in the <emphasis> - <property>value</property></emphasis> property.The files will be opened in the default system graphical editor.</para></listitem> - </itemizedlist> + + <listitem> + <para> + @Roles + </para> </listitem> - <listitem id="xmlFiles"> - <para>OpenOn is also supported in Page Descriptors (<property>.page.xml</property> and <property>pages.xml</property>). OpenOn allows you to navigate to Java beans as well as to view pages. - You can <property>Ctrl + left click</property> on a bean or on view page file (e.g. XTML file) to navigate to the file you clicked on. </para> - - <figure> - <title>OpenOn in .page.xml file</title> + </itemizedlist> + + <figure> + <title>OpenOn in Seam Component</title> <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_2a.png"/> - </imageobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_2b.png"/> + </imageobject> </mediaobject> - </figure> - <para>If you use Rule-based authorization with Drools in your Seam application you can apply OpenOn - in <emphasis> - <property>components.xml</property></emphasis> to open the files containing rule definitions in the <emphasis> - <property>"rule-files"</property></emphasis> tag. + </figure> + </listitem> + </itemizedlist> + </section> + + <section id="SeamValidation"> + <title>Seam Validation</title> + <para> + Validation of various possible problematic definitions is implemented for Seam applications. + </para> + + <para> + If an issue is found it will be shown in the standard <property>Problems View</property>. + </para> + + <figure> + <title>Seam Validation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_6.png" scale="70"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para> + Please note, only files within source path and web content are validated, meaning temporary files or test files are not included. </para> - <figure> - <title>OpenOn in components.xml file</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_2c.png"/> - </imageobject> - </mediaobject> - </figure> - <para>You can also use OpenOn to open jBPM components that are described in Seam component descriptor. - Two places where it works are available: </para> - <itemizedlist> - <listitem><para>inside <emphasis> - <property>&lt;component&gt;</property></emphasis> definition;</para> - <figure> - <title>OpenOn in components.xml file</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_2d.png"/> - </imageobject> - </mediaobject> - </figure></listitem> - <listitem><para>inside <emphasis> - <property>jbpm</property></emphasis> tags;</para> - <figure> - <title>OpenOn in components.xml file</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_2e.png"/> - </imageobject> - </mediaobject> - </figure></listitem> - </itemizedlist> - </listitem> - <listitem id="javaFiles"> - <para> - OpenOn is also supported in seam components where <property> In annotation</property> is presented. - After pressing <property>Ctrl + left click</property> on the seam component specified in <code>@In </code> you will get the possibility to open the file where the component is declarated as well as - all of the seam components where it is used in the next declarations:</para> - <itemizedlist> - <listitem><para>@Out</para></listitem> - <listitem><para>@DataModel</para></listitem> - <listitem><para>@Role</para></listitem> - <listitem><para>@Roles</para></listitem> - </itemizedlist> + </note> - <figure> - <title>OpenOn in Seam Component</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_2b.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - </section> - - <section id="SeamValidation"> - <title>Seam Validation</title> - - <para>Validation of various possible problematic definitions is implemented for Seam - applications.</para> - - <para>If an issue is found it will be shown in the standard <property>Problems - View</property>.</para> - - <figure> - <title>Seam Validation</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_6.png" scale="70"/> - </imageobject> - </mediaobject> - </figure> - - <note> - <title>Note:</title> - <para>Please note, only files within source path and web content are validated, meaning temporary files or test files are not included.</para> - </note> - - <para>In the preferences page for Seam Validator you can see and modify the validator - behavior. Go to <emphasis> - <property>Window > Preferences > JBoss Tools > Web > Seam > Validator</property> - </emphasis> and select the severity level for the optional Seam Validator - problem.</para> - - <figure> - <title>Seam Validator Preferences</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_3.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>On WTP projects validation are enabled by default and thus executed automatically, but - on normal Java projects you will have to go and add the Validation builder of your - project . It is available in the properties of your project under - <emphasis><property>Validation</property>.</emphasis></para> - - <figure> - <title>Enabling the Validation Builder</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/validator1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The validations can be run manually by clicking - <emphasis><property>Validate</property></emphasis> via the context menu on your project (folder or file inside your project) which will - execute all the active WTP validations. Following to the project&apos;s preferences under <emphasis> - <property>Validation</property></emphasis> it&apos;s possible to enable/disable any validator. - </para> - - <para>It&apos;s also possible to turn off the validation for some resource (a file, folder) inside your project via the <emphasis> - <property>Exclude Validation</property></emphasis> context menu option.</para> - - <figure> - <title>Excluding Validation for the WebContent Folder</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/validator2.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>As a result, if you&apos;ve turned off the validation for a folder (or file), it is put to the excluded group of the Validation filters and be ignored during the validation.</para> - - <figure> - <title>Validation Filters</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/validator3.png"/> - </imageobject> - </mediaobject> - </figure> + <para> + In the preferences page for Seam Validator you can see and modify the validator behavior. Go to <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>JBoss Tools</guimenuitem><guimenuitem>Web</guimenuitem><guimenuitem>Seam</guimenuitem><guimenuitem>Validator</guimenuitem></menuchoice> and select the severity level for the optional Seam Validator problem. + </para> + + <figure> + <title>Seam Validator Preferences</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_3.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + On WTP projects validation are enabled by default and thus executed automatically, but on normal Java projects you will have to go and add the Validation builder of your project . It is available in the properties of your project under <emphasis><property>Validation</property>.</emphasis> + </para> + + <figure> + <title>Enabling the Validation Builder</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/validator1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + The validations can be run manually by clicking <emphasis><property>Validate</property></emphasis> via the context menu on your project (folder or file inside your project) which will execute all the active WTP validations. Following to the project&apos;s preferences under <emphasis> <property>Validation</property></emphasis> it&apos;s possible to enable/disable any validator. + </para> + + <para> + It&apos;s also possible to turn off the validation for some resource (a file, folder) inside your project via the <emphasis> <property>Exclude Validation</property></emphasis> context menu option. + </para> + + <figure> + <title>Excluding Validation for the WebContent Folder</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/validator2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + As a result, if you&apos;ve turned off the validation for a folder (or file), it is put to the excluded group of the Validation filters and be ignored during the validation. + </para> + + <figure> + <title>Validation Filters</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/validator3.png"/> + </imageobject> + </mediaobject> + </figure> </section> - -</section> -</chapter> \ No newline at end of file + </section> +</chapter> Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_faq.xml =================================================================== --- branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_faq.xml 2011-07-18 02:37:17 UTC (rev 32983) +++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_faq.xml 2011-07-18 02:42:15 UTC (rev 32984) @@ -1,73 +1,60 @@ -<?xml version='1.0' encoding='UTF-8'?> -<chapter id="seam_faq"> - <?dbhtml filename="vwt_faq.html"?> - <title>FAQ</title> - - <section id="seam_question_1"> - <title>How to get Code Assist for Seam specific resources in an externally generated - project?</title> - - <para>To get Code Assist for Seam specific resources in an externally generated project, you - should enable Seam features in Project Preferences. Right click an imported project and - navigate <emphasis> - <property>Properties > Seam Settings</property>.</emphasis> Check <emphasis> - <property>Seam support</property> - </emphasis> box to enable all available <xref linkend="project_pref"/>.</para> - </section> - - <section id="seam_question_2"> - <title>How to import an example Seam project from jboss-eap directory?</title> - - <para>To import an example Seam project from <emphasis> - <property>jboss-eap</property> - </emphasis> into your working directory, you should perform the following steps:</para> - - <itemizedlist> - <listitem> - <para>Go to <emphasis> - <property>New > Other > Java Project from Existing Buildfile</property> - </emphasis></para> - </listitem> - - <listitem> - <para>Point to the <emphasis> - <property>build.xml</property> - </emphasis> of any chosen project by pressing <emphasis> - <property>Browse</property> - </emphasis> button</para> - </listitem> - - <listitem> - <para>Hit <emphasis> - <property>Finish</property> - </emphasis> to open the project</para> - </listitem> - </itemizedlist> - - <para>As these seam examples are non WTP projects, next you should enable Seam support for - them. To do that, right click the project and go to <emphasis> - <property>Properties > Seam Settings</property>.</emphasis></para> - </section> - - <section id="seam_question_3"> - <title>How to change the deploy folders for Seam source code from src/hot and src/main?</title> - - <para>You should right-click the project, select <emphasis> - <property>Properties &gt; Java Build Path</property>,</emphasis> then switch to the <emphasis> - <property>Source tab</property>,</emphasis> select the output folder for <emphasis> - <property>src/hot</property></emphasis> (<emphasis> - <property>src/main</property>)</emphasis> and click <emphasis> - <property>Edit</property></emphasis> to change their output location.</para> - - <para>In conclusion, the main goal of this document is to get you know with a full featureset - that <property>JBoss Tools</property> provides to support Seam development. Thus if you have - some questions, comments or suggestions on the topic, please fell free to ask in the <ulink - url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... - Tools Forum</ulink>. You can also influence on how you want to see JBoss Tools docs in - future leaving your vote on the article <ulink - url="http://wiki.jboss.org/wiki/JBossToolsDocsFuture" - >Overview of the improvements required by JBossTools/JBDS Docs users</ulink>. </para> - - <para>A set of movies on Seam tooling is available on <ulink url="http://docs.jboss.org/tools/movies">Seam movies page</ulink>.</para> - </section> -</chapter> +<?xml version='1.0' encoding='UTF-8'?> +<chapter id="seam_faq"> +<?dbhtml filename="vwt_faq.html"?> + <title>FAQ</title> + <section id="seam_question_1"> + <title>How to get Code Assist for Seam specific resources in an externally generated project?</title> + <para> + To get Code Assist for Seam specific resources in an externally generated project, you should enable Seam features in Project Preferences. Right click an imported project and navigate <menuchoice><guimenuitem>Properties</guimenuitem><guimenuitem>Seam Settings.</guimenuitem></menuchoice> Check <emphasis> <property>Seam support</property> </emphasis> box to enable all available <xref linkend="project_pref"/>. + </para> + </section> + + <section id="seam_question_2"> + <title>How to import an example Seam project from jboss-eap directory?</title> + <para> + To import an example Seam project from <emphasis> <property>jboss-eap</property> </emphasis> into your working directory, you should perform the following steps: + </para> + + <itemizedlist> + <listitem> + <para> + Go to <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Java Project from Existing Buildfile</guimenuitem></menuchoice> + </para> + </listitem> + + <listitem> + <para> + Point to the <emphasis> <property>build.xml</property> </emphasis> of any chosen project by pressing <emphasis> <property>Browse</property> </emphasis> button + </para> + </listitem> + + <listitem> + <para> + Hit <emphasis> <property>Finish</property> </emphasis> to open the project + </para> + </listitem> + </itemizedlist> + + <para> + As these seam examples are non WTP projects, next you should enable Seam support for them. To do that, right click the project and go to <menuchoice><guimenuitem>Properties</guimenuitem><guimenuitem>Seam Settings.</guimenuitem></menuchoice> + </para> + </section> + + <section id="seam_question_3"> + <title>How to change the deploy folders for Seam source code from src/hot and src/main?</title> + <para> + You should right-click the project, select <menuchoice><guimenuitem>Properties</guimenuitem><guimenuitem>Java Build Path,</guimenuitem></menuchoice> then switch to the <emphasis> <property>Source tab</property>,</emphasis> select the output folder for <emphasis> <property>src/hot</property></emphasis> (<emphasis> <property>src/main</property>)</emphasis> and click <emphasis> <property>Edit</property></emphasis> to change their output location. + </para> + + <para> + In conclusion, the main goal of this document is to get you know with a full feature set that <property>JBoss Tools</property> provides to support Seam development. Thus if you have some questions, comments or suggestions on the topic, please fell free to ask in the <ulink + url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... Tools Forum</ulink>. You can also influence on how you want to see JBoss Tools docs in future leaving your vote on the article <ulink + url="http://wiki.jboss.org/wiki/JBossToolsDocsFuture" + >Overview of the improvements required by JBossTools/JBDS Docs users</ulink>. + </para> + + <para> + A set of movies on Seam tooling is available on <ulink url="http://docs.jboss.org/tools/movies">Seam movies page</ulink>. + </para> + </section> +</chapter> Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_menus_and_actions.xml =================================================================== --- branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_menus_and_actions.xml 2011-07-18 02:37:17 UTC (rev 32983) +++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_menus_and_actions.xml 2011-07-18 02:42:15 UTC (rev 32984) @@ -1,361 +1,363 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="menus_and_actions"> - <?dbhtml filename="seam_menus_and_actions.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Seam</keyword> - <keyword>JBDS</keyword> - <keyword>menus</keyword> - <keyword>actions</keyword> - </keywordset> - </chapterinfo> - - <title>Seam Menus and Actions</title> - - <para>In this chapter we provide a description of Seam actions that are available from</para> - <itemizedlist> - <listitem> - <para>Menu bar</para> - </listitem> - <listitem> - <para>Toolbar</para> - </listitem> - <listitem> - <para>Context menus in views</para> - </listitem> - </itemizedlist> - - - <section id="file_menu"> - - <title>File Menu Actions</title> - - <para>In a Seam perspective, by default there are the following actions in <emphasis> - <property>File > New</property> - </emphasis> submenu</para> - - <table> - <title>Seam Actions in the New Submenu</title> - <tgroup cols="2"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" colwidth="4*"/> - - <thead> - <row> - <entry align="center"> - <para>Name</para> - </entry> - - <entry align="center"> - <para>Function</para> - </entry> - - </row> - </thead> - - <tbody> - - - <row> - <entry> - <para> - <property>Seam Web Project</property> - </para> - - </entry> - - <entry> - <para>Runs <xref linkend="standaloneSeam"/> wizard - for creating a new Seam project </para> - </entry> - - - </row> - - - <row> - <entry> - <para> - <property>Seam Action</property> - </para> - - </entry> - - <entry> - <para>Runs <xref linkend="seam_action"/> wizard for - creating a new Seam action </para> - </entry> - - - </row> - - - - <row> - <entry> - <para> - <property>Seam Form</property> - </para> - - </entry> - - <entry> - <para>Runs <xref linkend="seam_form"/> wizard for - creating a new Seam form </para> - </entry> - - - </row> - - - <row> - <entry> - <para> - <property>Seam Entity</property> - </para> - - </entry> - - <entry> - <para>Runs <xref linkend="seam_entity"/> wizard for - creating a new Seam entity </para> - </entry> - - - </row> - - <row> - <entry> - <para> - <property>Seam Conversation</property> - </para> - - </entry> - - <entry> - <para>Runs <xref linkend="seam_conversation"/> wizard for creating a new Seam conversation - </para> - </entry> - - - - </row> - - <row> - <entry> - <para> - <property>Seam Generate Entities</property> - </para> - - </entry> - - <entry> - <para>Runs <xref linkend="generate_entities"/> wizard</para> - </entry> - - - - </row> - - - </tbody> - </tgroup> - </table> - - - </section> - - <section id="navigate_menu"> - <title>Navigate Menu Actions</title> - - <para>In the next sections we are going to describe Seam actions which can help you to - easily navigate through the source code.</para> - - <section id="find_seam_ref_decl"> - - <title>Find Seam References/Declarations</title> - - <para>To find EL expressions both in <emphasis> - <property>.java</property> - </emphasis> and <emphasis> - <property>.xhtml</property> - </emphasis> files use Find Seam References/Declarations actions. For that, in the main menu bar click on <emphasis> - <property>Search > Find Seam References</property> - </emphasis> or <emphasis><property>Find Seam Declarations</property>.</emphasis> - </para> - - <para>Look at the description of the actions in the table below.</para> - - <table> - <title>Find Seam References/Declarations actions</title> - <tgroup cols="3"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" colwidth="4*"/> - <colspec colnum="3" colwidth="2*"/> - - - <thead> - <row> - <entry align="center"> - <para>Name</para> - </entry> - - <entry align="center"> - <para>Function</para> - </entry> - - <entry align="center"> - <para>Keyboard Shortcut</para> - </entry> - </row> - </thead> - - <tbody> - - - <row> - <entry> - <para> - <property>Find Seam References</property> - </para> - <para> - <property>Find Seam Declarations</property> - </para> - </entry> - - <entry> - <para>Find all references and declarations to the selected element. - It's available for EL expressions in both .java and .xhtml - files. Differs from normal Eclipse Find References/Declarations - by showing an EL or Seam references in the Search View. </para> - </entry> - - <entry> - <para>Ctrl+G</para> - <para>Ctrl+Shift+G</para> - <para>also Ctrl + 1 for .java files</para> - - </entry> - - </row> - </tbody> - </tgroup> - </table> - - - <para>On the screenshot example below you could see that the search results are listed - in the - <property>Search view</property>. - </para> - - <figure> - <title>Find Seam Declaration for &quot;Identity&quot;</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_menus_and_actions/menus_and_actions1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>You can also use Ctrl + 1 in .java files to activate the actions:</para> - - <figure> - <title>Find Seam References for &quot;Identity&quot;</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_menus_and_actions/menus_and_actions2.png"/> - </imageobject> - </mediaobject> - </figure> - - </section> - - <section id="open_seam_component"> - <title>Open Seam Component</title> - - <para>To open Seam Components click on <emphasis><property>Navigate > Open Seam - Component</property></emphasis> in the main menu bar. This dialog is also available from toolbar - icon or with hot keys combination "Ctrl+Shift+Z ".</para> - - <figure> - <title>Open Seam Components icon</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_menus_and_actions/menus_and_actions3_0.png" - /> - </imageobject> - </mediaobject> - </figure> - - <para>In the table below read a description about the dialog.</para> - - <table> - <title>Open Seam Components Dialog</title> - <tgroup cols="3"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" colwidth="4*"/> - <colspec colnum="3" colwidth="2*"/> - - - <thead> - <row> - <entry align="center"> - <para>Name</para> - </entry> - - <entry align="center"> - <para>Function</para> - </entry> - - <entry align="center"> - <para>Keyboard Shortcut</para> - </entry> - </row> - </thead> - - <tbody> - - - <row> - <entry> - <para> - <property>Open Seam Components</property> - </para> - - </entry> - - <entry> - <para>Brings up the Open Seam Component dialog to open a component - in the editor. The Open Seam Component selection dialog shows - all Seam components existing in the workspace. You can search - the components via their short, imported or full name.</para> - </entry> - - <entry> - <para>Ctrl+Shift+Z</para> - - </entry> - - </row> - </tbody> - </tgroup> - </table> - - <para>Enter a name in the text field and see the results as it shown on screenshot: </para> - - <figure> - <title>Open Seam Components Dialog</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_menus_and_actions/menus_and_actions3.png"/> - </imageobject> - </mediaobject> - </figure> - <para>You can also open Seam Component from the other component where the required one is declared in <code>@In </code> by using - <xref linkend="OpenOn"/> (<property>Ctrl + left click</property> and select <property>Open Declaration of Seam Component for seam_component in Seam_class.java</property> ).</para> - </section> - - </section> - -</chapter> +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="menus_and_actions"> +<?dbhtml filename="seam_menus_and_actions.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + + <keyword>Seam</keyword> + + <keyword>JBDS</keyword> + + <keyword>menus</keyword> + + <keyword>actions</keyword> + </keywordset> + </chapterinfo> + <title>Seam Menus and Actions</title> + <para> + In this chapter we provide a description of Seam actions that are available from + </para> + + <itemizedlist> + <listitem> + <para> + Menu bar + </para> + </listitem> + + <listitem> + <para> + Toolbar + </para> + </listitem> + + <listitem> + <para> + Context menus in views + </para> + </listitem> + </itemizedlist> + + <section id="file_menu"> + <title>File Menu Actions</title> + <para> + In a Seam perspective, by default there are the following actions in <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem></menuchoice> submenu + </para> + + <table> + <title>Seam Actions in the New Submenu</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="1*"/> + + <colspec colnum="2" colwidth="4*"/> + + <thead> + <row> + <entry align="center"> + <para> + Name + </para> + </entry> + + <entry align="center"> + <para> + Function + </para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para> + <property>Seam Web Project</property> + </para> + </entry> + + <entry> + <para> + Runs <xref linkend="standaloneSeam"/> wizard for creating a new Seam project + </para> + </entry> + </row> + + <row> + <entry> + <para> + <property>Seam Action</property> + </para> + </entry> + + <entry> + <para> + Runs <xref linkend="seam_action"/> wizard for creating a new Seam action + </para> + </entry> + </row> + + <row> + <entry> + <para> + <property>Seam Form</property> + </para> + </entry> + + <entry> + <para> + Runs <xref linkend="seam_form"/> wizard for creating a new Seam form + </para> + </entry> + </row> + + <row> + <entry> + <para> + <property>Seam Entity</property> + </para> + </entry> + + <entry> + <para> + Runs <xref linkend="seam_entity"/> wizard for creating a new Seam entity + </para> + </entry> + </row> + + <row> + <entry> + <para> + <property>Seam Conversation</property> + </para> + </entry> + + <entry> + <para> + Runs <xref linkend="seam_conversation"/> wizard for creating a new Seam conversation + </para> + </entry> + </row> + + <row> + <entry> + <para> + <property>Seam Generate Entities</property> + </para> + </entry> + + <entry> + <para> + Runs <xref linkend="generate_entities"/> wizard + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="navigate_menu"> + <title>Navigate Menu Actions</title> + <para> + In the next sections we are going to describe Seam actions which can help you to easily navigate through the source code. + </para> + + <section id="find_seam_ref_decl"> + <title>Find Seam References/Declarations</title> + <para> + To find EL expressions both in <emphasis> <property>.java</property> </emphasis> and <emphasis> <property>.xhtml</property> </emphasis> files use Find Seam References/Declarations actions. For that, in the main menu bar click on <menuchoice><guimenuitem>Search</guimenuitem><guimenuitem>Find Seam References</guimenuitem></menuchoice> or <emphasis><property>Find Seam Declarations</property>.</emphasis> + </para> + + <para> + Look at the description of the actions in the table below. + </para> + + <table> + <title>Find Seam References/Declarations actions</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + + <colspec colnum="2" colwidth="4*"/> + + <colspec colnum="3" colwidth="2*"/> + + <thead> + <row> + <entry align="center"> + <para> + Name + </para> + </entry> + + <entry align="center"> + <para> + Function + </para> + </entry> + + <entry align="center"> + <para> + Keyboard Shortcut + </para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para> + <property>Find Seam References</property> + </para> + + <para> + <property>Find Seam Declarations</property> + </para> + </entry> + + <entry> + <para> + Find all references and declarations to the selected element. It's available for EL expressions in both .java and .xhtml files. Differs from normal Eclipse Find References/Declarations by showing an EL or Seam references in the Search View. + </para> + </entry> + + <entry> + <para> + Ctrl+G + </para> + + <para> + Ctrl+Shift+G + </para> + + <para> + also Ctrl + 1 for .java files + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + On the screenshot example below you could see that the search results are listed in the <property>Search view</property>. + </para> + + <figure> + <title>Find Seam Declaration for &quot;Identity&quot;</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_menus_and_actions/menus_and_actions1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + You can also use Ctrl + 1 in .java files to activate the actions: + </para> + + <figure> + <title>Find Seam References for &quot;Identity&quot;</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_menus_and_actions/menus_and_actions2.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="open_seam_component"> + <title>Open Seam Component</title> + <para> + To open Seam Components click on <menuchoice><guimenuitem>Navigate</guimenuitem><guimenuitem>Open Seam Component</guimenuitem></menuchoice> in the main menu bar. This dialog is also available from toolbar icon or with hot keys combination "Ctrl+Shift+Z ". + </para> + + <figure> + <title>Open Seam Components icon</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_menus_and_actions/menus_and_actions3_0.png" + /> + </imageobject> + </mediaobject> + </figure> + + <para> + In the table below read a description about the dialog. + </para> + + <table> + <title>Open Seam Components Dialog</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + + <colspec colnum="2" colwidth="4*"/> + + <colspec colnum="3" colwidth="2*"/> + + <thead> + <row> + <entry align="center"> + <para> + Name + </para> + </entry> + + <entry align="center"> + <para> + Function + </para> + </entry> + + <entry align="center"> + <para> + Keyboard Shortcut + </para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para> + <property>Open Seam Components</property> + </para> + </entry> + + <entry> + <para> + Brings up the Open Seam Component dialog to open a component in the editor. The Open Seam Component selection dialog shows all Seam components existing in the workspace. You can search the components via their short, imported or full name. + </para> + </entry> + + <entry> + <para> + Ctrl+Shift+Z + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + Enter a name in the text field and see the results as it shown on screenshot: + </para> + + <figure> + <title>Open Seam Components Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_menus_and_actions/menus_and_actions3.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + You can also open Seam Component from the other component where the required one is declared in <code>@In </code> by using <xref linkend="OpenOn"/> (<property>Ctrl + left click</property> and select <property>Open Declaration of Seam Component for seam_component in Seam_class.java</property> ). + </para> + </section> + </section> +</chapter> Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_preferences.xml =================================================================== --- branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_preferences.xml 2011-07-18 02:37:17 UTC (rev 32983) +++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_preferences.xml 2011-07-18 02:42:15 UTC (rev 32984) @@ -1,237 +1,250 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="seam_preferences"> - <!-- mark as new --> - <?dbhtml filename="seam_preferences.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Seam</keyword> - <keyword>Preferences</keyword> - </keywordset> - </chapterinfo> - - <title>Seam Preferences</title> - - <para>In this chapter you get to know how Seam preferences can be modified during the - development process.</para> - - <section id="gen_pref"> - <title>General Preferences</title> - - <para>Seam preferences can be set using the Seam preference page. Click on - <emphasis><property>Window > Preferences > JBoss Tools > Web > - Seam</property>.</emphasis></para> - - <para>On this page you can manage the Seam Runtime. Use the appropriate buttons to - <property>Add</property> more runtimes or to <property>Remove</property> those that - are not needed.</para> - - <figure> - <title>Seam Preferences Page</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_preferences/seam_preferences1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Clicking on <property>Edit</property> button you get the form where you can change the - path of Seam runtime home folder, modify name and version. Press - <property>Finish</property> to apply the changes.</para> - - <figure> - <title>Edit Seam Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_preferences/seam_preferences1_2.png"/> - </imageobject> - </mediaobject> - </figure> - <note> - <title>Tip:</title> - <para>If you try to delete the Seam Runtime that is already in use by some project in the current workspace, then a warning message will appear. To confirm the removal press <property>OK</property> - </para> - <para>Besides, when you right-click on your Seam project with deleted runtime in Project Explorer and select<property> Properties > Seam Settings</property> the error message "Runtime &lt;runtime_name&gt; does not exist" will appear. </para> - </note> - <section id="validator_pref"> - - <title>Validator Preferences</title> - - <para>Seam preference page includes a subsection <property>Validator</property>. See - <emphasis><property>Window > Preferences > JBoss Tools > Web > Seam > - Validator</property>.</emphasis></para> - <para>On this page you can choose a severity level for the various Seam validator - problems. For example, if you want to ignore the case when component name is - duplicated expand the <property>Components</property> node and select - <property>Ignore</property> next to <property>Duplicate component - name</property>. After that you won&apos;t see the error.</para> - - - <figure> - <title>Seam Validator Preference Page</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_preferences/seam_preferences1_3.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Notice, that in the <emphasis> - <property>Expression language</property> - </emphasis> section there is now a preference for setting severity of EL Syntax. You - can select whether the Seam validator displays an error, a warning or just ignore - the EL Syntax error.</para> - <note><para>There are references made between each EL and variable name, so you can revalidate a particular EL if a context variable was changed. This makes parsing of each resource with referenced ELs much faster.</para></note> - - - <figure> - <title>Severity Preference for EL Syntax</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_preferences/el_syntax_error.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The <emphasis> - <property>Revalidate unresolved ELs automatically</property></emphasis> option is enabled by default. - If necessary, you can uncheck it. It may increase a performance for big complex projects.</para> - - <para>In the upper right corner of the Seam Validator preferences page there is a <emphasis><property>Configure Project - Specific Settings</property></emphasis> link. Clicking on it you get the form where you can - choose a project for specific setting. Project specific configuration allows you to - have different validator settings for each project. Check the <emphasis><property>Show only - projects with project specific settings</property></emphasis> if you want to see the - projects that have been already set. Click on <property>Ok</property>.</para> - - <figure> - <title>Project Specific Configuration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_preferences/seam_preferences1_4.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>You get the validator properties page for chosen project. Check the - <property>Enable project specific settings</property> to be able to change the - settings.</para> - - <note> - <title>Note:</title> - <para>You can open the same page by right clicking on the needed project in Package - Explorer, then <emphasis><property>Properties > Seam - Validator</property>.</emphasis></para> - </note> - - <figure> - <title>Validator Properties Page for Chosen Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_preferences/seam_preferences1_5.png"/> - </imageobject> - </mediaobject> - </figure> - - - </section> - </section> - - <section id="project_pref"> - <title>Project Preferences</title> - - <para>Once Seam project is created you can modify its settings. Right click on Seam project - in Project Explorer and select <emphasis><property>Properties &gt; Seam - Settings</property>.</emphasis></para> - <para>This project properties page allows you to have a flexible project layout. It means - that you are not restricted with a specific project structure. You can use the Seam - wizards (New Action, Form, Entity, etc.) on Maven, command line seam-gen or your own - project structure. </para> - - <figure> - <title>Properties for Seam Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_preferences/seam_preferences2.png"/> - </imageobject> - </mediaobject> - </figure> - - <note> - <title>Tip:</title> - <para>The wizard doesn&apos;t allow the renaming of the artifacts listed in the Seam - Settings. It&apos;s possible to do in the <property>Package Explorer</property>. - See <xref linkend="renaming_projects_folders"/>.</para> - </note> - - <para>Also notice, you are not required to use the <property>New Seam Project - wizard</property> to benefit from Seam artifact wizards. You can just enable Seam on - your existing project by checking <property>Seam Support</property> and targeting to - Seam Runtime, and then configure the folders as you want.</para> - - <figure> - <title>Properties for Seam Project when Seam runtime is not selected</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_preferences/seam_preferences2_2.png"/> - </imageobject> - </mediaobject> - </figure> - - <note> - <title>Tip:</title> - <para>On the figure above fields for configuring Seam artifacts are unavailable because Seam - Runtime is not selected.</para> - </note> - - <para>In Seam Wizards (New Action, Form, Entity, Conversation, Generate Entities) you can - get a quick access to project settings using the <property>Settings</property> link in - the upper right corner of each wizard.</para> - - <figure> - <title>Quick Setting Link In Seam Wizards</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_preferences/seam_preferences2_1.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - - <section id="add_custom_capabilities"> - <title>Adding Custom Capabilities</title> - - <para><property>JBoss Tools</property> provides a possibility to add custom capabilities to any Seam project, - i.e. add a support of additional frameworks built on top of JSF, such as <itemizedlist> - <listitem><para>ADF</para></listitem> - <listitem><para>Facelets</para></listitem> - <listitem><para>JBoss Rich Faces (versions 3.1, 3.2, 3.3)</para></listitem> - </itemizedlist> - </para> - <para>To enable it, you should call the context menu for a Seam project and select <emphasis><property>JBoss - Tools &gt; Add Custom Capabilities</property>.</emphasis> Then check the needed modules and press - <emphasis><property>Finish</property>.</emphasis></para> - - <figure> - <title> Custom Capabilities be added to Seam Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_preferences/addCustomCapabilities.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The next page displays all the updates that have been made to the project.</para> - - <figure> - <title>Adding Custom Capabilities to Seam Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_preferences/addCustomCapabilities2.png"/> - </imageobject> - </mediaobject> - </figure> - - </section> - -</chapter> +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="seam_preferences"> +<!-- mark as new --> +<?dbhtml filename="seam_preferences.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + + <keyword>Seam</keyword> + + <keyword>Preferences</keyword> + </keywordset> + </chapterinfo> + <title>Seam Preferences</title> + <para> + In this chapter you get to know how Seam preferences can be modified during the development process. + </para> + + <section id="gen_pref"> + <title>General Preferences</title> + <para> + Seam preferences can be set using the Seam preference page. Click on <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>JBoss Tools</guimenuitem><guimenuitem>Web</guimenuitem><guimenuitem>Seam.</guimenuitem></menuchoice> + </para> + + <para> + On this page you can manage the Seam Runtime. Use the appropriate buttons to <property>Add</property> more runtimes or to <property>Remove</property> those that are not needed. + </para> + + <figure> + <title>Seam Preferences Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_preferences/seam_preferences1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Clicking on <property>Edit</property> button you get the form where you can change the path of Seam runtime home folder, modify name and version. Press <property>Finish</property> to apply the changes. + </para> + + <figure> + <title>Edit Seam Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_preferences/seam_preferences1_2.png"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Tip:</title> + <para> + If you try to delete the Seam Runtime that is already in use by some project in the current workspace, then a warning message will appear. To confirm the removal press <property>OK</property> + </para> + + <para> + Besides, when you right-click on your Seam project with deleted runtime in Project Explorer and select <menuchoice><guimenuitem>Properties</guimenuitem><guimenuitem>Seam Settings</guimenuitem></menuchoice> the error message "Runtime &lt;runtime_name&gt; does not exist" will appear. + </para> + </note> + + <section id="validator_pref"> + <title>Validator Preferences</title> + <para> + Seam preference page includes a subsection <property>Validator</property>. See <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>JBoss Tools</guimenuitem><guimenuitem>Web</guimenuitem><guimenuitem>Seam</guimenuitem><guimenuitem>Validator.</guimenuitem></menuchoice> + </para> + + <para> + On this page you can choose a severity level for the various Seam validator problems. For example, if you want to ignore the case when component name is duplicated expand the <property>Components</property> node and select <property>Ignore</property> next to <property>Duplicate component name</property>. After that you won&apos;t see the error. + </para> + + <figure> + <title>Seam Validator Preference Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_preferences/seam_preferences1_3.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Notice, that in the <emphasis> <property>Expression language</property> </emphasis> section there is now a preference for setting severity of EL Syntax. You can select whether the Seam validator displays an error, a warning or just ignore the EL Syntax error. + </para> + + <note> + <para> + There are references made between each EL and variable name, so you can revalidate a particular EL if a context variable was changed. This makes parsing of each resource with referenced ELs much faster. + </para> + </note> + + <figure> + <title>Severity Preference for EL Syntax</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_preferences/el_syntax_error.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + The <emphasis> <property>Revalidate unresolved ELs automatically</property></emphasis> option is enabled by default. If necessary, you can uncheck it. It may increase a performance for big complex projects. + </para> + + <para> + In the upper right corner of the Seam Validator preferences page there is a <emphasis><property>Configure Project Specific Settings</property></emphasis> link. Clicking on it you get the form where you can choose a project for specific setting. Project specific configuration allows you to have different validator settings for each project. Check the <emphasis><property>Show only projects with project specific settings</property></emphasis> if you want to see the projects that have been already set. Click on <property>Ok</property>. + </para> + + <figure> + <title>Project Specific Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_preferences/seam_preferences1_4.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + You get the validator properties page for chosen project. Check the <property>Enable project specific settings</property> to be able to change the settings. + </para> + + <note> + <title>Note:</title> + <para> + You can open the same page by right clicking on the needed project in Package Explorer, then <menuchoice><guimenuitem>Properties</guimenuitem><guimenuitem>Seam Validator.</guimenuitem></menuchoice> + </para> + </note> + + <figure> + <title>Validator Properties Page for Chosen Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_preferences/seam_preferences1_5.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + + <section id="project_pref"> + <title>Project Preferences</title> + <para> + Once Seam project is created you can modify its settings. Right click on Seam project in Project Explorer and select <menuchoice><guimenuitem>Properties</guimenuitem><guimenuitem>Seam Settings.</guimenuitem></menuchoice> + </para> + + <para> + This project properties page allows you to have a flexible project layout. It means that you are not restricted with a specific project structure. You can use the Seam wizards (New Action, Form, Entity, etc.) on Maven, command line seam-gen or your own project structure. + </para> + + <figure> + <title>Properties for Seam Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_preferences/seam_preferences2.png"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Tip:</title> + <para> + The wizard doesn&apos;t allow the renaming of the artifacts listed in the Seam Settings. It&apos;s possible to do in the <property>Package Explorer</property>. See <xref linkend="renaming_projects_folders"/>. + </para> + </note> + + <para> + Also notice, you are not required to use the <property>New Seam Project wizard</property> to benefit from Seam artifact wizards. You can just enable Seam on your existing project by checking <property>Seam Support</property> and targeting to Seam Runtime, and then configure the folders as you want. + </para> + + <figure> + <title>Properties for Seam Project when Seam runtime is not selected</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_preferences/seam_preferences2_2.png"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Tip:</title> + <para> + On the figure above fields for configuring Seam artifacts are unavailable because Seam Runtime is not selected. + </para> + </note> + + <para> + In Seam Wizards (New Action, Form, Entity, Conversation, Generate Entities) you can get a quick access to project settings using the <property>Settings</property> link in the upper right corner of each wizard. + </para> + + <figure> + <title>Quick Setting Link In Seam Wizards</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_preferences/seam_preferences2_1.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="add_custom_capabilities"> + <title>Adding Custom Capabilities</title> + <para> + <property>JBoss Tools</property> provides a possibility to add custom capabilities to any Seam project, i.e. add a support of additional frameworks built on top of JSF, such as + <itemizedlist> + <listitem> + <para> + ADF + </para> + </listitem> + + <listitem> + <para> + Facelets + </para> + </listitem> + + <listitem> + <para> + JBoss Rich Faces (versions 3.1, 3.2, 3.3) + </para> + </listitem> + </itemizedlist> + </para> + + <para> + To enable it, you should call the context menu for a Seam project and select <menuchoice><guimenuitem>JBoss Tools</guimenuitem><guimenuitem>Add Custom Capabilities.</guimenuitem></menuchoice> Then check the needed modules and press <emphasis><property>Finish</property>.</emphasis> + </para> + + <figure> + <title> Custom Capabilities be added to Seam Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_preferences/addCustomCapabilities.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + The next page displays all the updates that have been made to the project. + </para> + + <figure> + <title>Adding Custom Capabilities to Seam Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_preferences/addCustomCapabilities2.png"/> + </imageobject> + </mediaobject> + </figure> + </section> +</chapter> Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_refactoring.xml =================================================================== --- branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_refactoring.xml 2011-07-18 02:37:17 UTC (rev 32983) +++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_refactoring.xml 2011-07-18 02:42:15 UTC (rev 32984) @@ -1,231 +1,292 @@ <?xml version='1.0' encoding='UTF-8'?> <chapter id="seam_refactoring"> - <?dbhtml filename="seam_refactoring.html"?> - <chapterinfo> - <keywordset> - <keyword>Seam refactoring tools - </keyword> - <keyword>seam</keyword> - <keyword>rename</keyword> - </keywordset> - </chapterinfo> - <title>Seam Refactoring Tools</title> - <para>The goal of Seam components refactoring is to make system-wide code changes without affecting the behavior of the program. - The Seam module of <property>JBoss Tools</property> provides assistance in easily code refactoring.</para> - - <para>Starting from Jboss Tools M4 refactoring functionality became also available for managed beans, method and properties used in ELs. - Thus now Seam refactoring tools include the next refactoring operations:</para> - - <itemizedlist> - <listitem><para><xref linkend="renaming_seam_components"/></para></listitem> - <listitem><para><xref linkend="renaming_seam_context_vars"/></para></listitem> - </itemizedlist> - - <para>Refactoring commands are available from the context menus of several views and editors and use a standard Eclipse refactoring wizard. - For details, see <xref linkend="RefactornigWizard"/> later in this chapter.</para> - - <note> - <title>Note:</title> - <para>Seam refactoring could be only performed in the file that is not marked as <emphasis><property>Read only</property></emphasis> in its properties.</para> - </note> - - <figure> - <title>Properties View for Java File</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_refactoring/seam_refactor10.png"/> - </imageobject> - </mediaobject> - </figure> - - <section id="RefactornigWizard"> - <title>Using the Refactorinig Wizard</title> - <para>This wizard is opened always when the user clicks the <emphasis><property>Rename Seam Component</property>,</emphasis> - <emphasis><property>Rename Seam Context Variable</property></emphasis> - or <emphasis><property>Rename</property></emphasis> command in any of the views/editors mentioned later in this chapter. - </para> - - <figure> - <title>Refactoring Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_refactoring/seam_refactor2.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>In the <property>Seam Components name</property> field you should enter a new name of the component, - then click <property>Next</property> and follow the next wizard steps: +<?dbhtml filename="seam_refactoring.html"?> + <chapterinfo> + <keywordset> + <keyword>Seam refactoring tools</keyword> + + <keyword>seam</keyword> + + <keyword>rename</keyword> + </keywordset> + </chapterinfo> + <title>Seam Refactoring Tools</title> + <para> + The goal of Seam components refactoring is to make system-wide code changes without affecting the behavior of the program. The Seam module of <property>JBoss Tools</property> provides assistance in easily code refactoring. + </para> + + <para> + Starting from Jboss Tools M4 refactoring functionality became also available for managed beans, method and properties used in ELs. Thus now Seam refactoring tools include the next refactoring operations: + </para> + + <itemizedlist> + <listitem> + <para> + <xref linkend="renaming_seam_components"/> + </para> + </listitem> + + <listitem> + <para> + <xref linkend="renaming_seam_context_vars"/> + </para> + </listitem> + </itemizedlist> + + <para> + Refactoring commands are available from the context menus of several views and editors and use a standard Eclipse refactoring wizard. For details, see <xref linkend="RefactornigWizard"/> later in this chapter. + </para> + + <note> + <title>Note:</title> + <para> + Seam refactoring could be only performed in the file that is not marked as <emphasis><property>Read only</property></emphasis> in its properties. + </para> + </note> + + <figure> + <title>Properties View for Java File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_refactoring/seam_refactor10.png"/> + </imageobject> + </mediaobject> + </figure> + + <section id="RefactornigWizard"> + <title>Using the Refactorinig Wizard</title> + <para> + This wizard is opened always when the user clicks the <emphasis><property>Rename Seam Component</property>,</emphasis> <emphasis><property>Rename Seam Context Variable</property></emphasis> or <emphasis><property>Rename</property></emphasis> command in any of the views/editors mentioned later in this chapter. + </para> + + <figure> + <title>Refactoring Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_refactoring/seam_refactor2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + In the <property>Seam Components name</property> field you should enter a new name of the component, then click <property>Next</property> and follow the next wizard steps: + </para> + + <figure> + <title>Navigating Between the Differences</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_refactoring/seam_refactor3.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + As you see, when performing a refactoring operation, you can preview all of the changes resulting from a refactoring action before you choose to carry them out. + </para> + + <para> + The view represents two windows: one with the original source code and the other with refactored one. + </para> + + <para> + With the help of + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/seam_refactoring/butt1.png"/> + </imageobject> + </inlinemediaobject> + , + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/seam_refactoring/butt2.png"/> + </imageobject> + </inlinemediaobject> + , + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/seam_refactoring/butt3.png"/> + </imageobject> + </inlinemediaobject> + , + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/seam_refactoring/butt4.png"/> + </imageobject> + </inlinemediaobject> + buttons you can quickly navigate between the differences in the code. If you don&apos;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/seam_refactoring/seam_refactor4.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + To apply the changes click <emphasis><property>Finish</property>.</emphasis> + </para> + + <para> + Renaming the selected seam component corrects all references to the component (also in other files in the project). Renaming a type doesn&apos;t allow to rename similarly named variables and methods. + </para> + </section> + + <section id="renaming_seam_components"> + <title>Renaming Seam Components</title> + <para> + Renaming a Seam component could be performed in the: + </para> + + <itemizedlist> + <listitem> + <para> + <xref linkend="JavaEditor"/> </para> - - <figure> - <title>Navigating Between the Differences</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_refactoring/seam_refactor3.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>As you see, when performing a refactoring operation, you can preview all of the changes resulting from a refactoring - action before you choose to carry them out.</para> - - <para>The view represents two windows: one with the original source code and the other with refactored one.</para> - - <para>With the help of - <inlinemediaobject> <imageobject> - <imagedata fileref="images/seam_refactoring/butt1.png"/> - </imageobject></inlinemediaobject>, - <inlinemediaobject> <imageobject> - <imagedata fileref="images/seam_refactoring/butt2.png"/> - </imageobject></inlinemediaobject>, - <inlinemediaobject> <imageobject> - <imagedata fileref="images/seam_refactoring/butt3.png"/> - </imageobject></inlinemediaobject>, - <inlinemediaobject> <imageobject> - <imagedata fileref="images/seam_refactoring/butt4.png"/> - </imageobject></inlinemediaobject> buttons you can quickly navigate between the differences in the code. - If you don&apos;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/seam_refactoring/seam_refactor4.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>To apply the changes click <emphasis><property>Finish</property>.</emphasis></para> - - <para>Renaming the selected seam component corrects all references to the - component (also in other files in the project). Renaming a type doesn&apos;t allow to rename - similarly named variables and methods. - </para> + </listitem> + + <listitem> + <para> + <xref linkend="SeamComponents"/> + </para> + </listitem> + + <listitem> + <para> + <xref linkend="components_xml_editor"/> + </para> + </listitem> + </itemizedlist> + + <section id="JavaEditor"> + <title>Renaming Seam Components in the Java Editor</title> + <para> + If you want to rename certain seam component using Java editor, first of all it&apos;s necessary to open it. If you don&apos;t know, where the seam component is declared, use <xref linkend="open_seam_component"/> icon. + </para> + + <para> + To rename a Seam component in the Java editor it's necessary to select the component, left click the file and then select <menuchoice><guimenuitem>Seam Refactor</guimenuitem><guimenuitem>Rename Seam Component.</guimenuitem></menuchoice> + </para> + + <figure> + <title>Opening Refactoring Wizard in Java Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_refactoring/seam_refactor1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + For details, see also the movie, <ulink url="http://docs.jboss.org/tools/movies/demos/rename_seam_components... a Seam component in the Java Editor&quot;</ulink>. + </para> </section> - - <section id="renaming_seam_components"> - <title>Renaming Seam Components</title> - - <para>Renaming a Seam component could be performed in the:</para> - - <itemizedlist> - <listitem><para><xref linkend="JavaEditor"/></para></listitem> - <listitem><para><xref linkend="SeamComponents"/></para></listitem> - <listitem><para><xref linkend="components_xml_editor"/></para></listitem> - </itemizedlist> - - <section id="JavaEditor"> - <title>Renaming Seam Components in the Java Editor</title> - <para>If you want to rename certain seam component using Java editor, first of all it&apos;s necessary to open it. - If you don&apos;t know, where the seam component is declared, use <xref linkend="open_seam_component"/> icon.</para> - <para>To rename a Seam component in the Java editor it's necessary to select the component, left click the file and then select - <emphasis><property>Seam Refactor &gt; Rename Seam Component</property>.</emphasis> - </para> - <figure> - <title>Opening Refactoring Wizard in Java Editor</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_refactoring/seam_refactor1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>For details, see also the movie, - <ulink url="http://docs.jboss.org/tools/movies/demos/rename_seam_components... a Seam component in the Java Editor&quot;</ulink>.</para> - </section> - - <section id="SeamComponents"> - <title>Renaming Seam Components in the Seam Components View</title> - <para>To open the <property>Refactoring</property> wizard in the <property>Seam Components</property> view - you should left click the component you want to open and choose <property>Rename Seam Component</property> option.</para> - - <figure> - <title>Opening Refactoring Wizard in Seam Components View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_refactoring/seam_refactor5.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>For details, see also the movie, - <ulink url="http://docs.jboss.org/tools/movies/demos/rename_seam_components... a Seam component in the Seam Components view&quot;</ulink>.</para> - </section> - - <section id="components_xml_editor"> - <title>Renaming Seam Components in the Seam Components Editor</title> - <para>When you open <literal>components.xml</literal> file using <property>JBoss Tools XML Editor</property>, open the - <property>Refactoring</property> wizard in the Tree tab by left-clicking the component in - <property>components</property> area and choosing <property>Rename</property> option.</para> - - <figure> - <title>Opening Refactoring Wizard in <emphasis><property>components.xml</property></emphasis> File</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_refactoring/seam_refactor6.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>For details, see also the movie, - <ulink url="http://docs.jboss.org/tools/movies/demos/rename_seam_components... a Seam component in the components.xml file&quot;</ulink>.</para> - </section> - - </section> - - <section id="renaming_seam_context_vars"> - <title>Renaming Seam Context Variables in EL</title> - - <para>Renaming a Seam context variables in EL could be executed in <literal>.java</literal>, <literal>.xml</literal>, <literal>.jsp</literal>, - <literal>.xhtml</literal> and <literal>.properties</literal> files in Seam projects using - the context menu command <emphasis><property>Seam Refactor &gt; Rename Seam Context Variable</property>.</emphasis></para> - - <figure> - <title>Refactoring Seam Context Variable in .properties File</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_refactoring/seam_refactor9.png"/> - </imageobject> - </mediaobject> - </figure> - - <figure> - <title>Opening Refactoring wizard in components.xml file</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_refactoring/seam_refactor7.png"/> - </imageobject> - </mediaobject> - </figure> - - <figure> - <title>Opening Refactoring wizard in .html file</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_refactoring/seam_refactor8.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>For details, see also a set of movies about renaming Seam context variables in EL in different locations:</para> - <itemizedlist> - <listitem> - <para><ulink url="http://docs.jboss.org/tools/movies/demos/rename_context_variabl... the Java editor</ulink></para> - </listitem> - <listitem> - <para><ulink url="http://docs.jboss.org/tools/movies/demos/rename_context_variabl... the JBoss Tools Properties Editor</ulink></para> - </listitem> - <listitem> - <para><ulink url="http://docs.jboss.org/tools/movies/demos/rename_context_variabl... the XML editor</ulink></para> - </listitem> - <listitem> - <para><ulink url="http://docs.jboss.org/tools/movies/demos/rename_context_variabl... the Visual Page Editor</ulink></para> - </listitem> - </itemizedlist> - </section> + + <section id="SeamComponents"> + <title>Renaming Seam Components in the Seam Components View</title> + <para> + To open the <property>Refactoring</property> wizard in the <property>Seam Components</property> view you should left click the component you want to open and choose <property>Rename Seam Component</property> option. + </para> + + <figure> + <title>Opening Refactoring Wizard in Seam Components View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_refactoring/seam_refactor5.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + For details, see also the movie, <ulink url="http://docs.jboss.org/tools/movies/demos/rename_seam_components... a Seam component in the Seam Components view&quot;</ulink>. + </para> + </section> + + <section id="components_xml_editor"> + <title>Renaming Seam Components in the Seam Components Editor</title> + <para> + When you open <literal>components.xml</literal> file using <property>JBoss Tools XML Editor</property>, open the <property>Refactoring</property> wizard in the Tree tab by left-clicking the component in <property>components</property> area and choosing <property>Rename</property> option. + </para> + + <figure> + <title>Opening Refactoring Wizard in <emphasis><property>components.xml</property></emphasis> File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_refactoring/seam_refactor6.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + For details, see also the movie, <ulink url="http://docs.jboss.org/tools/movies/demos/rename_seam_components... a Seam component in the components.xml file&quot;</ulink>. + </para> + </section> + </section> + + <section id="renaming_seam_context_vars"> + <title>Renaming Seam Context Variables in EL</title> + <para> + Renaming a Seam context variables in EL could be executed in <literal>.java</literal>, <literal>.xml</literal>, <literal>.jsp</literal>, <literal>.xhtml</literal> and <literal>.properties</literal> files in Seam projects using the context menu command <menuchoice><guimenuitem>Seam Refactor</guimenuitem><guimenuitem>Rename Seam Context Variable.</guimenuitem></menuchoice> + </para> + + <figure> + <title>Refactoring Seam Context Variable in .properties File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_refactoring/seam_refactor9.png"/> + </imageobject> + </mediaobject> + </figure> + + <figure> + <title>Opening Refactoring wizard in components.xml file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_refactoring/seam_refactor7.png"/> + </imageobject> + </mediaobject> + </figure> + + <figure> + <title>Opening Refactoring wizard in .html file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_refactoring/seam_refactor8.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + For details, see also a set of movies about renaming Seam context variables in EL in different locations: + </para> + + <itemizedlist> + <listitem> + <para> + <ulink url="http://docs.jboss.org/tools/movies/demos/rename_context_variabl... the Java editor</ulink> + </para> + </listitem> + + <listitem> + <para> + <ulink url="http://docs.jboss.org/tools/movies/demos/rename_context_variabl... the JBoss Tools Properties Editor</ulink> + </para> + </listitem> + + <listitem> + <para> + <ulink url="http://docs.jboss.org/tools/movies/demos/rename_context_variabl... the XML editor</ulink> + </para> + </listitem> + + <listitem> + <para> + <ulink url="http://docs.jboss.org/tools/movies/demos/rename_context_variabl... the Visual Page Editor</ulink> + </para> + </listitem> + </itemizedlist> + </section> </chapter> - - Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_view.xml =================================================================== --- branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_view.xml 2011-07-18 02:37:17 UTC (rev 32983) +++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_view.xml 2011-07-18 02:42:15 UTC (rev 32984) @@ -29,7 +29,7 @@ <para>The Seam Components View can show a components default scope in two ways:</para> <itemizedlist> - <listitem><para>as labels on each component (click on the triangular symbol at the top of the Seam Components View page and select <emphasis><property>Scope Presentation &gt; Label</property></emphasis>)</para></listitem> + <listitem><para>as labels on each component (click on the triangular symbol at the top of the Seam Components View page and select <menuchoice><guimenuitem>Scope Presentation</guimenuitem><guimenuitem>Label</guimenuitem></menuchoice>)</para></listitem> </itemizedlist> <figure> Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_wizards.xml =================================================================== --- branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_wizards.xml 2011-07-18 02:37:17 UTC (rev 32983) +++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/seam_wizards.xml 2011-07-18 02:42:15 UTC (rev 32984) @@ -1,341 +1,370 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="seam_wizards"> - <?dbhtml filename="seam_wizards.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Seam</keyword> - <keyword>JBDS</keyword> - </keywordset> - </chapterinfo> - - <title>Seam Wizards</title> - - <para>This chapter introduces you with Seam Components.</para> - <para>All the Seam component generations options known from Seam-gen are available as wizards - (with sensible auto-defaulting) for creating various common Seam components:</para> - - <itemizedlist> - <listitem> - <para> - <property>Seam Action</property> - </para> - </listitem> - <listitem> - <para> - <property>Seam Form</property> - </para> - </listitem> - <listitem> - <para> - <property>Seam Entity</property> - </para> - </listitem> - <listitem> - <para> - <property>Seam Conversation</property> - </para> - </listitem> - </itemizedlist> - - <para>Go to <emphasis> - <property>File > New</property> - </emphasis> and select the component wizard.</para> - - <figure> - <title>Seam Component Wizards</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_wizards/seam_wizards_1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The wizards create multiple resources and place it in the appropriate folders depending on - your project structure (WAR or EAR).</para> - <para>Let&apos;s create a WAR project using the New Seam Project wizard.</para> - - <figure> - <title>Seam Project WAR Deployment</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_wizards/seam_wizards_2.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>After the project is created you need deploy it on server.</para> - - - <section id="seam_action"> - - <title>New Seam Action</title> - - <para>In this and following sections you can see example creating Seam Components.</para> - <para>To create a New Seam Action you should select a necessary project, type a name for - <property>Seam component</property>, <property>POJO class</property>, - <property>Method</property>, <property>Page</property> and select a - <property>Package</property> using the <emphasis> - <property>Browse</property> - </emphasis> button.</para> - - <figure> - <title>New Seam Action Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_wizards/seam_wizards_4.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>If you specify a class which already exists, the wizard will warn you about it.</para> - - <figure> - <title>Wizard Warning against Existing File</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_wizards/action_warning.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>You can see the action page in <property>WebContent</property> folder. Click on it to - open in JBoss Tools HTML Editor.</para> - - <figure> - <title>Action Page in JBoss Tools HTML Editor.</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_wizards/seam_wizards_5.png" scale="70"/> - </imageobject> - </mediaobject> - </figure> - - - <note> - <title>Note:</title> - <para>You don't need to restart the server to see how the action component works. Just - use context menu <emphasis><property>Run As > Run On - Server</property>.</emphasis></para> - </note> - - <para>Action component was hot-deployed. Forms and Conversations will work the same - way.</para> - - <figure> - <title>Action Component</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_wizards/seam_wizards_6.png"/> - </imageobject> - </mediaobject> - </figure> - - - - </section> - <section id="seam_form"> - <title>New Seam Form</title> - - <para>Click on <property>actionMethod</property> in the internal browser and add a form in - your project using the New Seam Form wizard <emphasis><property>File > New > Seam - Form</property>.</emphasis></para> - <para>Select a necessary project, type a name for <property>Seam component</property>, - <property>POJO class</property>, <property>Method</property>, - <property>Page</property> and select a <property>Package</property> using <emphasis> - <property>Browse</property> - </emphasis> button.</para> - - <figure> - <title>New Seam Form Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_wizards/seam_wizards_7.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>If you specify a class which already exists, the wizard will warn you about it.</para> - - <figure> - <title>Wizard Warning against Existing File</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_wizards/form_warning.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The Form Page was created in <property>WebContent</property> folder.</para> - - <figure> - <title>Form Page in JBoss Tools HTML Editor.</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_wizards/seam_wizards_8.png" scale="70"/> - </imageobject> - </mediaobject> - </figure> - - <para>Deploy the form on server. Right click on Form Page, select <emphasis><property>Run As - > Run On Server</property>.</emphasis></para> - - <figure> - <title>Form Component</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_wizards/seam_wizards_9.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Form component was hot-deployed.</para> - - </section> - - <section id="seam_conversation"> - <title>New Seam Conversation</title> - - <para>Enter some value in the text field (e.g. <property>value1</property>) and click on - <property>formMethod</property>.</para> - <para>Add a conversation using the New Seam Conversation wizard <emphasis><property>File > - New > Seam Form</property>.</emphasis></para> - <para>You should select a necessary project, type a name for <property>Seam - component</property>, <property>POJO class</property>, <property>Method</property>, - <property>Page</property> and select a <property>Package</property> using <emphasis> - <property>Browse</property> - </emphasis> button.</para> - - - <figure> - <title>New Seam Conversation Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_wizards/seam_wizards_10.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>If you specify a class which already exists, the wizard will warn you about it.</para> - - <figure> - <title>Wizard Warning against Existing File</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_wizards/conversation_warning.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Conversation page was created in <property>WebContent</property> folder.</para> - - <figure> - <title>Conversation Page in JBoss Tools HTML Editor.</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_wizards/seam_wizards_11.png" scale="70"/> - </imageobject> - </mediaobject> - </figure> - - <para>Right click on Conversation page, select <emphasis><property>Run As > Run On - Server</property>.</emphasis></para> - - <figure> - <title>Conversation Component</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_wizards/seam_wizards_12.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Conversation component was hot-deployed.</para> - <para>Click on <property>Begin</property> and <property>Increment</property> buttons to - check the conversation functionality.</para> - - </section> - - - <section id="seam_entity"> - <title>New Seam Entity</title> - - <para>Entities cannot be hot-deployed, so we need to stop the server.</para> - <para>Create an Entity using the New Entity wizard <emphasis><property>File > New > Seam - Entity</property>.</emphasis> - </para> - - <para>You should select a necessary project, type a name for <property>Entity - class</property>, select a <property>Package</property> using <emphasis> - <property>Browse</property> - </emphasis> button, type a name for <property>Master Page</property> and - <property>Page</property>.</para> - - <figure> - <title>New Seam Entity Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_wizards/seam_wizards_13.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>If you specify a class which already exists, the wizard will warn you about it.</para> - - <figure> - <title>Wizard Warning against Existing File</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_wizards/entity_warning.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The Master Page and the Entity were created in <property>WebContent</property> - folder.</para> - - <figure> - <title>Master Page in JBoss Tools HTML Editor.</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_wizards/seam_wizards_14.png" scale="70"/> - </imageobject> - </mediaobject> - </figure> - - <para>The Entity page is:</para> - - <figure> - <title>Entity Page in JBoss Tools HTML Editor.</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_wizards/seam_wizards_15.png" scale="70"/> - </imageobject> - </mediaobject> - </figure> - - <para>Run the Entity page on server. This is what you get:</para> - - <figure> - <title>Customer Page</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_wizards/seam_wizards_16.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Let's create two customers <property>c1</property> and <property>c2</property>. Enter - the name in the text field and press the <property>Save</property> button. Customer - should be successfully created. Press <property>Done</property>. Do the same for - <property>c2</property> customer. The result should be:</para> - - <figure> - <title>Two Customers Are Created</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_wizards/seam_wizards_17.png"/> - </imageobject> - </mediaobject> - </figure> - </section> -</chapter> +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="seam_wizards"> +<?dbhtml filename="seam_wizards.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + + <keyword>Seam</keyword> + + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + <title>Seam Wizards</title> + <para> + This chapter introduces you with Seam Components. + </para> + + <para> + All the Seam component generations options known from Seam-gen are available as wizards (with sensible auto-defaulting) for creating various common Seam components: + </para> + + <itemizedlist> + <listitem> + <para> + <property>Seam Action</property> + </para> + </listitem> + + <listitem> + <para> + <property>Seam Form</property> + </para> + </listitem> + + <listitem> + <para> + <property>Seam Entity</property> + </para> + </listitem> + + <listitem> + <para> + <property>Seam Conversation</property> + </para> + </listitem> + </itemizedlist> + + <para> + Go to <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem></menuchoice> and select the component wizard. + </para> + + <figure> + <title>Seam Component Wizards</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/seam_wizards_1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + The wizards create multiple resources and place it in the appropriate folders depending on your project structure (WAR or EAR). + </para> + + <para> + Let&apos;s create a WAR project using the New Seam Project wizard. + </para> + + <figure> + <title>Seam Project WAR Deployment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/seam_wizards_2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + After the project is created you need deploy it on server. + </para> + + <section id="seam_action"> + <title>New Seam Action</title> + <para> + In this and following sections you can see example creating Seam Components. + </para> + + <para> + To create a New Seam Action you should select a necessary project, type a name for <property>Seam component</property>, <property>POJO class</property>, <property>Method</property>, <property>Page</property> and select a <property>Package</property> using the <emphasis> <property>Browse</property> </emphasis> button. + </para> + + <figure> + <title>New Seam Action Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/seam_wizards_4.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + If you specify a class which already exists, the wizard will warn you about it. + </para> + + <figure> + <title>Wizard Warning against Existing File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/action_warning.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + You can see the action page in <property>WebContent</property> folder. Click on it to open in JBoss Tools HTML Editor. + </para> + + <figure> + <title>Action Page in JBoss Tools HTML Editor.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/seam_wizards_5.png" scale="70"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para> + You don't need to restart the server to see how the action component works. Just use context menu <menuchoice><guimenuitem>Run As</guimenuitem><guimenuitem>Run On Server.</guimenuitem></menuchoice> + </para> + </note> + + <para> + Action component was hot-deployed. Forms and Conversations will work the same way. + </para> + + <figure> + <title>Action Component</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/seam_wizards_6.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="seam_form"> + <title>New Seam Form</title> + <para> + Click on <property>actionMethod</property> in the internal browser and add a form in your project using the New Seam Form wizard <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Seam Form</guimenuitem></menuchoice>. + </para> + + <para> + Select a necessary project, type a name for <property>Seam component</property>, <property>POJO class</property>, <property>Method</property>, <property>Page</property> and select a <property>Package</property> using <emphasis> <property>Browse</property> </emphasis> button. + </para> + + <figure> + <title>New Seam Form Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/seam_wizards_7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + If you specify a class which already exists, the wizard will warn you about it. + </para> + + <figure> + <title>Wizard Warning against Existing File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/form_warning.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + The Form Page was created in <property>WebContent</property> folder. + </para> + + <figure> + <title>Form Page in JBoss Tools HTML Editor.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/seam_wizards_8.png" scale="70"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Deploy the form on server. Right click on Form Page, select <menuchoice><guimenuitem>Run As</guimenuitem><guimenuitem>Run On Server.</guimenuitem></menuchoice> + </para> + + <figure> + <title>Form Component</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/seam_wizards_9.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Form component was hot-deployed. + </para> + </section> + + <section id="seam_conversation"> + <title>New Seam Conversation</title> + <para> + Enter some value in the text field (e.g. <property>value1</property>) and click on <property>formMethod</property>. + </para> + + <para> + Add a conversation using the New Seam Conversation wizard <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Seam Form.</guimenuitem></menuchoice> + </para> + + <para> + You should select a necessary project, type a name for <property>Seam component</property>, <property>POJO class</property>, <property>Method</property>, <property>Page</property> and select a <property>Package</property> using <emphasis> <property>Browse</property> </emphasis> button. + </para> + + <figure> + <title>New Seam Conversation Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/seam_wizards_10.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + If you specify a class which already exists, the wizard will warn you about it. + </para> + + <figure> + <title>Wizard Warning against Existing File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/conversation_warning.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Conversation page was created in <property>WebContent</property> folder. + </para> + + <figure> + <title>Conversation Page in JBoss Tools HTML Editor.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/seam_wizards_11.png" scale="70"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Right click on Conversation page, select <menuchoice><guimenuitem>Run As</guimenuitem><guimenuitem>Run On Server.</guimenuitem></menuchoice> + </para> + + <figure> + <title>Conversation Component</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/seam_wizards_12.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Conversation component was hot-deployed. + </para> + + <para> + Click on <property>Begin</property> and <property>Increment</property> buttons to check the conversation functionality. + </para> + </section> + + <section id="seam_entity"> + <title>New Seam Entity</title> + <para> + Entities cannot be hot-deployed, so we need to stop the server. + </para> + + <para> + Create an Entity using the New Entity wizard <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Seam Entity.</guimenuitem></menuchoice> + </para> + + <para> + You should select a necessary project, type a name for <property>Entity class</property>, select a <property>Package</property> using <emphasis> <property>Browse</property> </emphasis> button, type a name for <property>Master Page</property> and <property>Page</property>. + </para> + + <figure> + <title>New Seam Entity Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/seam_wizards_13.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + If you specify a class which already exists, the wizard will warn you about it. + </para> + + <figure> + <title>Wizard Warning against Existing File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/entity_warning.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + The Master Page and the Entity were created in <property>WebContent</property> folder. + </para> + + <figure> + <title>Master Page in JBoss Tools HTML Editor.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/seam_wizards_14.png" scale="70"/> + </imageobject> + </mediaobject> + </figure> + + <para> + The Entity page is: + </para> + + <figure> + <title>Entity Page in JBoss Tools HTML Editor.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/seam_wizards_15.png" scale="70"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Run the Entity page on server. This is what you get: + </para> + + <figure> + <title>Customer Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/seam_wizards_16.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Let's create two customers <property>c1</property> and <property>c2</property>. Enter the name in the text field and press the <property>Save</property> button. Customer should be successfully created. Press <property>Done</property>. Do the same for <property>c2</property> customer. The result should be: + </para> + + <figure> + <title>Two Customers Are Created</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/seam_wizards_17.png"/> + </imageobject> + </mediaobject> + </figure> + </section> +</chapter> Modified: branches/jbosstools-3.2.x/seam/docs/reference/en-US/testng.xml =================================================================== --- branches/jbosstools-3.2.x/seam/docs/reference/en-US/testng.xml 2011-07-18 02:37:17 UTC (rev 32983) +++ branches/jbosstools-3.2.x/seam/docs/reference/en-US/testng.xml 2011-07-18 02:42:15 UTC (rev 32984) @@ -1,249 +1,294 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="testNG"> - <?dbhtml filename="testNG.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Developer Studio</keyword> - <keyword>JBDS</keyword> - <keyword>testNG</keyword> - </keywordset> - </chapterinfo> - <title>Using TestNG project</title> - <para>With the help this chapter you will get to know with TestNG.</para> - <section> - <title>What is TestNG?</title> - <para><property>TestNG</property> (&quot;Testing, the Next Generation&quot;) is a - Java unit testing framework that aims to overcome many limitations of JUnit. TestNG - introduces some new functionalities that make it more powerful and easier to use, such - as:</para> - <itemizedlist> - <listitem> - <para>JDK 5 Annotations (JDK 1.4 is also supported with JavaDoc annotations)</para> - </listitem> - <listitem> - <para>Flexible test configuration</para> - </listitem> - <listitem> - <para>Support for data-driven testing (with @DataProvider)</para> - </listitem> - <listitem> - <para>Support for parameters</para> - </listitem> - <listitem> - <para>Allows distribution of tests on slave machines</para> - </listitem> - <listitem> - <para>Powerful execution model (no more TestSuite)</para> - </listitem> - <listitem> - <para>Supported by a variety of tools and plug-ins (Eclipse, IDEA, Maven, - etc...)</para> - </listitem> - <listitem> - <para>Embeds BeanShell for further flexibility</para> - </listitem> - <listitem> - <para>Default JDK functions for runtime and logging (no dependencies)</para> - </listitem> - <listitem> - <para>Dependent methods for application server testing</para> - </listitem> - </itemizedlist> - - <para>More information can be found on home page: <ulink url="http://testng.org" - >www.testng.org</ulink></para> - </section> - <section id="OtherRelevantResourcesOnTheTopic5"> - <?dbhtml filename="OtherRelevantResourcesOnTheTopic5.html"?> - <title>Other relevant resources on the topic</title> - <para> - <ulink url="http://www.artima.com/lejava/articles/testng.html">Next... Testing - with TestNG (An Interview with Cedric Beust)</ulink> - </para> - <para> - <ulink url="http://www.javaworld.com/javaworld/jw-04-2005/jw-0404-testng.ht...: - The next generation of unit testing</ulink> - </para> - <para> - <ulink url="http://dev2dev.bea.com/pub/a/2006/09/testng-categorization.html... - Categorization Techniques with TestNG</ulink> - </para> - <para> - <ulink url="http://www-128.ibm.com/developerworks/java/library/j-testng/&qu... makes - Java unit testing a breeze</ulink> - </para> - <para> - <ulink url="http://www-128.ibm.com/developerworks/java/library/j-cq08296/in... - pursuit of code quality: JUnit 4 vs. TestNG</ulink> - </para> - </section> - <section> - <title>How to use the generated Seam-test project to run Seam tests?</title> - - <itemizedlist> - <listitem> - <para>Create a new Seam Web Project with EAR deployment using the New Seam Project - wizard.</para> - </listitem> - </itemizedlist> - - <itemizedlist> - <listitem> - <para>After a project is created you will have the generated Seam-test project that - is setup to run TestNG directly against the proper libraries and server runtime - libraries.</para> - </listitem> - </itemizedlist> - - <figure> - <title>Seam-test Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/testng/testng_5.png"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Add Seam Action to your project via <emphasis><property>File > New > Seam - Action</property>.</emphasis></para> - </listitem> - </itemizedlist> - - <figure> - <title>Seam Action Creation</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/testng/testng_6.png"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Fill out the wizard fields. New Seam Action wizard will create resources and - place them in the appropriate folders dependent on EAR project structure.</para> - </listitem> - </itemizedlist> - - <figure> - <title>New Seam Action Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/testng/testng_7.png"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>When Action is created you will see <property>actionPage.xhtml</property> in - Package Explorer view. <property>ActionBean.java</property> will be - automatically opened in Java Editor.</para> - </listitem> - </itemizedlist> - - <figure> - <title>Created Action</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/testng/testng_8.png" scale="70"/> - </imageobject> - </mediaobject> - </figure> - - - <itemizedlist> - <listitem> - <para>Select <property>ActionLocalTest.xml</property> in Seam-test project and run - the test with right click <emphasis><property>Run As > TestNG - Suite</property>.</emphasis></para> - </listitem> - </itemizedlist> - <note><para>OpenOn is available in testNG XML files opened in JBoss XML Editor</para></note> - <figure> - <title>Running TestNG</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/testng/testng_9.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The test process will start and its output will be written in Console View.</para> - - <figure> - <title>Test is Finished</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/testng/testng_10.png" scale="70"/> - </imageobject> - </mediaobject> - </figure> - - - <itemizedlist> - <listitem> - <para>After running TestNG you will have the test results in <emphasis> - <property>test-output</property> - </emphasis> folder in Seam-test project (press F5 to refresh the Package - Explorer view). Open <property>index.html</property> file with Web Browser or - simply use the TestNG view.</para> - </listitem> - </itemizedlist> - - <para>The below view shows a successful run of the test.</para> - - <figure> - <title>Viewing the Test Results</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/testng/testng_11.png" scale="70"/> - </imageobject> - </mediaobject> - </figure> - - - <para>You can see the test results in Web Browser.</para> - - <figure> - <title>Test Results in Browser</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/testng/testng_12.png" scale="70"/> - </imageobject> - </mediaobject> - </figure> - - <para>After clicking on <emphasis> - <property>ActionLocal Tests</property> - </emphasis> link you will see the Results for ActionLocal Tests.</para> - - <figure> - <title>Test Information</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/testng/testng_13.png" scale="70"/> - </imageobject> - </mediaobject> - </figure> - - <para>Select a result on the left-hand pane and its details will be displayed on the - right-hand one.</para> - - <figure> - <title>ActionLocal Test Details</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/testng/testng_14.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Thus with Seam tooling you can easily take advantage of TestNG framework. As you can - see, it generates its own TestNG project as a separate module within which you can - easily monitor the tests execution and their output.</para> - - </section> -</chapter> +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="testNG"> +<?dbhtml filename="testNG.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + + <keyword>JBDS</keyword> + + <keyword>testNG</keyword> + </keywordset> + </chapterinfo> + <title>Using TestNG project</title> + <para> + With the help this chapter you will get to know with TestNG. + </para> + + <section> + <title>What is TestNG?</title> + <para> + <property>TestNG</property> (&quot;Testing, the Next Generation&quot;) is a Java unit testing framework that aims to overcome many limitations of JUnit. TestNG introduces some new functionalities that make it more powerful and easier to use, such as: + </para> + + <itemizedlist> + <listitem> + <para> + JDK 5 Annotations (JDK 1.4 is also supported with JavaDoc annotations) + </para> + </listitem> + + <listitem> + <para> + Flexible test configuration + </para> + </listitem> + + <listitem> + <para> + Support for data-driven testing (with @DataProvider) + </para> + </listitem> + + <listitem> + <para> + Support for parameters + </para> + </listitem> + + <listitem> + <para> + Allows distribution of tests on slave machines + </para> + </listitem> + + <listitem> + <para> + Powerful execution model (no more TestSuite) + </para> + </listitem> + + <listitem> + <para> + Supported by a variety of tools and plug-ins (Eclipse, IDEA, Maven, etc...) + </para> + </listitem> + + <listitem> + <para> + Embeds BeanShell for further flexibility + </para> + </listitem> + + <listitem> + <para> + Default JDK functions for runtime and logging (no dependencies) + </para> + </listitem> + + <listitem> + <para> + Dependent methods for application server testing + </para> + </listitem> + </itemizedlist> + + <para> + More information can be found on home page: <ulink url="http://testng.org" + >www.testng.org</ulink> + </para> + </section> + + <section id="OtherRelevantResourcesOnTheTopic5"> +<?dbhtml filename="OtherRelevantResourcesOnTheTopic5.html"?> + <title>Other relevant resources on the topic</title> + <para> + <ulink url="http://www.artima.com/lejava/articles/testng.html">Next... Testing with TestNG (An Interview with Cedric Beust)</ulink> + </para> + + <para> + <ulink url="http://www.javaworld.com/javaworld/jw-04-2005/jw-0404-testng.ht...: The next generation of unit testing</ulink> + </para> + + <para> + <ulink url="http://dev2dev.bea.com/pub/a/2006/09/testng-categorization.html... Categorization Techniques with TestNG</ulink> + </para> + + <para> + <ulink url="http://www-128.ibm.com/developerworks/java/library/j-testng/&qu... makes Java unit testing a breeze</ulink> + </para> + + <para> + <ulink url="http://www-128.ibm.com/developerworks/java/library/j-cq08296/in... pursuit of code quality: JUnit 4 vs. TestNG</ulink> + </para> + </section> + + <section> + <title>How to use the generated Seam-test project to run Seam tests?</title> + <itemizedlist> + <listitem> + <para> + Create a new Seam Web Project with EAR deployment using the New Seam Project wizard. + </para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para> + After a project is created you will have the generated Seam-test project that is setup to run TestNG directly against the proper libraries and server runtime libraries. + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Seam-test Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/testng/testng_5.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + Add Seam Action to your project via <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Seam Action.</guimenuitem></menuchoice> + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Seam Action Creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/testng/testng_6.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + Fill out the wizard fields. New Seam Action wizard will create resources and place them in the appropriate folders dependent on EAR project structure. + </para> + </listitem> + </itemizedlist> + + <figure> + <title>New Seam Action Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/testng/testng_7.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + When Action is created you will see <property>actionPage.xhtml</property> in Package Explorer view. <property>ActionBean.java</property> will be automatically opened in Java Editor. + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Created Action</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/testng/testng_8.png" scale="70"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + Select <property>ActionLocalTest.xml</property> in Seam-test project and run the test with right click <menuchoice><guimenuitem>Run As</guimenuitem><guimenuitem>TestNG Suite.</guimenuitem></menuchoice> + </para> + </listitem> + </itemizedlist> + + <note> + <para> + OpenOn is available in testNG XML files opened in JBoss XML Editor + </para> + </note> + + <figure> + <title>Running TestNG</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/testng/testng_9.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + The test process will start and its output will be written in Console View. + </para> + + <figure> + <title>Test is Finished</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/testng/testng_10.png" scale="70"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + After running TestNG you will have the test results in <emphasis> <property>test-output</property> </emphasis> folder in Seam-test project (press F5 to refresh the Package Explorer view). Open <property>index.html</property> file with Web Browser or simply use the TestNG view. + </para> + </listitem> + </itemizedlist> + + <para> + The below view shows a successful run of the test. + </para> + + <figure> + <title>Viewing the Test Results</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/testng/testng_11.png" scale="70"/> + </imageobject> + </mediaobject> + </figure> + + <para> + You can see the test results in Web Browser. + </para> + + <figure> + <title>Test Results in Browser</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/testng/testng_12.png" scale="70"/> + </imageobject> + </mediaobject> + </figure> + + <para> + After clicking on <emphasis> <property>ActionLocal Tests</property> </emphasis> link you will see the Results for ActionLocal Tests. + </para> + + <figure> + <title>Test Information</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/testng/testng_13.png" scale="70"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Select a result on the left-hand pane and its details will be displayed on the right-hand one. + </para> + + <figure> + <title>ActionLocal Test Details</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/testng/testng_14.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Thus with Seam tooling you can easily take advantage of TestNG framework. As you can see, it generates its own TestNG project as a separate module within which you can easily monitor the tests execution and their output. + </para> + </section> +</chapter> Modified: branches/jbosstools-3.2.x/seam/docs/reference/pom.xml =================================================================== --- branches/jbosstools-3.2.x/seam/docs/reference/pom.xml 2011-07-18 02:37:17 UTC (rev 32983) +++ branches/jbosstools-3.2.x/seam/docs/reference/pom.xml 2011-07-18 02:42:15 UTC (rev 32984) @@ -1,7 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> -<project xmlns="http://maven.apache.org/POM/4.0.0" - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> +<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>org.jboss.tools</groupId> @@ -10,229 +8,237 @@ <packaging>jdocbook</packaging> <name>${bookname}-(${translation})</name> - <properties> - <translation>en-US</translation> - <docname>Seam_Reference_Guide</docname> - <bookname>Seam Reference Guide</bookname> - </properties> - - <profiles> + <properties> + <translation>en-US</translation> + <docname>Seam_Reference_Guide</docname> + <bookname>Seam Reference Guide</bookname> + </properties> + <profiles> + <!-- mvn compile --> - <profile> - <id>all</id> - <activation> - <activeByDefault>true</activeByDefault> - </activation> - <build> - <plugins> - <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> - <version>2.3.3</version> - <extensions>true</extensions> - <configuration> - <formats> - <format> - <formatName>pdf</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> - <finalName>${docname}.pdf</finalName> - </format> - <format> - <formatName>html</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - <format> - <formatName>html_single</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - <format> - <formatName>eclipse</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - </formats> - </configuration> - </plugin> + <profile> + <id>all</id> + <activation> + <activeByDefault>true</activeByDefault> + </activation> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.3.4</version> + <extensions>true</extensions> + <configuration> + <profiling> + <enabled>true</enabled> + <attributeName>condition</attributeName> + <attributeValue>jbt</attributeValue> + </profiling> + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> + <finalName>${docname}.pdf</finalName> + </format> + <format> + <formatName>html</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>html_single</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>eclipse</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + <options> + <useRelativeImageUris>true</useRelativeImageUris> + </options> + </configuration> + </plugin> </plugins> </build> </profile> <!-- mvn compile -Phtml --> - <profile> - <id>html</id> - <activation> - <activeByDefault>false</activeByDefault> - </activation> - <build> - <plugins> - <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> - <version>2.3.3</version> - <extensions>true</extensions> - <configuration> - <formats> - <format> - <formatName>html</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - </formats> - </configuration> - </plugin> + <profile> + <id>html</id> + <activation> + <activeByDefault>false</activeByDefault> + </activation> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.3.3</version> + <extensions>true</extensions> + <configuration> + <formats> + <format> + <formatName>html</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + </configuration> + </plugin> </plugins> </build> </profile> <!-- mvn compile -Phtml-single --> - <profile> - <id>html-single</id> - <activation> - <activeByDefault>false</activeByDefault> - </activation> - <build> - <plugins> - <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> - <version>2.3.3</version> - <extensions>true</extensions> - </plugin> + <profile> + <id>html-single</id> + <activation> + <activeByDefault>false</activeByDefault> + </activation> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.3.3</version> + <extensions>true</extensions> + </plugin> </plugins> </build> </profile> <!-- mvn compile -Ppdf --> - <profile> - <id>pdf</id> - <activation> - <activeByDefault>false</activeByDefault> - </activation> - <build> - <plugins> - <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> - <version>2.3.3</version> - <extensions>true</extensions> - <configuration> - <formats> - <format> - <formatName>pdf</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> - <finalName>${docname}.pdf</finalName> - </format> - </formats> - </configuration> - </plugin> + <profile> + <id>pdf</id> + <activation> + <activeByDefault>false</activeByDefault> + </activation> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.3.3</version> + <extensions>true</extensions> + <configuration> + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> + <finalName>${docname}.pdf</finalName> + </format> + </formats> + </configuration> + </plugin> </plugins> </build> </profile> <!-- mvn compile -Peclipse --> - <profile> - <id>eclipse</id> - <activation> - <activeByDefault>false</activeByDefault> - </activation> - <build> - <plugins> - <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> - <version>2.3.3</version> - <extensions>true</extensions> - <configuration> - <formats> - <format> - <formatName>eclipse</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - </formats> - </configuration> - </plugin> - </plugins> - </build> - </profile> + <profile> + <id>eclipse</id> + <activation> + <activeByDefault>false</activeByDefault> + </activation> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.3.3</version> + <extensions>true</extensions> + <configuration> + <formats> + <format> + <formatName>eclipse</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + </configuration> + </plugin> + </plugins> + </build> + </profile> - </profiles> - <build> - <pluginManagement> - <plugins> - <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> - <version>2.3.3</version> - <extensions>true</extensions> - <dependencies> - <dependency> - <groupId>org.jboss.pressgang</groupId> - <artifactId>pressgang-xslt</artifactId> - <version>1.2.0</version> - </dependency> - <dependency> - <groupId>org.jboss</groupId> - <artifactId>jbossorg-jdocbook-style</artifactId> - <version>1.1.1</version> - <type>jdocbook-style</type> - </dependency> - </dependencies> - <configuration> - <sourceDirectory>${project.basedir}</sourceDirectory> + </profiles> + <build> + <pluginManagement> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.3.3</version> + <extensions>true</extensions> + <dependencies> + <dependency> + <groupId>org.jboss.pressgang</groupId> + <artifactId>pressgang-xslt</artifactId> + <version>1.2.0</version> + </dependency> + <dependency> + <groupId>org.jboss</groupId> + <artifactId>jbossorg-jdocbook-style</artifactId> + <version>1.1.1</version> + <type>jdocbook-style</type> + </dependency> + </dependencies> + <configuration> + <sourceDirectory>${project.basedir}</sourceDirectory> <!-- <sourceDocumentName>${docname}.xml</sourceDocumentName> --> - <sourceDocumentName>master.xml</sourceDocumentName> - <masterTranslation>en-US</masterTranslation> - <imageResource> - <directory>${project.basedir}/en-US</directory> - <includes> - <include>images/**/*</include> - </includes> - </imageResource> - <formats> - <format> - <formatName>pdf</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> - <finalName>${pdf.name}</finalName> - </format> - <format> - <formatName>html</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - <format> - <formatName>html_single</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - <format> - <formatName>eclipse</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - </formats> - <options> - <xincludeSupported>true</xincludeSupported> - <xmlTransformerType>saxon</xmlTransformerType> - <docbookVersion>1.72.0</docbookVersion> - <localeSeparator>-</localeSeparator> - <transformerParameters> - <property> - <name>javax.xml.parsers.DocumentBuilderFactory</name> - <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value> - </property> - <property> - <name>javax.xml.parsers.SAXParserFactory</name> - <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value> - </property> - </transformerParameters> - </options> - </configuration> - </plugin> - </plugins> - </pluginManagement> - </build> + <sourceDocumentName>master.xml</sourceDocumentName> + <masterTranslation>en-US</masterTranslation> + <imageResource> + <directory>${project.basedir}/en-US</directory> + <includes> + <include>images/**/*</include> + </includes> + </imageResource> + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> + <finalName>${pdf.name}</finalName> + </format> + <format> + <formatName>html</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>html_single</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>eclipse</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + <options> + <xincludeSupported>true</xincludeSupported> + <xmlTransformerType>saxon</xmlTransformerType> + <docbookVersion>1.72.0</docbookVersion> + <localeSeparator>-</localeSeparator> + <transformerParameters> + <property> + <name>javax.xml.parsers.DocumentBuilderFactory</name> + <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value> + </property> + <property> + <name>javax.xml.parsers.SAXParserFactory</name> + <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value> + </property> + </transformerParameters> + </options> + </configuration> + </plugin> + </plugins> + </pluginManagement> + </build> </project> Modified: branches/jbosstools-3.2.x/seam/docs/reference/publican.cfg =================================================================== --- branches/jbosstools-3.2.x/seam/docs/reference/publican.cfg 2011-07-18 02:37:17 UTC (rev 32983) +++ branches/jbosstools-3.2.x/seam/docs/reference/publican.cfg 2011-07-18 02:42:15 UTC (rev 32984) @@ -4,4 +4,4 @@ xml_lang: en-US type: Book brand: JBoss - +condition: jbds