JBoss Tools SVN: r14150 - branches/jbosstools-3.0.x/documentation/jboss-tools-docs.
by jbosstools-commits@lists.jboss.org
Author: ochikvina
Date: 2009-03-10 10:46:42 -0400 (Tue, 10 Mar 2009)
New Revision: 14150
Modified:
branches/jbosstools-3.0.x/documentation/jboss-tools-docs/pom.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-655 - updating the pom.xml;
Modified: branches/jbosstools-3.0.x/documentation/jboss-tools-docs/pom.xml
===================================================================
--- branches/jbosstools-3.0.x/documentation/jboss-tools-docs/pom.xml 2009-03-10 14:43:19 UTC (rev 14149)
+++ branches/jbosstools-3.0.x/documentation/jboss-tools-docs/pom.xml 2009-03-10 14:46:42 UTC (rev 14150)
@@ -11,6 +11,8 @@
<name>All_Userguides</name>
<modules>
+ <module>../jbosstools-docbook-xslt</module>
+ <module>../../ws/docs/reference</module>
<module>../guides/Exadel-migration</module>
<module>../guides/GettingStartedGuide</module>
<module>../../as/docs/reference</module>
@@ -23,7 +25,6 @@
<module>../../struts/docs/struts_tools_ref_guide</module>
<module>../../struts/docs/struts_tools_tutorial</module>
<module>../../esb/docs/esb_ref_guide</module>
- <module>../../ws/docs/reference</module>
<module>../../portlet/docs/reference</module>
<module>../../birt/docs</module>
<module>../../drools/docs/reference</module>
15 years, 3 months
JBoss Tools SVN: r14149 - branches/jbosstools-3.0.x/ws/docs/reference/en.
by jbosstools-commits@lists.jboss.org
Author: ochikvina
Date: 2009-03-10 10:43:19 -0400 (Tue, 10 Mar 2009)
New Revision: 14149
Modified:
branches/jbosstools-3.0.x/ws/docs/reference/en/master_output.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-655 - adding master_output.xml;
Modified: branches/jbosstools-3.0.x/ws/docs/reference/en/master_output.xml
===================================================================
--- branches/jbosstools-3.0.x/ws/docs/reference/en/master_output.xml 2009-03-10 14:42:12 UTC (rev 14148)
+++ branches/jbosstools-3.0.x/ws/docs/reference/en/master_output.xml 2009-03-10 14:43:19 UTC (rev 14149)
@@ -16,11 +16,11 @@
<pubdate>July 2008</pubdate>
<copyright>
<year>2008</year>
- <year>2009</year>
- <holder>JBoss, a division of Red Hat</holder>
+ <year diffmk:change="added"><diffmk:wrapper diffmk:change="added">2009</diffmk:wrapper></year>
+ <holder><diffmk:wrapper diffmk:change="changed">JBoss, a division of Red Hat</diffmk:wrapper></holder>
</copyright>
<releaseinfo><diffmk:wrapper diffmk:change="changed">
- Version: 3.0.0.GA
+ Version: 1.0.0.GA
</diffmk:wrapper></releaseinfo>
<abstract>
<title></title>
@@ -129,7 +129,7 @@
</emphasis> settings, you should check the second radio button and specify a JBossWS
runtime from the list. You also can create a new JBossWS runtime, click on the <emphasis>
<property moreinfo="none">New...</property>
- </emphasis><diffmk:wrapper diffmk:change="changed"> button will bring you to another dialog to configure new JBossWS runtime.</diffmk:wrapper></para>
+ </emphasis> button will bring you to another dialog to configure new JBossWS runtime.</para>
<figure float="0" id="figure_addfacet1">
<title>Configure JBossWS Runtime</title>
<mediaobject>
@@ -237,7 +237,7 @@
</section>
- <section id="bottomupws">
+ <section id="bottomupws" role="updated">
<title>Creating a Web service from a Java bean using JBossWS runtime</title>
<para>The Web Service wizard assists you in creating a new Web service, configuring it for
deployment, and then deploying it to the server.</para>
@@ -324,9 +324,9 @@
</itemizedlist>
</listitem>
<listitem>
- <para><diffmk:wrapper diffmk:change="changed">Select your server: the default server is displayed. If you want to deploy
+ <para>Select your server: the default server is displayed. If you want to deploy
your service to a different server click the link to specify a different server.
- </diffmk:wrapper></para>
+ </para>
</listitem>
<listitem>
<para>Select your runtime: ensure the JBoss WS runtime is selected.</para>
@@ -365,9 +365,9 @@
address. </para>
</listitem>
<listitem>
- <para><diffmk:wrapper diffmk:change="changed">After the Web service has been created, the following option can become
+ <para>After the Web service has been created, the following option can become
available depending on the options you selected: Update the default web.xm
- file. If selected, you may test the web service by Explorer.</diffmk:wrapper></para>
+ file. If selected, you may test the web service by Explorer.</para>
</listitem>
</itemizedlist>
<para>Click on the <property moreinfo="none">Next</property> button.</para>
@@ -394,7 +394,7 @@
<para>the generated web services code</para>
</listitem>
<listitem>
- <para><diffmk:wrapper diffmk:change="changed">If you selected to generate a WSDL file, you will get the file in your project's wsdl folder.</diffmk:wrapper></para>
+ <para>If you selected to generate a WSDL file, you will get the file in your project's wsdl folder.</para>
<figure float="0">
<title>The generated WSDL file</title>
<mediaobject>
@@ -423,7 +423,7 @@
</chapter>
-<chapter id="client" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/ws/docs/reference/en/modules/client.xml">
+<chapter id="client" revisionflag="added" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/ws/docs/reference/en/modules/client.xml">
<title>Creating a Web Service Client from a WSDL Document using JBoss WS</title>
<para>To create a Web Service Client from a WSDL Document using JBoss WS:</para>
<para>Setup <link linkend="preference">JBoss WS and development environment</link>.</para>
@@ -496,21 +496,21 @@
</chapter>
-<chapter id="preference" >
+<chapter id="preference" revisionflag="added" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/ws/docs/reference/en/modules/preference.xml">
<title>JBoss WS and development environment</title>
<section id="jbosswspreference">
<title>JBossWS Preferences</title>
- <para><diffmk:wrapper diffmk:change="changed">In this section you will know how JBossWS preferences can be modified during the
- development process.</diffmk:wrapper></para>
+ <para>In this section you will know how JBossWS preferences can be modified during the
+ development process.</para>
- <para><diffmk:wrapper diffmk:change="changed">JBossWS preferences can be set on the JBossWS preference page. Click on
- </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Window > Preferences > JBoss Tools > Web > JBossWS
- Preferences</diffmk:wrapper></property>.</emphasis></para>
+ <para>JBossWS preferences can be set on the JBossWS preference page. Click on
+ <emphasis><property moreinfo="none">Window > Preferences > JBoss Tools > Web > JBossWS
+ Preferences</property>.</emphasis></para>
- <para><diffmk:wrapper diffmk:change="changed">On this page you can manage the JBossWS Runtime. Use the appropriate buttons to
- </diffmk:wrapper><property moreinfo="none">Add</property> more runtimes or to <property moreinfo="none">Remove</property><diffmk:wrapper diffmk:change="changed"> those that
- are not needed.</diffmk:wrapper></para>
+ <para>On this page you can manage the JBossWS Runtime. Use the appropriate buttons to
+ <property moreinfo="none">Add</property> more runtimes or to <property moreinfo="none">Remove</property> those that
+ are not needed.</para>
<figure float="0">
<title>JBossWS Preferences Page</title>
@@ -525,10 +525,10 @@
<property moreinfo="none">Add</property>
</emphasis> or <emphasis>
<property moreinfo="none">Edit</property>
- </emphasis><diffmk:wrapper diffmk:change="changed"> button will open the form where you can configure a new JbossWS runtime and
+ </emphasis> button will open the form where you can configure a new JbossWS runtime and
change the path to JBossWS runtime home folder, modify the name and version of the
- existing JBossWS runtime settings. Press </diffmk:wrapper><property moreinfo="none">Finish</property><diffmk:wrapper diffmk:change="changed"> to apply the
- changes.</diffmk:wrapper></para>
+ existing JBossWS runtime settings. Press <property moreinfo="none">Finish</property> to apply the
+ changes.</para>
<figure float="0">
<title>Edit JBossWS Runtime</title>
@@ -538,15 +538,47 @@
</imageobject>
</mediaobject>
</figure>
+
+
+
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">WS container allows Source and JavaDoc locations to be set via the Properties dialog on each contained .jar: right-click on any .jar file in the Project Explorer view, select </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Properties</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">. Choose </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Java Source Attachment</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> and select location (folder, JAR or zip) containing new source for the chosen .jar using one of the suggested options (workspace, external folder or file) or enter the path manually:</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Classpath Container: Java Source Attachment</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/jbossws_container1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Click on </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Apply</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> and then on </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Ok</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">To change Javadoc Location choose </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Javadoc Location</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> and specify URL to the documentation generated by Javadoc. The Javadoc location will contain a file called </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">package-list</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">:</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Classpath Container: Javadoc Location</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/jbossws_container2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Click on </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Apply</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> and then on </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Ok</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
+
+
+
+
+
+
</section>
- <section diffmk:change="added" id="serverruntime">
+ <section id="serverruntime">
<title>Default Server and Runtime</title>
- <para><diffmk:wrapper diffmk:change="changed">Open </diffmk:wrapper><emphasis>
+ <para>Open <emphasis>
<property moreinfo="none">Window > Preferences > Web Services > Server and Runtime</property>
</emphasis>. On this page, you can specify a default server and runtime.</para>
<para>For ease of use, the better way is to set runtime to JBoss WS.</para>
- <para>After server and runtime are specified, click on the <property moreinfo="none">Aply</property><diffmk:wrapper diffmk:change="changed"> button
- to save the values.</diffmk:wrapper></para>
+ <para>After server and runtime are specified, click on the <property moreinfo="none">Aply</property> button
+ to save the values.</para>
<figure float="0">
<title></title>
<mediaobject>
@@ -556,12 +588,13 @@
</mediaobject>
</figure>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">On the whole, this guide covers the fundamental concepts of work with tooling for
- </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBossWS</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. It describes how to easily create a Web Service and a Web Service Client using
- JBossWS Runtime and adjust JBossWS and development environment as well.</diffmk:wrapper></para>
+ <para>On the whole, this guide covers the fundamental concepts of work with tooling for
+ <property moreinfo="none">JBossWS</property>. It describes how to easily create a Web Service and a Web Service Client using
+ JBossWS Runtime and adjust JBossWS and development environment as well.</para>
- <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If the information on JBossWS tools in this guide isn't enough for you, ask
- questions on our </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201"><diffmk:wrapper diffmk:change="added">forum</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">. Your comments and suggestions are also welcome.</diffmk:wrapper></para>
+ <para>If the information on JBossWS tools in this guide isn't enough for you, ask
+ questions on our <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">forum</ulink>. Your comments and suggestions are also welcome.</para>
</section>
- </chapter>
+</chapter>
+
</book>
15 years, 3 months
JBoss Tools SVN: r14148 - branches/jbosstools-3.0.x/ws/docs/reference.
by jbosstools-commits@lists.jboss.org
Author: ochikvina
Date: 2009-03-10 10:42:12 -0400 (Tue, 10 Mar 2009)
New Revision: 14148
Modified:
branches/jbosstools-3.0.x/ws/docs/reference/pom.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-655 - adding profiles to pom.xml;
Modified: branches/jbosstools-3.0.x/ws/docs/reference/pom.xml
===================================================================
--- branches/jbosstools-3.0.x/ws/docs/reference/pom.xml 2009-03-10 14:39:17 UTC (rev 14147)
+++ branches/jbosstools-3.0.x/ws/docs/reference/pom.xml 2009-03-10 14:42:12 UTC (rev 14148)
@@ -12,9 +12,40 @@
<profiles>
<profile>
+ <id>release</id>
+ <properties>
+ <master>master_output.xml</master>
+ <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-release.xsl</xsl-single>
+ <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-release.xsl</xsl-chunked>
+ <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf>
+ </properties>
+ </profile>
+ <profile>
+ <id>releaseTest</id>
+ <properties>
+ <master>master_output.xml</master>
+ <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-release-nomarker.xsl</xsl-single>
+ <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-release-nomarker.xsl</xsl-chunked>
+ <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf>
+ </properties>
+ </profile>
+ <profile>
+ <id>releaseJBDS</id>
+ <properties>
+ <master>master_output.xml</master>
+ <xsl-single>classpath:/xslt/com/jboss/tools/xhtml-single-release.xsl</xsl-single>
+ <xsl-chunked>classpath:/xslt/com/jboss/tools/xhtml-release.xsl</xsl-chunked>
+ <xsl-pdf>classpath:/xslt/com/jboss/tools/pdf.xsl</xsl-pdf>
+ <cssdir>../../../documentation/jbosstools-jdocbook-style/src/main/com/css/</cssdir>
+ </properties>
+ </profile>
+ <profile>
<id>diffmk</id>
<properties>
- <master>master_output.xml</master>
+ <master>master_output.xml</master>
+ <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-diff.xsl</xsl-single>
+ <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-diff.xsl</xsl-chunked>
+ <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf-diff.xsl</xsl-pdf>
</properties>
</profile>
</profiles>
@@ -27,9 +58,24 @@
<version>2.1.0-200803311251UTC-MPJDOCBOOK-8</version>
<extensions>true</extensions>
-
- <dependencies>
+ <dependencies>
<dependency>
+ <groupId>org.jboss.tools</groupId>
+ <artifactId>jbosstools-docbook-xslt</artifactId>
+ <version>1.0.0-SNAPSHOT</version>
+ </dependency>
+ <dependency>
+ <groupId>com.jboss</groupId>
+ <artifactId>jbossent-docbook-xslt</artifactId>
+ <version>1.0.0</version>
+ </dependency>
+ <dependency>
+ <groupId>com.jboss</groupId>
+ <artifactId>jbossent-jdocbook-style</artifactId>
+ <version>1.0.0</version>
+ <type>jdocbook-style</type>
+ </dependency>
+ <dependency>
<groupId>org.jboss</groupId>
<artifactId>jbossorg-docbook-xslt</artifactId>
<version>1.1.0</version>
@@ -55,25 +101,25 @@
<directory>${pom.basedir}/${cssdir}</directory>
</cssResource>
- <formats>
+ <formats>
<format>
<formatName>pdf</formatName>
- <stylesheetResource>file:${pom.basedir}/${stylesdir}/xslt/org/jboss/tools/pdf.xsl</stylesheetResource>
+ <stylesheetResource>${xsl-pdf}</stylesheetResource>
<finalName>${pom.name}.pdf</finalName>
</format>
<format>
<formatName>html</formatName>
- <stylesheetResource>file:${pom.basedir}/${stylesdir}/xslt/org/jboss/tools/xhtml.xsl</stylesheetResource>
+ <stylesheetResource>${xsl-chunked}</stylesheetResource>
<finalName>index.html</finalName>
</format>
<format>
<formatName>html_single</formatName>
- <stylesheetResource>file:${pom.basedir}/${stylesdir}/xslt/org/jboss/tools/xhtml-single.xsl</stylesheetResource>
+ <stylesheetResource>${xsl-single}</stylesheetResource>
<finalName>index.html</finalName>
</format>
<format>
<formatName>eclipse</formatName>
- <stylesheetResource>file:${pom.basedir}/${stylesdir}/xslt/org/jboss/tools/eclipse.xsl</stylesheetResource>
+ <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
<finalName>index.html</finalName>
</format>
</formats>
@@ -108,7 +154,9 @@
</distributionManagement>
<properties>
- <stylesdir>../../../documentation/jbosstools-docbook-xslt/src/main/resources/</stylesdir>
+ <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single.xsl</xsl-single>
+ <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml.xsl</xsl-chunked>
+ <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf>
<cssdir>../../../documentation/jbosstools-jdocbook-style/src/main/org/css/</cssdir>
<master>master.xml</master>
<translation>en-US</translation>
15 years, 3 months
JBoss Tools SVN: r14147 - branches/jbosstools-3.0.x/struts/docs/struts_tools_tutorial/en.
by jbosstools-commits@lists.jboss.org
Author: ochikvina
Date: 2009-03-10 10:39:17 -0400 (Tue, 10 Mar 2009)
New Revision: 14147
Added:
branches/jbosstools-3.0.x/struts/docs/struts_tools_tutorial/en/master_output.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-655 - adding master_output.xml;
Added: branches/jbosstools-3.0.x/struts/docs/struts_tools_tutorial/en/master_output.xml
===================================================================
--- branches/jbosstools-3.0.x/struts/docs/struts_tools_tutorial/en/master_output.xml (rev 0)
+++ branches/jbosstools-3.0.x/struts/docs/struts_tools_tutorial/en/master_output.xml 2009-03-10 14:39:17 UTC (rev 14147)
@@ -0,0 +1,1340 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.docbook.org/xml/4.3/docbookx.dtd"
+
+[<!ENTITY introduction SYSTEM "modules/introduction.xml">
+<!ENTITY struts_application SYSTEM "modules/struts_application.xml">
+<!ENTITY generating_stub SYSTEM "modules/generating_stub.xml">
+<!ENTITY coding_files SYSTEM "modules/coding_files.xml">
+<!ENTITY compiling_and_running SYSTEM "modules/compiling_and_running.xml">
+<!ENTITY struts_validation SYSTEM "modules/struts_validation.xml">
+<!ENTITY relevant_resources SYSTEM "modules/relevant_resources.xml">
+
+<!ENTITY seamlink "../../seam/html_single/index.html">
+<!ENTITY aslink "../../as/html_single/index.html">
+<!ENTITY esblink "../../esb_ref_guide/html_single/index.html">
+<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html">
+<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html">
+<!ENTITY jbpmlink "../../jbpm/html_single/index.html">
+<!ENTITY jsflink "../../jsf/html_single/index.html">
+<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html">
+<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html">
+<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html">
+<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html">
+
+]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
+
+ <bookinfo>
+ <title>Struts Tools Tutorial</title>
+
+ <author><firstname>Anatoly</firstname><surname>Fedosik</surname></author>
+ <author><firstname>Olga</firstname><surname>Chikvina</surname></author>
+ <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author>
+
+ <pubdate>April 2008</pubdate>
+ <copyright>
+ <year>2007</year>
+ <year><diffmk:wrapper diffmk:change="changed">2009</diffmk:wrapper></year>
+ <holder><diffmk:wrapper diffmk:change="changed">JBoss, a division of Red Hat</diffmk:wrapper></holder>
+ </copyright>
+ <releaseinfo><diffmk:wrapper diffmk:change="changed">
+ Version: 3.0.0.GA
+ </diffmk:wrapper></releaseinfo>
+
+<abstract>
+ <title></title>
+ <para>
+ <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/struts_tools_tutoria...">PDF version</ulink>
+ </para>
+</abstract>
+
+
+ </bookinfo>
+
+ <toc></toc>
+
+
+<chapter id="introduction" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/struts/docs/struts_tools_tutorial/en/modules/introduction.xml" xreflabel="introduction">
+ <?dbhtml filename="introduction.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Introduction</title>
+ <para>The following chapters describe how to deal with classic/old style of Struts development. We
+ recommend users to use <ulink url="../../seam/html_single/index.html">JBoss Seam</ulink> to
+ simplify development, but until then you can read about classical Struts usage here.</para>
+
+ <para>We are going to show you how to create a simple <emphasis>
+ <property moreinfo="none">Struts application</property>
+ </emphasis> using the JBoss Tools. The completed application will ask a user to enter
+ a name and click a button. The resulting new page will display the familiar message,
+ "Hello <name>!"</para>
+ <para>This document will show you how to create such an application from the beginning, along the
+ way demonstrating some of the powerful features of JBoss Tools. With the help of our tutorial you will design the
+ application, generate stub code for the application, fill in the stub coding, compile the
+ application, and finally run it all from inside the Eclipse.</para>
+
+ <section>
+ <title>Other relevant resources on the topic</title>
+
+ <para>All JBoss Developer Studio/JBoss Tools documentation you can find <ulink url="http://docs.jboss.org/tools/">here</ulink>.</para>
+ <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">here</ulink>.</para>
+
+ </section>
+
+</chapter>
+
+
+<chapter id="struts_application" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/struts/docs/struts_tools_tutorial/en/modules/struts_application.xml" xreflabel="struts_application">
+ <?dbhtml filename="struts_application.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>Struts</keyword>
+ <keyword>Struts Application</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Creating a Simple Struts Application</title>
+
+ <para>Firstly, we assume that you have already launched Eclipse with JBoss Tools installed and
+ also that the <property moreinfo="none">Web Development perspective</property> is the current perspective. (If not, make it
+ active by selecting <emphasis>
+ <property moreinfo="none">Window > Open Perspective > Other > Web
+ Development</property>
+ </emphasis> from the menu bar.)</para>
+
+ <section id="StartingUp">
+ <title>Starting Up</title>
+ <para>We are first going to create a new project for the application.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Go to the menu bar and select <emphasis>
+ <property moreinfo="none">File > New > Project...</property>
+ </emphasis>.</para>
+ </listitem>
+ <listitem>
+ <para>Select <emphasis>
+ <property moreinfo="none">JBoss Tools Web > Struts > Struts Project</property>
+ </emphasis> in the New Project dialog box</para>
+ </listitem>
+ <listitem>
+ <para>Click <emphasis>
+ <property moreinfo="none">Next </property>
+ </emphasis></para>
+ </listitem>
+ <listitem>
+ <para>Enter "StrutsHello" as the project name</para>
+ </listitem>
+ <listitem>
+ <para>Leave everything else as is, and click <emphasis>
+ <property moreinfo="none">Next</property>
+ </emphasis></para>
+ </listitem>
+ <listitem>
+ <para>Click <emphasis>
+ <property moreinfo="none">Next</property>
+ </emphasis> again</para>
+ </listitem>
+ <listitem>
+ <para>Make sure that <emphasis>
+ <property moreinfo="none">struts-bean.tld</property>
+ </emphasis>, <emphasis>
+ <property moreinfo="none">struts-html.tld</property>
+ </emphasis>, and <emphasis>
+ <property moreinfo="none">struts-logic.tld</property>
+ </emphasis> are checked in the list of included tag libraries and then click <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis></para>
+ </listitem>
+ </itemizedlist>
+ <para>A "StrutsHello" node should appear in the upper-left Package
+ Explorer view.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Click the plus sign next to <emphasis>
+ <property moreinfo="none">StrutsHello</property>
+ </emphasis> to reveal the child nodes</para>
+ </listitem>
+ <listitem>
+ <para>Click the plus sign next to <emphasis>
+ <property moreinfo="none">WebContent</property>
+ </emphasis> under StrutsHello</para>
+ </listitem>
+ <listitem>
+ <para>Click the plus sign next to <emphasis>
+ <property moreinfo="none">WEB-INF</property>
+ </emphasis> under WebContent</para>
+ </listitem>
+ <listitem>
+ <para>Then, double-click on the <emphasis>
+ <property moreinfo="none">struts-config.xml</property>
+ </emphasis> node to display a diagram of the Struts application configuration
+ file in the editing area</para>
+ </listitem>
+ </itemizedlist>
+ <para>At this point, its empty except for the background grid lines.</para>
+ </section>
+
+ <section id="CreatingtheApplicationComponents">
+ <?dbhtml filename="CreatingtheApplicationComponents.html"?>
+ <title>Creating the Application Components</title>
+ <para>Now, we will design the application by creating the individual components as
+ placeholders first. (We dont have to complete all of the details inside the components
+ until afterwards.)</para>
+ <section id="CreatingJSPPagePlaceholders">
+ <title>Creating JSP Page Placeholders</title>
+ <para>Next, let's create and place two JSP pages. We will not write any code
+ for the files, but only create them as placeholders so that we can create links to
+ them in the diagram. We will write the code a little bit later.</para>
+ <section id="CreatingthePagePlaceholders">
+ <title>Creating the Page Placeholders</title>
+ <itemizedlist>
+ <listitem>
+ <para>Bring the Web Projects view to the front of the Package Explorer view
+ by selecting the <emphasis>
+ <property moreinfo="none">Web Projects</property>
+ </emphasis> tab next to that tab.</para>
+ </listitem>
+ <listitem>
+ <para>Right-click the <emphasis>
+ <property moreinfo="none">StrutsHello > WEB-ROOT (WebContent)</property>
+ </emphasis> folder in the Web Projects view and select <emphasis>
+ <property moreinfo="none">New > Folder...</property>
+ </emphasis></para>
+ </listitem>
+ <listitem>
+ <para>Enter <emphasis>
+ <property moreinfo="none">pages</property>
+ </emphasis> for a folder name and click <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis></para>
+ </listitem>
+
+ <listitem>
+ <para>We will keep our presentation files in this folder</para>
+ </listitem>
+
+ <listitem>
+ <para>Right-click the pages folder and select <emphasis>
+ <property moreinfo="none">New > Fila > JSP...</property>
+ </emphasis>
+ </para>
+ </listitem>
+ <listitem>
+ <para>For Name type in <emphasis>
+ <property moreinfo="none">inputname</property>
+ </emphasis> (the JSP extension will be automatically added to the file),
+ for Template select <emphasis>
+ <property moreinfo="none">StrutsForm</property>
+ </emphasis> and then click on the <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> button</para>
+ </listitem>
+ <listitem>
+ <para>Right-click the pages folder again and select <emphasis>
+ <property moreinfo="none">New > File > JSP...</property>
+ </emphasis></para>
+ </listitem>
+ <listitem>
+ <para>For Name type in <emphasis>
+ <property moreinfo="none">greeting</property>
+ </emphasis>, for Template leave as Blank, and then click on the <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> button</para>
+ </listitem>
+ </itemizedlist>
+ <para>Just leave these files as is for now.</para>
+ </section>
+ <section id="PlacingthePagePlaceholders">
+ <title>Placing the Page Placeholders</title>
+ <para>Lets now place the two pages just created on the diagram.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Click on the <emphasis>
+ <property moreinfo="none">struts-config.xml</property>
+ </emphasis> tab in the Editing area to bring the diagram to the
+ front</para>
+ </listitem>
+ <listitem>
+ <para>Click on the <emphasis>
+ <property moreinfo="none">inputname.jsp</property>
+ </emphasis> page in the Web Projects view, drag it onto the diagram, and
+ drop it</para>
+ </listitem>
+ <listitem><para>Click on the <emphasis>
+ <property moreinfo="none">greeting.jsp</property>
+ </emphasis> page in the Web Projects view, drag it onto the diagram, and
+ drop it to the right of the <emphasis>
+ <property moreinfo="none">/pages/inputname.jsp</property>
+ </emphasis> icon with some extra space</para></listitem>
+ </itemizedlist>
+ <para>You should now have two JSP pages in the diagram.</para>
+ </section>
+ </section>
+ <section id="CreatinganActionMappings">
+ <title>Creating an Action Mappings</title>
+ <para>Using a context menu on the diagram, we are next going to create an Action
+ mapping.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Right-click between the two icons and select <emphasis>
+ <property moreinfo="none">Add > Action</property>
+ </emphasis></para>
+ </listitem>
+ <listitem>
+ <para>Enter the following values:</para>
+ </listitem>
+ </itemizedlist>
+ <table>
+ <title>Action values</title>
+ <tgroup cols="2">
+ <tbody>
+ <row>
+ <entry>path</entry>
+ <entry>/greeting</entry>
+ </row>
+ <row>
+ <entry>name</entry>
+ <entry>GetNameForm</entry>
+ </row>
+ <row>
+ <entry>scope</entry>
+ <entry>request</entry>
+ </row>
+ <row>
+ <entry>type</entry>
+ <entry>sample.GreetingAction</entry>
+ </row>
+ <row>
+ <entry>validate</entry>
+ <entry><leave blank></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <para>("GetNameForm" is the name for a form bean that we will create
+ later.)</para>
+ <itemizedlist>
+ <listitem>
+ <para>Click <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis></para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The <emphasis>
+ <property moreinfo="none">/greeting</property>
+ </emphasis> action should appear in four places, in the diagram, under the
+ action-mappings node, under the struts-config.xml node in Tree view, in Web Projects
+ view and in the Outline view. Also, note the asterisk to the right of the name,
+ struts-config.xml, in the Outline view showing that the file has been changed, but
+ not saved to disk.</para>
+ </section>
+ <section id="CreatingaLink">
+ <title>Creating a Link</title>
+ <para>Let's now create a link from the inputname.jsp page to the action.</para>
+ <itemizedlist>
+ <listitem>
+ <para>On the left-hand side of the diagram in the column of icons, click on this
+ icon:</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Create New Connection Icon</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts_application/struts_application_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>In the connect-the-components mode you are in now, click on the <emphasis>
+ <property moreinfo="none">/pages/inputname.jsp</property>
+ </emphasis> icon in the diagram and then click on the <emphasis>
+ <property moreinfo="none">/greeting</property>
+ </emphasis> action</para>
+ </listitem>
+ </itemizedlist>
+ <para>A link will be created from the page to the action.</para>
+ </section>
+ <section id="CreatingaForward">
+ <title>Creating a Forward</title>
+ <para>Next, we are going to create a forward for the action.</para>
+ <itemizedlist>
+ <listitem>
+ <para>On the left-hand side of the diagram in the column of icons, click on this
+ icon, again:</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Create New Connection Icon</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts_application/struts_application_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>Click on the <emphasis>
+ <property moreinfo="none">/greeting</property>
+ </emphasis> action icon in the diagram and then click on the <emphasis>
+ <property moreinfo="none">pages/greeting.jsp</property>
+ </emphasis> icon</para>
+ </listitem>
+ <listitem>
+ <para>That's it. A link will be drawn from the actions new greeting
+ forward to the greeting.jsp JSP page. Note that the forwards name will be
+ set based on the name of the target JSP file name. If you don't
+ like it, you can easily change it</para>
+ </listitem>
+ <listitem>
+ <para>Select the <emphasis>
+ <property moreinfo="none">Tree</property>
+ </emphasis> tab at the bottom of the editor window (between Diagram and
+ Source)</para>
+ </listitem>
+ <listitem>
+ <para>Expand the <emphasis>
+ <property moreinfo="none">struts-config.xml/action-mappings//greeting</property>
+ </emphasis> node and then select the greeting forward</para>
+ </listitem>
+ <listitem>
+ <para>In the Properties Editor to the right, change the text to
+ "sayHello" in the Name field</para>
+ </listitem>
+ <listitem>
+ <para>Select the <emphasis>
+ <property moreinfo="none">Diagram</property>
+ </emphasis> tab at the bottom of the editor window and see how the diagram
+ is also updated to reflect the change</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="CreatingaGlobalForward">
+ <title>Creating a Global Forward</title>
+ <para>One last component that we need to create in the diagram is a global forward.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Somewhere in the top-left corner of diagram, right-click and select <emphasis>
+ <property moreinfo="none"> Add > Global Forward...</property>
+ </emphasis></para>
+ </listitem>
+ <listitem>
+ <para>Enter <emphasis>
+ <property moreinfo="none">getName</property>
+ </emphasis> in the Name field</para>
+ </listitem>
+ <listitem>
+ <para>Select the <emphasis>
+ <property moreinfo="none">Change...</property>
+ </emphasis>button for Path</para>
+ </listitem>
+ <listitem>
+ <para>In the Edit Path window, switch to the <emphasis>
+ <property moreinfo="none">Pages</property>
+ </emphasis> tab</para>
+ </listitem>
+ <listitem>
+ <para>Expand the <emphasis>
+ <property moreinfo="none">StrutsHello > WEB-ROOT (WebContent) > pages</property>
+ </emphasis> node and then select the inputname.jsp page</para>
+ </listitem>
+ <listitem>
+ <para>Click <emphasis>
+ <property moreinfo="none">Ok</property>
+ </emphasis>.</para>
+ </listitem>
+ <listitem>
+ <para>Leave the rest of the fields blank and click <emphasis>
+ <property moreinfo="none">OK</property>
+ </emphasis></para>
+ </listitem>
+ </itemizedlist>
+ <para>A forward object now appears on the diagram and also in the global-forwards folder
+ in the Outline view.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Tidy up the diagram, by clicking and dragging around each icon, so that
+ the diagram looks something like this:</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Diagram View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts_application/struts_application_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section id="CreatingaFormBean">
+ <title>Creating a Form Bean</title>
+ <para>One last thing that we need to do is to create a form bean.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Switch to the Tree viewer in the editor for the struts-config.xml file, by
+ selecting the <emphasis>
+ <property moreinfo="none">Tree</property>
+ </emphasis> tab at the bottom of the editor window</para>
+ </listitem>
+ <listitem>
+ <para>Right-click <emphasis>
+ <property moreinfo="none">struts-config.xml > form-beans</property>
+ </emphasis> and select Create Form Bean</para>
+ </listitem>
+ <listitem>
+ <para>Enter <emphasis>
+ <property moreinfo="none">GetNameForm</property>
+ </emphasis> in the name field and <emphasis>
+ <property moreinfo="none">sample.GetNameForm</property>
+ </emphasis> for type</para>
+ </listitem>
+ <listitem>
+ <para>Click <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis></para>
+ </listitem>
+ <listitem>
+ <para>To save your changes to struts-config.xml, select <emphasis>
+ <property moreinfo="none">File > Save</property>
+ </emphasis> from the menu bar</para>
+ </listitem>
+ </itemizedlist>
+ <para>Note the disappearance of the asterisk next to the name, struts-config.xml.</para>
+ </section>
+ </section>
+</chapter>
+
+<chapter id="generating_stub" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/struts/docs/struts_tools_tutorial/en/modules/generating_stub.xml" xreflabel="generating_stub">
+ <?dbhtml filename="generating_stub.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>Struts</keyword>
+ <keyword>Struts Application</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Generating Stub Coding</title>
+ <para>We are done with designing the application through the diagram. Now we need to write
+ code for the action component. We also need to write an action class for the <emphasis>
+ <property moreinfo="none">/greeting</property>
+ </emphasis> mapping along with a FormBean. To aid in the coding phase, JBoss Developer
+ Studio can generate Java class stubs for all of the components shown in the diagram.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Switch back to the diagram, by selecting the <emphasis>
+ <property moreinfo="none">Diagram</property>
+ </emphasis> tab at the bottom of the editor window</para>
+ </listitem>
+ <listitem>
+ <para>Right-click a blank space in the diagram and select <emphasis>
+ <property moreinfo="none">Generate Java Code</property>
+ </emphasis></para>
+ </listitem>
+ <listitem>
+ <para>Leave everything as is in the dialog box and click <emphasis>
+ <property moreinfo="none">Generate</property>
+ </emphasis></para>
+ </listitem>
+ </itemizedlist>
+ <para>You should see a screen that says:</para>
+ <para>Generated classes: 2</para>
+ <para>Actions: 1</para>
+ <para>Form beans: 1</para>
+ <itemizedlist>
+ <listitem>
+ <para>Click <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis></para>
+ </listitem>
+ </itemizedlist>
+ <para>The Java files will be generated in a <emphasis>
+ <property moreinfo="none">JavaSource > sample</property>
+ </emphasis> folder that you can see in the Package Explorer view under the
+ "StrutsHello" node. One Action stub and one FormBean stub will have
+ been generated.</para>
+ </chapter>
+
+<chapter id="coding_files" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/struts/docs/struts_tools_tutorial/en/modules/coding_files.xml" xreflabel="coding_files">
+ <?dbhtml filename="coding_files.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>Struts</keyword>
+ <keyword>Struts Application</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Coding the Various Files</title>
+ <para>We will now code both the Java stub classes just generated, the JSP files left in as
+ placeholders from previous steps, and a new start JSP page we will have to create.</para>
+ <section id="JavaStubClasses">
+ <title>Java Stub Classes</title>
+ <itemizedlist>
+ <listitem>
+ <para>To finish the two Java classes, switch to the <emphasis>
+ <property moreinfo="none">Package Explorer</property>
+ </emphasis> view and expand the <emphasis>
+ <property moreinfo="none">JavaSource > sample</property>
+ </emphasis> folder</para>
+ </listitem>
+ </itemizedlist>
+ <section id="GetNameForm.java">
+ <title>GetNameForm.java</title>
+ <itemizedlist>
+ <listitem>
+ <para>Double-click <emphasis>
+ <property moreinfo="none">GetNameForm.java</property>
+ </emphasis> for editing</para>
+ </listitem>
+
+ <listitem>
+ <para>You are looking at a Java stub class that was generated by JBoss
+ Developer Studio. Now we are going to edit the file</para>
+ </listitem>
+
+ <listitem>
+ <para>Add the following attributes at the beginning of the class:</para>
+ </listitem>
+ </itemizedlist>
+ <programlisting format="linespecific" role="JAVA"><![CDATA[private String name = "";
+ private String greetName = "";
+]]></programlisting>
+
+ <itemizedlist>
+ <listitem>
+ <para>Inside the reset method, delete the TO DO and throw lines and
+ add:</para>
+ </listitem>
+ </itemizedlist>
+ <programlisting format="linespecific" role="JAVA"><![CDATA[this.name = "";
+ this.greetName = "";
+]]></programlisting>
+
+ <itemizedlist>
+ <listitem>
+ <para>Inside the validate method, delete the TO DO and throw lines and
+ add:</para>
+ </listitem>
+ </itemizedlist>
+ <programlisting format="linespecific" role="JAVA"><![CDATA[ActionErrors errors = new ActionErrors();
+ return errors;
+]]></programlisting>
+
+ <itemizedlist>
+ <listitem>
+ <para>Right-click and select <emphasis>
+ <property moreinfo="none">Source > Generate Getters and Setters...</property>
+ </emphasis>from the context menu</para>
+ </listitem>
+ <listitem>
+ <para>In the dialog box, check the check boxes for name and greetName,
+ select First method for Insertion point, and click on the <emphasis>
+ <property moreinfo="none">OK</property>
+ </emphasis> button</para>
+ </listitem>
+ </itemizedlist>
+ <para>The final GetNameForm.java file should look like this:</para>
+ <programlisting format="linespecific" role="JAVA"><![CDATA[package sample;
+import javax.servlet.http.HttpServletRequest;
+import org.apache.struts.action.ActionErrors;
+import org.apache.struts.action.ActionMapping;
+
+public class GetNameForm extends org.apache.struts.action.ActionForm
+{
+
+ private String name = "";
+ private String greetName = "";
+
+ public String getName()
+ {
+ return name;
+ }
+ public void setName(String name)
+ {
+ this.name = name;
+ }
+
+ public String getGreetName()
+ {
+ return greetName;
+ }
+
+ public void setGreetName(String greetName)
+ {
+ this.greetName = greetName;
+ }
+
+ public GetNameForm()
+ {
+ }
+
+ public void reset(ActionMapping actionMapping, HttpServletRequest request)
+ {
+ this.name = "";
+ this.greetName = "";
+ }
+
+ public ActionErrors validate(ActionMapping actionMapping,
+ HttpServletRequest request)
+ {
+ ActionErrors errors = new ActionErrors();
+ return errors;
+ }
+}
+]]></programlisting>
+
+ <itemizedlist>
+ <listitem>
+ <para>Save the file</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="GreetingAction.java">
+ <title>GreetingAction.java</title>
+ <itemizedlist>
+ <listitem>
+ <para>Open GreetingAction.java for editing</para>
+ </listitem>
+ <listitem>
+ <para>Inside the execute method, delete the TO DO lines and add the
+ following:</para>
+ </listitem>
+ </itemizedlist>
+
+ <programlisting format="linespecific" role="JAVA"><![CDATA[String name = ((GetNameForm)form).getName();
+String greeting = "Hello, "+name+"!";
+((GetNameForm)form).setName(greeting);
+return mapping.findForward(FORWARD_sayHello);
+]]></programlisting>
+
+ <para>The final version of GreetingAction.java should look like this:</para>
+
+ <programlisting format="linespecific" role="JAVA"><![CDATA[package sample;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+import org.apache.struts.action.ActionForm;
+import org.apache.struts.action.ActionForward;
+import org.apache.struts.action.ActionMapping;
+
+public class GreetingAction extends org.apache.struts.action.Action
+{
+
+ // Global Forwards
+ public static final String GLOBAL_FORWARD_getName = "getName";
+
+ // Local Forwards
+ public static final String FORWARD_sayHello = "sayHello";
+
+ public GreetingAction()
+ {
+ }
+ public ActionForward execute(ActionMapping mapping, ActionForm form,
+ HttpServletRequest request, HttpServletResponse response) throws Exception
+ {
+ String name = ((GetNameForm)form).getName();
+ String greeting = "Hello, "+name+"!";
+ ((GetNameForm)form).setName(greeting);
+ return mapping.findForward(FORWARD_sayHello);
+ }
+}
+]]></programlisting>
+ <itemizedlist>
+ <listitem>
+ <para>Save the file</para>
+ </listitem>
+ <listitem>
+ <para>Close the editors for the two Java files</para>
+ </listitem>
+ </itemizedlist>
+ <para>The last thing left to do is to code the JSP files whose editors should still
+ be open from having been created as placeholders.</para>
+ </section>
+ </section>
+ <section id="JSPPages">
+ <title>JSP Pages</title>
+ <section id="inputname.jsp">
+ <title>inputname.jsp</title>
+ <para>In this page, the user will enter any name and click the <emphasis>
+ <property moreinfo="none">submit</property>
+ </emphasis> button. Then, the greeting action will be called through the form.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Click on the <emphasis>
+ <property moreinfo="none">inputname.jsp</property>
+ </emphasis> tab in the Editing area to bring its editor forward</para>
+ </listitem>
+ <listitem>
+ <para>In the Web Projects view, expand <emphasis>
+ <property moreinfo="none">StrutsHello > Configuration > default
+ > struts-config.xml > action-mappings</property>
+ </emphasis> and select <emphasis>
+ <property moreinfo="none">/greeting</property>
+ </emphasis></para>
+ </listitem>
+ <listitem>
+ <para>Drag it and drop it between the quotes for the <emphasis role="italic">
+ <property moreinfo="none">"action"</property>
+ </emphasis> attribute to the <emphasis role="bold">
+ <property moreinfo="none"><html:form></property>
+ </emphasis> element in the Source pane of the editor</para>
+ </listitem>
+ <listitem>
+ <para>Then type this text on a new line just below this line:</para>
+ <programlisting format="linespecific" role="XML"><![CDATA[Input name:
+ ]]></programlisting>
+ </listitem>
+
+ <listitem>
+ <para>Select the <emphasis>
+ <property moreinfo="none">Visual</property>
+ </emphasis> pane of the editor</para>
+ </listitem>
+ <listitem>
+ <para>Then, in the JBoss Tools Palette, expand the <emphasis>
+ <property moreinfo="none">Struts Form</property>
+ </emphasis> library, select <emphasis>
+ <property moreinfo="none">text</property>
+ </emphasis>, and drag it onto the box
+ <note>
+ <title>Note:</title>
+ <para>By default there are only four groups on the JBoss Tools
+ Palette. If you wish to make some group visible click the <emphasis>
+ <property moreinfo="none">Show/Hide</property>
+ </emphasis> button on the top of palette and in the prompted
+ dialog check the group (or groups) you want to be shown.</para>
+ </note>
+ </para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>JBoss Tools Palette</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts_application/struts_application_3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>In the Insert Tag dialog box, type in name for property and select <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis></para>
+ </listitem>
+ <listitem>
+ <para>In the StrutsForm library in the JBoss Tools Palette, select <emphasis>
+ <property moreinfo="none">submit</property>
+ </emphasis>, and drag it to right after the text box in the Visual pane
+ of the editor</para>
+ </listitem>
+ <listitem>
+ <para>Right-click the <emphasis>
+ <property moreinfo="none">submit</property>
+ </emphasis> button and select <emphasis role="bold">
+ <property moreinfo="none"><html:submit></property>
+ </emphasis> Attributes from the context menu</para>
+ </listitem>
+ <listitem>
+ <para>In the Attributes dialog box, select the <emphasis>
+ <property moreinfo="none">value</property>
+ </emphasis> field and type in "Say Hello!" for its
+ value</para>
+ </listitem>
+ </itemizedlist>
+ <para>After tidying the page source, the Editor window for the file should look
+ something like this:</para>
+ <figure float="0">
+ <title>Editor Window</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts_application/struts_application_4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section id="greeting.jsp">
+ <title>greeting.jsp</title>
+ <para>Next, we will fill in the result page.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Click on the <emphasis>
+ <property moreinfo="none">greeting.jsp</property>
+ </emphasis> tab in the Editing area to bring its editor forward</para>
+ </listitem>
+ <listitem>
+ <para>Type in the following code:</para>
+ </listitem>
+ </itemizedlist>
+ <programlisting format="linespecific" role="XML"><![CDATA[<html>
+<head>
+ <title>Greeting</title>
+</head>
+ <body>
+ <p>
+ </p>
+ </body>
+</html>
+]]></programlisting>
+
+ <para>To complete editing of this file, we will use macros from the JBoss Tools
+ Palette. This palette is a view that should be available to the right of the
+ editing area.</para>
+ <itemizedlist>
+ <listitem>
+ <para>Click on the <emphasis>
+ <property moreinfo="none">Struts Common</property>
+ </emphasis> folder in the JBoss Tools Palette to open it</para>
+ </listitem>
+ <listitem>
+ <para>Position the cursor at the beginning of the greeting.jsp file in the
+ Source pane and then click on bean taglib in the JBoss Tools
+ Palette</para>
+ </listitem>
+ </itemizedlist>
+ <para>This will insert the following line at the top of the file:</para>
+ <programlisting format="linespecific" role="JAVA"><![CDATA[
+<%@ taglib uri="/WEB-INF/struts-bean.tld" prefix="bean" %>
+]]></programlisting>
+ <itemizedlist>
+ <listitem>
+ <para>Click on the <emphasis>
+ <property moreinfo="none">Struts Bean</property>
+ </emphasis> folder in the JBoss Tools Palette to open it</para>
+ </listitem>
+ <listitem>
+ <para>Position the cursor inside the <emphasis role="bold">
+ <property moreinfo="none"><p></property>
+ </emphasis> element</para>
+ </listitem>
+ <listitem>
+ <para>Click on write in the JBoss Tools Palette</para>
+ </listitem>
+ <listitem>
+ <para>Type in "GetNameForm" for the <emphasis role="italic">
+ <property moreinfo="none">"name"</property>
+ </emphasis> attribute and add a <emphasis role="italic">
+ <property moreinfo="none">"property"</property>
+ </emphasis> attribute with "greetName" as its
+ value</para>
+ </listitem>
+ </itemizedlist>
+ <para>The editor should now look like this:</para>
+ <figure float="0">
+ <title>Editor Window</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts_application/struts_application_5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section id="index.jsp">
+ <title>index.jsp</title>
+ <para>Finally, we will need to create and edit an index.jsp page. This page will use
+ a Struts forward to simply redirect us to the getName global forward.</para>
+ <itemizedlist>
+ <listitem>
+ <para>In the Web Projects view, right-click on <emphasis>
+ <property moreinfo="none">StrutsHello > WEB-ROOT(WebContent)</property>
+ </emphasis> node and select <emphasis>
+ <property moreinfo="none">New > File > JSP..</property>
+ </emphasis></para>
+ </listitem>
+ <listitem>
+ <para>Type index for Name and click on the <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> button</para>
+ </listitem>
+ <listitem>
+ <para>On the JBoss Tools Palette, select the <emphasis>
+ <property moreinfo="none">Struts Common</property>
+ </emphasis> folder of macros by clicking on it in the palette</para>
+ </listitem>
+ <listitem>
+ <para>Click on the logic taglib icon</para>
+ </listitem>
+ <listitem>
+ <para>Press the <emphasis>
+ <property moreinfo="none">Enter</property>
+ </emphasis> key in the editor to go to the next line</para>
+ </listitem>
+ <listitem>
+ <para>Back on the palette, select the <emphasis>
+ <property moreinfo="none">Struts Logic</property>
+ </emphasis> folder of macros</para>
+ </listitem>
+ <listitem>
+ <para>Click on redirect</para>
+ </listitem>
+ <listitem>
+ <para>Delete the ending tag, put a forward slash in front of the closing
+ angle bracket, and type "forward=getName" in front of
+ the slash</para>
+ </listitem>
+ </itemizedlist>
+ <para>The finished code for the page is shown below:</para>
+ <programlisting format="linespecific" role="JAVA"><![CDATA[<%@ taglib uri="/WEB-INF/struts-logic.tld" prefix="logic" %>
+<logic:redirect forward="getName"/>
+]]></programlisting>
+ <itemizedlist>
+ <listitem>
+ <para>To save all the edits to files, select <emphasis>
+ <property moreinfo="none">File>Save All</property>
+ </emphasis> from the menu bar</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ </section>
+ </chapter>
+
+<chapter id="compiling_and_running" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/struts/docs/struts_tools_tutorial/en/modules/compiling_and_running.xml" xreflabel="compiling_and_running">
+ <?dbhtml filename="compiling_and_running.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>Struts</keyword>
+ <keyword>Struts Application</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Compiling the Classes and Running the Application</title>
+
+ <para>As this is the Eclipse environment, no explicit compilation step is required. By
+ default, Eclipse compiles as you go.</para>
+
+ <para>Thus at this point everything is ready for running our application without having to leave JBoss
+ Developer Studio by using the JBoss Application Server engine that comes with the JBoss
+ Developer Studio. For controlling JBoss AS within JBoss Developer Studio, there is JBoss
+ Server view.</para>
+ <figure float="0">
+ <title>JBoss Server Panel</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts_application/struts_application_6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>Start up JBoss AS by clicking on the icon in JBoss Server view. (If JBoss AS
+ is already running, stop it by clicking on the red icon and then start it again.
+ Remember, the Struts run-time requires restarting the servlet engine when any
+ changes have been made.)</para>
+ </listitem>
+ <listitem>
+ <para>After the messages in the Console tabbed view stop scrolling, JBoss AS is
+ available. At this point, right-click on the getName global forward in the
+ struts-config.xml diagram view and select Run on Server.</para>
+ </listitem>
+ </itemizedlist>
+ <para>The browser should appear with the application started.</para>
+ </chapter>
+
+<chapter id="struts_validation" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/struts/docs/struts_tools_tutorial/en/modules/struts_validation.xml" xreflabel="struts_validation">
+ <?dbhtml filename="struts_validation.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Struts</keyword>
+ <keyword>Struts Validation</keyword>
+ </keywordset>
+ </chapterinfo>
+<title>Struts Validation Examples</title>
+
+<para><property moreinfo="none">Validation</property> of input is an important part of any Web application. All Apache Jakarta frameworks,
+including Struts, can use a common Jakarta Validation Framework for streamlining this aspect of Web
+application development. The Validation Framework allows you to define validation rules and then apply these rules on the client-side or the server-side.</para>
+
+ <para>JBoss Developer Studio makes using the <property moreinfo="none">Validation Framework</property> in Struts even easier with the help of a specialized editor for the XML files that controls validation in a project. In this document, we'll show you how this all works by creating some simple client-side validation and server-side validation examples.</para>
+
+<section id="StartingPoint">
+<?dbhtml filename="StartingPoint.html"?>
+<title>Starting Point</title>
+<para>The example assumes that you have already created our sample "StrutsHello" application from the
+Getting Started Guide for Creating a Struts Application. You should have the JBoss Developer Studio perspective
+ open on this StrutsHello project.</para>
+</section>
+
+<section id="DefiningTheValidationRule">
+<?dbhtml filename="DefiningTheValidationRule.html"?>
+<title>Defining the Validation Rule</title>
+<para>In these steps you will set up the validation that can be used for either client-side or
+server side validation. You need to enable validation as a part of the project, define an error message, and tie it into an appropriate part of the application.</para>
+
+<itemizedlist>
+<listitem><para>Right-click on a "plug-ins" node under the <emphasis><property moreinfo="none">StrutsHello > Configuration > default > struts-config.xml</property></emphasis> node in the Web Projects view and select <emphasis><property moreinfo="none">Create Special Plugin > Validators</property></emphasis> from the context menu</para></listitem>
+<listitem><para>Further down in the Web Projects view, right-click on the
+<emphasis><property moreinfo="none">StrutsHello > ResourceBundles</property></emphasis> node and select <emphasis><property moreinfo="none"> New > Properties File...</property></emphasis>from the context menu</para></listitem>
+<listitem><para>In the dialog box, click on the <emphasis><property moreinfo="none">Browse...</property></emphasis>button next to the Folder field, expand the
+ JavaSource folder in this next dialog box, select the sample subfolder, and click on the <emphasis><property moreinfo="none">OK</property></emphasis> button</para></listitem>
+ <listitem><para>Back in the first dialog box, type in "applResources" for the Name field and click on the <emphasis><property moreinfo="none">Finish</property></emphasis> button</para></listitem>
+<listitem><para>Right-click on a newly created file and select <emphasis><property moreinfo="none">Add > Default Error Messages</property></emphasis>
+ from the context menu</para></listitem>
+
+<listitem><para>Drag up the sample.applResources icon until you can drop it on the resources folder under struts-config.xml</para></listitem>
+<listitem><para>Select<emphasis><property moreinfo="none"> File > Save </property></emphasis>All from the menu bar</para></listitem>
+<listitem><para>Select validation.xml under the <emphasis><property moreinfo="none">StrutsHello > Validation</property></emphasis> node and double-click it to open it with the JBoss Tools XML Editor</para></listitem>
+<listitem><para>Here you must create a Formset.</para></listitem>
+<listitem><para>In the validation.xml file editor click the button <emphasis><property moreinfo="none">Create Formset</property></emphasis> on the panel <emphasis><property moreinfo="none">Formsets</property></emphasis></para></listitem>
+<listitem><para>In the dialog <emphasis><property moreinfo="none">Add Formset</property></emphasis> fill the fields <emphasis><property moreinfo="none">Language</property></emphasis> and <emphasis><property moreinfo="none">Country</property></emphasis> or just leave them empty to create a default formset. Click <emphasis><property moreinfo="none">OK</property></emphasis></para></listitem>
+</itemizedlist>
+<figure float="0">
+ <title>Create Formset</title>
+<mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts_validation/struts_validation.png"></imagedata>
+ </imageobject>
+</mediaobject>
+</figure>
+<itemizedlist>
+<listitem><para>Expand the "form-beans" node under the <emphasis><property moreinfo="none">StrutsHello > Configuration > default > struts-config.xml node.</property></emphasis> Then, drag the form bean "GetNameForm" and drop it onto a formset in the <property moreinfo="none">XML</property> Editor</para></listitem>
+<listitem><para>In the Validation Editor, expand the formset node, right-click GetNameForm, and select <emphasis><property moreinfo="none">Create Field...</property></emphasis> from the context menu</para></listitem>
+<listitem><para>Enter a name for Property in the dialog box. A new property will be created:</para></listitem>
+</itemizedlist>
+<figure float="0">
+ <title>New Property Is Added</title>
+<mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts_validation/struts_validation_2.png"></imagedata>
+ </imageobject>
+</mediaobject>
+</figure>
+<itemizedlist>
+<listitem><para>In the Properties view for the name field to the right of the "tree" for the validation.xml file, click on the <emphasis><property moreinfo="none">Change...</property></emphasis>button next to the Depends entry field</para></listitem>
+<listitem><para>In the displayed double list, select <emphasis><property moreinfo="none">required</property></emphasis> from the left list and then click <emphasis><property moreinfo="none">Add</property></emphasis></para></listitem>
+ <listitem><para>Click <emphasis><property moreinfo="none">Ok</property></emphasis></para></listitem>
+<listitem><para>Right-click name and select <emphasis><property moreinfo="none">Add Arg...</property></emphasis> from the context menu</para></listitem>
+<listitem><para>In the Add Arg dialog box, click on the <emphasis><property moreinfo="none">Change...</property></emphasis>button next to the <emphasis><property moreinfo="none">Key</property></emphasis> field</para></listitem>
+ <listitem><para>In the Key dialog box that appears now, click on the <emphasis><property moreinfo="none">Add</property></emphasis> button</para></listitem>
+ <listitem><para>Enter "name.required" in the Name field, and enter a person's name in the Value field</para></listitem>
+ <listitem><para>Click <emphasis><property moreinfo="none">Finish</property></emphasis>, then <emphasis><property moreinfo="none">Ok</property></emphasis>, and then <emphasis><property moreinfo="none">Ok</property></emphasis> again</para></listitem>
+<listitem><para>Select <emphasis><property moreinfo="none">File > Save All</property></emphasis> from the menu bar</para></listitem>
+</itemizedlist>
+</section>
+
+<section id="Client-SideValidation">
+<?dbhtml filename="Client-SideValidation.html"?>
+<title>Client-Side Validation</title>
+<para>Client-side <property moreinfo="none">validation</property> uses a scripting language (like JavaScript) running in the client browser to actually do the <property moreinfo="none">validation</property>. In a Struts application using the <property moreinfo="none">Validation</property> Framework, however, you don't actually have to do any of the script coding. The <property moreinfo="none">Validation</property> Framework handles this.</para>
+<para>To see how this works in our application, you'll just need to make a couple of modifications to one of the JSP files.</para>
+<itemizedlist>
+<listitem><para>Double-click inputname.jsp under <emphasis><property moreinfo="none">StrutsHello > WEB-ROOT(WebContent) > pages</property></emphasis> to open it for editing</para></listitem>
+<listitem><para>Find the tag near the top and hit Return to make a new line under it</para></listitem>
+ <listitem><para>In the JBoss Tools Palette view to the right, open the Struts HTML folder and click on the javascript tag</para></listitem>
+<listitem><para>Back in the editor, just in front of the closing slash for this inserted tag, hit Ctrl+Space and select "formName" from the prompting menu</para></listitem>
+<listitem><para>Over in the Web Projects view, select GetNameForm under the <emphasis><property moreinfo="none">StrutsHello > Configuration > default > struts-config.xml > form-beans</property></emphasis> node, drag it, and drop it between the quotes in the editor</para></listitem>
+<listitem><para>Modify the <emphasis role="bold"><property moreinfo="none"><html:form></property></emphasis> tag by inserting this attribute:</para></listitem>
+</itemizedlist>
+<programlisting format="linespecific" role="XML"><![CDATA[onsubmit="return validateGetNameForm(this)"
+]]></programlisting>
+<para></para>
+<para>The file should now look like this:</para>
+<programlisting format="linespecific" role="XML"><![CDATA[
+<%@ taglib uri="/WEB-INF/struts-html.tld" prefix="html" %>
+<html:html>
+<head>
+ <title>Input name</title>
+ <html:javascript formName="GetNameForm"/>
+</head>
+<body>
+ <html:form action="/greeting.do" onsubmit="return
+ <para>validateGetNameForm(this)"></para>
+ <table border="0" cellspacing="0" cellpadding="0">
+ <tr>
+ <td><b>Input name:</b></td>
+ </tr>
+ <tr>
+ <td>
+ <html:text property="name" />
+ <html:submit value=" Say Hello! " />
+ </td>
+ </tr>
+ </table>
+ </html:form>
+</body>
+</html:html>
+]]></programlisting>
+<itemizedlist>
+<listitem><para>Select<emphasis><property moreinfo="none"> File > Save </property></emphasis>from the menu bar</para></listitem>
+<listitem><para>Start JBoss Application Server by clicking on its icon (a right-pointing arrow) in the toolbar</para></listitem>
+<listitem><para>Click the Run icon or right click your project folder and select <emphasis><property moreinfo="none">Run As > Run on Server</property></emphasis></para></listitem>
+</itemizedlist>
+<figure float="0">
+ <title>Run Icon</title>
+<mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts_validation/struts_validation_1.png"></imagedata>
+ </imageobject>
+</mediaobject>
+</figure>
+<itemizedlist><listitem><para>In the browser window, click on the "Say Hello!" button without having entered any name in the form</para></listitem></itemizedlist>
+<para>A JavaScript error message should be displayed in an alert box.</para>
+</section>
+<section id="Server-SideValidation">
+<?dbhtml filename="Server-SideValidation.html"?>
+<title>Server Side Validation</title>
+<para>Server side validation does the validation inside the application on the server. In a Struts application using the Validation Framework, you still don't have to do any of the actual validation coding. The Validation Framework handles this. You will though have to make a few changes to the JSP file you modified for client-side validation along with a change to an action and a few changes to the form bean class.</para>
+</section>
+
+<section id="EditingTheJSPFile">
+<?dbhtml filename="EditingTheJSPFile.html"?>
+<title>Editing the JSP File</title>
+<itemizedlist>
+<listitem><para>Reopen inputname.jsp for editing</para></listitem>
+<listitem><para>Delete the <emphasis role="italic"><property moreinfo="none">"onsubmit"</property></emphasis> attribute in the <emphasis role="bold"><property moreinfo="none"><html:form></property></emphasis> element that you put in for client-side validation</para></listitem>
+
+<listitem><para>Add an <emphasis role="bold"><property moreinfo="none"><html:errors></property></emphasis> tag after the <emphasis role="bold"><property moreinfo="none"><html:form></property></emphasis> tag</para></listitem>
+</itemizedlist>
+<para>The JSP file should now look like this:</para>
+
+<programlisting format="linespecific" role="XML"><![CDATA[<%@ taglib uri="/WEB-INF/struts-html.tld" prefix="html" %>
+<html:html>
+<head>
+ <title>Input name</title>
+ <html:javascript formName="GetNameForm"/>
+</head>
+<body>
+ <html:form action="/greeting.do">
+ <table border="0" cellspacing="0" cellpadding="0">
+ <tr>
+ <td><b>Input name:</b></td>
+ </tr>
+ <tr>
+ <td>
+ <html:text property="name" />
+ <html:submit value=" Say Hello! " />
+ </td>
+ </tr>
+ </table>
+ </html:form>
+ <html:errors />
+</body>
+</html:html>
+]]></programlisting>
+
+</section>
+
+<section id="EditingTheAction">
+<?dbhtml filename="EditingTheAction.html"?>
+<title>Editing the Action</title>
+<itemizedlist>
+<listitem><para>In the Web Projects view, expand the node under the <emphasis><property moreinfo="none">StrutsHello > Configuration > default > struts-config.xml > action-mappings</property></emphasis> node, right-click the <emphasis><property moreinfo="none">/greeting</property></emphasis> action, and then select <emphasis><property moreinfo="none">Properties...</property></emphasis>from the context menu</para></listitem>
+
+ <listitem><para>In the Edit Properties window, insert the cursor into the value column for the input property and click on the <property moreinfo="none">...</property> button</para></listitem>
+
+ <listitem><para>In the dialog box, make sure the Pages tab is selected, select <emphasis><property moreinfo="none">StrutsHello > WEB-ROOT(WebContent) > pages > inputname.jsp</property></emphasis>, click the <emphasis><property moreinfo="none">Ok</property></emphasis> button, and then click on the <emphasis><property moreinfo="none">Close</property></emphasis> button</para></listitem>
+</itemizedlist>
+</section>
+<section id="EditingTheFormBean">
+<?dbhtml filename="EditingTheFormBean.html"?>
+
+<title>Editing the Form Bean</title>
+<itemizedlist>
+<listitem><para>Right-click the <emphasis><property moreinfo="none">/greeting</property></emphasis> action again and select Open Form-bean Source to open the GetNameForm.java file for editing</para></listitem>
+<listitem><para>Change the class that it extends from: <emphasis><property moreinfo="none">org.apache.struts.action.ActionForm</property></emphasis> to <emphasis><property moreinfo="none">org.apache.struts.validator.ValidatorForm</property></emphasis></para></listitem>
+<listitem><para>Comment out a validate method</para></listitem>
+</itemizedlist>
+<para>The file should now look like this:</para>
+<programlisting format="linespecific" role="JAVA"><![CDATA[package sample;
+import javax.servlet.http.HttpServletRequest;
+import org.apache.struts.action.ActionErrors;
+import org.apache.struts.action.ActionMapping;
+public class GetNameForm extends
+
+org.apache.struts.validator.ValidatorForm
+{
+
+ private String name = "";
+
+ /**
+ * @return Returns the name.
+ */
+ public String getName()
+ {
+ return name;
+ }
+
+ /**
+ * @param name The name to set.
+ */
+ public void setName(String name)
+ {
+ this.name = name;
+ }
+
+ public GetNameForm ()
+ {
+ }
+
+ public void reset(ActionMapping actionMapping,
+ HttpServletRequest request)
+ {
+ this.name = "";
+ }
+
+ // public ActionErrors validate(ActionMapping actionMapping,
+ HttpServletRequest request)
+ {
+ // ActionErrors errors = new ActionErrors();
+ // return errors;
+ // }
+ }
+]]></programlisting>
+
+<itemizedlist>
+<listitem><para>Select <emphasis><property moreinfo="none">File > Save All </property></emphasis>from the menu bar</para></listitem>
+<listitem><para>Reload the application into JBoss AS by clicking on the "Change Time Stamp" icon (a finger pointing with a little star) in the toolbar</para></listitem>
+<listitem><para>Run the application</para></listitem>
+<listitem><para>In the browser window, click on the "Say Hello!" button without having entered any name in the form</para></listitem>
+</itemizedlist>
+<para>The error message should appear in a refreshed version of the form.</para>
+</section>
+
+</chapter>
+
+<chapter id="relevant_resources" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/struts/docs/struts_tools_tutorial/en/modules/relevant_resources.xml" xreflabel="relevant_resources">
+ <?dbhtml filename="relevant_resources.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>Struts</keyword>
+ <keyword>Struts Application</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Other Relevant Resources on the topic</title>
+
+ <para>Our reference: <ulink url="../../struts_tools_ref_guide/html_single/index.html">Struts Tools Reference Guide</ulink></para>
+ <para>Apache Struts: <ulink url="http://struts.apache.org/">Struts Technology</ulink></para>
+ <para>Struts 2: <ulink url="http://struts.apache.org/2.x/">Apache Struts 2</ulink></para>
+ <para>Get Started: <ulink url="http://struts.apache.org/2.x/docs/home.html">Struts Getting
+ Started</ulink></para>
+ <para>Struts on IBM: <ulink url="http://www.ibm.com/developerworks/library/j-struts/">Struts -
+ An open-source MVC implementation</ulink></para>
+ <para>FAQ: <ulink url="http://struts.apache.org/2.x/docs/faqs.html">Struts FAQ</ulink></para>
+ <para>Download: <ulink url="http://struts.apache.org/download.cgi#struts206">Release of Apache
+ Struts</ulink></para>
+
+ <para>Thus, this tutorial should help you to execute the hole development circle for building a
+ sample Struts-based Web application using <property moreinfo="none">JBoss Tools</property> bundle of Eclipse
+ plugins starting from organizing a new Struts project and ending with the running and
+ deploying it onto the <property moreinfo="none">JBoss Server</property>.</para>
+
+ <para>To find out all the features of <property moreinfo="none">JBoss Tools</property> for working with Struts
+ refer to our <ulink url="../../struts_tools_ref_guide/html_single/index.html">Struts Tools Reference Guide</ulink>. If you
+ still have questions you are always welcome on <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss
+ Tools Forum</ulink>.</para>
+</chapter>
+
+
+
+</book>
15 years, 3 months
JBoss Tools SVN: r14146 - branches/jbosstools-3.0.x/struts/docs/struts_tools_ref_guide/en.
by jbosstools-commits@lists.jboss.org
Author: ochikvina
Date: 2009-03-10 10:38:48 -0400 (Tue, 10 Mar 2009)
New Revision: 14146
Added:
branches/jbosstools-3.0.x/struts/docs/struts_tools_ref_guide/en/master_output.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-655 - adding master_output.xml;
Added: branches/jbosstools-3.0.x/struts/docs/struts_tools_ref_guide/en/master_output.xml
===================================================================
--- branches/jbosstools-3.0.x/struts/docs/struts_tools_ref_guide/en/master_output.xml (rev 0)
+++ branches/jbosstools-3.0.x/struts/docs/struts_tools_ref_guide/en/master_output.xml 2009-03-10 14:38:48 UTC (rev 14146)
@@ -0,0 +1,1262 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.docbook.org/xml/4.3/docbookx.dtd"
+
+[
+<!ENTITY introduction SYSTEM "modules/introduction.xml">
+<!ENTITY projects SYSTEM "modules/projects.xml">
+<!ENTITY editors SYSTEM "modules/editors.xml">
+<!ENTITY modules SYSTEM "modules/modules.xml">
+<!ENTITY code_generation SYSTEM "modules/code_generation.xml">
+<!ENTITY config_file_debugger SYSTEM "modules/config_file_debugger.xml">
+<!ENTITY page_links_recognizer SYSTEM "modules/page_links_recognizer.xml">
+<!ENTITY project_verification SYSTEM "modules/project_verification.xml">
+<!ENTITY rel_resources_links SYSTEM "modules/rel_resources_links.xml">
+
+<!ENTITY seamlink "../../seam/html_single/index.html">
+<!ENTITY aslink "../../as/html_single/index.html">
+<!ENTITY esblink "../../esb_ref_guide/html_single/index.html">
+<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html">
+<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html">
+<!ENTITY jbpmlink "../../jbpm/html_single/index.html">
+<!ENTITY jsflink "../../jsf/html_single/index.html">
+<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html">
+<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html">
+<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html">
+<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html">
+<!ENTITY migrationlink "../../Exadel-migration/html_single/index.html">
+
+]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
+ <bookinfo>
+ <title>Struts Tools Reference Guide</title>
+
+ <author><firstname>Anatoly</firstname><surname>Fedosik</surname></author>
+ <author><firstname>Olga</firstname><surname>Chikvina</surname></author>
+ <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author>
+
+ <pubdate>April 2008</pubdate>
+ <copyright>
+ <year>2007</year>
+ <year><diffmk:wrapper diffmk:change="changed">2009</diffmk:wrapper></year>
+ <holder><diffmk:wrapper diffmk:change="changed">JBoss, a division of Red Hat</diffmk:wrapper></holder>
+ </copyright>
+ <releaseinfo><diffmk:wrapper diffmk:change="changed">
+ Version: 3.0.0.GA
+ </diffmk:wrapper></releaseinfo>
+
+<abstract>
+ <title></title>
+ <para>
+ <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/struts_tools_ref_gui...">PDF version</ulink>
+ </para>
+</abstract>
+
+
+ </bookinfo>
+
+ <toc></toc>
+
+
+<chapter id="intoduction" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/struts/docs/struts_tools_ref_guide/en/modules/introduction.xml">
+ <?dbhtml filename="introduction.html"?>
+
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Introduction</title>
+
+ <para>If you prefer to develop web applications using Struts technology JBoss Tools also meet
+ your needs. The professional developer toolset provides all necessary editors and wizards
+ for creating Struts resources that enhances the process of building high-quality web
+ applications.</para>
+ <note>
+ <title>Note:</title>
+ <para>Note that JBoss Tools support the Struts 1.1, 1.2.x versions.</para>
+ </note>
+
+ <para>In this guide you will learn how to take advantage of Struts support that <property moreinfo="none">JBoss Tools</property>
+ provide.</para>
+
+ <section id="struts_key_features">
+ <title>Key Features of Struts Tools</title>
+
+ <para>For a start, we propose you to look through the table of main features of Struts
+ Tools:</para>
+
+ <table>
+
+ <title>Key Functionality for Struts Tools</title>
+ <tgroup cols="3">
+
+ <colspec align="left" colnum="1" colwidth="2*"></colspec>
+ <colspec colnum="2" colwidth="4*"></colspec>
+ <colspec align="left" colnum="3" colwidth="2*"></colspec>
+
+ <thead>
+ <row>
+ <entry>Feature</entry>
+ <entry>Benefit</entry>
+ <entry>Chapter</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry><para>Struts Support</para></entry>
+ <entry><para>Step-by-step wizards for creating a new struts project with a number
+ of predefined templates, importing existing ones and adding struts
+ capabilities to non-struts web projects.</para></entry>
+ <entry>
+ <link linkend="projects">struts support</link>
+ </entry>
+ </row>
+
+ <row>
+ <entry><para>Support for Struts Configuration File</para></entry>
+ <entry><para>Working on file using three modes: diagram, tree and source.
+ Synchronization between the modes and full control over the code. Easy
+ moving around the diagram using the Diagram Navigator. Working with
+ struts projects that have multiple modules. Possibility to use Struts
+ configuration file debugger allowing to set break points on struts
+ diagram and then launch the server in debug mode.</para></entry>
+ <entry>
+ <link linkend="struts_config_editor">graphical editor for struts</link>
+ <link linkend="config_file_debugger">configuration file debugger</link>
+ </entry>
+ </row>
+
+ <row>
+ <entry><para>Support for Struts modules</para></entry>
+ <entry><para>A Struts module (struts-config.xml) is automatically created while
+ creating a new project. There is also possibility to add new ones or edit
+ already existing modules in your existing project or while importing Struts project.</para></entry>
+ <entry>
+ <link linkend="modules">modules</link>
+ </entry>
+ </row>
+
+ <row>
+ <entry><para>Verification and Validation</para></entry>
+ <entry><para>All occuring errors will be immediately reported by verification
+ feature, no matter in what view you are working. Constant validation and
+ errors checking allows to catch many of the errors during development
+ process that significantly reduces development time.</para></entry>
+ <entry>
+ <link linkend="project_verification">verification and validation</link>
+ </entry>
+
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ </section>
+
+ <section>
+ <title>Other relevant resources on the topic</title>
+
+ <para>All JBoss Developer Studio/JBoss Tools documentation you can find <ulink url="http://docs.jboss.org/tools/">here</ulink>.</para>
+ <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">here</ulink>.</para>
+
+ </section>
+
+</chapter>
+
+
+<chapter id="projects" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/struts/docs/struts_tools_ref_guide/en/modules/projects.xml">
+ <?dbhtml filename="projects.html"?>
+
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Projects</title>
+
+ <para>JBoss Tools provide the following functionality when working with Struts:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Create new <property moreinfo="none">Struts projects</property></para>
+ </listitem>
+ <listitem>
+ <para>Import (open) existing Struts projects. You can import any project
+ structure</para>
+ </listitem>
+ <listitem>
+ <para>Add <property moreinfo="none">Struts capabilities</property> to any existing Eclipse
+ project</para>
+ </listitem>
+ <listitem>
+ <para>Import and add Struts capabilities to any existing project created outside
+ Eclipse.</para>
+ </listitem>
+ </itemizedlist>
+ <para>Now, we'll focus on all these points more fully.</para>
+
+ <section id="CreatingANewStrutsProjec745t">
+
+ <title>Creating a New Struts Project</title>
+
+
+ <para>JBoss Tools provides a New Struts Project Wizard that radically simplifies the process
+ for getting started with a new Struts project. You just need to follow these steps:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Select<emphasis>
+ <property moreinfo="none">File > New > Project...</property>
+ </emphasis> from the menu bar. Then, select <emphasis>
+ <property moreinfo="none">JBoss Tools Web > Struts > Struts Project</property>
+ </emphasis> in this dialog box. Click <emphasis>
+ <property moreinfo="none">Next</property>: </emphasis></para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Selecting Struts Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>On this form, provide the <property moreinfo="none">Project Name</property>. You can also
+ select where to create the project or use the default path.</para>
+ <para>Next to <property moreinfo="none">Struts Environment</property> set which Struts version to
+ use.</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Creating Struts Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <tip>
+ <title>Tip:</title>
+ <para>Don't put spaces in project names since some OS could experience problems
+ with their processing and searching these files.</para>
+ </tip>
+
+ <para>You can select the KickStart template, then the project created will include a simple
+ Hello World type application that is ready to run.</para>
+
+ <figure float="0">
+ <title>Choosing Struts Template </title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_3_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Next, you register this application with the current servlet container defined
+ for your workspace (JBoss AS, by default) in order to allow you to test your
+ application more easily while still developing it. A new entry will be added in
+ the servlet container configuration file to enable running the application
+ in-place (called null deployment or link deployment). Uncheck the <emphasis role="italic">
+ <property moreinfo="none">"Target Server"</property>
+ </emphasis> check box if for some reason you don't want to register
+ your application at this point.</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Registering The Project at Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>On the next form, you can select the TLD files to include in this
+ project:</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Selecting Tag Libraries</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>After the project is created, you should have the following project structure (if you
+ used the KickStart template):</para>
+
+ <figure float="0">
+ <title>Project Structure</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <tip>
+ <title>Tip:</title>
+ <para>If you want to hide the jar files from Web App Libraries in view, select the
+ down-pointing arrow in the upper right corner, select
+ <emphasis>Filters...</emphasis>, check the box next to Name filter patterns
+ (matching names will be hidden), and type *.jar into the field. Then, click OK.
+ </para>
+ </tip>
+ </section>
+ <section id="ImportingAnExistingStrutsProjectWithAnyStructure9653">
+
+ <title>Importing an Existing Struts Project with Any Structure</title>
+
+ <para>For detailed information on migration projects to JBoss Developer Studio see <ulink url="../../Exadel-migration/html_single/index.html">Migration Guide</ulink>.</para>
+
+ </section>
+ <section id="AddingStrutsCapabilityToAnExistingWebApplication532">
+
+ <title>Adding Struts Capability to an Existing Web Application</title>
+
+ <para>Here, we'll consider how to add Struts functionality (Struts libraries, tag
+ libraries and a Struts configuration file) to any existing Web application project in
+ your Eclipse workspace.</para>
+
+ <para>By adding a Struts Nature to your project, you can now edit files using JBoss Tools
+ editors, such as the <link linkend="struts_config_editor">Struts configuration
+ editor</link> and the JBoss Tools JSP editor. To take advantage of this just right-click
+ the project and select <emphasis>
+ <property moreinfo="none">JBoss Tools > Add Struts Capabilities</property>
+ </emphasis> from the context menu. This will start the process of adding all necessary
+ libraries and files to make a Web Struts project from your one.</para>
+
+ <figure float="0">
+ <title>Adding Struts Capabilities</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_7.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>In the wizard you should point to location of your deployment descriptor file web.xml
+ and name of the project.</para>
+
+ <figure float="0">
+ <title>Choosing Project Location</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_8.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>After hitting <emphasis>
+ <property moreinfo="none">Next</property>, </emphasis> you will see the following screen. This
+ screen simply means that you need to add at least one Struts module to your project to
+ make this project a Struts project. Adding a Struts module means that a new
+ struts-config.xml will be added to your project and registered in the web.xml file. In
+ addition, all required Struts libraries will be added. To add a Struts module, select
+ the <emphasis>
+ <property moreinfo="none">Add Struts Support</property>
+ </emphasis> button.</para>
+ <figure float="0">
+ <title>Project Modules</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_9.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Here you can select what Struts <property moreinfo="none">Version</property>, <property moreinfo="none">Servlet
+ Class</property>, <property moreinfo="none">URL Pattern</property> and <property moreinfo="none">TLD</property>s to add
+ to this project.</para>
+
+ <figure float="0">
+ <title>Selecting Struts Support Options</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_10.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>When done, you will see the default Struts module configuration information. See how
+ to Edit <link linkend="modules">Struts modules</link>.</para>
+
+ <figure float="0">
+ <title>Project Configuration Information</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_11.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>On the last screen you can set the different folders for your project as well as
+ register this application with a servlet container. If you want the libraries (.jar
+ files) will be automatically added to your project, click on the checkbox <emphasis>
+ <property moreinfo="none">Add Libraries</property>.</emphasis></para>
+
+ <figure float="0">
+ <title>Registering the Project at Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_12.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>When done, you can open end edit the struts-config.xml file using usefull Struts
+ configuration file editor provided by JBDS. (The Struts configuration is shown below in
+ the Tree viewer).</para>
+
+ <figure float="0">
+ <title>Struts-config.xml File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_13.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+</chapter>
+
+
+<chapter id="editors" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/struts/docs/struts_tools_ref_guide/en/modules/editors.xml">
+ <?dbhtml filename="editors.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Struts Tools</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Editors</title>
+ <para>In this chapter we'll introduce you to featured graphical editors for specific
+ Struts files such as Struts Configuration files, Tiles files and Struts Validation files.</para>
+ <section id="struts_config_editor">
+
+ <title>Graphical Editor for Struts Configuration Files</title>
+ <para>First, let's dwell on the Struts Configuration file editor.</para>
+ <para>This editor has three views with different representation of <emphasis>
+ <property moreinfo="none">struts-config.xml</property>: </emphasis>Diagram, Tree and Source. The
+ views can be selected via the tabs at the bottom of the editor. Any changes made in one
+ view are immediately visible when you switch to any other view.</para>
+
+ <para>Now, we'll consider every view in more detail.</para>
+ <section id="StrutsDiagramMode453">
+
+ <title>Diagram View</title>
+
+ <para>The Diagram view graphically displays the Web flow of the application defined in
+ the Struts configuration file.</para>
+
+ <figure float="0">
+ <title>Diagram View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_14.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The Diagram view allows to edit navigation in your Struts application. Just by
+ right-clicking anywhere on the diagram, you can use a context menu to create the
+ building blocks of a Struts application:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Actions</para>
+ </listitem>
+ <listitem>
+ <para>Global forwards</para>
+ </listitem>
+ <listitem>
+ <para>Global exceptions</para>
+ </listitem>
+ <listitem>
+ <para>JSP Pages</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Diagram Context Menu</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_15.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Along the upper-left side of the editor is a stack of seven icons for changing the
+ behavior of the cursor in the diagram. </para>
+
+ <figure float="0">
+ <title>Editor Icons</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_16.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The first icon switches to the default regular selection cursor, the second to the
+ marquee selection cursor and the third to the new connection cursor. The last four
+ icons switch the cursor to an insert cursor for each type of Struts build block
+ listed above (and in the order listed).</para>
+
+ <para>For instance, clicking on the first of these four icons (the one with the gears)
+ will switch the cursor to insert actions. Clicking anywhere in the diagram with this
+ cursor has the same effect as right-click and selecting <emphasis>
+ <property moreinfo="none">Add > Action...</property>
+ </emphasis> from the context menu with the regular cursor active. It's just
+ more efficient to use this cursor if you're adding more than one action at
+ once.</para>
+
+
+ </section>
+ <section id="StrutsTreeMode42">
+
+ <title>Tree View</title>
+
+ <para>The Tree view represents the different elements of the Struts application that are
+ organized into functional categories on the left-hand side and a form for editing
+ the properties of currently selected items on the right-hand side.</para>
+
+ <figure float="0">
+ <title>Tree View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_17.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>You can also right-click on any node in the category tree and perform appropriate
+ operations through a context menu. For instance, by right-clicking on the
+ action-mappings category node, you can add new actions to the application.</para>
+
+ <figure float="0">
+ <title>Tree Context Menu</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_18.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section id="StrutsSourceMode9655">
+
+ <title>Source View</title>
+
+ <para>In the Source view, you have complete editing control of the underlying XML
+ coding.</para>
+
+ <figure float="0">
+ <title>Source View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_19.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>When working in Source view, you always have all the following features available:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Content Assist</para>
+ </listitem>
+ <listitem>
+ <para>Open On Selection</para>
+ </listitem>
+ <listitem>
+ <para>File Folding</para>
+ </listitem>
+ </itemizedlist>
+ <para>You can take advantage of <ulink url="../../jsf/html_single/index.html#CodeAssistAndDynamicCodeAssist42BasedOnProjectData">code assist</ulink>.</para>
+ <figure float="0">
+ <title>Code Assist</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_20.png" scale="85"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The editor will also immediately flag any errors.</para>
+
+ <figure float="0">
+ <title>Errors in Source View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_21.png" scale="85"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Finally, you can use the Outline view with the editor to easily navigate through
+ the file.</para>
+
+ <figure float="0">
+ <title>Outline View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_22.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Find more information about editor features <ulink url="../../jsf/html_single/index.html#editors_features">here</ulink>.</para>
+ </section>
+ </section>
+
+ <section id="GraphicalEditorForTilesFiles132">
+
+ <title>Graphical Editor for Tiles Files</title>
+ <para>Here, you'll know how to make use of the special graphical editor for Tiles configuration files.</para>
+ <para>The editor has three main views: Tree, Diagram and Source.
+ The views can be selected via the tabs at the bottom of the editor. Any changes made in
+ one view are immediately visible when you switch to any other view.</para>
+
+ <para>Before we consider each view of the editor, let's look at the way of creating new Tiles files.</para>
+ <section id="CreateNewTilesFile1422">
+
+ <title>Create New Tiles File</title>
+
+ <para>To create new Tiles files, right click any folder and select <emphasis>
+ <property moreinfo="none">New > Tiles File</property>. </emphasis></para>
+ <figure float="0">
+ <title>Creating a New Tiles File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_23.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section id="StrutsTreeView896">
+
+ <title>Tree View</title>
+
+ <para>The Tree view represents the different elements of the Tiles file that are
+ organized into functional categories on the left-hand side and a form for editing
+ the properties of currently selected items on the right-hand side.</para>
+ <figure float="0">
+ <title>Tree View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_24.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>To edit the file, simply right click any node and select among the available
+ actions.</para>
+ <figure float="0">
+ <title>Editing in Tiles Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_25.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section id="StrutsDiagramView4643">
+
+ <title>Diagram View</title>
+
+ <para>The Diagram view allows you to create complex Tiles files in the form of a
+ diagram.</para>
+ <figure float="0">
+ <title>Diagram Mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_26.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>To create new definitions, simply right click anywhere in the diagram.</para>
+ <figure float="0">
+ <title>Creating New Definition</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_27.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>You can also use the Diagram toolbar to make editing easier.</para>
+ <figure float="0">
+ <title>Diagram Toolbar</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_28.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para> It contains four icons for changing the cursor state. The first one is the
+ default cursor state for selecting existing nodes. The second icon is marquee
+ selector. The third is used for creating new connections and the last one is for
+ adding definition template to the content.</para>
+ </section>
+ <section id="StrutsSource75">
+
+ <title>Source</title>
+
+ <para>The other view of the <property moreinfo="none">Tiles editor</property> is the Source view that
+ gives you full control over the source. Any changes here will immediately appear in
+ other modes when you switch to them.</para>
+
+ <para>When working in Source view, you always have all following features available:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Content Assist</para>
+ </listitem>
+ <listitem>
+ <para>Open On Selection</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Source View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_29.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para><ulink url="../../jsf/html_single/index.html#CodeAssistAndDynamicCodeAssist42BasedOnProjectData">Code
+ assist</ulink> is available in the Source mode.</para>
+ <figure float="0">
+ <title>Code Assist</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_30.png" scale="85"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Any errors are immediately reported as shown below:</para>
+ <figure float="0">
+ <title>Errors Reporting</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_31.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>You can also use the Outline view together with the editor's Source mode.
+ It provides an easier navigation through the file.</para>
+ <figure float="0">
+ <title>Outline View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_32.png" scale="85"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ </section>
+
+ <section id="GraphicalEditorForStrutsValidationFiles86">
+
+ <title>Graphical Editor for Struts Validation Files</title>
+
+ <para>Providing full support for development Struts applications JBoss Tools comes with a
+ visual validation editor. To open the editor double-click on the validation file or if you don't have it create a new one.</para>
+
+ <para>To create a new validation file, right click any folder in
+ Project Explorer and select <emphasis>
+ <property moreinfo="none">File > New > Other...</property>
+ </emphasis>from the context menu and then <emphasis>
+ <property moreinfo="none">JBoss Tools Web > Struts > Validation File</property>. </emphasis></para>
+ <figure float="0">
+ <title>Creating New Validation File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_33.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The validation editor works with five modes: Formsets, Validators, Constants and
+ standard Tree and Source that you can easily switch over using tabs at the bottom of the
+ editor.</para>
+ <para>The Formsets view shows forms and their elements on the left side and the dialogue for
+ defining their validation rules on the right side.</para>
+ <figure float="0">
+ <title>Formsets View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_34.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The Constants view let you set constant values for your validation rules.</para>
+ <figure float="0">
+ <title>Constansts View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_35.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The validation file can also be viewed in a Tree view.</para>
+ <figure float="0">
+ <title>Tree View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_36.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>At any point you have full control over the source by switching to the Source view.
+ Any editing in this view will immediately be available in other views of the editor.</para>
+ <figure float="0">
+ <title>Source View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_37.png" scale="85"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>You can also open your own custom or Struts-standard <emphasis>
+ <property moreinfo="none">validation-rules.xml</property>
+ </emphasis> file.</para>
+ <para>The Validators view shows the validation rules for a selected validator. You can of
+ course add your own rules.</para>
+ <figure float="0">
+ <title>Validators View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_38.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Here are the validation rules shown in the Source mode.</para>
+ <figure float="0">
+ <title>Validation Rules</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_39.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+</chapter>
+
+
+<chapter id="modules" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/struts/docs/struts_tools_ref_guide/en/modules/modules.xml">
+ <?dbhtml filename="modules.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Struts Tools</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Modules</title>
+
+ <para>JBoss Tools support working with Struts projects that have
+ multiple modules. You can easily do the following:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Add new modules</para>
+ </listitem>
+ <listitem>
+ <para>Edit modules for an existing project or during Struts project
+ import</para>
+ </listitem>
+ </itemizedlist>
+ <para>Now, let's discuss this functionality in more detail.</para>
+ <section id="WhenImportingAStrutsProject432">
+
+ <title>When Importing a Struts Project</title>
+
+ <para>During Struts project import, if the project has multiple modules, you
+ will see a screen with all existing modules. You can select each
+ module and edit its details.</para>
+
+ <figure float="0">
+ <title>Configuring Project Modules</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_40.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section id="EditingModulesInAnExistingProject1">
+
+ <title>Editing Modules in an Existing Project</title>
+ <para>To edit modules in an existing project, right click the project and
+ select <emphasis>
+ <property moreinfo="none">JBoss Tools > Modules Configuration</property>.
+ </emphasis></para>
+ <figure float="0">
+ <title>Choosing Modules Configuration</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_41.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>You will see the same screen as above where you will be able to select
+ a module and edit its details.</para>
+ <figure float="0">
+ <title>Modules Configuration</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_42.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section id="AddingNewModules1">
+
+ <title>Adding New Modules</title>
+
+ <para>Adding a new module is very simple. First switch to Web Project view.
+ Expand your project to the Configuration folder. Under that folder
+ you should see the current modules. Right click on Configuration and
+ select <emphasis>
+ <property moreinfo="none">New > Struts Config</property>. </emphasis></para>
+ <figure float="0">
+ <title>Adding New Modules</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_43.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>You will see the screen below. You can specify a new module name and
+ also add the new Struts configuration file to web.xml file.</para>
+ <figure float="0">
+ <title>Adding New Modules</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_44.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+</chapter>
+
+
+<chapter id="code_generation" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/struts/docs/struts_tools_ref_guide/en/modules/code_generation.xml">
+ <?dbhtml filename="code_generation.html"?>
+
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Struts Tools</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Code Generation</title>
+
+ <para>JBoss Tools comes with a <property moreinfo="none">code generation</property>
+ feature. You can generate stub code for Struts Actions, FormBeans, Forwards
+ and Exceptions.</para>
+
+ <para>The code generation that JBoss tooling provides is based on Velocity templates
+ which can be modified for your use. The templates are located at <emphasis>
+ <property moreinfo="none"> {JBossStudioHome} > templates >
+ codegeneration</property>. </emphasis></para>
+
+ <para>There are a number of ways to invoke code generation. One is simply
+ right-clicking the Struts diagram and selecting <emphasis>
+ <property moreinfo="none">Generate Java Code....</property>
+ </emphasis></para>
+
+ <figure float="0">
+ <title>Selecting Generate Java Code</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_45.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>On this screen you can select for which elements to generate code. If you
+ select Next you will be able to specify more options for each of the
+ categories you selected.</para>
+
+ <figure float="0">
+ <title>Generate - Step 1</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_46.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <tip>
+ <title>Tip:</title>
+ <para>Please be careful not to override your existing files.</para>
+ </tip>
+
+ <para>When generation is complete, a result window will appear letting you know how
+ many classes were generated:</para>
+
+ <figure float="0">
+ <title>Generation Finished</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_47.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>You don't always have to generate code for all elements at once. You
+ can invoke generation for just an individual Struts artifact as well.
+ Right-click an element on the diagram of the Struts configuration file and
+ select <emphasis>
+ <property moreinfo="none">Generate Java Code...</property>
+ </emphasis> from the context menu.</para>
+
+ <figure float="0">
+ <title>Generation For Individual Struts Artifact</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_48.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The same can be done from within the Tree viewer for the editor of the Struts
+ configuration file.</para>
+
+ <figure float="0">
+ <title>Generation in Struts Config Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_49.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+</chapter>
+
+<chapter id="config_file_debugger" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/struts/docs/struts_tools_ref_guide/en/modules/config_file_debugger.xml">
+ <?dbhtml filename="config_file_debugger.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Struts Tools</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Struts Configuration File Debugger</title>
+
+ <para>JBoss Tools come with <property moreinfo="none">Struts configuration file
+ debugger</property>. It allows you to set break points on Struts diagram and
+ then simply launch the server in debug mode.</para>
+
+ <para>Simply right click an Action or a page and select Add <emphasis>
+ <property moreinfo="none">Breakpoint</property>. </emphasis></para>
+ <figure float="0">
+ <title>Adding Breakpoint</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_50.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+</chapter>
+
+<chapter id="page_links_recognizer" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/struts/docs/struts_tools_ref_guide/en/modules/page_links_recognizer.xml">
+ <?dbhtml filename="page_links_recognizer.html"?>
+
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Customizable Page Links Recognizer</title>
+
+ <para><property moreinfo="none">Custom page links</property> allow you to define custom Struts page
+ links that will be recognizable in the Struts application diagram. You can
+ define these links by selecting <emphasis>
+ <property moreinfo="none">Window > Preferences</property>
+ </emphasis> from the menu bar and then selecting <emphasis>
+ <property moreinfo="none">JBoss Tools > Web > Struts > Customization</property>
+ </emphasis> from the Preferences dialog box.</para>
+ <figure float="0">
+ <title>Customization Panel</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/struts/struts_51.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+</chapter>
+
+<chapter id="project_verification" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/struts/docs/struts_tools_ref_guide/en/modules/project_verification.xml">
+ <?dbhtml filename="project_verification.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Struts Tools</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Struts Project Verification</title>
+
+ <para>In this section we'll consider one more functionality that JBoss Tools provide for Struts
+ projects, namely adjusting projects verification.</para>
+
+ <para>To configure Struts project verification select <emphasis>
+ <property moreinfo="none">Window > Preferences</property>
+ </emphasis> from the menu bar, select <emphasis>
+ <property moreinfo="none">JBoss Tools > Web > Verification</property>
+ </emphasis> from the Preferences dialog box and then expand the
+ Struts Rules node.</para>
+ <figure float="0">
+ <title>Struts Rules</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_8.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Suppose you are working in the Source viewer for a Struts
+ configuration file as shown below:</para>
+ <figure float="0">
+ <title>Struts Configuration File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_9.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>While typing a class name or entering it from the graphical editor,
+ you might make a minor typo (like <emphasis role="italic">
+ <property moreinfo="none">"sample.GreetingAction1"</property>
+ </emphasis> instead of <emphasis role="italic">
+ <property moreinfo="none">"sample.GreetingAction"</property>
+ </emphasis>). After saving the file,
+ <property moreinfo="none">verification</property> checks to make sure everything is
+ correct and finds the error below:</para>
+ <figure float="0">
+ <title>Error Reporting</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_10.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Notice that the Package Explorer View shows a marked folder and a
+ marked file where the error is.</para>
+ <para>You can place the cursor over the line with the error to view a
+ detailed error message:</para>
+ <figure float="0">
+ <title>Error Message</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_11.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The verification also checks to make sure you have specified the
+ correct JSP page for the forward:</para>
+ <figure float="0">
+ <title>JSP Page Verification</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_12.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Once you place the cursor over the line, you can see the error
+ message:</para>
+ <figure float="0">
+ <title>Error Message</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_13.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>You can always invoke the verification by switching to the Diagram
+ viewer, right-clicking and selecting <emphasis>
+ <property moreinfo="none">Verify</property>
+ </emphasis> from the context menu:</para>
+ <figure float="0">
+ <title>Verify Command</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/verif_valid/verif_valid_14.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+</chapter>
+
+<chapter id="rel_resources_links" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/struts/docs/struts_tools_ref_guide/en/modules/rel_resources_links.xml">
+ <?dbhtml filename="rel_resources_links.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Developer Studio</keyword>
+ <keyword>Eclipse</keyword>
+ <keyword>Struts Tools</keyword>
+ <keyword>Java</keyword>
+ <keyword>JBoss</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Relevant Resources Links</title>
+
+ <para>Find out necessary information on <ulink url="http://struts.apache.org/">Struts
+ technology</ulink> if you don't know enough.</para>
+
+ <para>In summary, this reference should help you to get familiar with those parts of
+ <property moreinfo="none">JBoss Tools</property> which are meant for development with Struts
+ technology. If you've carefully gone through the document, you should know
+ now how to create/import Struts project or enable Struts capabilities for an
+ existing web project as well as organize and edit all necessary staff for your
+ Struts application using a set of views and editors provided by <property moreinfo="none">JBoss
+ Tools</property>.</para>
+
+ <para>If you'd like to contribute your feedback is always appreciated. You can
+ leave your questions and suggestions on our <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">Forum</ulink>.</para>
+</chapter>
+
+</book>
15 years, 3 months
JBoss Tools SVN: r14145 - branches/jbosstools-3.0.x/smooks/docs/reference/en.
by jbosstools-commits@lists.jboss.org
Author: ochikvina
Date: 2009-03-10 10:37:57 -0400 (Tue, 10 Mar 2009)
New Revision: 14145
Added:
branches/jbosstools-3.0.x/smooks/docs/reference/en/master_output.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-655 - adding master_output.xml;
Added: branches/jbosstools-3.0.x/smooks/docs/reference/en/master_output.xml
===================================================================
--- branches/jbosstools-3.0.x/smooks/docs/reference/en/master_output.xml (rev 0)
+++ branches/jbosstools-3.0.x/smooks/docs/reference/en/master_output.xml 2009-03-10 14:37:57 UTC (rev 14145)
@@ -0,0 +1,902 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.docbook.org/xml/4.3/docbookx.dtd"
+
+[
+<!ENTITY introduction SYSTEM "modules/introduction.xml">
+<!ENTITY quickstart SYSTEM "modules/quick_start.xml">
+<!ENTITY smooksformeditor_graphicaltab SYSTEM "modules/smooksformeditor_graphicalpage.xml">
+<!ENTITY smooksformeditor_configurationtab SYSTEM "modules/smooksformeditor_configurationpage.xml">
+<!ENTITY smooksformeditor_sourcetab SYSTEM "modules/smooksformeditor_sourcepage.xml">
+]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
+
+ <bookinfo>
+
+ <title>Smooks Dev Tools Reference Guide</title>
+ <author>
+ <firstname>Xue(Dart)</firstname>
+ <surname>Peng</surname>
+ </author>
+
+ <pubdate>November 2008</pubdate>
+ <copyright>
+ <year><diffmk:wrapper diffmk:change="changed">2009</diffmk:wrapper></year>
+ <holder><diffmk:wrapper diffmk:change="changed">JBoss, a division of Red Hat</diffmk:wrapper></holder>
+ </copyright>
+ <releaseinfo><diffmk:wrapper diffmk:change="changed">
+ Version: 1.0.0.GA
+ </diffmk:wrapper></releaseinfo>
+
+ <abstract>
+ <title></title>
+ <para>
+ <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/smooks/pdf/Smooks_Re...">PDF version</ulink>
+ </para>
+ </abstract>
+
+
+ </bookinfo>
+ <toc></toc>
+
+<chapter id="introduction" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/smooks/docs/reference/en/modules/introduction.xml">
+ <?dbhtml filename="introduction.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>Smooks</keyword>
+ <keyword>JBDS</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Introduction</title>
+ <section>
+ <title>What is Smooks?</title>
+
+ <para><property moreinfo="none">Smooks</property> is a Java Framework/Engine for processing XML and non XML
+ data (CSV, EDI, Java, JSON etc).</para>
+ <para></para>
+ <para>
+ <orderedlist continuation="restarts" inheritnum="inherit" numeration="upperroman">
+ <listitem>
+ <para><emphasis role="bold">Transformation</emphasis>: Perform a wide range of
+ Data Transforms. Supports many different Source and Result types
+ -XML/CSV/EDI/Java/JSON to XML/CSV/EDI/Java/JSON.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis role="bold">Java Binding</emphasis>: Bind into a Java Object
+ Model from any data source (CSV, EDI, XML, Java, JSON etc). </para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis role="bold">Huge Message Processing</emphasis>: Process huge
+ messages (GBs) - Split, Transform and Route message fragments to JMS, File,
+ Database etc destinations. Route multiple message formats to multiple
+ destinations in a single pass over a message. </para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis role="bold">Message Enrichment</emphasis>: Enrich a message with
+ data from a Database, or other Datasources. </para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis role="bold">Combine</emphasis>: Combine the above features in
+ different ways e.g. add Message Enrichment as part of a Splitting and
+ Routing process. </para>
+ </listitem>
+ </orderedlist>
+ </para>
+ <figure float="0">
+ <title>Smooks</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/introduction/introduction1.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para> For More informations about <property moreinfo="none">Smooks</property>, please visit <ulink url="http://www.smooks.org">Smooks official site</ulink>.</para>
+ </section>
+ <section>
+ <title>What is Smooks dev tools?</title>
+
+ <para>Smooks dev tools is a set of graphical tools for editing Smooks configuration file
+ base on Eclipse.</para>
+ <figure float="0">
+ <title>Smooks form editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/introduction/introduction2.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section>
+ <title>How to install Smooks dev tools?</title>
+
+ <para> The Smooks dev tools was included by the <property moreinfo="none">JBoss Tools</property> since 3.0.0
+ Beta1 version. You can download the <property moreinfo="none">JBoss Tools</property> from <ulink url="http://www.jboss.org/tools/download/index.html">here</ulink>.</para>
+ <para> Smooks dev tools (<property moreinfo="none">JBoss Tools</property>) run with the latest Eclipse and
+ other required plug-ins (GEF, EMF, etc.).</para>
+ <para> You should download the latest IDE for Java EE developers from this <ulink url="http://www.eclipse.org/downloads/">site</ulink>. It contains many plug-ins (
+ GEF, EMF, etc. ) required by Smooks dev tools. </para>
+ </section>
+</chapter>
+
+
+<chapter id="quickstart" role="updated" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/smooks/docs/reference/en/modules/quick_start.xml" xreflabel="Quick Start">
+ <?dbhtml filename="quick_start.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>Smooks</keyword>
+ <keyword>JBDS</keyword>
+ <keyword>java</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Quick Start</title>
+ <para> This "Quick Start" will show how to use the <property moreinfo="none">Smooks tools</property> to create/edit the Smooks
+ configuration file for Java2Java data transformation.</para>
+ <para> This chapter should give you a brief understanding of the <property moreinfo="none">Smooks dev tools</property>.</para>
+ <section>
+ <title>Download Smooks Java-to-Java Example</title>
+ <para> Visit <ulink url="http://www.smooks.org/documentation/documentation-smooks-1-1-x/examples/e...">here</ulink> to download the "java-to-java" example project. </para>
+ <tip>
+ <title>Tip:</title>
+
+ <para> The example project is base on Maven, you suggest you to create a new eclipse
+ Java project and copy the example code and .jar files from the example project paste
+ them into the eclipse Java project. </para>
+ </tip>
+ </section>
+ <section>
+ <title>Smooks Configuration File Wizard</title>
+ <para>Select the Smooks Java-to-Java example project what you created and right-click,
+ select the menu <emphasis><property moreinfo="none">New > Other</property>,</emphasis> then find
+ <emphasis><property moreinfo="none">Smooks > Smooks Configuration File</property>.</emphasis>
+ Click the <emphasis>
+ <property moreinfo="none">Next</property>
+ </emphasis> button. </para>
+ <figure float="0">
+ <title>Selecting Smooks Configuration File Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start1.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The first wizard page is a file path creation page. Select the <emphasis>
+ <property moreinfo="none">src</property>
+ </emphasis> folder to be the files container, and input the name
+ <emphasis><property moreinfo="none">newConfig.smooks</property>.</emphasis> Click
+ <emphasis><property moreinfo="none">Next</property>.</emphasis></para>
+ <figure float="0">
+ <title>Choosing the configuration file container and the file name</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start2.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The second wizard page is a transform data type choose page.</para>
+ <para> As the quick start introduces how to create/edit the Java-to-Java Smooks
+ configuration file, let's select the<emphasis>
+ <property moreinfo="none">Java-to-Java</property>
+ </emphasis> type as the source/target transform data type. </para>
+
+ <figure float="0">
+ <title>Selecting Data Type</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start3.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>On the next page you are prompted to choose the source data for transformation.
+ Let's select the <property moreinfo="none">Order</property> class from the example project as
+ the source JavaBean class.</para>
+
+ <figure float="0">
+ <title>Selecting the Source Data</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start4.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Then the wizard page asks you to choose the target data for transformation. We select
+ the <property moreinfo="none">ListOrder</property> class as the target JavaBean class.</para>
+ <figure float="0">
+ <title>Selecting the Target Data</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start5.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para></para>
+
+ <tip>
+ <title>Tip:</title>
+ <para>You can omit two these steps and just press
+ <emphasis><property moreinfo="none">Finish</property>.</emphasis> This will open the empty
+ Smooks Configuration file. It's possible to <link linkend="graphicaleditor_datalink">select source/target data</link> afterwards
+ in the Smooks Graph editor.</para>
+ </tip>
+ </section>
+ <section id="quickstart_formeditor">
+ <title>Smooks Editor</title>
+
+ <para>When all the wizard steps are passed, a new Smooks Configuration file is created and
+ the <property moreinfo="none">Smooks Editor</property> will be opened automatically:</para>
+ <figure float="0">
+ <title>Smooks Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start6.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para> This editor contains several parts: <table>
+ <title>The Smooks Editor Parts</title>
+ <tgroup cols="2">
+
+ <colspec align="left" colnum="1" colwidth="1*"></colspec>
+ <colspec colnum="2" colwidth="5*"></colspec>
+
+ <thead>
+ <row>
+ <entry>Editor feature</entry>
+ <entry>Functionality</entry>
+ </row>
+ </thead>
+
+ <tbody>
+
+ <row>
+ <entry>
+ <para>Problems area</para>
+ </entry>
+ <entry>
+ <para>If there are any errors when you are editing the file, the
+ Problems area will display them</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Source data tree</para>
+ </entry>
+ <entry>
+ <para>The tree will display the structure of transformed source
+ data</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Target data tree</para>
+ </entry>
+ <entry>
+ <para>The tree will display the structure of transformed target
+ data</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Mapping graphical area</para>
+ </entry>
+ <entry>
+ <para>Show the data mapping connection lines</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Source/Target data selection links</para>
+ </entry>
+ <entry>
+ <para>Click the link, and <link linkend="graphicaleditor_datalink">Data Selection wizard</link> will be opened helping you to
+ choose the source/target data</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </para>
+ </section>
+
+ <section id="graphicaleditor_datalink">
+ <title>Choosing the Source/Target Data</title>
+
+ <para>To choose the transform data you should make use of the data selection links:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><emphasis>
+ <property moreinfo="none">Source Select</property>
+ </emphasis> for selecting source data</para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis>
+ <property moreinfo="none">Target Select</property>
+ </emphasis> for selecting target data</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>After clicking the link the <property moreinfo="none">Data Type Selection wizard</property> will be
+ opened, and there are two data types on the list: Java and XML.</para>
+ <note>
+ <title>Note</title>
+ <para> There will be more and more data types on the list as the development went on.
+ </para>
+ </note>
+
+ <figure float="0">
+ <title>Data Type Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start7.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Select the <emphasis>
+ <property moreinfo="none">Java</property>
+ </emphasis> data type and click <emphasis><property moreinfo="none">Next</property>,</emphasis> you will
+ see the JavaBean class selection page:</para>
+
+ <figure float="0">
+ <title>JavaBean Data Selection</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start8.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>When you select all the necessary java classes, click <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> and the structure of the java class will be displayed on the source/target
+ data tree.</para>
+ <figure float="0">
+ <title>Displaying the Structure of the Transformed Data</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start9.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section id="quickstart_mapping">
+ <title>Mapping</title>
+
+ <para> As you see, the source/target data tree displays the structure of the java class. </para>
+ <para>How to map it?</para>
+
+ <para>First, you should know what to transform:</para>
+
+ <orderedlist continuation="restarts" inheritnum="inherit" numeration="loweralpha">
+ <listitem>
+ <para>Bind the <emphasis>
+ <property moreinfo="none">"customerName"</property>
+ </emphasis> property of the <property moreinfo="none">Order#header</property> to the <emphasis>
+ <property moreinfo="none">"customerName"</property>
+ </emphasis> property of <property moreinfo="none">LineOrder</property>.</para>
+ </listitem>
+ <listitem>
+ <para>Bind the <emphasis>
+ <property moreinfo="none">"customerNumber"</property>
+ </emphasis> property of the <property moreinfo="none">Order#header</property> to the <emphasis>
+ <property moreinfo="none">"customerId"</property>
+ </emphasis> property of <property moreinfo="none">LineOrder</property>.</para>
+ </listitem>
+ <listitem>
+ <para>Bind the <emphasis>
+ <property moreinfo="none">"price"</property>
+ </emphasis> property of the <property moreinfo="none">OrderItem</property> to the <emphasis>
+ <property moreinfo="none">"unitPrice"</property>
+ </emphasis> property of <property moreinfo="none">LineItem</property>.</para>
+ </listitem>
+ <listitem>
+ <para>Bind the <emphasis>
+ <property moreinfo="none">"productId"</property>
+ </emphasis> property of the <property moreinfo="none">OrderItem</property> to the <emphasis>
+ <property moreinfo="none">"productCode"</property>
+ </emphasis> property of <property moreinfo="none">LineItem</property>.</para>
+ </listitem>
+ <listitem>
+ <para>Bind the <emphasis>
+ <property moreinfo="none">"quantity"</property>
+ </emphasis> property of the <property moreinfo="none">OrderItem</property> to the <emphasis>
+ <property moreinfo="none">"unitQuantity"</property>
+ </emphasis> property of <property moreinfo="none">LineItem</property>.</para>
+ </listitem>
+ </orderedlist>
+
+ <para> Make sense?</para>
+ <para> OK, let's select the <emphasis>
+ <property moreinfo="none">"customerName"</property>
+ </emphasis> item of the <emphasis>
+ <property moreinfo="none">"header"</property>
+ </emphasis> item on the source data tree and start to drag it. When the drag item
+ crosses the Mapping graphical area, you will see a connection line. Drop the item onto
+ the <emphasis>
+ <property moreinfo="none">"customerName"</property>
+ </emphasis> of the <property moreinfo="none">LineOrder</property> on the target data
+ view.</para>
+ <para> Now a dialog is opened asking you to connect the root node:</para>
+
+ <figure float="0">
+ <title>Dialog Asking You to Connect to the Root Nodes</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start10.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para> Please, click <emphasis>
+ <property moreinfo="none">Yes</property>
+ </emphasis> to connect the root node. If you don't do that, this dialog will be
+ opened again when you connect other nodes.</para>
+ <note>
+ <title>Note:</title>
+ <para>Please, remember that: The root nodes of the source data and target data *MUST* be
+ connected.</para>
+ <para>This rule is not only for Java-to-Java, but the same is also relevant for
+ XML-to-Java </para>
+ </note>
+ <para> Now let's do the same operation with the <emphasis>
+ <property moreinfo="none">"customerNumber"</property>,</emphasis> that is what you
+ should see:</para>
+ <figure float="0">
+ <title>Correctly Mapping Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start11.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Next, you are going to bind the properties of the <property moreinfo="none">OrderItem</property> to
+ the properties of the <property moreinfo="none">LineItem</property>.</para>
+ <para>Select the <emphasis>
+ <property moreinfo="none">"price"</property>
+ </emphasis> and drag it onto the <emphasis>
+ <property moreinfo="none">"unitPrice"</property>
+ </emphasis> of the other side tree viewer. The Problems area will show an
+ error:</para>
+ <figure float="0">
+ <title>Connection Error 1</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start12.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>How to deal with the error?</para>
+ <para>Please click the <emphasis>
+ <property moreinfo="none">Fix it</property></emphasis> link, a menu is popped-up with several
+ resolve methods on it.</para>
+ <figure float="0">
+ <title>Fixing the Connection Error</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start13.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para> Select the first resolve method: <emphasis>
+ 'Connect the "OrderItem" to the
+ "LineItem" '.</emphasis> As the result the <emphasis>
+ <property moreinfo="none">"OrderItem"</property></emphasis> is connected with
+ the <emphasis>
+ <property moreinfo="none">"LineItem"</property>.</emphasis></para>
+ <para>But the notify message area still shows some other errors:</para>
+ <figure float="0">
+ <title>Connection Error 2</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start14.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>OK, let's deal with the fire error. Click the <emphasis>
+ <property moreinfo="none">Fix it</property></emphasis> link and
+ select the first resolve method. The <emphasis>
+ <property moreinfo="none">"orderItems"</property></emphasis> is connected with
+ the <emphasis>
+ <property moreinfo="none">"lineItems"</property>.</emphasis></para>
+
+ <tip>
+ <title>Tip:</title>
+ <para> Why does the error occur?</para>
+ <para> You will find that, if you only connect the property node without connecting the
+ parent node of the property, the "connection error" occurs.</para>
+ <para>The connection of the "price-to-unitPrice" is the
+ "Binding Connection", but it needs an "Instance Creation
+ Connection" - the connection of the
+ "OrderItem-to-LineItem".</para>
+ </tip>
+ <para> After that, connect <emphasis>
+ <property moreinfo="none">"quantity"</property></emphasis> to the <emphasis>
+ <property moreinfo="none">"unitQuantity"</property></emphasis> and <emphasis>
+ <property moreinfo="none">"productId"</property></emphasis> to the
+ <emphasis>
+ <property moreinfo="none">"productCode"</property>:</emphasis></para>
+ <figure float="0">
+ <title>Complete Mapping</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/quick_start/quick_start15.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Now, you should save the file and the <property moreinfo="none">Smooks tools</property> will generate the correct
+ configuration file content.</para>
+ <para>OK, let run the test class: <property moreinfo="none">example.Main</property>. (Please, make sure that the Smooks engine
+ loads the correct configuration file).</para>
+ <para>Success!</para>
+ </section>
+</chapter>
+
+
+<chapter id="smooksformeditor_graphicaltab" role="updated" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/smooks/docs/reference/en/modules/smooksformeditor_graphicalpage.xml" xreflabel="Smooks Graphical Editor Page">
+ <?dbhtml filename="smooks_form_editor_graphicaltab.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>Smooks</keyword>
+ <keyword>JBDS</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Smooks Graphical Editor Page</title>
+
+ <para>Smooks Graphical Editor page is one tab of the <property moreinfo="none">Smooks Editor</property>.</para>
+ <figure float="0">
+ <title>Graphical Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/graph_editor/graph_editor1.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para> This <property moreinfo="none">Graphical editor</property> allows you to perform drug/drop operations
+ with the nodes of transform data to map the source data to target data. </para>
+ <para> When you save the changes in the Graphical editor the correct Smooks Configuration file
+ content will be generated. </para>
+ <section>
+
+ <title>Introducing the areas of graphical editor</title>
+ <para>Information on the topic could be found in the <link linkend="quickstart_formeditor">Quick Start/Smooks Editor</link> section.</para>
+ </section>
+ <section>
+
+ <title>Load Source/Target Data</title>
+ <para> Click the links under the data view, the <property moreinfo="none">Data Type Selection wizard</property> page will be
+ shown.</para>
+ <figure float="0">
+ <title>Data Type Selection Wizard Page</title>
+ <mediaobject>
+ <imageobject>
+
+ <imagedata fileref="images/graph_editor/graph_editor2.png" scale="90"></imagedata>
+
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para> There are sets of transform data type on the wizard page, select one type and click
+ <emphasis><property moreinfo="none">Next</property>,</emphasis> the data source selection wizard
+ page will be shown.</para>
+
+ <tip>
+ <title>Note:</title>
+ <para>For different data type, the Data source selection wizard are different too.
+ </para>
+ </tip>
+ <figure float="0">
+ <title>Java Data Source Selection Wizard Page</title>
+ <mediaobject>
+ <imageobject>
+
+ <imagedata fileref="images/graph_editor/graph_editor3.png" scale="90"></imagedata>
+
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <figure float="0">
+ <title>XML File Path Selection Wizard Page</title>
+ <mediaobject>
+ <imageobject>
+
+ <imagedata fileref="images/graph_editor/graph_editor4.png" scale="90"></imagedata>
+
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para> When you finish the data selection (file path selection), click
+ <emphasis><property moreinfo="none">Finish</property>,</emphasis> the data view will display the
+ selected data structure.</para>
+ </section>
+ <section>
+
+ <title>Using Graphical Editor for Mapping</title>
+ <para>To get information on the topic please, read the <link linkend="quickstart_mapping">Quick Start/Mapping</link> section. </para>
+ </section>
+ <section>
+
+ <title>Error Messages</title>
+ <para>When you do any mapping operations, the <property moreinfo="none">Smooks tools</property> validate the
+ file content with "Mapping Logic". If there are any errors of the configuration file
+ content, error messages are shown in the <link linkend="quickstart_formeditor">Problems
+ area</link>.</para>
+ <para> Please, read the <link linkend="quickstart_mapping">Quick Start/Mapping</link> section to
+ find how to fix the errors.</para>
+ </section>
+ <section id="graphicalpage_propertiesview">
+ <title>Properties View</title>
+
+ <para> You can edit the properties of the connection lines with the <property moreinfo="none">Properties
+ view</property>.</para>
+ <para>Navigate to <emphasis><property moreinfo="none">Window > Show View > Other >
+ Properties</property>,</emphasis> to open the <property moreinfo="none">Properties
+ view</property>.</para>
+ <para> When you select on the connection lines, the <property moreinfo="none">Properties view</property>
+ will show a set of section GUI for editing the properties of the connection line.</para>
+ <tip>
+
+ <title>Tip:</title>
+ <para>This GUI on the <property moreinfo="none">Properties view</property> is displayed when the Smooks
+ Graphical editor is active, if not, the <property moreinfo="none">Properties view</property>
+ displays empty GUI.</para>
+ <para>If the source data type of the selected connection line is
+ "XML", the <property moreinfo="none">Properties view</property> shows an XML
+ Properties section GUI.</para>
+ <para>But if the source data type of the selected connection line is
+ "Java", the XML Properties section GUI isn't
+ displayed.</para>
+ <para>It means that if the source/target data type of the selected connection line is
+ different, the <property moreinfo="none">Properties view</property> shows different GUI.</para>
+ </tip>
+ <figure float="0">
+ <title>JavaBean Properties Section</title>
+ <mediaobject>
+ <imageobject>
+
+ <imagedata fileref="images/graph_editor/graph_editor5.png" scale="90"></imagedata>
+
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure float="0">
+ <title>XML Properties Section</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/graph_editor/graph_editor6.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure float="0">
+ <title>Mapping Properties Section</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/graph_editor/graph_editor7.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+</chapter>
+
+
+<chapter id="smooksformeditor_configurationtab" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/smooks/docs/reference/en/modules/smooksformeditor_configurationpage.xml" xreflabel="Smooks Configuration Editor Page">
+ <?dbhtml filename="smooks_form_editor_configurationtab.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>Smooks</keyword>
+ <keyword>JBDS</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Smooks Configuration Editor Page</title>
+ <para> Smooks Configuration Editor Page is one tab of the <property moreinfo="none">Smooks Editor</property>. </para>
+ <figure float="0">
+ <title>Graphical Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/config_page/config_page1.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para> You can add/edit/remove the <link linkend="configurationpage_datedecoder">Date
+ Decoder</link> on the Сonfiguration page of the <property moreinfo="none">Smooks Editor</property>. </para>
+ <para> The configuration also edit the <link linkend="configurationpage_parsetype">Smooks parse
+ type</link> and manage the <link linkend="configurationpage_importfile">Import
+ Files</link>.</para>
+
+ <section id="configurationpage_parsetype">
+
+ <title>Smooks Parse Type</title>
+ <para>Open the <emphasis>
+ <property moreinfo="none">Other Configurations</property>
+ </emphasis> section, we will see there is a set of radio buttons:</para>
+
+ <figure float="0">
+ <title>Smooks Parse Types</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/config_page/config_page2.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para> Select the radio button to change the Smooks parse type. </para>
+ </section>
+ <section id="configurationpage_importfile">
+
+ <title>Import File</title>
+ <para> Open the <emphasis>
+ <property moreinfo="none">Other Configurations</property>
+ </emphasis> section, there is an <emphasis>
+ <property moreinfo="none">Import Files</property>
+ </emphasis> list under the Smooks parse type buttons.</para>
+
+ <figure float="0">
+ <title>Import File</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/config_page/config_page2.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>There are three buttons on the right side of the <emphasis>
+ <property moreinfo="none">File Import</property>
+ </emphasis> list. You can click those to add/edit/remove the import files.</para>
+
+ <tip>
+
+ <title>Tip:</title>
+ <para> If the import file dosen't exist, the image of the import file will change to
+ "Error Image". If you double-click the import file in the Import File list, the file
+ will be open with a new default editor. </para>
+
+ </tip>
+ </section>
+ <section id="configurationpage_datedecoder">
+ <title>Date Decoder Detail Page</title>
+
+ <para>Date Decoder is a resourceConfig element in the Smooks configuration file. It
+ describes how to transform the "Date" type.</para>
+ <para> Click the <emphasis>
+ <property moreinfo="none">New</property>
+ </emphasis> button to open the <property moreinfo="none">New Resource Type wizard</property>
+ dialog.</para>
+ <figure float="0">
+ <title>Resource Type Selection Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/config_page/config_page4.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>There are several resource type on the list. Select the <emphasis>
+ <property moreinfo="none">Date Decoder</property>
+ </emphasis> and click the <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> button, a new <emphasis>
+ <property moreinfo="none">Date Decoder</property>
+ </emphasis> item was added and shown on the resource type list.</para>
+ <para> There are several parameters in the <emphasis>
+ <property moreinfo="none">Date Decoder</property>
+ </emphasis> resourceConfig element:</para>
+
+ <para>
+
+ <itemizedlist>
+ <listitem>
+ <para>locale-language</para>
+
+ </listitem>
+
+ <listitem>
+ <para>format</para>
+ </listitem>
+
+ <listitem>
+ <para>locale-country</para>
+
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para> You can modify the parameters of the <emphasis>
+ <property moreinfo="none">Date Decoder</property></emphasis> item with the left detail page.</para>
+
+ <figure float="0">
+ <title>Date Decoder Detail Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/config_page/config_page5.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para> When you defined a new <emphasis>
+ <property moreinfo="none">Date Decoder</property></emphasis>, they can use the <link linkend="graphicalpage_propertiesview">JavaBean Properties</link> GUI to set the
+ them to be the "Java type".</para>
+
+ <!--
+ <para> The XML fragment generated by Smooks tools for the "Date
+ Decoder": </para> <para> <programlisting> <![CDATA[<resource-config
+ selector="decoder:DateLong">
+ <resource>org.milyn.javabean.decoders.DateDecoder</resource> <param
+ name="locale-language">en</param> <param name="format">yyy-MM-dd
+ HH:mm:ss</param> <param name="locale-country">IE</param>
+ </resource-config>]]> </programlisting> </para>
+ -->
+ </section>
+ <!--
+ <section id="configurationpage_documenttype"> <title>Document Type
+ Detail Page</title> <para> </para> </section> <section
+ id="configurationpage_unhandleresourceconfig"> <title>Unhandle
+ ResourceConfig</title> </section>
+ -->
+</chapter>
+
+
+<chapter id="smooksformeditor_sourcetab" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/smooks/docs/reference/en/modules/smooksformeditor_sourcepage.xml" xreflabel="Smooks Source Editor Page">
+ <?dbhtml filename="smooks_form_editor_sourcetab.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>Smooks</keyword>
+ <keyword>JBDS</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Smooks Source Editor Page</title>
+ <section>
+ <title>XML Source Editor</title>
+ <para>You can use this editor to edit the Smooks Configuration file directly. </para>
+ <figure float="0">
+ <title>Graphical Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/source_editor/source_editor1.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section>
+ <title>Error Messages GUI</title>
+ <para>If the <property moreinfo="none">Smooks tools</property> can't understand the configuration
+ file or the configuration file is illegal (XML structure isn't right for Smooks
+ Configuration file, etc.), the error will be underlined.</para>
+ <figure float="0">
+ <title>Graphical Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/source_editor/source_editor2.png" scale="90"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <!--note>
+ <title>Tip:</title>
+ <para> When the error message panel is displayed, other editors ( Graphical Editor,
+ Configuration Editor ) are disabled. </para>
+ <para> You can't edit the configuration file with other editors until file becomes
+ valid. </para>
+ </note-->
+
+ </section>
+</chapter>
+
+</book>
15 years, 3 months
JBoss Tools SVN: r14144 - branches/jbosstools-3.0.x/smooks/docs/reference.
by jbosstools-commits@lists.jboss.org
Author: ochikvina
Date: 2009-03-10 10:37:37 -0400 (Tue, 10 Mar 2009)
New Revision: 14144
Modified:
branches/jbosstools-3.0.x/smooks/docs/reference/pom.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-655 - adding profiles to pom.xml;
Modified: branches/jbosstools-3.0.x/smooks/docs/reference/pom.xml
===================================================================
--- branches/jbosstools-3.0.x/smooks/docs/reference/pom.xml 2009-03-10 14:37:02 UTC (rev 14143)
+++ branches/jbosstools-3.0.x/smooks/docs/reference/pom.xml 2009-03-10 14:37:37 UTC (rev 14144)
@@ -12,9 +12,40 @@
<profiles>
<profile>
+ <id>release</id>
+ <properties>
+ <master>master_output.xml</master>
+ <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-release.xsl</xsl-single>
+ <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-release.xsl</xsl-chunked>
+ <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf>
+ </properties>
+ </profile>
+ <profile>
+ <id>releaseTest</id>
+ <properties>
+ <master>master_output.xml</master>
+ <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-release-nomarker.xsl</xsl-single>
+ <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-release-nomarker.xsl</xsl-chunked>
+ <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf>
+ </properties>
+ </profile>
+ <profile>
+ <id>releaseJBDS</id>
+ <properties>
+ <master>master_output.xml</master>
+ <xsl-single>classpath:/xslt/com/jboss/tools/xhtml-single-release.xsl</xsl-single>
+ <xsl-chunked>classpath:/xslt/com/jboss/tools/xhtml-release.xsl</xsl-chunked>
+ <xsl-pdf>classpath:/xslt/com/jboss/tools/pdf.xsl</xsl-pdf>
+ <cssdir>../../../documentation/jbosstools-jdocbook-style/src/main/com/css/</cssdir>
+ </properties>
+ </profile>
+ <profile>
<id>diffmk</id>
<properties>
- <master>master_output.xml</master>
+ <master>master_output.xml</master>
+ <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-diff.xsl</xsl-single>
+ <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-diff.xsl</xsl-chunked>
+ <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf-diff.xsl</xsl-pdf>
</properties>
</profile>
</profiles>
@@ -27,8 +58,24 @@
<version>2.1.0-200803311251UTC-MPJDOCBOOK-8</version>
<extensions>true</extensions>
- <dependencies>
+ <dependencies>
<dependency>
+ <groupId>org.jboss.tools</groupId>
+ <artifactId>jbosstools-docbook-xslt</artifactId>
+ <version>1.0.0-SNAPSHOT</version>
+ </dependency>
+ <dependency>
+ <groupId>com.jboss</groupId>
+ <artifactId>jbossent-docbook-xslt</artifactId>
+ <version>1.0.0</version>
+ </dependency>
+ <dependency>
+ <groupId>com.jboss</groupId>
+ <artifactId>jbossent-jdocbook-style</artifactId>
+ <version>1.0.0</version>
+ <type>jdocbook-style</type>
+ </dependency>
+ <dependency>
<groupId>org.jboss</groupId>
<artifactId>jbossorg-docbook-xslt</artifactId>
<version>1.1.0</version>
@@ -54,25 +101,25 @@
<directory>${pom.basedir}/${cssdir}</directory>
</cssResource>
- <formats>
+ <formats>
<format>
<formatName>pdf</formatName>
- <stylesheetResource>file:${pom.basedir}/${stylesdir}/xslt/org/jboss/tools/pdf.xsl</stylesheetResource>
+ <stylesheetResource>${xsl-pdf}</stylesheetResource>
<finalName>${pom.name}.pdf</finalName>
</format>
<format>
<formatName>html</formatName>
- <stylesheetResource>file:${pom.basedir}/${stylesdir}/xslt/org/jboss/tools/xhtml.xsl</stylesheetResource>
+ <stylesheetResource>${xsl-chunked}</stylesheetResource>
<finalName>index.html</finalName>
</format>
<format>
<formatName>html_single</formatName>
- <stylesheetResource>file:${pom.basedir}/${stylesdir}/xslt/org/jboss/tools/xhtml-single.xsl</stylesheetResource>
+ <stylesheetResource>${xsl-single}</stylesheetResource>
<finalName>index.html</finalName>
</format>
<format>
<formatName>eclipse</formatName>
- <stylesheetResource>file:${pom.basedir}/${stylesdir}/xslt/org/jboss/tools/eclipse.xsl</stylesheetResource>
+ <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource>
<finalName>index.html</finalName>
</format>
</formats>
@@ -105,7 +152,9 @@
</distributionManagement>
<properties>
- <stylesdir>../../../documentation/jbosstools-docbook-xslt/src/main/resources/</stylesdir>
+ <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single.xsl</xsl-single>
+ <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml.xsl</xsl-chunked>
+ <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf>
<cssdir>../../../documentation/jbosstools-jdocbook-style/src/main/org/css/</cssdir>
<master>master.xml</master>
<translation>en-US</translation>
15 years, 3 months
JBoss Tools SVN: r14143 - branches/jbosstools-3.0.x/seam/docs/reference/en.
by jbosstools-commits@lists.jboss.org
Author: ochikvina
Date: 2009-03-10 10:37:02 -0400 (Tue, 10 Mar 2009)
New Revision: 14143
Added:
branches/jbosstools-3.0.x/seam/docs/reference/en/master_output.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-655 - adding master_output.xml;
Added: branches/jbosstools-3.0.x/seam/docs/reference/en/master_output.xml
===================================================================
--- branches/jbosstools-3.0.x/seam/docs/reference/en/master_output.xml (rev 0)
+++ branches/jbosstools-3.0.x/seam/docs/reference/en/master_output.xml 2009-03-10 14:37:02 UTC (rev 14143)
@@ -0,0 +1,3348 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.docbook.org/xml/4.3/docbookx.dtd"
+
+[<!ENTITY intro SYSTEM "modules/intro.xml">
+<!ENTITY creating_new_seam SYSTEM "modules/creating_new_seam.xml">
+<!ENTITY directory_structure SYSTEM "modules/directory_structure.xml">
+<!ENTITY menus_and_actions SYSTEM "modules/seam_menus_and_actions.xml">
+<!ENTITY seam_wizards SYSTEM "modules/seam_wizards.xml">
+<!ENTITY generate_entities SYSTEM "modules/generate_entities.xml">
+<!ENTITY seam_editors SYSTEM "modules/seam_editors.xml">
+<!ENTITY seam_view SYSTEM "modules/seam_view.xml">
+<!ENTITY seam_preferences SYSTEM "modules/seam_preferences.xml">
+<!ENTITY adding_seam_support_to_ear_project SYSTEM "modules/adding_seam_support_to_ear_project.xml">
+<!ENTITY crud_database_application SYSTEM "modules/crud_database_application.xml">
+<!ENTITY crud_application_walkthrough SYSTEM "modules/crud_application_walkthrough.xml">
+<!ENTITY business_application SYSTEM "modules/business_application.xml">
+<!ENTITY testng SYSTEM "modules/testng.xml">
+
+
+<!ENTITY seamlink "../../seam/html_single/index.html">
+<!ENTITY aslink "../../as/html_single/index.html">
+<!ENTITY esblink "../../esb_ref_guide/html_single/index.html">
+<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html">
+<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html">
+<!ENTITY jbpmlink "../../jbpm/html_single/index.html">
+<!ENTITY jsflink "../../jsf/html_single/index.html">
+<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html">
+<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html">
+<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html">
+<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html">
+
+
+]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
+
+ <bookinfo>
+
+ <title>Seam Dev Tools Reference Guide</title>
+ <author><firstname>Anatoly</firstname><surname>Fedosik</surname></author>
+ <author><firstname>Olga</firstname><surname>Chikvina</surname></author>
+ <author diffmk:change="added"><firstname diffmk:change="added"><diffmk:wrapper diffmk:change="added">Michael</diffmk:wrapper></firstname><surname diffmk:change="added"><diffmk:wrapper diffmk:change="added">Sorokin</diffmk:wrapper></surname></author>
+
+ <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author>
+
+ <pubdate>April 2008</pubdate>
+ <copyright>
+ <year>2007</year>
+ <year><diffmk:wrapper diffmk:change="changed">2009</diffmk:wrapper></year>
+ <holder><diffmk:wrapper diffmk:change="changed">JBoss, a division of Red Hat</diffmk:wrapper></holder>
+ </copyright>
+ <releaseinfo><diffmk:wrapper diffmk:change="changed">
+ Version: 3.0.0.GA
+ </diffmk:wrapper></releaseinfo>
+
+<abstract>
+ <title></title>
+ <para>
+ <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/seam/pdf/Seam_Refere...">PDF version</ulink>
+ </para>
+</abstract>
+
+
+ </bookinfo>
+ <toc></toc>
+
+
+<chapter id="intro" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/seam/docs/reference/en/modules/intro.xml" xreflabel="intro">
+ <?dbhtml filename="intro.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>Seam</keyword>
+ <keyword>JBDS</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Introduction</title>
+
+ <section>
+
+ <title>What is Seam?</title>
+ <para>This introduction will help you to understand what is <property moreinfo="none">Seam</property>.</para>
+ <para><property moreinfo="none">Seam</property> is a fully featured application framework on top of Java EE
+ 5. It is also one of the most popular enterprise Java framework today. Seam deeply
+ integrates many other standard-based or open source frameworks (e.g., JSF, EJB3, JMS,
+ Web Services, jBPM, JBoss Rules, Ajax4jsf, RichFaces, Facelets, Spring, iText, Quartz,
+ TestNG, etc.), and provides a single programming model for developers to
+ "drive" those underlying frameworks via simple annotated POJOs (Plain
+ Old Java Objects). It makes life easier for developers to tackle complex enterprise
+ applications with many component frameworks.</para>
+ </section>
+
+ <section>
+ <title>Installation into Eclipse</title>
+
+ <para>Here, we are going to explain how to install Seam plugin into Eclipse.</para>
+
+ <para>Seam is a one module of JBoss Tools project. Since Seam has a dependence on other JBoss Tools modules we recommend you to install
+ a bundle of all <ulink url="http://labs.jboss.com/tools/download/index.html">JBoss Tools plug-ins</ulink>. Installation instruction you can find on JBoss Wiki in <ulink url="http://labs.jboss.com/wiki/InstallingJBossTools">InstallingJBossTools</ulink> section.</para>
+
+ </section>
+
+ <section>
+ <title>Other relevant resources on the topic</title>
+
+ <para>The <ulink url="http://seamframework.org/">Seam Framework</ulink> - Next generation enterprise Java development.</para>
+ <para>All latest release versions of JBoss Developer Studio/JBoss Tools documentation you can find <ulink url="http://docs.jboss.org/tools/2.1.0.GA/">here</ulink>.</para>
+ <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">here</ulink>.</para>
+
+ </section>
+</chapter>
+
+
+<chapter id="create_seam" role="updated" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/seam/docs/reference/en/modules/creating_new_seam.xml" xreflabel="create_seam">
+ <?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><diffmk:wrapper diffmk:change="changed">In this chapter we provide you with the necessary steps to start working with Seam
+ Framework.</diffmk:wrapper></para>
+
+ <para>At first, we suggest setting the specific Seam perspective that combines a number of
+ different views and editors needed for work with resources concerned. For that select <emphasis>
+ <property moreinfo="none">Window > Open Perspective > Other > Seam</property>
+ </emphasis> or you can also access it through the button in the right top corner.</para>
+
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Seam Perspective Icon</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_0.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Also the </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Open Web Browser</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> action is directly available in the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Seam perspective</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Embedded Web Browser Button</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/create_new_seam/create_seam_01.png"></imagedata>
+ </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 organise a simple Seam Project and
+ experiment with it by creating variations.</para>
+ <para>Thus, you should select <emphasis>
+ <property moreinfo="none">File > New > Seam Web Project</property>
+ </emphasis> to run the <property moreinfo="none">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's get through the wizard step-by-step. First, you should enter a name and
+ a location directory for your new project.</para>
+
+ <figure float="0" id="figure_create_seam1">
+ <title>New Seam Project Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para><diffmk:wrapper diffmk:change="added">On the figure above you can see the runtime and the server already created.</diffmk:wrapper></para>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If you need to create a new runtime, click on the </diffmk:wrapper><emphasis>
+ <property moreinfo="none">New...</property>
+ </emphasis> button in the <property moreinfo="none">Target Runtime</property><diffmk:wrapper diffmk:change="changed"> section. It brings up the
+ wizard where you can specify a new JBoss Server Runtime environment or the other type of
+ runtime appropriate for configuring your project. Let's create one more JBoss 4.2
+ Runtime. Hence, after choosing it click on </diffmk:wrapper><emphasis>
+ <property moreinfo="none">Next</property>
+ </emphasis> button.</para>
+
+ <figure float="0">
+ <title>Specifying Target Runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_2.png"></imagedata>
+ </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 moreinfo="none">Browse</property>
+ </emphasis> button, select a Java Runtime Environment, and select which configuration
+ you want.</para>
+
+ <figure float="0">
+ <title>Specifying Target Runtime Configurations</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para> Clicking on <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> returns you to the <link linkend="figure_create_seam1"><diffmk:wrapper diffmk:change="changed">New Seam Project
+ wizard page</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The next step is to define a Server that you can do by clicking
+ on </diffmk:wrapper><emphasis>
+ <property moreinfo="none">New...</property>
+ </emphasis> button in the <property moreinfo="none">Target Server</property><diffmk:wrapper diffmk:change="changed"> section. In appeared
+ </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">New Server dialog</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> the last server which matches the runtime
+ will be selected.</diffmk:wrapper></para>
+
+ <para><diffmk:wrapper diffmk:change="changed">All declared runtimes are listed in the combo box under the servers view. Here, you
+ can indicate a server runtime that you need. Click </diffmk:wrapper><emphasis>
+ <property moreinfo="none">Add</property>
+ </emphasis> if you want to add a new Server Runtime.</para>
+
+ <figure float="0">
+ <title>Specifying Target Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para><diffmk:wrapper diffmk:change="changed">Next page allows you to verify the information for chosen server. Leave everything as
+ it is and click on </diffmk:wrapper><emphasis>
+ <property moreinfo="none">Next</property>
+ </emphasis>.</para>
+
+ <figure float="0">
+ <title>Specifying Server Configurations</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para><diffmk:wrapper diffmk:change="changed">On the last wizard step you can modify your projects to configure them on the
+ Server.</diffmk:wrapper></para>
+
+ <figure float="0">
+ <title>Project Modification for Configuring on the Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ <para>Once you have the Target Server defined click on <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> button to return to the first page of the <property moreinfo="none">New Seam Project
+ wizard</property>.</para>
+
+ <tip>
+ <title>Tip:</title>
+ <para>We suggest that you look through our <ulink url="../../as/html_single/index.html">AS manager
+ guide</ulink> to find out more about runtimes and servers.</para>
+ </tip>
+
+ <figure float="0">
+ <title>Completion of Runtime and Server Configuration</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_7.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The last section on this wizard step is <property moreinfo="none">Configuration</property><diffmk:wrapper diffmk:change="changed">. 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 </diffmk:wrapper><emphasis>
+ <property moreinfo="none">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>Select the Project Facets</title>
+
+ <para>The <property moreinfo="none">Project Facets wizard</property> allows you to enable or disable
+ specific facets which define necessary characteristics for the project. In time 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 float="0">
+ <title>Project Facets Selection</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_8.png"></imagedata>
+ </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 moreinfo="none">Save</property>
+ </emphasis> button.</para>
+
+ <figure float="0">
+ <title>Specifying Custom Facet Preset</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_15.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>To see all available Server runtimes click on <property moreinfo="none">Runtimes</property> tab on the
+ left. You can create a new one using the <emphasis>
+ <property moreinfo="none">New</property>
+ </emphasis> button. If more than one runtimes are checked here, the <emphasis>
+ <property moreinfo="none">Make Primary</property>
+ </emphasis> button won't be dimmed yet. So you can make use of it to mark
+ primary runtime.</para>
+
+ <figure float="0">
+ <title>Runtime Manipulations</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_16.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para><emphasis>
+ <property moreinfo="none">Ok</property>
+ </emphasis> button will bring you to the <property moreinfo="none">Web Module</property> wizard form
+ again.</para>
+ </section>
+
+ <section id="configureWebModule">
+ <title>How to Configure Web Module Settings</title>
+
+ <para> As we deal with a Dynamic Web Application we should first specify the top level
+ directory of our application for deploying it to a server afterwards. You know, this
+ kind of application contains both Web and Java code resources. Thus, it's also important
+ to indicate the content directory as well as Java source directory. The wizard will put
+ all those values itself. So you can leave everything as it is.</para>
+
+ <figure float="0">
+ <title>Web Module Settings</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_9.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Choose <emphasis>
+ <property moreinfo="none">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 into your project for representing
+ appropriate behaviours associated with JSF. </para>
+ <para>Checking <emphasis>
+ <property moreinfo="none">Server Supplied JSF Implementation</property>
+ </emphasis> means that you will have a default JSF implementation given by
+ server.</para>
+
+ <figure float="0">
+ <title>Adding JSF Capabilities to Web Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_10.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>In case when you want to use your custom JSF implementation check a lower radio
+ button. You are able to create a library of jars by clicking on <emphasis>
+ <property moreinfo="none">New</property>
+ </emphasis> button.</para>
+ <para>Here, it's necessary to type a <property moreinfo="none">Library Name</property>, select a
+ <property moreinfo="none">Version Supported</property> and add proper <property moreinfo="none">Library
+ jars</property>. Then click on <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> to complete the choice.</para>
+ <figure float="0">
+ <title>Create JSF Implementation Library</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_17.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>In the Component Libraries section of the wizard you can also add <property moreinfo="none">Component
+ Libraries</property> (e.g. <ulink url="http://www.jboss.org/jbossrichfaces">Richfaces</ulink>). Just click on <emphasis>
+ <property moreinfo="none">New</property>
+ </emphasis> button. Appeared dialog will ask you to type the Library name, supported
+ version and add necessary jar's. Press <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> to complete the choice.</para>
+
+ <figure float="0">
+ <title>Create JSF Implementation Component Library</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_18.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The last wizard options allows to edit a path for <property moreinfo="none">JSF Configuration
+ File</property>, a name for <property moreinfo="none">JSF Servlet</property>, <property moreinfo="none">JSF Servlet
+ Classname</property> and change <property moreinfo="none">URL Mapping Patterns</property>.</para>
+
+ <figure float="0">
+ <title>JSF Capabilities Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_19.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Finally, as 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 float="0">
+ <title>Seam Facet Settings</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_11.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Create Seam runtime and define Seam home folder.</para>
+ </listitem>
+ </itemizedlist>
+ <para>For that click on <emphasis>
+ <property moreinfo="none">Add</property>
+ </emphasis> button in the <property moreinfo="none">General</property> section. Notice that in this
+ wizard presented below you can create a Seam runtime only for that version which was
+ selected in the <link linkend="projectFacets">Project Facets</link> wizard (version 1.2
+ in our case).</para>
+
+ <figure float="0">
+ <title>Seam Runtime Creation</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_12.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Select EAR or WAR deployment by checking a necessary radio button.</para>
+ </listitem>
+ <listitem>
+ <para>Select a <emphasis>
+ <property moreinfo="none">Database Type</property>
+ </emphasis></para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Seam Runtime Creation</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_20.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>and then specify a <emphasis>
+ <property moreinfo="none">Connection profile</property>
+ </emphasis> appropriate for your database.</para>
+
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Connection Profile Options</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_21.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>You can edit chosen profile by using <emphasis>
+ <property moreinfo="none">Edit</property>
+ </emphasis> button or organise a new one by clicking on <emphasis>
+ <property moreinfo="none">New</property>
+ </emphasis> button and selecting necessary for you type of connection profile.</para>
+ <figure float="0">
+ <title>Connection Profile Selecting</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_13.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>On the other dialog you'll be asked to enter its name and description. And
+ then you should select a proper driver and adjust connection details. Press <emphasis>
+ <property moreinfo="none">Next</property>
+ </emphasis> to preview all the adjusted settings and complete the creation of the new
+ profile.</para>
+
+ <figure float="0">
+ <title>Connection Details</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_22.png"></imagedata>
+ </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 moreinfo="none">Code Generation</property> section the wizard have already put the
+ names for your <property moreinfo="none">Session Bean</property>, <property moreinfo="none">Entity Bean</property> and
+ <property moreinfo="none">Test</property> packages. Of course, you can change them into the others
+ which you like.</para>
+
+ <figure float="0">
+ <title>Code Generation Section</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_14.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Click on <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> to generate a project.</para>
+
+ <para></para>
+ </section>
+</chapter>
+
+
+<chapter id="directory_str" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/seam/docs/reference/en/modules/directory_structure.xml" xreflabel="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 float="0">
+ <title>Project Layout for WAR projects</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/directory_structure/directory_structure_1.png" scale="75"></imagedata>
+ </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 1.2.1 war hotdeploy feature. Classes put
+ into <emphasis>
+ <property moreinfo="none">src/action</property>
+ </emphasis> will be deployed to <emphasis>
+ <property moreinfo="none">WEB-INF/dev</property>
+ </emphasis> from which Seam 1.2.1 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 moreinfo="none">WEB-INF/classes</property>, </emphasis> but since Seam gives <emphasis>
+ <property moreinfo="none">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
+ <link linkend="testNG">TestNG</link> directly against the proper libraries and
+ server runtime libraries. When the TestNG plugin is installed you can just run your
+ tests via <emphasis><property moreinfo="none">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 moreinfo="none">Run As > Run on Server</property>.</emphasis> Studio will deploy
+ WAR project into one web application on server to <property moreinfo="none">deploy</property><diffmk:wrapper diffmk:change="changed">
+ folder.</diffmk:wrapper></para>
+
+ </section>
+
+ <section id="EAR">
+ <title>EAR Deployment</title>
+ <para>The project layout for EAR projects is:</para>
+
+ <figure float="0">
+ <title>Project Layout for EAR projects</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/directory_structure/directory_structure_2.png" scale="75"></imagedata>
+ </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 moreinfo="none">-ear</property> postfix and select <emphasis>
+ <property moreinfo="none">Run As > Run on Server</property>.</emphasis> Studio will take care
+ about all modules and deploy EAR project into one enterprise application on server to
+ <property moreinfo="none">deploy</property> folder. EAR application keeps <property moreinfo="none">ejb</property>
+ and <property moreinfo="none">war</property> modules of the EAR project.</para>
+ </section>
+
+ <section diffmk:change="added" id="seam_version_changing">
+
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Changing the Seam Version</diffmk:wrapper></title>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">To upgrade or downgrade your projects Seam version use the facet preferences. You
+ should right-click your project and choose </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Project Facets</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> category. Next select </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Seam</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> and change its version to needed one.</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Changing the Seam Facet Version</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/directory_structure/directory_structure_3.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">After pressing </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Apply</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> the wizard for adjusting new Seam runtime settings appears.</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Changing the Seam Facet Version</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/directory_structure/directory_structure_4.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If you need to update the libraries for you project, check the </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Update libraries</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> option. All libraries you checked will be removed and the libraries from the
+ new Seam distribution will be added after clicking </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Ok</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></emphasis></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Changing the Seam Facet Version</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/directory_structure/directory_structure_5.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Note:</diffmk:wrapper></title>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The note "Seam configuration files and their XSDs won'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.</diffmk:wrapper></para>
+ </note>
+ </section>
+
+ <section diffmk:change="added" id="changing_seam_parent_project">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Changing Seam Parent Project</diffmk:wrapper></title>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Starting from the 2.0.0.CR2 version of </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> 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.</diffmk:wrapper></para>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Go to your project preferences and select </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Seam Settings</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> category on the left. Press the </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Browse</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> button next to the </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Main Seam Project</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> section to select the other Seam parent project.</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Changing Seam Parent Project</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/directory_structure/directory_structure_6.png" scale="75"></imagedata>
+ </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><project_name></emphasis>,
+ <emphasis><project_name>-test</emphasis>,
+ <emphasis><project_name>-test</emphasis> or
+ <emphasis><project_name>-ejb</emphasis>) or any entire folder like
+ <emphasis><project_name>/WebContent</emphasis>,
+ <emphasis><project_name>/ejbModule</emphasis>,
+ <emphasis><project_name>-test/test-src</emphasis>, or project name in
+ packages <emphasis>org.domain.<project_name>.session</emphasis>,
+ <emphasis>org.domain.<project_name>.entity</emphasis>, you can do this
+ by brining the context menu and navigating <emphasis>
+ <property moreinfo="none">Refactor > Rename...</property>
+ </emphasis> or just pressing <emphasis>
+ <property moreinfo="none">Shift + Alt + R</property>
+ </emphasis> under the chosen resource.</para>
+
+ <para>Use <emphasis>
+ <property moreinfo="none">Refactor > Move...</property>
+ </emphasis> (or <emphasis>
+ <property moreinfo="none">Shift + Alt + V</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed">), if you need to move
+ </diffmk:wrapper><emphasis><project_name>/WebContent</emphasis><diffmk:wrapper diffmk:change="changed"> folder,
+ </diffmk:wrapper><emphasis><project_name>/ejbModule</emphasis><diffmk:wrapper diffmk:change="changed"> folder or
+ </diffmk:wrapper><emphasis><project_name>/test-src</emphasis> folder in the other place
+ within the Project structure.</para>
+ </section>
+</chapter>
+
+
+<chapter id="menus_and_actions" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/seam/docs/reference/en/modules/seam_menus_and_actions.xml" xreflabel="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 moreinfo="none">File > New</property>
+ </emphasis> submenu</para>
+
+ <table>
+ <title>Seam Actions in the New Submenu</title>
+ <tgroup cols="2">
+ <colspec align="left" colnum="1" colwidth="1*"></colspec>
+ <colspec colnum="2" colwidth="4*"></colspec>
+
+ <thead>
+ <row>
+ <entry align="center">
+ <para>Name</para>
+ </entry>
+
+ <entry align="center">
+ <para>Function</para>
+ </entry>
+
+ </row>
+ </thead>
+
+ <tbody>
+
+
+ <row>
+ <entry>
+ <para>
+ <property moreinfo="none">Seam Web Project</property>
+ </para>
+
+ </entry>
+
+ <entry>
+ <para>Runs <link linkend="standaloneSeam">New Seam Project</link> wizard
+ for creating a new Seam project </para>
+ </entry>
+
+
+ </row>
+
+
+ <row>
+ <entry>
+ <para>
+ <property moreinfo="none">Seam Action</property>
+ </para>
+
+ </entry>
+
+ <entry>
+ <para>Runs <link linkend="seam_action">New Seam Action</link> wizard for
+ creating a new Seam action </para>
+ </entry>
+
+
+ </row>
+
+
+
+ <row>
+ <entry>
+ <para>
+ <property moreinfo="none">Seam Form</property>
+ </para>
+
+ </entry>
+
+ <entry>
+ <para>Runs <link linkend="seam_form">New Seam Form</link> wizard for
+ creating a new Seam form </para>
+ </entry>
+
+
+ </row>
+
+
+ <row>
+ <entry>
+ <para>
+ <property moreinfo="none">Seam Entity</property>
+ </para>
+
+ </entry>
+
+ <entry>
+ <para>Runs <link linkend="seam_entity">New Seam Entity</link> wizard for
+ creating a new Seam entity </para>
+ </entry>
+
+
+ </row>
+
+ <row>
+ <entry>
+ <para>
+ <property moreinfo="none">Seam Conversation</property>
+ </para>
+
+ </entry>
+
+ <entry>
+ <para>Runs <link linkend="seam_conversation">New Seam
+ Conversation</link> wizard for creating a new Seam conversation
+ </para>
+ </entry>
+
+
+
+ </row>
+
+ <row>
+ <entry>
+ <para>
+ <property moreinfo="none">Seam Generate Entities</property>
+ </para>
+
+ </entry>
+
+ <entry>
+ <para>Runs <link linkend="generate_entities">Generate Seam
+ Entities</link> 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 expretions both in <emphasis>
+ <property moreinfo="none">.java</property>
+ </emphasis> and <emphasis>
+ <property moreinfo="none">.xhtml</property>
+ </emphasis> files use Find Seam References/Declarations actions. For that, in the main menu bar click on <emphasis>
+ <property moreinfo="none">Search > Find Seam References</property>
+ </emphasis> or <emphasis><property moreinfo="none">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 align="left" colnum="1" colwidth="1*"></colspec>
+ <colspec colnum="2" colwidth="4*"></colspec>
+ <colspec colnum="3" colwidth="2*"></colspec>
+
+
+ <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 moreinfo="none">Find Seam References</property>
+ </para>
+ <para>
+ <property moreinfo="none">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 moreinfo="none">Search view</property>.
+ </para>
+
+ <figure float="0">
+ <title>Find Seam Declaration for "Identity"</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_menus_and_actions/menus_and_actions1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>You can also use Ctrl + 1 in .java files to activate the actions:</para>
+
+ <figure float="0">
+ <title>Find Seam References for "Identity"</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_menus_and_actions/menus_and_actions2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+
+ <section id="open_seam_component">
+ <title>Open Seam Component</title>
+
+ <para>To open Seam Components click on <emphasis><property moreinfo="none">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 float="0">
+ <title>Open Seam Components icon</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_menus_and_actions/menus_and_actions3_0.png"></imagedata>
+ </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 align="left" colnum="1" colwidth="1*"></colspec>
+ <colspec colnum="2" colwidth="4*"></colspec>
+ <colspec colnum="3" colwidth="2*"></colspec>
+
+
+ <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 moreinfo="none">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 float="0">
+ <title>Open Seam Components Dialog</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_menus_and_actions/menus_and_actions3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+
+ </section>
+
+</chapter>
+
+
+<chapter id="seam_wizards" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/seam/docs/reference/en/modules/seam_wizards.xml" xreflabel="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><diffmk:wrapper diffmk:change="changed">All the Seam component generations options known from Seam-gen are available as wizards
+ (with sensible auto-defaulting) for creating various common Seam components:</diffmk:wrapper></para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <property moreinfo="none">Seam Action</property>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <property moreinfo="none">Seam Form</property>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <property moreinfo="none">Seam Entity</property>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <property moreinfo="none">Seam Conversation</property>
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Go to <emphasis>
+ <property moreinfo="none">File > New</property>
+ </emphasis> and select the component wizard.</para>
+
+ <figure float="0">
+ <title>Seam Component Wizards</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para><diffmk:wrapper diffmk:change="changed">The wizards create multiple resources and place it in the appropriate folders depending on
+ your project structure (WAR or EAR).</diffmk:wrapper></para>
+ <para>Let's create a WAR project using the New Seam Project wizard.</para>
+
+ <figure float="0">
+ <title>Seam Project WAR Deployment</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_2.png"></imagedata>
+ </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><diffmk:wrapper diffmk:change="changed">To create a New Seam Action you should select a necessary project, type a name for
+ </diffmk:wrapper><property moreinfo="none">Seam component</property>, <property moreinfo="none">POJO class</property><diffmk:wrapper diffmk:change="changed">,
+ </diffmk:wrapper><property moreinfo="none">Method</property>, <property moreinfo="none">Page</property><diffmk:wrapper diffmk:change="changed"> and select a
+ </diffmk:wrapper><property moreinfo="none">Package</property><diffmk:wrapper diffmk:change="changed"> using the </diffmk:wrapper><emphasis>
+ <property moreinfo="none">Browse</property>
+ </emphasis> button.</para>
+
+ <figure float="0">
+ <title>New Seam Action Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para><diffmk:wrapper diffmk:change="added">If you specify a class which already exists, the wizard will warn you about it.</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Wizard Warning against Existing File</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/seam_wizards/action_warning.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para diffmk:change="added">You can see the action page in <property moreinfo="none">WebContent</property><diffmk:wrapper diffmk:change="changed"> folder. Click on it to
+ open in JBoss Tools HTML Editor.</diffmk:wrapper></para>
+
+ <figure float="0">
+ <title>Action Page in JBoss Tools HTML Editor.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_5.png" scale="70"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ <note>
+ <title>Note:</title>
+ <para><diffmk:wrapper diffmk:change="changed">You don't need to restart the server to see how the action component works. Just
+ use context menu </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Run As > Run On
+ Server</diffmk:wrapper></property>.</emphasis></para>
+ </note>
+
+ <para><diffmk:wrapper diffmk:change="changed">Action component was hot-deployed. Forms and Conversations will work the same
+ way.</diffmk:wrapper></para>
+
+ <figure float="0">
+ <title>Action Component</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+
+ </section>
+ <section id="seam_form">
+ <title>New Seam Form</title>
+
+ <para>Click on <property moreinfo="none">actionMethod</property><diffmk:wrapper diffmk:change="changed"> in the internal browser and add a form in
+ your project using the New Seam Form wizard </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">File > New > Seam
+ Form</diffmk:wrapper></property>.</emphasis></para>
+ <para>Select a necessary project, type a name for <property moreinfo="none">Seam component</property><diffmk:wrapper diffmk:change="changed">,
+ </diffmk:wrapper><property moreinfo="none">POJO class</property><diffmk:wrapper diffmk:change="changed">, </diffmk:wrapper><property moreinfo="none">Method</property><diffmk:wrapper diffmk:change="changed">,
+ </diffmk:wrapper><property moreinfo="none">Page</property> and select a <property moreinfo="none">Package</property> using <emphasis>
+ <property moreinfo="none">Browse</property>
+ </emphasis> button.</para>
+
+ <figure float="0">
+ <title>New Seam Form Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_7.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para><diffmk:wrapper diffmk:change="added">If you specify a class which already exists, the wizard will warn you about it.</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Wizard Warning against Existing File</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/seam_wizards/form_warning.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para diffmk:change="added">The Form Page was created in <property moreinfo="none">WebContent</property> folder.</para>
+
+ <figure float="0">
+ <title>Form Page in JBoss Tools HTML Editor.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_8.png" scale="70"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Deploy the form on server. Right click on Form Page, select <emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Run As
+ > Run On Server</diffmk:wrapper></property>.</emphasis></para>
+
+ <figure float="0">
+ <title>Form Component</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_9.png"></imagedata>
+ </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 moreinfo="none">value1</property><diffmk:wrapper diffmk:change="changed">) and click on
+ </diffmk:wrapper><property moreinfo="none">formMethod</property>.</para>
+ <para><diffmk:wrapper diffmk:change="changed">Add a conversation using the New Seam Conversation wizard </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">File >
+ New > Seam Form</diffmk:wrapper></property>.</emphasis></para>
+ <para>You should select a necessary project, type a name for <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Seam
+ component</diffmk:wrapper></property>, <property moreinfo="none">POJO class</property><diffmk:wrapper diffmk:change="changed">, </diffmk:wrapper><property moreinfo="none">Method</property><diffmk:wrapper diffmk:change="changed">,
+ </diffmk:wrapper><property moreinfo="none">Page</property> and select a <property moreinfo="none">Package</property> using <emphasis>
+ <property moreinfo="none">Browse</property>
+ </emphasis> button.</para>
+
+
+ <figure float="0">
+ <title>New Seam Conversation Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_10.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para><diffmk:wrapper diffmk:change="added">If you specify a class which already exists, the wizard will warn you about it.</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Wizard Warning against Existing File</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/seam_wizards/conversation_warning.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para diffmk:change="added">Conversation page was created in <property moreinfo="none">WebContent</property> folder.</para>
+
+ <figure float="0">
+ <title>Conversation Page in JBoss Tools HTML Editor.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_11.png" scale="70"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Right click on Conversation page, select <emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Run As > Run On
+ Server</diffmk:wrapper></property>.</emphasis></para>
+
+ <figure float="0">
+ <title>Conversation Component</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_12.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Conversation component was hot-deployed.</para>
+ <para>Click on <property moreinfo="none">Begin</property> and <property moreinfo="none">Increment</property><diffmk:wrapper diffmk:change="changed"> buttons to
+ check the conversation functionality.</diffmk:wrapper></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 moreinfo="none"><diffmk:wrapper diffmk:change="changed">File > New > Seam
+ Entity</diffmk:wrapper></property>.</emphasis>
+ </para>
+
+ <para>You should select a necessary project, type a name for <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Entity
+ class</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed">, select a </diffmk:wrapper><property moreinfo="none">Package</property> using <emphasis>
+ <property moreinfo="none">Browse</property>
+ </emphasis> button, type a name for <property moreinfo="none">Master Page</property><diffmk:wrapper diffmk:change="changed"> and
+ </diffmk:wrapper><property moreinfo="none">Page</property>.</para>
+
+ <figure float="0">
+ <title>New Seam Entity Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_13.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If you specify a class which already exists, the wizard will warn you about it.</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Wizard Warning against Existing File</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/seam_wizards/entity_warning.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The Master Page and the Entity were created in <property moreinfo="none">WebContent</property><diffmk:wrapper diffmk:change="changed">
+ folder.</diffmk:wrapper></para>
+
+ <figure float="0">
+ <title>Master Page in JBoss Tools HTML Editor.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_14.png" scale="70"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The Entity page is:</para>
+
+ <figure float="0">
+ <title>Entity Page in JBoss Tools HTML Editor.</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_15.png" scale="70"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Run the Entity page on server. This is what you get:</para>
+
+ <figure float="0">
+ <title>Customer Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_16.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Let's create two customers <property moreinfo="none">c1</property> and <property moreinfo="none">c2</property><diffmk:wrapper diffmk:change="changed">. Enter
+ the name in the text field and press the </diffmk:wrapper><property moreinfo="none">Save</property><diffmk:wrapper diffmk:change="changed"> button. Customer
+ should be successfully created. Press </diffmk:wrapper><property moreinfo="none">Done</property><diffmk:wrapper diffmk:change="changed">. Do the same for
+ </diffmk:wrapper><property moreinfo="none">c2</property> customer. The result should be:</para>
+
+ <figure float="0">
+ <title>Two Customers Are Created</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_wizards/seam_wizards_17.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+</chapter>
+
+
+<chapter id="generate_entities" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/seam/docs/reference/en/modules/generate_entities.xml" xreflabel="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 within Eclipse using Hibernate Tools plugin for the standard seam-gen generation.</para>
+ <para>Generate Entities 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 float="0">
+ <title>Generate Seam Entities Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/generate_entities/generate_entities1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>In the Generate Seam Entities wizard there are two generation modes: Reverse Engineer from database
+ and Use existing entities.</para>
+
+ <para>The <property moreinfo="none">Reverse Engineer from database</property> mode can be described in four steps:</para>
+ <orderedlist continuation="restarts" inheritnum="ignore">
+ <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
+ <property moreinfo="none">org.domain.project.entity</property> package</para></listitem>
+ <listitem><para>For the entities from step 2 the classes <property moreinfo="none">EntityList</property> and <property moreinfo="none">EntityHome</property> are generated
+ into <property moreinfo="none">org.domain.project.session</property> package</para></listitem>
+ <listitem><para>The xhtml pages are generated.</para></listitem>
+ </orderedlist>
+ <para>
+ Checking the <property moreinfo="none">Use existing entities</property> mode the wizard executes only 3 and 4 steps. It generates missing classes and
+ xhtml pages.
+ </para>
+
+ <para>Read the <link linkend="crud_database_application">Generate a CRUD Database Application</link> chapter in order to see how the <property moreinfo="none">Generate Seam Entities</property> wizard can be used.</para>
+
+
+ </chapter>
+
+
+
+<chapter id="seam_editors" role="updated" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/seam/docs/reference/en/modules/seam_editors.xml" xreflabel="seam_editors">
+ <?dbhtml filename="seam_editors.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>Seam</keyword>
+ <keyword>JBDS</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title><diffmk:wrapper diffmk:change="changed">Seam Editors</diffmk:wrapper></title>
+
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">This chapter tells about Seam Editors and their features.</diffmk:wrapper></para>
+
+ <section diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Visual Page Editor</diffmk:wrapper></title>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Visual Page Editor fits perfectly for authoring view Seam pages. The major features of VPE are listed in </diffmk:wrapper><link diffmk:change="added" linkend="SeamEditors"><diffmk:wrapper diffmk:change="added">Main Features of Seam Editors</diffmk:wrapper></link> </para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You can also read more about Visual Page Editor in </diffmk:wrapper><ulink diffmk:change="added" url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf/html/editors.htm..."><diffmk:wrapper diffmk:change="added">Visual Page Editor</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> chapter of "Visual Web Tools Reference Guide".</diffmk:wrapper></para>
+ </section>
+
+
+
+
+ <section diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Seam Pages Editor</diffmk:wrapper></title>
+
+
+ <para diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Seam Pages Editor</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> provides a handy way to edit the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">pages.xml</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> file.
+
+ </diffmk:wrapper></para>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">
+ You can edit the pages.xml file in three modes: Graphical, Tree and Source.
+
+ </diffmk:wrapper></para>
+
+ <section diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Graphical Mode</diffmk:wrapper></title>
+
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Graphical mode provides you with a set of visual tools to organize your project pageflow, exception handling etc.</diffmk:wrapper></para>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Seam Pages Editor: Graphical View</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/seam_editors/seam_editors_7.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The Graphical part of the editor has some visual elements. The table below shows graphical representation of the elements and explains their meanings. </diffmk:wrapper></para>
+
+<table diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Pages Editor: Graphical View. Visual elements</diffmk:wrapper></title>
+ <tgroup cols="2" diffmk:change="added">
+ <thead diffmk:change="added">
+ <row diffmk:change="added">
+ <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Element</diffmk:wrapper></entry>
+
+ <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Description</diffmk:wrapper></entry>
+ </row>
+ </thead>
+ <tbody diffmk:change="added">
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/seam_editors/element_page.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </entry>
+ <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">A yellow box with a solid border represents a </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added"><page></diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> element.
+ </diffmk:wrapper></para></entry>
+ </row>
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/seam_editors/element_param.png"></imagedata>
+ </imageobject>
+ </mediaobject></entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Pressing on the plus icon (</diffmk:wrapper><inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/seam_editors/icon_plus.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject><diffmk:wrapper diffmk:change="added">)
+
+
+ on the </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added"><page></diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> element reveals a box that lists the parameters for the page.</diffmk:wrapper></para>
+ </entry>
+
+ </row>
+
+ <row diffmk:change="added">
+ <entry diffmk:change="added"> <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/seam_editors/element_page2.png"></imagedata>
+ </imageobject>
+ </mediaobject></entry>
+ <entry diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">A red cross in the upper left corner of the page box indicates that the view-id is not found in the project.</diffmk:wrapper></para>
+ </entry>
+ </row>
+
+ <row diffmk:change="added">
+ <entry diffmk:change="added"><mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/seam_editors/element_page1.png"></imagedata>
+ </imageobject>
+ </mediaobject></entry>
+ <entry diffmk:change="added"> <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">
+ 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.
+ </diffmk:wrapper></para></entry>
+ </row>
+
+
+ <row diffmk:change="added">
+ <entry diffmk:change="added"> <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/seam_editors/element_exception.png"></imagedata>
+ </imageobject>
+ </mediaobject></entry>
+ <entry diffmk:change="added"> <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">An <exception> is represented by a blue box with a orange diamond.</diffmk:wrapper></para></entry>
+ </row>
+
+
+
+
+
+ </tbody>
+ </tgroup>
+</table>
+
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Pageflow relations are shown with gray arrows, when you select a relationship the arrow is changed to orange. </diffmk:wrapper></para>
+
+
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">On the lefthand side of the Graphical view of </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Seam Page Editor</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> you can find a toolbar with a set of icons for the most frequently used commands. </diffmk:wrapper></para>
+
+ <table diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Pages Editor: Graphical View. Commands Icons</diffmk:wrapper></title>
+ <tgroup cols="2" diffmk:change="added">
+ <thead diffmk:change="added">
+ <row diffmk:change="added">
+ <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Icon Image</diffmk:wrapper></entry>
+
+ <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Command</diffmk:wrapper></entry>
+ </row>
+ </thead>
+ <tbody diffmk:change="added">
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/seam_editors/icon_select.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+
+ </entry>
+ <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Select a page element</diffmk:wrapper></entry>
+
+ </row>
+
+ <row diffmk:change="added">
+ <entry diffmk:change="added"><inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/seam_editors/icon_marquee.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject></entry>
+ <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Marquee a page item</diffmk:wrapper></entry>
+ </row>
+
+
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/seam_editors/icon_new_link.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+
+ </entry>
+ <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Add a page relationship</diffmk:wrapper></entry>
+ </row>
+
+
+ <row diffmk:change="added">
+ <entry diffmk:change="added">
+ <inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/seam_editors/icon_exception.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject>
+
+ </entry>
+ <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Add an exception rule</diffmk:wrapper></entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Context menus are also available when you click either on an item or a blank space.</diffmk:wrapper></para>
+
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">A context menu called on a blank space of the diagram provides the following options:</diffmk:wrapper></para>
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added" role="bold"><diffmk:wrapper diffmk:change="added">Page</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> creates a new page element on the diagram</diffmk:wrapper></para></listitem>
+ <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added" role="bold"><diffmk:wrapper diffmk:change="added">Exception</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> creates a new exception element on the diagram</diffmk:wrapper></para></listitem>
+ <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added" role="bold"><diffmk:wrapper diffmk:change="added">Auto Layout</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> formats the layout of the diagram automatically</diffmk:wrapper></para></listitem>
+ <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added" role="bold"><diffmk:wrapper diffmk:change="added">Select Element</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> calls the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Select Element Wizard</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> with a filter to perform a quick search through the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">pages</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> file </diffmk:wrapper></para></listitem>
+ </itemizedlist>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Rightclicking on a </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added"><page></diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> element calls a context menu where you can choose the following options if you click on the </diffmk:wrapper><emphasis diffmk:change="added" role="bold"><diffmk:wrapper diffmk:change="added">New</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> menu item: </diffmk:wrapper></para>
+
+
+
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added" role="bold"><diffmk:wrapper diffmk:change="added">Rule</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> defines a new navigation rule for the element </diffmk:wrapper></para></listitem>
+ <listitem diffmk:change="added"><para diffmk:change="added"><emphasis diffmk:change="added" role="bold"><diffmk:wrapper diffmk:change="added">Param</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> adds a </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added"><param></diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> tag
+ </diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> to the </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added"><page></diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> element</diffmk:wrapper></para></listitem>
+ </itemizedlist>
+ </section>
+
+
+ <section diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Tree Mode</diffmk:wrapper></title>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Tree Mode provides a wider range of options and way to edit and modify the pages.xml file.</diffmk:wrapper></para>
+
+
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Seam Pages Editor: Tree View</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/seam_editors/seam_editors_8.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">
+ In this mode all elements and attributes of the page.xml
+ file can be viewed and edited in a visual, user friendly way.
+ </diffmk:wrapper></para>
+
+ </section>
+
+
+ <section diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Outline Support for Seam Pages Editor</diffmk:wrapper></title>
+
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Seam Pages Editor provides </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Outline</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> view support.
+ You can explore the pages.xml using Outline view in two modes: </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Tree</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> ( </diffmk:wrapper><inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/seam_editors/outline_tree.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject><diffmk:wrapper diffmk:change="added"> ) and </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Diagram Navigation</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> ( </diffmk:wrapper><inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/seam_editors/outline_navigation.png"></imagedata>
+ </imageobject>
+ </inlinemediaobject><diffmk:wrapper diffmk:change="added"> ).</diffmk:wrapper></para>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">
+ The Diagram Navigation mode of Outline view gives a birds-view of the layout to allow quick navigation for large-scale applications.
+ </diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Outline view: Diagram Navigation mode</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/seam_editors/seam_editors_9.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The Tree mode shows a tree for every element in the pages.xml file. You can get a quick overview of the whole file and selecting an element the related element is highlighted in the Graphical, Tree or Source page of Seam Pages Editor.</diffmk:wrapper></para>
+
+
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Outline view: Tree mode</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/seam_editors/seam_editors_10.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+
+
+ </section>
+
+
+ </section>
+
+
+ <section diffmk:change="added">
+
+
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Seam Components Editor</diffmk:wrapper></title>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">When editing </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">components.xml</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> a structured tree editor is available
+ in addition to pure source editing. It has a graphical view (Tree tab) and source
+ (Source tab).</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">component.xml Editor</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/seam_editors/seam_editors_4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Note:</diffmk:wrapper></title>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You can view and edit </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">components.xml</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> and other xml files
+ directly in the Project Explorer and Properties sheet without opening the
+ components.xml editor.</diffmk:wrapper></para>
+ </note>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">component.xml Editor</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/seam_editors/seam_editors_5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+
+
+
+ <section diffmk:change="added" id="SeamEditors">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Main Features of Seam Editors</diffmk:wrapper></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 moreinfo="none">Content Assist</property><diffmk:wrapper diffmk:change="changed"> (Ctrl + Space) is available when using EL expressions in the following file formats:</diffmk:wrapper></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 float="0">
+ <title>Content Assist</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_1.png" scale="70"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note>
+ <title>Note:</title>
+
+ <para>To get Code Assist available for an externally generated and imported project,
+ don't forget to enable Seam features and configure Seam Settings in <link linkend="project_pref">Project Preferences</link>.</para>
+ </note>
+
+ <section id="components_code_assist" role="new">
+ <title>Content Assist for components.xml</title>
+
+ <para>While you are editing a <emphasis>
+ <property moreinfo="none">components.xml</property>
+ </emphasis> file you can make use of the Content Assist for inserting needed
+ elements.</para>
+
+ <figure float="0">
+ <title>Content Assist in the component.xml Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_1a.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The editor also makes code completion aware of methods/attributes for EntityQuery
+ component.</para>
+
+ <figure float="0">
+ <title>Content Assist for EntityQuery Component</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_1b.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ </section>
+
+ <section id="OpenOn">
+ <title>OpenOn</title>
+
+ <para><property moreinfo="none">OpenOn</property> let's you easily navigate through your project without
+ using the Package Explorer or Project Explorer. After pressing <emphasis>
+ <property moreinfo="none">Ctrl + left click</property>
+ </emphasis> (or just F3) you will see a corresponding method or class.</para>
+
+ <figure float="0">
+ <title>OpenOn</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">OpenOn is also supported in Page Descriptors(page.xml). You can </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Ctrl + left click</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> on the bean to open navigate to the bean you clicked on. </diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">OpenOn in page.xml file</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/seam_editors/seam_editors_2a.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+
+ </section>
+
+ <section id="SeamValidation">
+ <title>Seam Validation</title>
+
+ <para>Validation of various possible problematic definitions is implemented for Seam
+ applications.</para>
+
+ <para><diffmk:wrapper diffmk:change="changed">If an issue is found it will be shown in the standard </diffmk:wrapper><property moreinfo="none">Problems
+ View</property>.</para>
+
+ <figure float="0">
+ <title>Seam Validation</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_6.png" scale="70"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ <para>In the preferences page for Seam Validator you can see and modify the validator
+ behavior. Go to <emphasis>
+ <property moreinfo="none">Window > Preferences > JBoss Tools > Web > Seam > Validator</property>
+ </emphasis> and select the severity level for the optional Seam Validator
+ problem.</para>
+
+ <figure float="0">
+ <title>Seam Validator Preferences</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para><diffmk:wrapper diffmk:change="changed">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
+ </diffmk:wrapper><property moreinfo="none">Validation</property>. The validations can be run manually by clicking
+ <property moreinfo="none">Validate</property> via the context menu on your project which will
+ execute all the active WTP validations.</para>
+ </section>
+
+</section>
+</chapter>
+
+
+<chapter id="seam_view" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/seam/docs/reference/en/modules/seam_view.xml" xreflabel="seam_view">
+ <?dbhtml filename="seam_view.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>Seam</keyword>
+ <keyword>JBDS</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Seam Views</title>
+
+ <section>
+ <title>Seam Components View</title>
+
+ <para>This chapter introduces you with Seam Components View.</para>
+ <para>The <property moreinfo="none">Seam Components View</property> is available from Seam perspective. It provides a list of seam components found in a project.</para>
+
+ <figure float="0">
+ <title>Seam Components View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_view/seam_view_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <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 moreinfo="none">Scope Presentation > Label</property></emphasis>)</para></listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>As label</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_view/seam_view_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem><para>as a node per scope where the components are grouped under a node representing its default scope.</para></listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>As node</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_view/seam_view_3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The Seam Packages can be presented in two ways:</para>
+
+ <itemizedlist>
+ <listitem><para>Flat</para></listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Flat Presentation of Seam Packages</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_view/seam_view_4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem><para>Hierarchical</para></listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Hierarchical Presentation of Seam Packages</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_view/seam_view_5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The Seam Component View can be filtered by choosing <property moreinfo="none">Customize View</property>.</para>
+
+ <figure float="0">
+ <title>Customize View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_view/seam_view_6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Select the <emphasis><property moreinfo="none">Seam Components from Libraries</property></emphasis> under the Filters tab.
+ This will make the view ignore components defined in jars. This will hide the many built-in Seam components and leave only those that are actually defined in the project or have been actively configured via components.xml. Therefore, deselecting the filter will show you all available components.</para>
+ <para>Selecting the <emphasis><property moreinfo="none">Seam Components from Referenced Projects</property></emphasis> will hide the components that dependent on other project.</para>
+
+ <figure float="0">
+ <title>Available Custimozations</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_view/seam_view_7.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+
+ <section>
+ <title>Project Explorer integration</title>
+
+ <para>If you don't like to have a view for every piece of information in Eclipse, the content of the Seam Components view is also available as a node in the built-in Project Explorer (not Package Explorer!) view in Eclipse.</para>
+
+ <figure float="0">
+ <title>Seam Components in Project Explorer</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_view/seam_view_8.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+
+ </chapter>
+
+
+<chapter id="seam_preferences" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/seam/docs/reference/en/modules/seam_preferences.xml" xreflabel="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 moreinfo="none">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 moreinfo="none">Add</property> more runtimes or to <property moreinfo="none">Remove</property> those that
+ are not needed.</para>
+
+ <figure float="0">
+ <title>Seam Preferences Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_preferences/seam_preferences1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Clicking on <property moreinfo="none">Edit</property> button you get the form where you can change the
+ path of Seam runtime home folder, modify name and version. Press
+ <property moreinfo="none">Finish</property> to apply the changes.</para>
+
+ <figure float="0">
+ <title>Edit Seam Runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_preferences/seam_preferences1_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <section id="validator_pref">
+
+ <title>Validator Preferences</title>
+
+ <para>Seam preference page includes a subsection <property moreinfo="none">Validator</property>. See
+ <emphasis><property moreinfo="none">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 moreinfo="none">Components</property> node and select
+ <property moreinfo="none">Ignore</property> next to <property moreinfo="none">Duplicate component
+ name</property>. After that you won't see the error.</para>
+
+
+ <figure float="0">
+ <title>Seam Validator Preference Page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_preferences/seam_preferences1_3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para><diffmk:wrapper diffmk:change="added">Notice, that in the </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Expression language</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> 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.</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Severity Preference for EL Syntax</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/seam_preferences/el_syntax_error.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para diffmk:change="added">In the upper right corner of the page there is a <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Configure Project
+ Specific Settings</diffmk:wrapper></property> 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 <property moreinfo="none">Show only
+ projects with project specific settings</property> if you want to see the
+ projects that have been already set. Click on <property moreinfo="none">Ok</property>.</para>
+
+ <figure float="0">
+ <title>Project Specific Configuration</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_preferences/seam_preferences1_4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>You get the validator properties page for chosen project. Check the
+ <property moreinfo="none">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 moreinfo="none">Properties > Seam
+ Validator</property>.</emphasis></para>
+ </note>
+
+ <figure float="0">
+ <title>Validator Properties Page for Chosen Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_preferences/seam_preferences1_5.png"></imagedata>
+ </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 moreinfo="none">Properties > 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 float="0">
+ <title>Properties for Seam Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_preferences/seam_preferences2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <tip>
+ <title>Tip:</title>
+ <para>The wizard doesn't allow the renaming of the artifacts listed in the Seam
+ Settings. It's possible to do in the <property moreinfo="none">Package Explorer</property>.
+ See <link linkend="renaming_projects_folders">Renaming the Projects and
+ Folders</link>.</para>
+ </tip>
+
+ <para>Also notice, you are not required to use the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">New Seam Project
+ wizard</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> to benefit from Seam artifact wizards. You can just enable Seam on
+ your existing project by checking </diffmk:wrapper><property moreinfo="none">Seam Support</property><diffmk:wrapper diffmk:change="changed"> and targeting to
+ Seam Runtime, and then configure the folders as you want.</diffmk:wrapper></para>
+
+ <figure float="0">
+ <title>Properties for Seam Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_preferences/seam_preferences2_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <tip>
+ <title>Tip:</title>
+ <para>On the figure above fields for configuring Seam artifacts are dimmed because Seam
+ Runtime is not selected.</para>
+ </tip>
+
+ <para>In Seam Wizards (New Action, Form, Entity, Conversation, Generate Entities) you can
+ get a quick access to project settings using the <property moreinfo="none">Settings</property> link in
+ the upper right corner of each wizard.</para>
+
+ <figure float="0">
+ <title>Settings Link</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_preferences/seam_preferences2_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ </section>
+
+</chapter>
+
+
+<chapter id="adding_seam_support_to_ear_project" role="new" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/seam/docs/reference/en/modules/adding_seam_support_to_ear_project.xml" xreflabel="adding_seam_support_to _ear_project">
+ <?dbhtml filename="adding_seam_support_to _ear_project.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>EAR</keyword>
+ <keyword>Seam</keyword>
+ <keyword></keyword>
+ <keyword></keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Adding Seam support to EAR project</title>
+ <para>From this chapter you will find out how to add Seam support to EAR project</para>
+ <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>
+ </itemizedlist>
+
+ <tip><title>Tip</title>
+ <para>You can add as many EJBs modules as you want just doing the same for each EJB project.</para></tip>
+
+ <figure float="0">
+ <title>WTP Projects</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/adding_seam_support_to_project/wtp_projects.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Make sure EJB and WAR are included in EAR as modules (Properties for seamproject-ear -> Java EE Module Dependencies)</para>
+
+ <figure float="0">
+ <title>Java EE Module Dependencies</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/adding_seam_support_to_project/java_ee_module_dependencies.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Make sure there is jboss-seam.jar in application.xml as well:</para>
+
+ <figure float="0">
+ <title>Java EE Module Dependencies</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/adding_seam_support_to_project/application_xml_with_jboss-seam_jar.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ <para>Then include libs from EAR to EJB Manifest Class-Path (Properties for seamproject-ejb -> Java EE Module Dependencies)</para>
+
+ <figure float="0">
+ <title>Including Libs from EAR to EJB Manifest Class-Path</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/adding_seam_support_to_project/including_libs_from_ear_to_ejb_manifest_class-path.png"></imagedata>
+ </imageobject>
+ </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>
+
+ <figure float="0">
+ <title>Including Libs from EAR and seamproject-ejb.jar to WAR Manifest Class-Path</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/adding_seam_support_to_project/including_libs_from_ear_to_war_manifest_class-path.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <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>
+
+
+ <figure float="0">
+ <title>Adding Seam Support to WAR Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/adding_seam_support_to_project/adding_seam_support_to_war_project.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ <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>
+
+ <figure float="0">
+ <title>Adding Seam Support to EJB Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/adding_seam_support_to_project/adding_seam_support_to_ejb_project.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>It&s important to set seamproject-war project as main Seam project there.</para>
+ <para>It will allow Seam Tools to use one common Seam model for seamproject-ejb and seamproject-war projects.</para>
+
+ <para>The last step is to clean/build the projects</para>
+
+ <para>That is all. You have added Seam support to your EAR project. </para>
+
+ <figure float="0">
+ <title>Added Seam Support to EAR Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/adding_seam_support_to_project/added_seam_support_to_ear_project.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+</chapter>
+
+<chapter id="crud_database_application" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/seam/docs/reference/en/modules/crud_database_application.xml" xreflabel="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>
+ <para>
+ <property moreinfo="none">CRUD</property> is an acronym for the four basic types of SQL commands: <emphasis>
+ <property moreinfo="none">Create</property>
+ </emphasis>, <emphasis>
+ <property moreinfo="none">Read</property>
+ </emphasis>, <emphasis>
+ <property moreinfo="none">Update</property>
+ </emphasis>, <emphasis>
+ <property moreinfo="none">Delete</property>
+ </emphasis>. Most applications have some kind of <property moreinfo="none">CRUD</property>
+ functionality, and we can assume that every programmer had to deal with
+ <property moreinfo="none">CRUD</property> at some point. A <property moreinfo="none">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 <link linkend="intro">Seam</link> Web application,
+ connect it to the <ulink url="http://www.hsqldb.org/">HSQL</ulink> database and add
+ <property moreinfo="none">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 moreinfo="none">./runDBServer.sh</property>
+ </emphasis> or <emphasis>
+ <property moreinfo="none">runDBServer.bat</property>
+ </emphasis> from the database directory.</para>
+ </listitem>
+ <listitem>
+ <para>Create a new Seam Web Project using <property moreinfo="none">New Seam Project
+ wizard</property> or main menu <emphasis><property moreinfo="none">File > New > Seam Web
+ Project</property>.</emphasis></para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Seam Web Project Creation</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_database_application/crud_database_application_01.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Name your project as <emphasis>
+ <property moreinfo="none">crudapp</property>, </emphasis> specify Target Runtime, Server and
+ Seam Runtime configuration. Then press <emphasis>
+ <property moreinfo="none">Next</property>
+ </emphasis> and follow the next wizard steps keeping default settings.</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>New Seam Project Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_database_application/crud_database_application_02.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <tip>
+ <title>Tip:</title>
+ <para>Please have a look <link linkend="create_seam">here</link> how to create Target
+ Runtime and Seam Runtime in order to get started creating, running, and debugging
+ J2EE applications.</para>
+ </tip>
+
+ <itemizedlist>
+ <listitem>
+ <para>On <emphasis>
+ <property moreinfo="none">Seam Facet</property>
+ </emphasis> page click <emphasis>
+ <property moreinfo="none">New...</property>
+ </emphasis> next to the <property moreinfo="none">Connection profile</property> section to
+ create a new <property moreinfo="none">Connection profile</property>.</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Seam Facet page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_database_application/crud_database_application_03.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>On <property moreinfo="none">New Connection Profile</property> dialog select the <emphasis>
+ <property moreinfo="none">HSQLDB</property>
+ </emphasis> connection profile type, name it <emphasis>
+ <property moreinfo="none">cruddb</property>
+ </emphasis> and click <emphasis>
+ <property moreinfo="none">Next</property>. </emphasis></para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>New JDBC Connection Profile</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_database_application/crud_database_application_04.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>On the next page click the round icon next to the <emphasis>
+ <property moreinfo="none">Drivers</property>
+ </emphasis> field to select a database driver.</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>New JDBC Connection Profile Database Driver</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_database_application/crud_database_application_06.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Now you should see the <property moreinfo="none">New Driver Definition</property> dialog. On
+ the first tab select the <emphasis>
+ <property moreinfo="none">HSQLDB JBDC Driver</property>. </emphasis> Underneath in the <emphasis>
+ <property moreinfo="none">Driver name</property>
+ </emphasis> field you can change its name if you need.</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Database Driver Type</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_database_application/crud_database_application_07.png"></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 moreinfo="none">Add JAR/Zip</property>
+ </emphasis> button.</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Driver Definition</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_database_application/crud_database_application_09.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>On the <property moreinfo="none">Properties</property> tab set the
+ <emphasis><property moreinfo="none">Connection URL</property>,</emphasis>
+ <emphasis>
+ <property moreinfo="none">Database Name</property>
+ </emphasis> and <emphasis>
+ <property moreinfo="none">User ID</property>
+ </emphasis> and click <emphasis>
+ <property moreinfo="none">OK</property>. </emphasis></para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Driver Definitions Properties</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_database_application/crud_database_application_10.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>After clicking <emphasis>
+ <property moreinfo="none">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 float="0">
+ <title>Driver and Connection Details</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_database_application/crud_database_application_11.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Now click <emphasis>
+ <property moreinfo="none">Test Connection</property>
+ </emphasis> to be sure that connection can be established.</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>JDBC Connection is OK</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_database_application/crud_database_application_12.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Validate <emphasis>
+ <property moreinfo="none">JDBC Connection profile</property>
+ </emphasis> settings and press <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> or <emphasis>
+ <property moreinfo="none">Back</property>
+ </emphasis> if something is wrong.</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Validate JDBC Connection settings</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_database_application/crud_database_application_13.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>After clicking <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> two projects <emphasis>
+ <property moreinfo="none">crudapp</property>
+ </emphasis> and <emphasis>
+ <property moreinfo="none">crudapp-test</property>
+ </emphasis> will be created.</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>CRUDAPP Seam Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_database_application/crud_database_application_14.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Have a look at the created projects. You can expand
+ <property moreinfo="none">WEB_CONTENT</property> folder and open
+ <property moreinfo="none">home.xhtml</property> or <property moreinfo="none">login.xhtml</property> with
+ <property moreinfo="none">JBoss Visual Editor</property>.</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>login.xhtml in VPE</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_database_application/crud_database_application_15.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Switch to <property moreinfo="none">Database Development</property> perspective with <emphasis>
+ <property moreinfo="none">Window->Open Perspective->Other...</property>
+ </emphasis> and connect to the <emphasis>
+ <property moreinfo="none">cruddb</property>
+ </emphasis> database.</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Connecting to the CRUDDB database</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_database_application/crud_database_application_16.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Expand <emphasis>
+ <property moreinfo="none">cruddb</property>
+ </emphasis> nodes to view its <emphasis>
+ <property moreinfo="none">Schemas</property>, </emphasis>
+ <emphasis>
+ <property moreinfo="none">Tables</property>, </emphasis>
+ <emphasis>
+ <property moreinfo="none">Columns</property>
+ </emphasis> etc.</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>CRUDDB Database</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_database_application/crud_database_application_17.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Switch back to the <property moreinfo="none">Seam</property> perspective. From the toolbar
+ select <emphasis>
+ <property moreinfo="none">New->Seam Generate Entities</property>
+ </emphasis> to create a set of <property moreinfo="none">CRUD</property> Seam components and web
+ pages based on existing tables in the database. On the first page of <emphasis>
+ <property moreinfo="none">Generate Seam Entities</property>
+ </emphasis> wizard keep everything by default and press <emphasis>
+ <property moreinfo="none">Next</property>. </emphasis></para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Generate Seam Entities</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_database_application/crud_database_application_18.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Click <emphasis>
+ <property moreinfo="none">Refresh</property></emphasis> to display all the tables from the
+ database.</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Dialog for Selecting Tables</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_database_application/crud_database_application_18a.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Now you can filter the tables. Use the <emphasis>
+ <property moreinfo="none">Include</property>
+ </emphasis> button to include only necessary ones.</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Selecting Tables</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_database_application/crud_database_application_18b.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Under <emphasis>
+ <property moreinfo="none">WebContent</property>
+ </emphasis> folder you can find all generated <property moreinfo="none">xhtml</property>
+ files:</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Entities Web Pages</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_database_application/crud_database_application_19.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>And under <emphasis>
+ <property moreinfo="none">src</property>
+ </emphasis> folder java classes are created.</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Entities Java Classes</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_database_application/crud_database_application_20.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Switch to <property moreinfo="none">Hibernate</property> perspective with <emphasis>
+ <property moreinfo="none">Window->Open Perspective->Other...</property>.
+ </emphasis> On <property moreinfo="none">Hibernate Configurations</property> view expand the <emphasis>
+ <property moreinfo="none">crudapp</property>
+ </emphasis> configuration. Right click on <property moreinfo="none">Customers</property> and
+ select <emphasis>
+ <property moreinfo="none">Open Mapping Diagram</property>
+ </emphasis> from the popup menu.</para>
+ </listitem>
+ </itemizedlist>
+ <figure float="0">
+ <title>Hibernate Configurations View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_database_application/crud_database_application_21.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Observe the <property moreinfo="none">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 moreinfo="none">Outline view</property>.</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Mapping Diagram</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_database_application/crud_database_application_22.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>For example, select <property moreinfo="none">Customers</property> entity, right click and
+ select <emphasis>
+ <property moreinfo="none">Open Source File</property>.
+ </emphasis> This will open the <property moreinfo="none">Customers.java</property> file in the
+ java editor. You can also do this by right-clicking on the same entity on the
+ <property moreinfo="none">Mapping Diagram</property>.</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Entity class from Mapping Diagram</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_database_application/crud_database_application_23.png" scale="75"></imagedata>
+ </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>
+
+
+<chapter id="crud_application_walkthrough" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/seam/docs/reference/en/modules/crud_application_walkthrough.xml" xreflabel="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 moreinfo="none">Package Explorer View </property>
+ </emphasis> right click on the <emphasis>
+ <property moreinfo="none">crudapp</property>
+ </emphasis> project, select <emphasis><property moreinfo="none"> Run As > Run on
+ Server</property>.</emphasis></para>
+
+ <figure float="0">
+ <title>Run Project on Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_application_walkthrough/crud_application_walkthrough_1.png" scale="70"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Select a Server and click <property moreinfo="none">Finish</property></para>
+
+ <figure float="0">
+ <title>Select a Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_application_walkthrough/crud_application_walkthrough_3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Home page of the <emphasis>
+ <property moreinfo="none">crudapp</property>
+ </emphasis> project should appear in <emphasis>
+ <property moreinfo="none">Web Browser</property>
+ </emphasis>.</para>
+ <figure float="0">
+ <title>Home page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_application_walkthrough/crud_application_walkthrough_4.png" scale="70"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>After that you can use CRUD application with
+ <property moreinfo="none">"employee"</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 moreinfo="none">Employees List</property>
+ </emphasis> link and observe that data from <emphasis>
+ <property moreinfo="none">employee</property>
+ </emphasis> database is displayed.</para>
+ <figure float="0">
+ <title>Employees List</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_application_walkthrough/crud_application_walkthrough_5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Use <property moreinfo="none">Employees search parameters</property> fields to filter the selected
+ list.</para>
+
+ <para> Press <property moreinfo="none">Select</property> opposite one of employees.</para>
+ <figure float="0">
+ <title>Employee details</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_application_walkthrough/crud_application_walkthrough_6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ <para> Press <property moreinfo="none">Edit</property> to edit employee fields.</para>
+ <para> Enter <emphasis>
+ <property moreinfo="none">Login</property>
+ </emphasis> and <emphasis>
+ <property moreinfo="none">Password</property>
+ </emphasis> to login. (Use
+ <emphasis>"crudapp-user"/"secret"</emphasis> for
+ example)</para>
+
+ <figure float="0">
+ <title>Login page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_application_walkthrough/crud_application_walkthrough_7.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <figure float="0">
+ <title>Edit Employee</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/crud_application_walkthrough/crud_application_walkthrough_8.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para> Fill in <emphasis>
+ <property moreinfo="none">firstname</property>
+ </emphasis> and press <property moreinfo="none">Save</property>.</para>
+ <para> Database will be updated.</para>
+ </section>
+</chapter>
+
+
+<chapter id="testNG" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/seam/docs/reference/en/modules/testng.xml" xreflabel="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 moreinfo="none">TestNG</property> ("Testing, the Next Generation") 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-Generation Testing
+ with TestNG (An Interview with Cedric Beust)</ulink>
+ </para>
+ <para>
+ <ulink url="http://www.javaworld.com/javaworld/jw-04-2005/jw-0404-testng.html">TestNG:
+ The next generation of unit testing</ulink>
+ </para>
+ <para>
+ <ulink url="http://dev2dev.bea.com/pub/a/2006/09/testng-categorization.html">Test
+ Categorization Techniques with TestNG</ulink>
+ </para>
+ <para>
+ <ulink url="http://www-128.ibm.com/developerworks/java/library/j-testng/">TestNG makes
+ Java unit testing a breeze</ulink>
+ </para>
+ <para>
+ <ulink url="http://www-128.ibm.com/developerworks/java/library/j-cq08296/index.html">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 float="0">
+ <title>Seam-test Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/testng/testng_5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Add Seam Action to your project via <emphasis><property moreinfo="none">File > New > Seam
+ Action</property>.</emphasis></para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Seam Action Creation</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/testng/testng_6.png"></imagedata>
+ </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 float="0">
+ <title>New Seam Action Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/testng/testng_7.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>When Action is created you will see <property moreinfo="none">actionPage.xhtml</property> in
+ Package Explorer view. <property moreinfo="none">ActionBean.java</property> will be
+ automatically opened in Java Editor.</para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Created Action</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/testng/testng_8.png" scale="70"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ <itemizedlist>
+ <listitem>
+ <para>Select <property moreinfo="none">ActionLocalTest.xml</property> in Seam-test project and run
+ the test with right click <emphasis><property moreinfo="none">Run As > TestNG
+ Suite</property>.</emphasis></para>
+ </listitem>
+ </itemizedlist>
+
+ <figure float="0">
+ <title>Running TestNG</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/testng/testng_9.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The test process will start and its output will be written in Console View.</para>
+
+ <figure float="0">
+ <title>Test is Finished</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/testng/testng_10.png" scale="70"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ <itemizedlist>
+ <listitem>
+ <para>After running TestNG you will have the test results in <emphasis>
+ <property moreinfo="none">test-output</property>
+ </emphasis> folder in Seam-test project (press F5 to refresh the Package
+ Explorer view). Open <property moreinfo="none">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 float="0">
+ <title>Viewing the Test Results</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/testng/testng_11.png" scale="70"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ <para>You can see the test results in Web Browser.</para>
+
+ <figure float="0">
+ <title>Test Results in Browser</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/testng/testng_12.png" scale="70"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>After clicking on <emphasis>
+ <property moreinfo="none">ActionLocal Tests</property>
+ </emphasis> link you will see the Results for ActionLocal Tests.</para>
+
+ <figure float="0">
+ <title>Test Information</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/testng/testng_13.png" scale="70"></imagedata>
+ </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 float="0">
+ <title>ActionLocal Test Details</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/testng/testng_14.png"></imagedata>
+ </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>
+
+ <para>In conclusion, the main goal of this document is to get you know with a full featureset
+ that <property moreinfo="none">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&op=viewforum&f=201">JBoss
+ Tools Forum</ulink>. You can also influence on how you want to see JBoss Tools docs in
+ future leaving your vote on our page <ulink url="http://wiki.jboss.org/wiki/JBossToolsDocsFuture">here</ulink>. </para>
+
+ <para>A set of movies on Seam tooling is available <ulink url="http://docs.jboss.org/tools/movies">here</ulink>.</para>
+ </section>
+</chapter>
+
+ <!-- TODO: drools used in this section is not available for eclipse .3.3 &business_application; -->
+
+</book>
15 years, 3 months
JBoss Tools SVN: r14142 - branches/jbosstools-3.0.x/portlet/docs/reference/en.
by jbosstools-commits@lists.jboss.org
Author: ochikvina
Date: 2009-03-10 10:36:31 -0400 (Tue, 10 Mar 2009)
New Revision: 14142
Added:
branches/jbosstools-3.0.x/portlet/docs/reference/en/master_output.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-655 - adding master_output.xml;
Added: branches/jbosstools-3.0.x/portlet/docs/reference/en/master_output.xml
===================================================================
--- branches/jbosstools-3.0.x/portlet/docs/reference/en/master_output.xml (rev 0)
+++ branches/jbosstools-3.0.x/portlet/docs/reference/en/master_output.xml 2009-03-10 14:36:31 UTC (rev 14142)
@@ -0,0 +1,995 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.docbook.org/xml/4.3/docbookx.dtd"
+
+[<!ENTITY intro SYSTEM "modules/intro.xml">
+<!ENTITY installation SYSTEM "modules/installation.xml">
+<!ENTITY starting_project SYSTEM "modules/starting_project.xml">
+<!ENTITY jsf_portlet SYSTEM "modules/jsf_portlet.xml">
+<!ENTITY seam_portlet SYSTEM "modules/seam_portlet.xml">
+<!ENTITY portlets_to_nonWTP_projects SYSTEM "modules/portlets_to_nonWTP_projects.xml">
+
+<!ENTITY seamlink "../../seam/html_single/index.html">
+<!ENTITY aslink "../../as/html_single/index.html">
+<!ENTITY esblink "../../esb_ref_guide/html_single/index.html">
+<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html">
+<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html">
+<!ENTITY jbpmlink "../../jbpm/html_single/index.html">
+<!ENTITY jsflink "../../jsf/html_single/index.html">
+<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html">
+<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html">
+<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html">
+<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html">
+]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff">
+
+ <bookinfo>
+ <title>JBoss Portal Tools Reference Guide</title>
+
+ <author><firstname>Olga</firstname><surname>Chikvina</surname></author>
+ <author><firstname>Snjezana</firstname><surname>Peco</surname><email>snjezana.peco(a)redhat.com</email></author>
+ <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author>
+ <author><firstname>Thomas</firstname><surname>Heute</surname><email>theute(a)jboss.org</email></author>
+
+ <pubdate>September 2008</pubdate>
+ <copyright>
+ <year>2008</year>
+ <year diffmk:change="added"><diffmk:wrapper diffmk:change="added">2009</diffmk:wrapper></year>
+ <holder><diffmk:wrapper diffmk:change="changed">JBoss, a division of Red Hat</diffmk:wrapper></holder>
+ </copyright>
+ <releaseinfo><diffmk:wrapper diffmk:change="changed">
+ Version: 1.0.0.GA
+ </diffmk:wrapper></releaseinfo>
+
+<abstract>
+ <title></title>
+ <para>
+ <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jboss_portal_tools_r...">PDF version</ulink>
+ </para>
+</abstract>
+
+
+ </bookinfo>
+ <toc></toc>
+
+
+
+<chapter id="intro" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/portlet/docs/reference/en/modules/intro.xml" xreflabel="intro">
+ <?dbhtml filename="intro.html"?>
+ <title>Introduction</title>
+
+ <para>Starting from 3.0.0.Alpha1 version, JBoss set of plugins extends <property moreinfo="none">JBoss Portal</property>
+ features. Thus, this guide is intended to explain you how to manage the functionality
+ <property moreinfo="none">JBoss Tools</property> provide to ease the development with <property moreinfo="none">JBoss
+ Portal</property>.</para>
+
+ <section id="preface">
+ <title>Preface</title>
+ <para><property moreinfo="none">JBoss Portal</property> provides an open source platform for hosting and
+ serving a portal's Web interface, publishing and managing its content, and customizing
+ its experience. It supports a wide range of features, including standard portlets,
+ single sign-on, clustering, and internationalization.</para>
+ </section>
+
+ <section id="key_features">
+ <title>Key Features</title>
+ <para>The next table lists key features supplied by <property moreinfo="none">JBoss Portal Tools</property>.</para>
+
+ <table>
+ <title>Key Functionality of JBoss Portal Tools</title>
+ <tgroup cols="3">
+
+ <colspec align="left" colnum="1" colwidth="1*"></colspec>
+ <colspec colnum="2" colwidth="5*"></colspec>
+ <colspec align="left" colnum="3" colwidth="1*"></colspec>
+
+ <thead>
+ <row>
+ <entry>Feature</entry>
+ <entry>Benefit</entry>
+ <entry>Chapter</entry>
+ </row>
+ </thead>
+
+ <tbody>
+
+ <row>
+ <entry>
+ <para>Wizards for creating Projects with Portlet Facets</para>
+ </entry>
+ <entry>
+ <para>New Dynamic Web Project wizard allows you to select a proper
+ Configuration to enable Portlet Facet in it.</para>
+ </entry>
+ <entry>
+ <link linkend="creating_project_with_jbossportal">Creating a Dynamic
+ Web Project</link>
+ </entry>
+ </row>
+
+
+ <row>
+ <entry>
+ <para>Create Java Portlet wizard</para>
+ </entry>
+
+ <entry>
+ <para>The wizard enables creating a JSR-186/JSR-286 compliant
+ portlet.</para>
+ </entry>
+ <entry>
+ <link linkend="adding_java_portlet">Adding Java Portlet to a
+ project</link>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>Create JSF/Seam Portlet wizard</para>
+ </entry>
+ <entry>
+ <para>This wizard allows to create JSF/Seam portlets</para>
+ </entry>
+ <entry>
+ <link linkend="jsf_portlet">Creating JSF Portlet</link>
+ <link linkend="seam_portlet">Creating Seam Portlet</link>
+ </entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+
+ <section id="rel_resources">
+ <title>Other relevant resources on the topic</title>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <ulink url="http://www.jboss.org/jbossportal/">JBoss Portal Home Page</ulink>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <ulink url="http://wiki.jboss.org/wiki/JBossPortal">JBoss Portal Wiki</ulink>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <ulink url="http://www.jboss.org/tools/">JBoss Tools Home Page</ulink>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss Tools Forum</ulink>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">The latest
+ JBossTools/JBDS documentation builds</ulink>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <ulink url="http://www.jboss.com/products/devstudio/docs">Stable JBossTools/JBDS
+ documentation</ulink> (supplied with the latest JBDS release, 1.1.0 GA
+ currently) </para>
+ </listitem>
+ </itemizedlist>
+
+ </section>
+</chapter>
+
+
+<chapter id="installation" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/portlet/docs/reference/en/modules/installation.xml" xreflabel="installation">
+ <?dbhtml filename="installation.html"?>
+ <title>Installation issues</title>
+
+ <para>This section provides you with the steps on how to start with <property moreinfo="none">JBoss
+ Portal</property> and integrated features using <property moreinfo="none">JBoss Tools</property>.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>First, you need to have Eclipse Ganymede with JBoss Tools 3.0.0.Alpha1 and higher installed.</para>
+
+ <tip>
+ <title>Tip:</title>
+ <para>Read <ulink url="../../GettingStartedGuide/html_single/index.html#JBossToolsInstall">JBoss Tools
+ Installation</ulink> section in our Getting Started documentation to find out
+ how to install <property moreinfo="none">JBoss Tools</property> onto Eclipse.</para>
+ </tip>
+ </listitem>
+
+ <listitem>
+ <para>Next, download the JBoss Portal + JBoss AS bundle from <ulink url="http://www.jboss.org/jbossportal/download/index.html">JBoss Portal Download
+ page</ulink></para>
+
+ <note>
+ <title>Note:</title>
+ <para>You need JBoss Portal 2.7 if you want to work with a Portlet 2.0</para>
+ </note>
+
+ </listitem>
+
+ <listitem>
+ <para>Extract the bundle wherever you want on your hard drive</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Now, when you have it installed, we are going to demonstrate some powerful features of
+ <property moreinfo="none">JBoss Portal</property> tooling for Eclipse.</para>
+</chapter>
+
+
+<chapter id="starting_project" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/portlet/docs/reference/en/modules/starting_project.xml" xreflabel="starting_project">
+ <?dbhtml filename="starting_project.html"?>
+ <title>Starting the Project with JBoss Portal</title>
+
+ <para>To get started with <property moreinfo="none">JBoss Portal</property> and <property moreinfo="none">JBoss
+ Tools</property>, you should first have a Web Project pointed to the JBoss Portal Runtime.
+ Thus, in this chapter we are going to show you how to create a Dynamic Web Project, add Java
+ Portlet to it and deploy it to the <property moreinfo="none">JBoss Portal</property>.</para>
+
+ <section id="creating_project_with_jbossportal">
+ <title>Creating a Dynamic Web Project</title>
+
+ <para>To create a Dynamic Web Project, go to <emphasis>
+ <property moreinfo="none">File > New > Dynamic Web Project</property>
+ </emphasis> if you are in the <property moreinfo="none">Web Perspective</property> or <property moreinfo="none">File >
+ New > Other > Web > Dynamic Web Project</property> in any other Perspective. The
+ first page of the New Dynamic Web Project wizard looks as follows.</para>
+
+ <figure float="0">
+ <title>New Dynamic Web Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Fill out the name of your project. Next, click the <emphasis>
+ <property moreinfo="none">New</property>
+ </emphasis> button in the <emphasis>
+ <property moreinfo="none">Target Runtime</property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> section to specify a new Target Runtime. Choose </diffmk:wrapper><emphasis>
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed"> JBoss Community > JBoss 4.2 Runtime</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> and select the </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Create a new local server</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> checkbox. Click </diffmk:wrapper><emphasis>
+ <property moreinfo="none">Next</property>.</emphasis></para>
+
+ <figure float="0">
+ <title>New Server Runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>On the next page you should give a name to the runtime. Let's call it <emphasis>
+ <property moreinfo="none">JBoss Portal 2.7 Runtime</property>
+ </emphasis>, and then point it to the location of your JBoss AS + Portal
+ installation.</para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">New Server Runtime Environment</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/starting_project/server_runtime_environment.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note>
+ <title>Note:</title>
+
+ <para>The JBoss Tools Portlet feature has been tested using 2.6.5 and 2.7.0.ALPHA
+ versions of <property moreinfo="none">JBoss Portal</property>. Remember, if you want to use Portlet
+ version 2.0 (JSR-268), you have to choose JBoss Portal 2.7.</para>
+ </note>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">At this point a new JBoss Server instance will be created. Here you can verify the
+ defined runtime information. If something is incorrect, press </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Back</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> to return on the previous wizard page.</diffmk:wrapper></para>
+
+ <figure float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Target Server</diffmk:wrapper></title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Click <emphasis>
+ <property moreinfo="none">Finish</property>.</emphasis></para>
+
+ <para>On the next step you should click the <emphasis>
+ <property moreinfo="none">Modify</property>
+ </emphasis> button next to the <property moreinfo="none">Configuration</property> section to enable
+ Portlet Facets for the project.</para>
+
+ <figure float="0">
+ <title>Setting the Project Configuration</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>On this page you should check the <emphasis>
+ <property moreinfo="none">JBoss Core Portlet</property>
+ </emphasis> and press <emphasis>
+ <property moreinfo="none">OK</property>
+ </emphasis>.</para>
+
+ <figure float="0">
+ <title>Enabling the Portlet Facet</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_4_a.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Note:</diffmk:wrapper></title>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If the portlet libraries aren't available in the runtime you targeted,
+ JBoss Portlet facets will be hidden on this page.</diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">To made portal functionality always visible no matter what the runtime support,
+ you should go to </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Window > Preferences</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> and then </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Tools > JBoss Portlet</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> and deselect </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Check runtimes for Portlet Components</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> checkbox (see figure below).</diffmk:wrapper></para>
+ </note>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBoss Runtime Preferences</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/starting_project/portlet_preferences.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para><diffmk:wrapper diffmk:change="changed">The next page is for configuring web modules. Here all values are set, so you can
+ leave everything as it is.</diffmk:wrapper></para>
+
+ <figure float="0">
+ <title>The Project Web Modules</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para><diffmk:wrapper diffmk:change="added">Finally, the last wizard page will ask you to add JBoss Portlet capabilities to your
+ project. Here you can choose whether to set up user libraries, libraries provided by
+ server runtime or not include libraries at all.</diffmk:wrapper></para>
+
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">To set up server runtime libraries, you need to select </diffmk:wrapper><emphasis>
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="added">Libraries provided by server runtime</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> in the list box.</diffmk:wrapper></para>
+ </listitem>
+ </itemizedlist>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Including Server Runtime Libraries</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/starting_project/portlet_capabilities6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">For setting up user libraries, select </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">User library</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> in the list box and then press </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Add</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> in the </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">User Library</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> section.</diffmk:wrapper></para>
+ </listitem>
+ </itemizedlist>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Adding User Library</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/starting_project/portlet_capabilities1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Then press </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">New</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> and type the user library name in the appeared dialog.</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Adding User Library</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/starting_project/portlet_capabilities2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Next add necessary jar's.</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Adding the Portlet API Jar</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/starting_project/portlet_capabilities3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Hit </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">OK</diffmk:wrapper></property>.</emphasis><diffmk:wrapper diffmk:change="added"> The user library will be added.
+ </diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">User Library Added</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/starting_project/portlet_capabilities4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If you don't need to include libraries at all, just deselect the </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Enable implementation library</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> checkbox.</diffmk:wrapper></para>
+ </listitem>
+ </itemizedlist>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Disabling Implementation Libraries</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/starting_project/portlet_capabilities5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">After setting JBoss Portlet capabilities press </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Finish</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></emphasis></para>
+
+ <para>That's it! Our base project is done.</para>
+
+ </section>
+
+ <section id="structure_overview">
+ <title>The Project Structure Overview</title>
+
+ <para>Now, let's look at the structure of the just created project.</para>
+
+ <figure float="0">
+ <title>The Project Structure Overview</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Here <property moreinfo="none">JBoos Tools</property> added JBoss Portlet facet to the project,
+ created an empty <emphasis>
+ <property moreinfo="none">portlet.xml</property>
+ </emphasis> file and added the Portlet library to the project classpath.</para>
+ </section>
+
+ <section id="adding_java_portlet">
+ <title>Adding a Java Portlet to the Project</title>
+
+ <para>At this point we'll show what the steps you need to proceed to add a new Java
+ Portlet to the project.</para>
+
+ <para>Call the <property moreinfo="none">Create Portlet wizard</property> by selecting <emphasis>
+ <property moreinfo="none">New > Other > JBoss Tools Web > Portlet > Java
+ Portlet</property>.</emphasis></para>
+
+ <figure float="0">
+ <title>New Java Portlet</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_7.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The wizard fills in the Web Project and Source Folder fields for you. Then you need to
+ specify the Java package and the Class name and click <emphasis>
+ <property moreinfo="none">Next</property>
+ </emphasis>.</para>
+
+ <figure float="0">
+ <title>Specifying Class File Destination</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_8.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>On the other page you will be able to set the display name of the Portlet, a title, a
+ description, the supported modes and init parameters.</para>
+
+ <figure float="0">
+ <title>Specifying Class File Destination</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_9.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>On the next screen you can define which methods from
+ <emphasis>GenericPortlet</emphasis> you want to override.</para>
+
+ <figure float="0">
+ <title>Specifying Class File Destination</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_10.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The last screen lets you build <property moreinfo="none">JBoss Portal</property> specific descriptors
+ to create an instance during the deployment and place it directly on the Portal.</para>
+
+ <figure float="0">
+ <title>Specifying Class File Destination</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_11.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <tip>
+ <title>Tip:</title>
+
+ <para>If you uncheck the <emphasis> Create Portlet Instance</emphasis> checkbox,
+ <property moreinfo="none">JBoss Tools</property> won't create the deployment elements
+ in the <emphasis> default-object.xml</emphasis> and <emphasis>
+ portlet-instances.xml</emphasis> files.</para>
+ </tip>
+
+ <para>Once Java Portlet is created, new resources have been added to the project structure.
+ As you can see on the figure below, it adds a Java Portlet class (<emphasis>
+ <property moreinfo="none">TestPortlet.java</property>
+ </emphasis> in our case), <emphasis>
+ <property moreinfo="none">default-object.xml</property>
+ </emphasis> and <emphasis>
+ <property moreinfo="none">portlet-instances.xml</property>
+ </emphasis> files and updates <emphasis>
+ <property moreinfo="none">portlet.xml</property>
+ </emphasis> as well.</para>
+
+ <figure float="0">
+ <title>The structure of Web Project with Java Portlet created</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_12.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Thus, now the Project is ready to be built and deployed.</para>
+ </section>
+
+ <section id="deploying_to_portal">
+ <title>Deploying a Portlet to JBoss Portal</title>
+
+ <para>You can deploy the created project in the way you deploy any other Web Application.
+ Right click on the project and do <emphasis>
+ <property moreinfo="none">Run As > Run On Server</property>
+ </emphasis> and accept the defaults. On the <emphasis>
+ <property moreinfo="none">Add and Remove Projects</property>
+ </emphasis> page move the created Project to the right and click <emphasis>
+ <property moreinfo="none">Finish</property>.</emphasis></para>
+
+ <figure float="0">
+ <title>Deploying the Portlet Application</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_13.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>It will deploy the Portlet Web Application and start <property moreinfo="none">JBoss
+ AS</property>.</para>
+
+ <tip>
+ <title>Tip:</title>
+
+ <para>You should use <emphasis>http://localhost:8080/portal</emphasis> URL to see your
+ Portlet in the Browser.</para>
+ </tip>
+
+ <para>In the Browser the Portlet looks as follows:</para>
+
+ <figure float="0">
+ <title>Java Portlet in the Browser Window</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/starting_project/starting_project_14.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Consequently, here you learnt how to create a Dynamic Web Project, add Java Portlet to
+ it and deploy the project to <property moreinfo="none">JBoss Portal</property>.</para>
+ </section>
+
+</chapter>
+
+
+<chapter id="jsf_portlet" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/portlet/docs/reference/en/modules/jsf_portlet.xml" xreflabel="jsf_portlet">
+ <?dbhtml filename="jsf_portlet.html"?>
+ <title>Creating JSF Portlet</title>
+
+ <para>This chapter will explain how you can configure JSF Portlet within Dynamic Web
+ Project and JSF Project by using the wizards <property moreinfo="none">JBoss Tools</property> provides.</para>
+
+ <section id="jsf_portlet1">
+ <title>Adding JSF Portlet to Dynamic Web Project</title>
+
+ <para>To add JSF Portlet to a Dynamic Web Project, you should set the Configuration to <emphasis>
+ <property moreinfo="none">JavaServer Faces v1.1 Project</property>
+ </emphasis> or <emphasis>
+ <property moreinfo="none">JavaServer Faces v1.2 Project</property>
+ </emphasis> and configure the JSF Portlet Facets in the <property moreinfo="none">New Dynamic Web
+ Project wizard</property> by clicking the <emphasis>
+ <property moreinfo="none">Modify</property>
+ </emphasis> button.</para>
+
+ <figure float="0">
+ <title>Setting the JSF Configuration</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>On the Project Facets dialog you should select <property moreinfo="none">JBoss Core Portlet</property>
+ and <property moreinfo="none">JBoss JSF Portlet</property> check boxes.</para>
+
+ <figure float="0">
+ <title>Enabling the Portlet Facets</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Next wizard page is for configuring JSF Capabilities. You can leave everything as it
+ is here.</para>
+
+ <figure float="0">
+ <title>JSF Capabilities</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>To support Portlets in JSF/Seam applications <property moreinfo="none">JBoss Tools</property> works
+ with <property moreinfo="none">JBoss Portlet Bridge</property>. Thus on the next page you should add JSF Portlet
+ capabilities by pointing to the Portletbridge Runtime location.</para>
+
+ <figure float="0">
+ <title>JSF Capabilities</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <tip>
+ <title>Tip:</title>
+
+ <para>You can download JBoss Portlet Bridge 1.0.0.B4 from <ulink url="http://www.jboss.org/portletbridge/download/">here</ulink>.</para>
+ </tip>
+
+ <para>Next click <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> to organize the Project.</para>
+ <para id="add_jsf_portlet">To add JSF Portlet to generated project you should call the
+ <property moreinfo="none">Create Portlet wizard</property> by navigating to <emphasis>
+ <property moreinfo="none">New > Other > JBoss Tools Web > Portlet > JSF/Seam
+ Portlet</property>.</emphasis></para>
+
+ <figure float="0">
+ <title>Calling New Portlet Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>As you see, the Seam and JSF Portlet wizards are merged into one. We set JSF
+ Configuration for the project, so default values in this wizard will be set as for a JSF
+ portlet.</para>
+
+ <figure float="0">
+ <title>Creating JSF Portlet</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Click <emphasis>
+ <property moreinfo="none">Finish</property>
+ </emphasis> to complete JSF Portlet creation. Now you can deploy the project the same
+ way as it was <link linkend="deploying_to_portal">described above</link>.</para>
+
+ <para>In the Browser JSF Portlet looks as follows.</para>
+
+ <figure float="0">
+ <title>JSF Portlet in the Browser</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet7.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section id="jsf_portlet_to_JSF_project">
+ <title>Adding JSF Portlet to JSF Project</title>
+
+ <para>How to organize a JSF Project you can find out in our <ulink url="../../jsf_tools_ref_guide/html_single/index.html#new_jsf_project">JSF Tools Reference Guide</ulink>. Just
+ remember to point Target Runtime to JBoss Portal directory location.</para>
+
+ <figure float="0">
+ <title>Creating New JSF Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet8.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Before adding a Portlet to the project you should enable necessary facets for it.
+ Right-click the created project and click <emphasis>
+ <property moreinfo="none">Preferences</property>
+ </emphasis> to open the <property moreinfo="none">Project Preferences</property> screen.</para>
+ <para>On the <property moreinfo="none">Project Facets</property> page select the <emphasis>
+ <property moreinfo="none">JBoss Core Portlet</property>
+ </emphasis> and <emphasis>
+ <property moreinfo="none">JBoss JSF Portlet</property>
+ </emphasis> checkboxes. And then the screen will ask you to enable <emphasis>
+ <property moreinfo="none">JavaServer Faces</property>
+ </emphasis> facet as well.</para>
+
+ <figure float="0">
+ <title>Project Facets</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet9.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Notice, <emphasis>
+ <property moreinfo="none">"Further configuration required..."</property>
+ </emphasis> warning appears at the bottom of the screen. It means that you should click
+ it to configure JSF and JSF Portlet Capabilities in the project.</para>
+
+ <figure float="0">
+ <title>JSF Capabilities</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet10.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <figure float="0">
+ <title>Project Facets</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/jsf_portlet/jsf_portlet11.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>After setting the path to Portletbridge Runtime location, click <emphasis>
+ <property moreinfo="none">OK</property>
+ </emphasis> and then <emphasis>
+ <property moreinfo="none">OK</property>
+ </emphasis> again.</para>
+
+ <para>Now you can add JSF Portlet to the generated JSF Project. How to do it we showed in
+ <link linkend="add_jsf_portlet">the previous section</link>.</para>
+ </section>
+</chapter>
+
+
+<chapter id="seam_portlet" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/portlet/docs/reference/en/modules/seam_portlet.xml" xreflabel="seam_portlet">
+ <?dbhtml filename="seam_portlet.html"?>
+ <title>Creating Seam Portlet</title>
+
+ <para>This chapter covers the steps on how to configure Seam Portlet within Dynamic Web
+ Project and Seam Project by using the wizards <property moreinfo="none">JBoss Tools</property> provides.</para>
+
+ <section id="seam_portlet1">
+ <title>Adding Seam Portlet to Dynamic Web Project</title>
+
+ <para>To add Seam Portlet to a Dynamic Web Project first you should organize New Dynamic Web
+ Project with the Configuration setting to <emphasis>
+ <property moreinfo="none">JBoss Seam Portlet Project v2.0</property>.</emphasis></para>
+
+ <figure float="0">
+ <title>Calling New Portlet Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet1.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>It will add all needed facets to your project. By clicking the <emphasis>
+ <property moreinfo="none">Modify</property>
+ </emphasis> button you can observe the chosen configuration of facets as well as modify
+ it. As you can see, all JBoss Portlets are checked.</para>
+
+ <figure float="0">
+ <title>Project Facets</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet2.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Next wizard pages are for adjusting the Project Web Modules and JSF Configuration.
+ They include default values, so you can skip them by pressing <emphasis>
+ <property moreinfo="none">Next</property>.</emphasis></para>
+
+ <para>On the <property moreinfo="none">Seam Facet</property> page <ulink url="../../seam/html_single/index.html#seamFacet">set
+ Connection Profile</ulink> and hit <emphasis>
+ <property moreinfo="none">Next</property>.</emphasis></para>
+
+ <figure float="0">
+ <title>Seam Facet Settings</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet3.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Last wizard page will prompt you to set the path to Portletbridge Runtime
+ location.</para>
+
+ <figure float="0">
+ <title>Setting the Portletbridge Runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet4.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <tip>
+ <title>Tip:</title>
+
+ <para>Thus you should have JBoss Portlet Bridge downloaded and extracted somewhere on
+ your hard drive. You can download JBoss Portlet Bridge 1.0.0.B4 from <ulink url="http://www.jboss.org/portletbridge/download/">here</ulink>.</para>
+ </tip>
+
+ <para>Now, to add Seam Portlet to the project you should follow to <emphasis>
+ <property moreinfo="none">New > Other > JBoss Tools Web > Portlet > JSF/Seam
+ Portlet</property>.</emphasis> This will call the wizard for creating JSF/Seam
+ Portlets.</para>
+
+ <figure float="0">
+ <title>Calling the Create Portlet Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet5.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>As we set Seam Configuration for the Dynamic Web Project, the wizard puts the values
+ as for Seam Portlet.</para>
+
+ <figure float="0">
+ <title>Creating Seam Portlet</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet6.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>After creating the Seam Portlet, you should <link linkend="deploying_to_portal">deploy
+ the project to JBoss Portal</link> and start the Server. In a Browser
+ you'll see the following:</para>
+
+ <figure float="0">
+ <title>Seam Portlet in the Browser</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet7.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section id="seam_portlet_to_seam_project">
+ <title>Adding Seam Portlet to Seam Project</title>
+
+ <para>First start a Seam Project by following to <emphasis>
+ <property moreinfo="none">New > Other > Seam > Seam Web Project</property>. </emphasis> On the first
+ wizard page specify JBoss Portal directory location as <property moreinfo="none">Target
+ Runtime</property> and <emphasis>
+ <property moreinfo="none">JBoss Seam Portlet Project v2.0</property>
+ </emphasis> as <property moreinfo="none">Configuration</property>.</para>
+
+ <figure float="0">
+ <title>Project Facets</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_portlet/seam_portlet8.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Next steps will be the same as we did for the Dynamic Web Project in the <link linkend="seam_portlet1">Adding Seam Portlet to Dynamic Web Project</link>
+ section.</para>
+ </section>
+</chapter>
+
+
+<chapter id="portlets_to_nonWTP_projects" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/portlet/docs/reference/en/modules/portlets_to_nonWTP_projects.xml" xreflabel="portlets_to_nonWTP_projects">
+ <?dbhtml filename="portlets_to_nonWTP_projects.html"?>
+ <title>Adding Portlets to non-WTP Projects</title>
+
+ <para>Starting from <property moreinfo="none">JBoss Tools 3.0.0.Beta1</property> version the JBoss Portlet
+ wizards no longer require a WTP project to be able to create Portlets.</para>
+
+ <note>
+ <title>Note:</title>
+ <para>Please note, if the project does not have the proper portlet API jar's, the generated
+ classes will have compile errors.</para>
+ </note>
+
+ <para>In conclusion, with this document you've learnt how to get started with <property moreinfo="none">JBoss
+ Portal</property> using <property moreinfo="none">JBoss Tools</property> suite of Eclipse plugins.
+ The above chapters walked you through the steps on how to organize a web project with
+ portlets which includes a sample staff and deploy it onto the <property moreinfo="none">JBoss
+ Portal</property>.</para>
+
+ <para>If you still have questions or suggestions you are always welcome on our <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">Forum</ulink>. Your feedback will be very much appreciated.</para>
+
+</chapter>
+
+
+</book>
15 years, 3 months
JBoss Tools SVN: r14141 - branches/jbosstools-3.0.x/jsf/docs/userguide/en.
by jbosstools-commits@lists.jboss.org
Author: ochikvina
Date: 2009-03-10 10:35:43 -0400 (Tue, 10 Mar 2009)
New Revision: 14141
Modified:
branches/jbosstools-3.0.x/jsf/docs/userguide/en/master_output.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-655 - adding master_output.xml;
Modified: branches/jbosstools-3.0.x/jsf/docs/userguide/en/master_output.xml
===================================================================
--- branches/jbosstools-3.0.x/jsf/docs/userguide/en/master_output.xml 2009-03-10 14:35:25 UTC (rev 14140)
+++ branches/jbosstools-3.0.x/jsf/docs/userguide/en/master_output.xml 2009-03-10 14:35:43 UTC (rev 14141)
@@ -31,12 +31,12 @@
<pubdate>April 2008</pubdate>
<copyright>
<year>2007</year>
- <year>2009</year>
- <holder>JBoss, a division of Red Hat</holder>
+ <year><diffmk:wrapper diffmk:change="changed">2009</diffmk:wrapper></year>
+ <holder><diffmk:wrapper diffmk:change="changed">JBoss, a division of Red Hat</diffmk:wrapper></holder>
</copyright>
- <releaseinfo>
+ <releaseinfo><diffmk:wrapper diffmk:change="changed">
Version: 2.0.0.GA
- </releaseinfo>
+ </diffmk:wrapper></releaseinfo>
<abstract>
<title></title>
<para>
@@ -185,7 +185,7 @@
components in any web application. Support for RichFaces and Ajax4jsf libraries in JBoss
Tools Palette. Rendering RichFaces components in Visual Page Editor.</entry>
<entry>
- <link linkend="RichFacesSupport"> RichFaces support</link>
+ <link linkend="RichFacesSupport">RichFaces support</link>
</entry>
</row>
</tbody>
@@ -230,7 +230,7 @@
</chapter>
-<chapter id="jbds_editors" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/userguide/en/modules/editors.xml" xreflabel="jbds_editors">
+<chapter id="jbds_editors" role="updated" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/userguide/en/modules/editors.xml" xreflabel="jbds_editors">
<?dbhtml filename="editors.html"?>
<chapterinfo>
<keywordset>
@@ -424,9 +424,9 @@
</listitem>
</itemizedlist>
- <para>Notice, that code completion for EL variables has icons illustrating what they are
+ <para><diffmk:wrapper diffmk:change="changed">Notice, that code completion for EL variables has icons illustrating what they are
from. Currently it's performed for resource bundles, JSF and Seam
- components.</para>
+ components.</diffmk:wrapper></para>
<figure float="0">
<title>JSF Content Assist</title>
@@ -446,8 +446,8 @@
</mediaobject>
</figure>
- <para>Also, as you can see, the ranking and sorting are available in EL code
- completions.</para>
+ <para><diffmk:wrapper diffmk:change="changed">Also, as you can see, the ranking and sorting are available in EL code
+ completions.</diffmk:wrapper></para>
<section id="JSFProjectFiles3087">
@@ -568,13 +568,13 @@
</mediaobject>
</figure>
- <para>Code Assist can also provide you with access to the beans located in jar archives.</para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Code Assist can also provide you with access to the beans located in jar archives.</diffmk:wrapper></para>
- <figure float="0">
- <title>Code Assist: accessing beans in jar archives</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/editors_features/editors_features_14_a.png"></imagedata>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Code Assist: accessing beans in jar archives</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/editors_features/editors_features_14_a.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -798,7 +798,7 @@
</mediaobject>
</figure>
</section>
- </section>
+
<section id="AddingDynamicCodeAssistToCustomComponents8745">
@@ -954,14 +954,14 @@
<title>Visual Page Editor</title>
<para><property moreinfo="none">JBoss Developer Studio</property> comes with a powerful and customizable
- <property moreinfo="none">Visual Page Editor</property> (VPE). You can use the Visual Page Editor to
- develop an application using any technology: JSF, Struts, JSP, HTML and others. Double-click on the necessary file in the Package Explorer view to open it in the Visual Editor or just drag-and-drop it into perspective (the drag-and-drop feature can be also applied to JSP, XHTML or HTML files created locally).</para>
+ <property moreinfo="none">Visual Page Editor</property><diffmk:wrapper diffmk:change="changed"> (VPE). You can use the Visual Page Editor to
+ develop an application using any technology: JSF, Struts, JSP, HTML and others. Double-click on the necessary file in the Package Explorer view to open it in the Visual Editor or just drag-and-drop it into perspective (the drag-and-drop feature can be also applied to JSP, XHTML or HTML files created locally).</diffmk:wrapper></para>
<para>Current VPE version has three tabs: <property moreinfo="none">Visual/Source</property>,
<property moreinfo="none">Source</property> and <property moreinfo="none">Preview</property>. To switch between the
views you can use tabs at the bottom of the VPE or the shortcuts <emphasis>
<property moreinfo="none">Ctrl + PageUp/Ctrl + PageDown</property>
- </emphasis>.</para>
+ </emphasis><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
<figure float="0">
<title>Visual Page Editor</title>
@@ -1026,30 +1026,30 @@
</imageobject>
</mediaobject>
</figure>
- <para> You can insert a tag/component from the palette into either the Source or the
- Visual part by calling a context menu and selecting <property moreinfo="none">Insert
- around</property>, <property moreinfo="none">Insert before</property>, <property moreinfo="none">Insert
- after</property> or <property moreinfo="none">Replace With</property>, pointing to
- <property moreinfo="none">From Palette</property>, picking the type of the tag and finally
- choosing the tag you want to insert. </para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> You can insert a tag/component from the palette into either the Source or the
+ Visual part by calling a context menu and selecting </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Insert
+ around</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Insert before</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Insert
+ after</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> or </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Replace With</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, pointing to
+ </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">From Palette</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, picking the type of the tag and finally
+ choosing the tag you want to insert. </diffmk:wrapper></para>
- <para>The image below illustrates how you can insert a tag into the Source part.</para>
- <figure float="0">
- <title>Inserting a tag into the Source part </title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/visual_page/visual_page_23a.png"></imagedata>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The image below illustrates how you can insert a tag into the Source part.</diffmk:wrapper></para>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Inserting a tag into the Source part </diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/visual_page/visual_page_23a.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
- <para>And this is how a tag is inserted using a context menu in the Visual part.</para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">And this is how a tag is inserted using a context menu in the Visual part.</diffmk:wrapper></para>
- <figure float="0">
- <title>Inserting a tag into the Visual part</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/visual_page/visual_page_23b.png"></imagedata>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Inserting a tag into the Visual part</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/visual_page/visual_page_23b.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -1113,51 +1113,51 @@
</itemizedlist>
</section>
- <section id="codefolding">
- <title>Using Code Folding</title>
- <para>
- <property moreinfo="none">Visual Page Editor</property> lets you collapse (hide) and expand
- (show) sections of your code to make it easier to navigate and read. </para>
- <para>Code folding can be enabled by right-clicking on the left margin on the Source
- part of Visual Page Editor, selecting <property moreinfo="none">Folding</property> and checking
- the <property moreinfo="none">Enable Folding</property> checkbox or using the <emphasis>
- <property moreinfo="none">Ctrl+Numpad_Divide</property>
- </emphasis> shortcut.</para>
- <para>When the code folding is enabled a minus sing ( <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/visual_page/visual_page_23c.png"></imagedata>
+ <section diffmk:change="added" id="codefolding">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Using Code Folding</diffmk:wrapper></title>
+ <para diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Visual Page Editor</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> lets you collapse (hide) and expand
+ (show) sections of your code to make it easier to navigate and read. </diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Code folding can be enabled by right-clicking on the left margin on the Source
+ part of Visual Page Editor, selecting </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Folding</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> and checking
+ the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Enable Folding</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> checkbox or using the </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Ctrl+Numpad_Divide</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> shortcut.</diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">When the code folding is enabled a minus sing ( </diffmk:wrapper><inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/visual_page/visual_page_23c.png"></imagedata>
</imageobject>
- </inlinemediaobject> ) will appear on the left margin of the editor next to each
- opening block tag. </para>
+ </inlinemediaobject><diffmk:wrapper diffmk:change="added"> ) will appear on the left margin of the editor next to each
+ opening block tag. </diffmk:wrapper></para>
- <figure float="0">
- <title>Enabled Code Folding </title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/visual_page/visual_page_24a.png"></imagedata>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Enabled Code Folding </diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/visual_page/visual_page_24a.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
- <para>Click the minus sign to collapse a block tag.</para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Click the minus sign to collapse a block tag.</diffmk:wrapper></para>
- <para>When the minus sing is clicked on the appropriate tag collapses and a plus
- sing ( <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/visual_page/visual_page_23d.png"></imagedata>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">When the minus sing is clicked on the appropriate tag collapses and a plus
+ sing ( </diffmk:wrapper><inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/visual_page/visual_page_23d.png"></imagedata>
</imageobject>
- </inlinemediaobject> ) is displayed on the left margin as well as a gray
- rectangle two dots ( <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/visual_page/visual_page_23e.png"></imagedata>
+ </inlinemediaobject><diffmk:wrapper diffmk:change="added"> ) is displayed on the left margin as well as a gray
+ rectangle two dots ( </diffmk:wrapper><inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/visual_page/visual_page_23e.png"></imagedata>
</imageobject>
- </inlinemediaobject> ) appears after opening and closing tags. </para>
+ </inlinemediaobject><diffmk:wrapper diffmk:change="added"> ) appears after opening and closing tags. </diffmk:wrapper></para>
- <figure float="0">
- <title>Collapsed Code</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/visual_page/visual_page_24b.png"></imagedata>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Collapsed Code</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/visual_page/visual_page_24b.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -1175,9 +1175,9 @@
<title>Support for Taglib versions</title>
<para>VPE templates now support various versions of tag libraries. It means that the
- <property moreinfo="none">VPE</property> takes control over those components which have
+ <property moreinfo="none">VPE</property><diffmk:wrapper diffmk:change="changed"> takes control over those components which have
different parameters or preview according to the framework version (like seam
- 1.2 and seam 2.0, or JSF 1.1 and JSF 1.2).</para>
+ 1.2 and seam 2.0, or JSF 1.1 and JSF 1.2).</diffmk:wrapper></para>
<para>For example, <emphasis>
<property moreinfo="none"><s:decorate></property>
@@ -1247,8 +1247,8 @@
<para>The pages you are working with in <property moreinfo="none">VPE</property> can use external
stylesheets. <property moreinfo="none">VPE</property> allows you to create new style classes in
existing stylesheets and/or edit them as well. For these purposes <property moreinfo="none">CSS
- Style Class Dialog</property> is provided (hot keys - <emphasis>
- <property moreinfo="none">CTRL+SHIT+C</property>).</emphasis></para>
+ Style Class Dialog</property><diffmk:wrapper diffmk:change="added"> is provided (hot keys - </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">CTRL+SHIT+C</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">).</diffmk:wrapper></emphasis></para>
<para>Select the element for which you need to create or edit style class and press
button next to <emphasis>
<property moreinfo="none">styleClass</property>
@@ -1273,8 +1273,8 @@
</imageobject>
</mediaobject>
</figure>
- <para>First, you should specify the CSS file where you are going to put your style
- class. Do this by pressing the button next to the <emphasis>
+ <para><diffmk:wrapper diffmk:change="changed">First, you should specify the CSS file where you are going to put your style
+ class. Do this by pressing the button next to the </diffmk:wrapper><emphasis>
<property moreinfo="none">CSS file</property>
</emphasis> field.</para>
<figure float="0">
@@ -1295,9 +1295,9 @@
<emphasis>
<property moreinfo="none">Boxes</property>, </emphasis>
<emphasis>
- <property moreinfo="none">Property Sheet</property>. </emphasis>The list of already exisiting classes with names begining with the symbols printed will be displayed on standard "Ctrl+Space" key combination. To add existing styling to
+ <property moreinfo="none">Property Sheet</property>. </emphasis><diffmk:wrapper diffmk:change="added">The list of already exisiting classes with names begining with the symbols printed will be displayed on standard "Ctrl+Space" key combination. To add existing styling to
the chosen element just point to the
- necessary one. Each time you select any class it is displayed in the Preview tab. Click on the <emphasis><property moreinfo="none">Apply</property></emphasis> button will apply the changes without closing the window.</para>
+ necessary one. Each time you select any class it is displayed in the Preview tab. Click on the </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Apply</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> button will apply the changes without closing the window.</diffmk:wrapper></para>
<figure float="0">
<title>Style Class Selection</title>
@@ -1308,13 +1308,13 @@
</mediaobject>
</figure>
- <para>The <emphasis>
- <property moreinfo="none">Edited properties</property>
- </emphasis> tab gives a preview of the properties which are set for the existing
- style class. You can easily modify them with the help of this wizard.</para>
+ <para><diffmk:wrapper diffmk:change="added">The </diffmk:wrapper><emphasis>
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Edited properties</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> tab gives a preview of the properties which are set for the existing
+ style class. You can easily modify them with the help of this wizard.</diffmk:wrapper></para>
<figure float="0">
- <title>Edited Properties</title>
+ <title><diffmk:wrapper diffmk:change="changed">Edited Properties</diffmk:wrapper></title>
<mediaobject>
<imageobject>
<imagedata fileref="images/visual_page/visual_page_21.png"></imagedata>
@@ -1322,39 +1322,39 @@
</mediaobject>
</figure>
- <para>If the style class isn't chosen, the tab doesn't show any properties.</para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If the style class isn't chosen, the tab doesn't show any properties.</diffmk:wrapper></para>
- <figure float="0">
- <title>Edited Properties</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/visual_page/edited_properties.png"></imagedata>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Edited Properties</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/visual_page/edited_properties.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
- <para>The <emphasis>
- <property moreinfo="none">Preview tab</property>
- </emphasis> is for observing the content of the chosen CSS file. This tab is hidden if no CSS file is chosen.</para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Preview tab</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> is for observing the content of the chosen CSS file. This tab is hidden if no CSS file is chosen.</diffmk:wrapper></para>
- <figure float="0">
- <title>Preview Tab</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/visual_page/preview_tab.png"></imagedata>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Preview Tab</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/visual_page/preview_tab.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
- <para>At the top of the <property moreinfo="none">CSS Style Class Dialog</property>
- you can see a preview box which visualizes the result. To edit the preview you should double click in the box. To leave the focus, use <emphasis>
- <property moreinfo="none">Ctrl + Tab</property>.</emphasis></para>
+ <para><diffmk:wrapper diffmk:change="changed">At the top of the </diffmk:wrapper><property moreinfo="none">CSS Style Class Dialog</property><diffmk:wrapper diffmk:change="added">
+ you can see a preview box which visualizes the result. To edit the preview you should double click in the box. To leave the focus, use </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Ctrl + Tab</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></emphasis></para>
- <figure float="0">
- <title>Editing the Preview</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/visual_page/preview_box.png"></imagedata>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Editing the Preview</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/visual_page/preview_box.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -1444,38 +1444,38 @@
<title>Advanced Settings</title>
<para>In the left vertical pane of the Visual part there are three buttons: <emphasis>
- <property moreinfo="none">Preferences</property></emphasis>
+ <property moreinfo="none">Preferences</property></emphasis><diffmk:wrapper diffmk:change="added">
(
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/visual_page/icon_1.png"></imagedata>
+ </diffmk:wrapper><inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/visual_page/icon_1.png"></imagedata>
</imageobject>
- </inlinemediaobject>
+ </inlinemediaobject><diffmk:wrapper diffmk:change="added">
),
- <emphasis>
+ </diffmk:wrapper><emphasis>
<property moreinfo="none">Refresh</property>
- </emphasis>
+ </emphasis><diffmk:wrapper diffmk:change="added">
(
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/visual_page/icon_2.png"></imagedata>
+ </diffmk:wrapper><inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/visual_page/icon_2.png"></imagedata>
</imageobject>
- </inlinemediaobject>
+ </inlinemediaobject><diffmk:wrapper diffmk:change="added">
)
- and <emphasis>
- <property moreinfo="none">Page Design Options</property> </emphasis>(
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/visual_page/icon_3.png"></imagedata>
+ and </diffmk:wrapper><emphasis>
+ <property moreinfo="none">Page Design Options</property> </emphasis><diffmk:wrapper diffmk:change="added">(
+ </diffmk:wrapper><inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/visual_page/icon_3.png"></imagedata>
</imageobject>
- </inlinemediaobject>
+ </inlinemediaobject><diffmk:wrapper diffmk:change="added">
)
- .</para>
+ .</diffmk:wrapper></para>
<figure float="0">
<title>Buttons on the Visual Part of VPE</title>
@@ -1490,20 +1490,20 @@
<listitem id="vpe_preferences">
<para><emphasis>
<property moreinfo="none">Preferences</property>
- </emphasis> button
+ </emphasis><diffmk:wrapper diffmk:change="added"> button
(
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/visual_page/icon_1.png"></imagedata>
+ </diffmk:wrapper><inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/visual_page/icon_1.png"></imagedata>
</imageobject>
- </inlinemediaobject>
+ </inlinemediaobject><diffmk:wrapper diffmk:change="added">
)
- provides a quick access to <property moreinfo="none">Visual Page
+ provides a quick access to </diffmk:wrapper><property moreinfo="none">Visual Page
Editor</property> preferences.</para>
<figure float="0">
@@ -1519,15 +1519,15 @@
<listitem>
<para>Clicking on <emphasis>
<property moreinfo="none">Refresh</property>
- </emphasis> button
+ </emphasis><diffmk:wrapper diffmk:change="added"> button
(
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/visual_page/icon_2.png"></imagedata>
+ </diffmk:wrapper><inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/visual_page/icon_2.png"></imagedata>
</imageobject>
- </inlinemediaobject>
+ </inlinemediaobject><diffmk:wrapper diffmk:change="added">
)
@@ -1536,30 +1536,30 @@
- you refresh the displayed information.</para>
+ you refresh the displayed information.</diffmk:wrapper></para>
</listitem>
<listitem>
<para><emphasis>
<property moreinfo="none">Page Design Options</property>
- </emphasis> button
+ </emphasis><diffmk:wrapper diffmk:change="added"> button
(
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/visual_page/icon_3.png"></imagedata>
+ </diffmk:wrapper><inlinemediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/visual_page/icon_3.png"></imagedata>
</imageobject>
- </inlinemediaobject>
+ </inlinemediaobject><diffmk:wrapper diffmk:change="added">
)
leads to a window which helps you specify necessary
references of the resources. It is represented by a window with 4 tabs. The
- first one, <emphasis>
- <property moreinfo="none">Actual Run-Time folders</property>,
- </emphasis> is used to replace absolute and relative path values when
- generating a preview: </para>
+ first one, </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Actual Run-Time folders</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">,
+ </diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="changed"> is used to replace absolute and relative path values when
+ generating a preview: </diffmk:wrapper></para>
<figure float="0">
- <title>Page Design Options: Actual Run-Time folders</title>
+ <title><diffmk:wrapper diffmk:change="changed">Page Design Options: Actual Run-Time folders</diffmk:wrapper></title>
<mediaobject>
<imageobject>
<imagedata fileref="images/visual_page/visual_page_10.png"></imagedata>
@@ -1568,16 +1568,16 @@
</figure>
- <para>The second tab, <emphasis>
- <property moreinfo="none">Included CSS files</property>
- </emphasis>, is used to add CSS files to be linked by Visual Page Editor
- when generating a preview:</para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The second tab, </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Included CSS files</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added">, is used to add CSS files to be linked by Visual Page Editor
+ when generating a preview:</diffmk:wrapper></para>
- <figure float="0">
- <title>Page Design Options: Included CSS files</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/visual_page/visual_page_10_2.png"></imagedata>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Page Design Options: Included CSS files</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/visual_page/visual_page_10_2.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -1585,36 +1585,36 @@
- <para>The third one, <emphasis>
- <property moreinfo="none">Included tag libs</property></emphasis>, can be used to add Taglibs that can be used by the editor for
- getting appropriate templates to generate a preview:</para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The third one, </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Included tag libs</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">, can be used to add Taglibs that can be used by the editor for
+ getting appropriate templates to generate a preview:</diffmk:wrapper></para>
- <figure float="0">
- <title>Page Design Options: Included tag libs</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/visual_page/visual_page_10_3.png"></imagedata>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Page Design Options: Included tag libs</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/visual_page/visual_page_10_3.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
- <para>And finally, the <emphasis>
- <property moreinfo="none">Substituted El expressions</property>
- </emphasis> tab is used to add El expressions that will be substituted by
- the editor when generating a preview:</para>
+ <para><diffmk:wrapper diffmk:change="added">And finally, the </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Substituted El expressions</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> tab is used to add El expressions that will be substituted by
+ the editor when generating a preview:</diffmk:wrapper></para>
- <figure float="0">
- <title>Page Design Options: Substituted El expressions</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/visual_page/visual_page_10_4.png"></imagedata>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Page Design Options: Substituted El expressions</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/visual_page/visual_page_10_4.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
- <para>The first two tabs of the window let you define actual runtime folders.
- The example below will help you understand how this can be done.</para>
+ <para><diffmk:wrapper diffmk:change="changed">The first two tabs of the window let you define actual runtime folders.
+ The example below will help you understand how this can be done.</diffmk:wrapper></para>
<para>Suppose you have the following project structure:</para>
@@ -1649,8 +1649,8 @@
pages'</emphasis> and you will see the image appeared.</para>
<para></para>
- <para>Let' consider an example for other tabs. For instance, the
- definition of your CSS on the page is the next:</para>
+ <para><diffmk:wrapper diffmk:change="changed">Let' consider an example for other tabs. For instance, the
+ definition of your CSS on the page is the next:</diffmk:wrapper></para>
<programlisting format="linespecific" role="XML"><![CDATA[<link rel="stylesheet" type="text/css"
href="#{facesContext.externalContext.requestContextPath}/style.css"/>
@@ -2278,9 +2278,11 @@
</section>
</section>
-</chapter>
+</section>
-
+
+
+</chapter>
<chapter id="palette" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/userguide/en/modules/palette.xml" xreflabel="palette">
<?dbhtml filename="palette.html"?>
<chapterinfo>
@@ -2843,101 +2845,100 @@
</chapter>
-<chapter id="richfaces_support" role="new" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/userguide/en/modules/richfaces_support.xml" xreflabel="richfaces_support">
- <?dbhtml filename="editors.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Developer Studio</keyword>
- <keyword>JBDS</keyword>
- <keyword>RichFaces</keyword>
+<chapter diffmk:change="added" id="richfaces_support" role="new" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/jsf/docs/userguide/en/modules/richfaces_support.xml" xreflabel="richfaces_support">
+ <chapterinfo diffmk:change="added">
+ <keywordset diffmk:change="added">
+ <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBoss Developer Studio</diffmk:wrapper></keyword>
+ <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBDS</diffmk:wrapper></keyword>
+ <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">RichFaces</diffmk:wrapper></keyword>
</keywordset>
</chapterinfo>
<title>RichFaces Support</title>
- <para><property moreinfo="none">JBoss Developer Studio</property> comes with a tight integration with <ulink url="http://labs.jboss.com/jbossrichfaces/">RichFaces component framework</ulink>.</para>
+ <para><property moreinfo="none">JBoss Developer Studio</property> comes with a tight integration with <ulink url="http://labs.jboss.com/jbossrichfaces/">RichFaces component framework</ulink><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
- <note>
- <title>Note:</title>
- <para><ulink url="http://www.jboss.org/jbossrichfaces/downloads/">RichFaces
- 3.3</ulink> is fully supported in the current version of <property moreinfo="none">JBoss Developer Studio</property> (i. e. 2.0.0.GA) and <property moreinfo="none">JBoss Tools 3.0.0.GA</property>.</para>
+ <note diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Note:</diffmk:wrapper></title>
+ <para diffmk:change="added"><ulink diffmk:change="added" url="http://www.jboss.org/jbossrichfaces/downloads/"><diffmk:wrapper diffmk:change="added">RichFaces
+ 3.3</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> is fully supported in the current version of </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Developer Studio</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> (i. e. 2.0.0.GA) and </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Tools 3.0.0.GA</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
</note>
- <para>The following features are implemented and fully supported for the current version of the RichFaces components:</para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The following features are implemented and fully supported for the current version of the RichFaces components:</diffmk:wrapper></para>
- <itemizedlist>
- <listitem><para><link linkend="ContentAssistForRF">Content Assist</link></para></listitem>
- <listitem><para><link linkend="RF_openOn">OpenOn</link></para></listitem>
- <listitem><para><link linkend="RF_in_palette">Representing in JBoss Tools Palette</link></para></listitem>
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added"><para diffmk:change="added"><link diffmk:change="added" linkend="ContentAssistForRF"><diffmk:wrapper diffmk:change="added">Content Assist</diffmk:wrapper></link></para></listitem>
+ <listitem diffmk:change="added"><para diffmk:change="added"><link diffmk:change="added" linkend="RF_openOn"><diffmk:wrapper diffmk:change="added">OpenOn</diffmk:wrapper></link></para></listitem>
+ <listitem diffmk:change="added"><para diffmk:change="added"><link diffmk:change="added" linkend="RF_in_palette"><diffmk:wrapper diffmk:change="added">Representing in JBoss Tools Palette</diffmk:wrapper></link></para></listitem>
</itemizedlist>
- <para>All you have to do is to <ulink url="http://www.jboss.org/jbossrichfaces/downloads/">download</ulink> and install RichFaces libraries into your
- project, i. e. just put <emphasis>
- <property moreinfo="none">richfaces-*.jar</property>
- </emphasis> files into the <emphasis>
- <property moreinfo="none">/lib</property>
- </emphasis> project folder. Also how to get started with <property moreinfo="none">RichFaces</property> you can find in <ulink url="http://jboss.org/file-access/default/members/jbossrichfaces/freezone/docs...">RichFaces documentation</ulink>.</para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">All you have to do is to </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jboss.org/jbossrichfaces/downloads/"><diffmk:wrapper diffmk:change="added">download</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> and install RichFaces libraries into your
+ project, i. e. just put </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">richfaces-*.jar</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> files into the </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">/lib</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> project folder. Also how to get started with </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">RichFaces</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> you can find in </diffmk:wrapper><ulink diffmk:change="added" url="http://jboss.org/file-access/default/members/jbossrichfaces/freezone/docs..."><diffmk:wrapper diffmk:change="added">RichFaces documentation</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
- <section id="ContentAssistForRF">
- <title>Code Assist for RichFaces</title>
+ <section diffmk:change="added" id="ContentAssistForRF">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Code Assist for RichFaces</diffmk:wrapper></title>
- <para><property moreinfo="none">JBDS/JBoss Tools</property> indeed provide code completion for <ulink url="http://www.jboss.org/jbossrichfaces">RichFaces</ulink> framework
- components.</para>
+ <para diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBDS/JBoss Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> indeed provide code completion for </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jboss.org/jbossrichfaces"><diffmk:wrapper diffmk:change="added">RichFaces</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> framework
+ components.</diffmk:wrapper></para>
- <tip>
- <title>Tip:</title>
+ <tip diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Tip:</diffmk:wrapper></title>
- <para>RichFaces 3.3 is now fully supported in code completion.</para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">RichFaces 3.3 is now fully supported in code completion.</diffmk:wrapper></para>
</tip>
- <figure float="0">
- <title>Content Assist for RichFaces Components</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/editors_features/editors_features_29.png" scale="65"></imagedata>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Content Assist for RichFaces Components</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/editors_features/editors_features_29.png" scale="65"></imagedata>
</imageobject>
</mediaobject>
</figure>
</section>
- <section id="RF_openOn">
- <title>OpenOn for RichFaces</title>
+ <section diffmk:change="added" id="RF_openOn">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">OpenOn for RichFaces</diffmk:wrapper></title>
- <para>Working with <emphasis>
- <property moreinfo="none">.jsp/.xhtml</property></emphasis> pages in <property moreinfo="none">VPE</property> you can also take the advantage of <emphasis>
- <property moreinfo="none">OpenOn</property></emphasis> feature for the <property moreinfo="none">RichFaces</property> components.</para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Working with </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">.jsp/.xhtml</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> pages in </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">VPE</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> you can also take the advantage of </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">OpenOn</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> feature for the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">RichFaces</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> components.</diffmk:wrapper></para>
- <para>For example, <property moreinfo="none">Richfaces</property> tags <emphasis>
- <property moreinfo="none"><rich:insert></property>
- </emphasis> and <emphasis>
- <property moreinfo="none"><a4j:include></property>
- </emphasis> has <property moreinfo="none">OpenOn</property> support.</para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">For example, </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Richfaces</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> tags </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added"><rich:insert></diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> and </diffmk:wrapper><emphasis diffmk:change="added">
+ <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added"><a4j:include></diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> has </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">OpenOn</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> support.</diffmk:wrapper></para>
- <figure float="0">
- <title>OpenOn With Richfaces Tag</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/editors_features/editors_features_8a.png"></imagedata>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">OpenOn With Richfaces Tag</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/editors_features/editors_features_8a.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
- <figure float="0">
- <title>OpenOn With A4j Tag</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/editors_features/editors_features_8b.png"></imagedata>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">OpenOn With A4j Tag</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/editors_features/editors_features_8b.png"></imagedata>
</imageobject>
</mediaobject>
</figure>
</section>
- <section id="RF_in_palette">
- <title>RichFaces in the JBoss Tools Palette</title>
+ <section diffmk:change="added" id="RF_in_palette">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">RichFaces in the JBoss Tools Palette</diffmk:wrapper></title>
- <para>RichFaces and Ajax4jsf tag libraries always exist in <link linkend="palette">JBoss Tools
- Palette</link>.</para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">RichFaces and Ajax4jsf tag libraries always exist in </diffmk:wrapper><link linkend="palette">JBoss Tools
+ Palette</link><diffmk:wrapper diffmk:change="changed">.</diffmk:wrapper></para>
<figure float="0">
<title>RichFaces Components</title>
@@ -2948,45 +2949,45 @@
</mediaobject>
</figure>
- <para>To insert a <property moreinfo="none">RichFaces</property> component on a page:</para>
- <itemizedlist>
- <listitem>
- <para>expand <emphasis>
- <property moreinfo="none">JBoss RichFaces</property>
- </emphasis> group on the palette</para>
+ <para><diffmk:wrapper diffmk:change="changed">To insert a </diffmk:wrapper><property moreinfo="none">RichFaces</property><diffmk:wrapper diffmk:change="added"> component on a page:</diffmk:wrapper></para>
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">expand </diffmk:wrapper><emphasis diffmk:change="added">
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss RichFaces</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="added"> group on the palette</diffmk:wrapper></para>
</listitem>
- <listitem>
- <para>click on some component</para>
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">click on some component</diffmk:wrapper></para>
</listitem>
- <listitem>
- <para>put the needed attributes in the <emphasis>
- <property moreinfo="none">Insert Tag</property>
- </emphasis> dialog and click <emphasis>
- <property moreinfo="none">Finish</property>
- </emphasis> button
- </para>
+ <listitem diffmk:change="added">
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">put the needed attributes in the </diffmk:wrapper><emphasis diffmk:change="added">
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Insert Tag</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> dialog and click </diffmk:wrapper><emphasis>
+ <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Finish</diffmk:wrapper></property>
+ </emphasis><diffmk:wrapper diffmk:change="changed"> button
+ </diffmk:wrapper></para>
</listitem>
</itemizedlist>
- <figure float="0">
- <title>Inserting Tag</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/editors_features/editors_features_30.png" scale="75"></imagedata>
+ <figure diffmk:change="added" float="0">
+ <title><diffmk:wrapper diffmk:change="changed">Inserting Tag</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/editors_features/editors_features_30.png" scale="75"></imagedata>
</imageobject>
</mediaobject>
</figure>
- <para>The <property moreinfo="none">RichFaces</property> component will be inserted on your page and displayed in source and visual
- modes:</para>
+ <para><diffmk:wrapper diffmk:change="changed">The </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">RichFaces</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> component will be inserted on your page and displayed in source and visual
+ modes:</diffmk:wrapper></para>
- <figure float="0">
- <title>RichFaces Component</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/editors_features/editors_features_31.png" scale="75"></imagedata>
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">RichFaces Component</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/editors_features/editors_features_31.png" scale="75"></imagedata>
</imageobject>
</mediaobject>
</figure>
@@ -2996,8 +2997,8 @@
<section>
<title>Relevant Resources Links</title>
- <para>To get more in-depth information on <property moreinfo="none">RichFaces</property> framework refer to <ulink url="http://jboss.org/file-access/default/members/jbossrichfaces/freezone/docs...">RichFaces Developer Guide</ulink>.</para>
- <para>It may be also helpful for you to look through the <ulink url="http://docs.jboss.org/tools/movies/">movies</ulink> where there are ones that demonstrate the usage of RichFaces components.</para>
+ <para><diffmk:wrapper diffmk:change="added">To get more in-depth information on </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">RichFaces</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> framework refer to </diffmk:wrapper><ulink diffmk:change="added" url="http://jboss.org/file-access/default/members/jbossrichfaces/freezone/docs..."><diffmk:wrapper diffmk:change="added">RichFaces Developer Guide</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">It may be also helpful for you to look through the </diffmk:wrapper><ulink diffmk:change="added" url="http://docs.jboss.org/tools/movies/"><diffmk:wrapper diffmk:change="added">movies</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> where there are ones that demonstrate the usage of RichFaces components.</diffmk:wrapper></para>
</section>
</chapter>
@@ -4471,6 +4472,4 @@
</figure>
</section>
-->
-</chapter>
-
-</book>
+</chapter></book>
15 years, 3 months