[jbosstools-commits] JBoss Tools SVN: r22661 - in tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US: images/create_new_seam and 4 other directories.
jbosstools-commits at lists.jboss.org
jbosstools-commits at lists.jboss.org
Tue Jun 8 20:28:37 EDT 2010
Author: irooskov at redhat.com
Date: 2010-06-08 20:28:36 -0400 (Tue, 08 Jun 2010)
New Revision: 22661
Added:
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/directory_structure/directory_structure_7.png
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/directory_structure/directory_structure_8.png
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_editors/seam_editors_1c.png
Modified:
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/Seam_Developer_Tools_Reference_Guide.xml
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/creating_new_seam.xml
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/directory_structure.xml
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/generate_entities.xml
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_1.png
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_11.png
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_12.png
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_13.png
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_15.png
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_16.png
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_20.png
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_21.png
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_7.png
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_8.png
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/crud_database_application/crud_database_application_15.png
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_wizards/seam_wizards_11.png
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_wizards/seam_wizards_14.png
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_wizards/seam_wizards_15.png
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_wizards/seam_wizards_5.png
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_wizards/seam_wizards_8.png
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/intro.xml
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/master.xml
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/master_output.xml
tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/seam_editors.xml
Log:
updated for 3.0.1
Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/Seam_Developer_Tools_Reference_Guide.xml
===================================================================
--- tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/Seam_Developer_Tools_Reference_Guide.xml 2010-06-09 00:21:45 UTC (rev 22660)
+++ tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/Seam_Developer_Tools_Reference_Guide.xml 2010-06-09 00:28:36 UTC (rev 22661)
@@ -6,7 +6,7 @@
<xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
<xi:include href="intro.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
<xi:include href="creating_new_seam.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
-<!--<xi:include href="creating_mavenized_seam.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>-->
+<xi:include href="creating_mavenized_seam.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
<xi:include href="directory_structure.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
<xi:include href="seam_menus_and_actions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
<xi:include href="seam_wizards.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include>
Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/creating_new_seam.xml
===================================================================
--- tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/creating_new_seam.xml 2010-06-09 00:21:45 UTC (rev 22660)
+++ tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/creating_new_seam.xml 2010-06-09 00:28:36 UTC (rev 22661)
@@ -1,464 +1,478 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="create_seam" xreflabel="create_seam" role="updated">
- <?dbhtml filename="create_new_seam.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Seam</keyword>
- <keyword>JBDS</keyword>
- </keywordset>
- </chapterinfo>
- <title>Creating a New Seam Project via the New Seam Project wizard</title>
- <para>In this chapter we provide you with the necessary steps to start working with Seam
- Framework.</para>
- <para>At first, we suggest to set the specific Seam perspective that combines a number of
- different views and editors needed for work with resources concerned. For that select
- <emphasis>
- <property>Window > Open Perspective > Other > Seam</property>
- </emphasis> or you can also access it through the button in the right top corner.</para>
- <figure>
- <title>Seam Perspective Icon</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_0.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Also the <emphasis>
- <property>Open Web Browser</property></emphasis> action is directly available in the
- <property>Seam perspective</property>.</para>
- <figure>
- <title>Embedded Web Browser Button</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_01.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <section id="standaloneSeam" role="updated">
- <title>Create standalone Seam Web Project</title>
- <para>The best way to get started with Seam is to create a simple Seam Project and
- experiment with it.</para>
- <para>Thus, you should select <emphasis>
- <property>File > New > Seam Web Project</property>
- </emphasis> to run the <property>New Seam Project</property> wizard. The wizard form
- allows you to create runtime and server instances in order to get started creating,
- running, and debugging J2EE (only) applications.</para>
- <para>Seam Web Project wizard has an option for selecting the actual Server (not just WTP
- runtime) that will be used for the project. This allows the wizard to identify correctly
- where the required datasource and driver libraries need to go.</para>
- <para>Let's get through the wizard step-by-step. First, you should enter a name and a
- location directory for your new project.</para>
- <figure id="figure_create_seam1">
- <title>New Seam Project Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>On the figure above you can see the runtime and the server already created.</para>
- <para>If you need to create a new runtime, click on the <emphasis>
- <property>New...</property>
- </emphasis> button in the <property>Target Runtime</property> section. It brings up the
- wizard where you can specify a new JBoss Server Runtime environment or the other type of
- runtime appropriate for your project configuration. Let's create one more JBoss 4.2
- Runtime. Hence, after choosing it click on <emphasis>
- <property>Next</property>
- </emphasis> button.</para>
- <figure>
- <title>Specifying Target Runtime</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>All what you need here is to name runtime, type the path to its install directory or
- locate it by using <emphasis>
- <property>Browse</property>
- </emphasis> button, select a Java Runtime Environment, and select which configuration
- you want.</para>
- <figure>
- <title>Specifying Target Runtime Configurations</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para> Clicking on <emphasis>
- <property>Finish</property>
- </emphasis> returns you to the <link linkend="figure_create_seam1">New Seam Project
- wizard page</link>.</para>
- <para>The next step is to define a Server by clicking on <emphasis>
- <property>New...</property>
- </emphasis> button in the <property>Target Server</property> section. In appeared
- <property>New Server dialog</property> the last server which matches the runtime
- will be selected.</para>
- <para>All declared runtimes are listed in the combo-box under the servers view. Here, you
- can indicate a server runtime that you need. Click <emphasis>
- <property>Add</property>
- </emphasis> if you want to add a new Server Runtime.</para>
- <figure>
- <title>Specifying Target Server</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_4.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Next page allows you to verify the information for a chosen server. Leave everything
- as it is and click on <emphasis>
- <property>Next</property>
- </emphasis>.</para>
- <figure>
- <title>JBoss Runtime Summary</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_5.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>On the last wizard step you can modify your projects to configure them on the
- Server.</para>
- <figure>
- <title>Project Modification for Configuring on the Server</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_6.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Once you have the Target Server defined click on <emphasis>
- <property>Finish</property>
- </emphasis> button to return to the first page of the <property>New Seam Project
- wizard</property>.</para>
- <tip>
- <title>Tip:</title>
- <para>We suggest that you look through AS manager guide to
- find out more about runtimes and servers.</para>
- </tip>
- <figure>
- <title>Completion of Runtime and Server Configuration</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_7.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>The last section on this wizard step is <property>Configuration</property>. Here, you
- can select one of the pre-defined project configurations either associated with Seam
- 1.2, Seam 2.0 or with Seam 2.1. Furthermore, you can create your own configuration by
- pressing the <emphasis>
- <property>Modify...</property>
- </emphasis> button. It will open the dialog which allows to configure your own set of
- facets for adding extra functionality to your project.</para>
- <para>Pass to the next section to find out more details on this dialog.</para>
- </section>
- <section id="projectFacets">
- <title>Selecting the Project Facets</title>
- <para>The <property>Project Facets wizard</property> allows you to enable or disable
- specific facets which define necessary features for the project. When you switch to this
- wizard form, all critical facets are already checked for the chosen
- Configuration.</para>
- <para>Notice that this page of the wizard also allows you to set the necessary version for
- any facet. </para>
- <figure>
- <title>Project Facets Selection</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_8.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Moreover, here you can specify your own preset of selected facets by checking needed
- ones in project facets window and clicking on <emphasis>
- <property>Save</property>
- </emphasis> button.</para>
- <figure>
- <title>Specifying Custom Facet Preset</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_15.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>To see all available Server runtimes click on <property>Runtimes</property> tab on the
- left. You can create a new one using the <emphasis>
- <property>New</property>
- </emphasis> button. If more than one runtime is checked here, the <emphasis>
- <property>Make Primary</property>
- </emphasis> button won't be dimmed yet. Thus, you can make use of it to mark
- primary runtime.</para>
- <figure>
- <title>Setting Runtime</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_16.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para><emphasis>
- <property>Ok</property>
- </emphasis> button will bring you to the <property>Web Module</property> wizard form
- again.</para>
- <section id="seamWithJPA">
- <title>Seam project with JPA facets</title>
- <para>For creating Seam project with JPA support you need to select<property> Java
- Persistent</property> facet on <property>Project Facets</property> page and
- click <property>OK</property>.</para>
- <para>Then you should press <property>Next</property> and may leave the default value on
- <property>Java application building</property> page and <property>Web Module
- Settings</property> page.</para>
- <para>After that you will see <property>JPA facet</property> page.</para>
- <figure>
- <title>JPA Facet page</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_16b.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>On this page you can choose <property>Platform</property> (vendor-specific JPA
- implementation) for your project, type of JPA Implementation, and configure the
- <property>Connection</property> to database in the <property
- >Connection</property> area.</para>
- <para>More about <property>JPA facet</property> page you can read in <ulink
- url="http://help.eclipse.org/galileo/index.jsp?topic=/org.eclipse.jpt.doc.user/ref_jpa_facet.htm"
- >Eclipse documentation</ulink>. </para>
- <para>On the next step you will see <property>JSF Capabilities</property> and <property>Seam
- facet</property> pages, which are mostly the same as in general Seam
- project.</para>
- </section>
- </section>
- <section id="configureJava">
- <title>Java application building configuration</title>
- <para>With this wizard you can define Java source directories which will be generated on
- build path. Also you can specify a default output folder. If you are agree with default
- values, press <property>Next</property></para>
- <figure>
- <title>Java application building Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_16a.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <section id="configureWebModule">
- <title>How to Configure Web Module Settings</title>
- <para> As we deal with a Dynamic Web Application, we should at first specify the top level
- directory of our application for deploying it to a server afterwards. You know, this
- kind of application contains Web resources. Thus, it's important to indicate the content
- directory. The wizard will put all those values itself, so you can leave everything as
- is.</para>
- <figure>
- <title>Web Module Settings</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_9.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Choose <emphasis>
- <property>Next</property>
- </emphasis> to switch to the next wizard form.</para>
- </section>
- <section id="addJSFCapab">
- <title>Adding JSF Capabilities</title>
- <para>This wizard helps you to add JSF capabilities to your project. </para>
- <para>Choose <emphasis>
- <property>Library provided by Target Runtime</property>
- </emphasis> from Library Type list if you'd like to use a default JSF implementation
- given by the present runtime.</para>
- <figure>
- <title>Adding JSF Capabilities to Web Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_10.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>In case if you prefer to use your custom JSF implementation, choose <property>User
- Library</property> Item from Library Type list. In User Library list you can check
- required library.</para>
- <figure>
- <title>Using Custom JSF implementation Library </title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_17.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para> If a new library is required, click <property>Manage libraries...</property> (
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_17a.png"/>
- </imageobject>
- </inlinemediaobject>) button. Then you should click <property>New</property>.</para>
- <figure>
- <title>Using Custom JSF implementation Library </title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_18.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para> Here, it's necessary to type a <property>Library Name</property>. </para>
- <figure>
- <title>Entering New User Library Name</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_23.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>To add proper <property>Library JARs</property>, click <property>Add
- JARs...</property> button and select the JARs on your hard drive. </para>
- <figure>
- <title>Selection Library JARs</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_25.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>You can download necessary JSF implementation libraries provided by Sun and Apache
- Foundation as well. Click <property>Download...</property> (<inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_23a.png"/>
- </imageobject>
- </inlinemediaobject>) button and choose one of proposed libraries.</para>
- <figure>
- <title>Download JSF Implementation Library</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_24.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>The last wizard options allows to edit a path for <property>JSF Configuration
- File</property>, a name for <property>JSF Servlet</property>, <property>JSF Servlet
- Classname</property> and change <property>URL Mapping Patterns</property>.</para>
- <figure>
- <title>JSF Capabilities Wizard</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_19.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Since we are arranging the Seam Web project, the last step we should do is to adjust
- project configurations associated with the Seam.</para>
- </section>
- <section id="seamFacet">
- <title>Configure Seam Facet Settings</title>
- <para>The last wizard step is related to Seam facet and allows you to do the
- following:</para>
- <figure>
- <title>Seam Facet Settings</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_11.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>Create Seam runtime and define Seam home folder.</para>
- </listitem>
- </itemizedlist>
- <para>For that click on <emphasis>
- <property>Add</property>
- </emphasis> button in the <property>General</property> section. Note, in the wizard
- shown below you can create a Seam runtime only for the version that was selected in the
- <link linkend="projectFacets">Project Facets</link> wizard (version 1.2 in our
- case).</para>
- <figure>
- <title>Seam Runtime Creation</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_12.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>Select EAR or WAR deployment by checking a necessary radio button.</para>
- </listitem>
- <listitem>
- <para>Select a <emphasis>
- <property>Database Type</property>
- </emphasis></para>
- </listitem>
- </itemizedlist>
- <figure>
- <title>Database Type Selecting</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_20.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <itemizedlist>
- <listitem>
- <para>and then specify a <emphasis>
- <property>Connection profile</property>
- </emphasis> appropriate for your database.</para>
- </listitem>
- </itemizedlist>
- <figure>
- <title>Connection Profile Options</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_21.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>You can edit chosen profile by using <emphasis>
- <property>Edit</property>
- </emphasis> button or organise a new one by clicking on <emphasis>
- <property>New</property>
- </emphasis> button and selecting necessary for you type of connection profile.</para>
- <figure>
- <title>Connection Profile Selecting</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_13.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>On the dialog you'll be asked to enter its name and description. And then you
- should select a proper driver and adjust connection details. Press <emphasis>
- <property>Next</property>
- </emphasis> to preview all the adjusted settings and complete the creation of the new
- profile.</para>
- <figure>
- <title>Connection Details</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_22.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>The next block of settings in the Seam Facet wizard are describing a Database and a
- connection to it.</para>
- <para>In the <property>Code Generation</property> section the wizard has already provided
- the names for your <property>Session Bean</property>, <property>Entity Bean</property>
- and <property>Test</property> packages generation (optional). Of course, you can change
- them on others of your choice.</para>
- <figure>
- <title>Code Generation Section</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_new_seam/create_seam_14.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>Click on <emphasis>
- <property>Finish</property>
- </emphasis> to generate a project.</para>
- <para/>
- </section>
-</chapter>
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="create_seam" xreflabel="create_seam" role="updated">
+ <?dbhtml filename="create_new_seam.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>Seam</keyword>
+ <keyword>JBDS</keyword>
+ </keywordset>
+ </chapterinfo>
+ <title>Creating a New Seam Project via the New Seam Project wizard</title>
+ <para>In this chapter we provide you with the necessary steps to start working with Seam
+ Framework.</para>
+ <para>At first, we suggest to set the specific Seam perspective that combines a number of
+ different views and editors needed for work with resources concerned. For that select
+ <emphasis>
+ <property>Window > Open Perspective > Other > Seam</property>
+ </emphasis> or you can also access it through the button in the right top corner.</para>
+ <figure>
+ <title>Seam Perspective Icon</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_0.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Also the <emphasis>
+ <property>Open Web Browser</property></emphasis> action is directly available in the
+ <property>Seam perspective</property>.</para>
+ <figure>
+ <title>Embedded Web Browser Button</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_01.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <section id="standaloneSeam" role="updated">
+ <title>Create standalone Seam Web Project</title>
+ <para>The best way to get started with Seam is to create a simple Seam Project and
+ experiment with it.</para>
+ <para>Thus, you should select <emphasis>
+ <property>File > New > Seam Web Project</property>
+ </emphasis> to run the <property>New Seam Project</property> wizard. The wizard form
+ allows you to create runtime and server instances in order to get started creating,
+ running, and debugging J2EE (only) applications.</para>
+ <para>Seam Web Project wizard has an option for selecting the actual Server (not just WTP
+ runtime) that will be used for the project. This allows the wizard to identify correctly
+ where the required datasource and driver libraries need to go.</para>
+ <para>Let's get through the wizard step-by-step. First, you should enter a name and a
+ location directory for your new project.</para>
+ <figure id="figure_create_seam1">
+ <title>New Seam Project Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>On the figure above you can see the runtime and the server already created.</para>
+ <para>If you need to create a new runtime, click on the <emphasis>
+ <property>New...</property>
+ </emphasis> button in the <property>Target Runtime</property> section. It brings up the
+ wizard where you can specify a new JBoss Server Runtime environment or the other type of
+ runtime appropriate for your project configuration. Let's create one more JBoss 4.2
+ Runtime. Hence, after choosing it click on <emphasis>
+ <property>Next</property>
+ </emphasis> button.</para>
+ <figure>
+ <title>Specifying Target Runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>All what you need here is to name runtime, type the path to its install directory or
+ locate it by using <emphasis>
+ <property>Browse</property>
+ </emphasis> button, select a Java Runtime Environment, and select which configuration
+ you want.</para>
+ <figure>
+ <title>Specifying Target Runtime Configurations</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para> Clicking on <emphasis>
+ <property>Finish</property>
+ </emphasis> returns you to the <link linkend="figure_create_seam1">New Seam Project
+ wizard page</link>.</para>
+ <para>The next step is to define a Server by clicking on <emphasis>
+ <property>New...</property>
+ </emphasis> button in the <property>Target Server</property> section. In appeared
+ <property>New Server dialog</property> the last server which matches the runtime
+ will be selected.</para>
+ <para>All declared runtimes are listed in the combo-box under the servers view. Here, you
+ can indicate a server runtime that you need. Click <emphasis>
+ <property>Add</property>
+ </emphasis> if you want to add a new Server Runtime.</para>
+ <figure>
+ <title>Specifying Target Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Next page allows you to verify the information for a chosen server. Leave everything
+ as it is and click on <emphasis>
+ <property>Next</property>
+ </emphasis>.</para>
+ <figure>
+ <title>JBoss Runtime Summary</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>On the last wizard step you can modify your projects to configure them on the
+ Server.</para>
+ <figure>
+ <title>Project Modification for Configuring on the Server</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_6.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Once you have the Target Server defined click on <emphasis>
+ <property>Finish</property>
+ </emphasis> button to return to the first page of the <property>New Seam Project
+ wizard</property>.</para>
+ <tip>
+ <title>Tip:</title>
+ <para>We suggest that you look through the Application Server Manager Guide to
+ find out more about runtimes and servers.</para>
+ </tip>
+ <figure>
+ <title>Completion of Runtime and Server Configuration</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_7.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The last section on this wizard step is <property>Configuration</property>. Here, you
+ can select one of the pre-defined project configurations either associated with Seam
+ 1.2, Seam 2.0 or with Seam 2.1. Furthermore, you can create your own configuration by
+ pressing the <emphasis>
+ <property>Modify...</property>
+ </emphasis> button. It will open the dialog which allows to configure your own set of
+ facets for adding extra functionality to your project.</para>
+ <para>Pass to the next section to find out more details on this dialog.</para>
+ </section>
+ <section id="projectFacets">
+ <title>Selecting the Project Facets</title>
+ <para>The <property>Project Facets wizard</property> allows you to enable or disable
+ specific facets which define necessary features for the project. When you switch to this
+ wizard form, all critical facets are already checked for the chosen
+ Configuration.</para>
+ <para>Notice that this page of the wizard also allows you to set the necessary version for
+ any facet. </para>
+ <figure>
+ <title>Project Facets Selection</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_8.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Moreover, here you can specify your own preset of selected facets by checking needed
+ ones in project facets window and clicking on <emphasis>
+ <property>Save</property>
+ </emphasis> button.</para>
+ <figure>
+ <title>Specifying Custom Facet Preset</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_15.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>To see all available Server runtimes click on <property>Runtimes</property> tab on the
+ left. You can create a new one using the <emphasis>
+ <property>New</property>
+ </emphasis> button. If more than one runtime is checked here, the <emphasis>
+ <property>Make Primary</property>
+ </emphasis> button won't be dimmed yet. Thus, you can make use of it to mark
+ primary runtime.</para>
+ <figure>
+ <title>Setting Runtime</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_16.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para><emphasis>
+ <property>Ok</property>
+ </emphasis> button will bring you to the <property>Web Module</property> wizard form
+ again.</para>
+ <section id="seamWithJPA">
+ <title>Seam project with JPA facets</title>
+ <para>For creating Seam project with JPA support you need to select<property> Java
+ Persistent</property> facet on <property>Project Facets</property> page and
+ click <property>OK</property>.</para>
+ <para>Then you should press <property>Next</property> and may leave the default value on
+ <property>Java application building</property> page and <property>Web Module
+ Settings</property> page.</para>
+ <para>After that you will see <property>JPA facet</property> page.</para>
+ <figure>
+ <title>JPA Facet page</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_16b.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>On this page you can choose <property>Platform</property> (vendor-specific JPA
+ implementation) for your project, type of JPA Implementation, and configure the
+ <property>Connection</property> to database in the <property
+ >Connection</property> area.</para>
+ <para>More about <property>JPA facet</property> page you can read in <ulink
+ url="http://help.eclipse.org/galileo/index.jsp?topic=/org.eclipse.jpt.doc.user/ref_jpa_facet.htm"
+ >Eclipse documentation</ulink>. </para>
+ <para>On the next step you will see <property>JSF Capabilities</property> and <property>Seam
+ facet</property> pages, which are mostly the same as in general Seam
+ project.</para>
+ </section>
+ </section>
+ <section id="configureJava">
+ <title>Java application building configuration</title>
+ <para>With this wizard you can define Java source directories which will be generated on
+ build path. Also you can specify a default output folder. If you are agree with default
+ values, press <property>Next</property></para>
+ <figure>
+ <title>Java application building Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_16a.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ <section id="configureWebModule">
+ <title>How to Configure Web Module Settings</title>
+ <para> As we deal with a Dynamic Web Application, we should at first specify the top level
+ directory of our application for deploying it to a server afterwards. You know, this
+ kind of application contains Web resources. Thus, it's important to indicate the content
+ directory. The wizard will put all those values itself, so you can leave everything as
+ is.</para>
+ <figure>
+ <title>Web Module Settings</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_9.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Choose <emphasis>
+ <property>Next</property>
+ </emphasis> to switch to the next wizard form.</para>
+ </section>
+ <section id="addJSFCapab">
+ <title>Adding JSF Capabilities</title>
+ <para>This wizard helps you to add JSF capabilities to your project. </para>
+ <para>Choose <emphasis>
+ <property>Library provided by Target Runtime</property>
+ </emphasis> from Library Type list if you'd like to use a default JSF implementation
+ given by the present runtime.</para>
+ <figure>
+ <title>Adding JSF Capabilities to Web Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_10.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>In case if you prefer to use your custom JSF implementation, choose <property>User
+ Library</property> Item from Library Type list. In User Library list you can check
+ required library.</para>
+ <figure>
+ <title>Using Custom JSF implementation Library </title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_17.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para> If a new library is required, click <property>Manage libraries...</property> (
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_17a.png"/>
+ </imageobject>
+ </inlinemediaobject>) button. Then you should click <property>New</property>.</para>
+ <figure>
+ <title>Using Custom JSF implementation Library </title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_18.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para> Here, it's necessary to type a <property>Library Name</property>. </para>
+ <figure>
+ <title>Entering New User Library Name</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_23.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>To add proper <property>Library JARs</property>, click <property>Add
+ JARs...</property> button and select the JARs on your hard drive. </para>
+ <figure>
+ <title>Selection Library JARs</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_25.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>You can download necessary JSF implementation libraries provided by Sun and Apache
+ Foundation as well. Click <property>Download...</property> (<inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_23a.png"/>
+ </imageobject>
+ </inlinemediaobject>) button and choose one of proposed libraries.</para>
+ <figure>
+ <title>Download JSF Implementation Library</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_24.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The last wizard options allows to edit a path for <property>JSF Configuration
+ File</property>, a name for <property>JSF Servlet</property>, <property>JSF Servlet
+ Classname</property> and change <property>URL Mapping Patterns</property>.</para>
+ <figure>
+ <title>JSF Capabilities Wizard</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_19.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Since we are arranging the Seam Web project, the last step we should do is to adjust
+ project configurations associated with the Seam.</para>
+ </section>
+ <section id="seamFacet">
+ <title>Configure Seam Facet Settings</title>
+ <para>The last wizard step is related to Seam facet and allows you to do the
+ following:</para>
+ <figure>
+ <title>Seam Facet Settings</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_11.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>Create Seam runtime and define Seam home folder.</para>
+ </listitem>
+ </itemizedlist>
+ <para>For that click on <emphasis>
+ <property>Add</property>
+ </emphasis> button in the <property>General</property> section. Note, in the wizard
+ shown below you can create a Seam runtime only for the version that was selected in the
+ <link linkend="projectFacets">Project Facets</link> wizard (version 1.2 in our
+ case).</para>
+ <figure>
+ <title>Seam Runtime Creation</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_12.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <itemizedlist>
+ <listitem>
+ <para>Select EAR or WAR deployment by checking a necessary radio button.</para>
+ </listitem>
+ <listitem>
+ <para>Enter EJB project name and EAR project name in case of EAR radio button is checked.</para>
+ </listitem>
+ </itemizedlist>
+
+ <tip>
+ <title>Tip:</title>
+ <para>If you want to name your web project "MyProject-war" note that the EJB project should not be "MyProject-war-ejb",
+ it should be "MyProject-ejb". The same for EAR and Test projects' names. They should be respectively "MyProject-ear"
+ and "MyProject-test".</para>
+ </tip>
+
+ <itemizedlist>
+ <listitem>
+ <para>Select a <emphasis>
+ <property>Database Type</property>
+ </emphasis></para>
+ </listitem>
+ </itemizedlist>
+ <figure>
+ <title>Database Type Selecting</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_20.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <itemizedlist>
+ <listitem>
+ <para>and then specify a <emphasis>
+ <property>Connection profile</property>
+ </emphasis> appropriate for your database.</para>
+ </listitem>
+ </itemizedlist>
+ <figure>
+ <title>Connection Profile Options</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_21.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>You can edit chosen profile by using <emphasis>
+ <property>Edit</property>
+ </emphasis> button or organise a new one by clicking on <emphasis>
+ <property>New</property>
+ </emphasis> button and selecting necessary for you type of connection profile.</para>
+ <figure>
+ <title>Connection Profile Selecting</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_13.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>On the dialog you'll be asked to enter its name and description. And then you
+ should select a proper driver and adjust connection details. Press <emphasis>
+ <property>Next</property>
+ </emphasis> to preview all the adjusted settings and complete the creation of the new
+ profile.</para>
+ <figure>
+ <title>Connection Details</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_22.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>The next block of settings in the Seam Facet wizard are describing a Database and a
+ connection to it.</para>
+ <para>In the <property>Code Generation</property> section the wizard has already provided
+ the names for your <property>Session Bean</property>, <property>Entity Bean</property>
+ and <property>Test</property> packages generation (optional). Of course, you can change
+ them on others of your choice.</para>
+ <figure>
+ <title>Code Generation Section</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/create_new_seam/create_seam_14.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>Click on <emphasis>
+ <property>Finish</property>
+ </emphasis> to generate a project.</para>
+ <para/>
+ </section>
+</chapter>
\ No newline at end of file
Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/directory_structure.xml
===================================================================
--- tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/directory_structure.xml 2010-06-09 00:21:45 UTC (rev 22660)
+++ tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/directory_structure.xml 2010-06-09 00:28:36 UTC (rev 22661)
@@ -1,209 +1,230 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="directory_str" 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>
- <title>Project Layout for WAR projects</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/directory_structure/directory_structure_1.png"
- scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>A WAR project can only use Seam JavaBean and JPA Entity bean components; it cannot use
- EJB3 Session beans etc.</para>
- <para>WAR projects are generated to enable Seam war hotdeploy feature. Classes put
- into <emphasis>
- <property>src/action</property>
- </emphasis> will be deployed to <emphasis>
- <property>WEB-INF/dev</property>
- </emphasis> from which Seam automatically will perform hotdeploy of new
- components.</para>
- <note>
- <title>Note:</title>
- <para>Because of Eclipse WTP limits the hot deployed classes also existed in <emphasis>
- <property>WEB-INF/classes</property>, </emphasis> but since Seam gives <emphasis>
- <property>WEB-INF/dev</property>
- </emphasis> precedence it will work.</para>
- </note>
-
- <para>Furthermore the Seam Project wizard generates a test project that is setup to run
- <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>Run As > TestNG Test</property>.</emphasis></para>
- <para>In order to deploy WAR project on server, right-click on the project and select <emphasis>
- <property>Run As > Run on Server</property>.</emphasis> Studio will deploy
- WAR project into one web application on server to <property>deploy</property>
- folder.</para>
-
- </section>
-
- <section id="EAR">
- <title>EAR Deployment</title>
- <para>The project layout for EAR projects is:</para>
-
- <figure>
- <title>Project Layout for EAR projects</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/directory_structure/directory_structure_2.png"
- scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>An EAR project can use the whole range of Seam components, including EJB3 Session
- beans.</para>
- <para>In order to deploy EAR project on server, right-click on the project with
- <property>-ear</property> postfix and select <emphasis>
- <property>Run As > Run on Server</property>.</emphasis> Studio will take care
- about all modules and deploy EAR project into one enterprise application on server to
- <property>deploy</property> folder. EAR application keeps <property>ejb</property>
- and <property>war</property> modules of the EAR project.</para>
-
- <note><title>Note:</title>
- <para>The <property>WAR</property> generated for <property>EARs</property> is now configured to utilize Seam hot-deployment (<emphasis><property>WEB-INF/dev</property></emphasis>) similar to standalone <property>WAR</property> projects.</para>
-
- </note>
-
- </section>
-
- <section id="seam_version_changing">
-
- <title>Changing the Seam Version</title>
-
- <para>To upgrade or downgrade your projects Seam version use the facet preferences. You
- should right-click your project, open its <property>Properties</property> and choose <emphasis>
- <property>Project Facets</property>
- </emphasis> category. Next select <emphasis>
- <property>Seam</property>
- </emphasis> and change its version to needed one.</para>
-
- <figure>
- <title>Changing the Seam Facet Version</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/directory_structure/directory_structure_3.png"
- scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>After pressing <emphasis>
- <property>Apply</property>
- </emphasis> the wizard for adjusting new Seam runtime settings appears.</para>
-
- <figure>
- <title>Changing the Seam Facet Version</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/directory_structure/directory_structure_4.png"
- scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>If you need to update the libraries for you project, check the <emphasis>
- <property>Update libraries</property>
- </emphasis> option. All libraries you checked will be removed and the libraries from the
- new Seam distribution will be added after clicking <emphasis>
- <property>Ok</property>.</emphasis></para>
-
- <figure>
- <title>Changing the Seam Facet Version</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/directory_structure/directory_structure_5.png"
- scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <note>
- <title>Note:</title>
-
- <para>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.</para>
- </note>
- </section>
-
- <section id="changing_seam_parent_project">
- <title>Changing Seam Parent Project</title>
-
- <para>Starting from the 2.0.0.CR2 version of <property>JBoss Tools</property> it is possible
- to change the Seam parent project. In earlier versions this was only controllable at a
- project creation time, now it can be changed for existing projects too.</para>
-
- <para>Go to your project preferences and select <emphasis>
- <property>Seam Settings</property>
- </emphasis> category on the left. Press the <emphasis>
- <property>Browse</property>
- </emphasis> button next to the <emphasis>
- <property>Main Seam Project</property>
- </emphasis> section to select the other Seam parent project.</para>
-
- <figure>
- <title>Changing Seam Parent Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/directory_structure/directory_structure_6.png"
- scale="75"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
-
- <section id="renaming_projects_folders">
- <title>Renaming the Projects and Folders</title>
-
- <para>If you need to rename one of the Seam Project artifacts
- (<emphasis><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>Refactor > Rename...</property>
- </emphasis> or just pressing <emphasis>
- <property>Shift + Alt + R</property>
- </emphasis> under the chosen resource.</para>
-
- <para>Use <emphasis>
- <property>Refactor > Move...</property>
- </emphasis> (or <emphasis>
- <property>Shift + Alt + V</property>
- </emphasis>), if you need to move
- <emphasis><project_name>/WebContent</emphasis> folder,
- <emphasis><project_name>/ejbModule</emphasis> folder or
- <emphasis><project_name>/test-src</emphasis> folder in the other place
- within the Project structure.</para>
- </section>
-</chapter>
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="directory_str" 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>
+ <title>Project Layout for WAR projects</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/directory_structure/directory_structure_1.png"
+ scale="75"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>A WAR project can only use Seam JavaBean and JPA Entity bean components; it cannot use
+ EJB3 Session beans etc.</para>
+ <para>WAR projects are generated to enable Seam war hotdeploy feature. Classes put
+ into <emphasis>
+ <property>src/action</property>
+ </emphasis> will be deployed to <emphasis>
+ <property>WEB-INF/dev</property>
+ </emphasis> from which Seam automatically will perform hotdeploy of new
+ components.</para>
+ <note>
+ <title>Note:</title>
+ <para>Because of Eclipse WTP limits the hot deployed classes also existed in <emphasis>
+ <property>WEB-INF/classes</property>, </emphasis> but since Seam gives <emphasis>
+ <property>WEB-INF/dev</property>
+ </emphasis> precedence it will work.</para>
+ </note>
+
+ <para>Furthermore the Seam Project wizard generates a test project that is setup to run
+ <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>Run As > TestNG Test</property>.</emphasis></para>
+ <para>In order to deploy WAR project on server, right-click on the project and select <emphasis>
+ <property>Run As > Run on Server</property>.</emphasis> Studio will deploy
+ WAR project into one web application on server to <property>deploy</property>
+ folder.</para>
+
+ </section>
+
+ <section id="EAR">
+ <title>EAR Deployment</title>
+ <para>The project layout for EAR projects is:</para>
+
+ <figure>
+ <title>Project Layout for EAR projects</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/directory_structure/directory_structure_2.png"
+ scale="75"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>An EAR project can use the whole range of Seam components, including EJB3 Session
+ beans.</para>
+ <para>In order to deploy EAR project on server, right-click on the project with
+ <property>-ear</property> postfix and select <emphasis>
+ <property>Run As > Run on Server</property>.</emphasis> Studio will take care
+ about all modules and deploy EAR project into one enterprise application on server to
+ <property>deploy</property> folder. EAR application keeps <property>ejb</property>
+ and <property>war</property> modules of the EAR project.</para>
+
+ <note><title>Note:</title>
+ <para>The <property>WAR</property> generated for <property>EARs</property> is now configured to utilize Seam hot-deployment (<emphasis><property>WEB-INF/dev</property></emphasis>) similar to standalone <property>WAR</property> projects.</para>
+
+ </note>
+
+ </section>
+
+ <section id="seam_version_changing">
+
+ <title>Changing the Seam Version</title>
+
+ <para>To upgrade or downgrade your projects Seam version use the facet preferences. You
+ should right-click your project, open its <property>Properties</property> and choose <emphasis>
+ <property>Project Facets</property>
+ </emphasis> category. Next select <emphasis>
+ <property>Seam</property>
+ </emphasis> and change its version to needed one.</para>
+
+ <figure>
+ <title>Changing the Seam Facet Version</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/directory_structure/directory_structure_3.png"
+ scale="75"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>After pressing <emphasis>
+ <property>Apply</property>
+ </emphasis> the wizard for adjusting new Seam runtime settings appears.</para>
+
+ <figure>
+ <title>Changing the Seam Facet Version</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/directory_structure/directory_structure_4.png"
+ scale="75"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>If you need to update the libraries for you project, check the <emphasis>
+ <property>Update libraries</property>
+ </emphasis> option. All libraries you checked will be removed and the libraries from the
+ new Seam distribution will be added after clicking <emphasis>
+ <property>Ok</property>.</emphasis></para>
+
+ <figure>
+ <title>Changing the Seam Facet Version</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/directory_structure/directory_structure_5.png"
+ scale="75"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note>
+ <title>Note:</title>
+
+ <para>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.</para>
+ </note>
+ </section>
+
+ <section id="changing_seam_parent_project">
+ <title>Changing Seam Parent Project</title>
+
+ <para>Starting from the 2.0.0.CR2 version of <property>JBoss Tools</property> it is possible
+ to change the Seam parent project. In earlier versions this was only controllable at a
+ project creation time, now it can be changed for existing projects too.</para>
+
+ <para>Go to your project preferences and select <emphasis>
+ <property>Seam Settings</property>
+ </emphasis> category on the left. Press the <emphasis>
+ <property>Browse</property>
+ </emphasis> button next to the <emphasis>
+ <property>Main Seam Project</property>
+ </emphasis> section to select the other Seam parent project.</para>
+
+ <figure>
+ <title>Changing Seam Parent Project</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/directory_structure/directory_structure_6.png"
+ scale="75"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section id="renaming_projects_folders">
+ <title>Renaming the Projects and Folders</title>
+
+ <para>If you need to rename one of the Seam Project artifacts
+ (<emphasis><project_name></emphasis>,
+ <emphasis><project_name>-ear</emphasis>,
+ <emphasis><project_name>-ejb</emphasis> or
+ <emphasis><project_name>-test</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>Refactor > Rename...</property>
+ </emphasis> or just pressing <emphasis>
+ <property>Shift + Alt + R</property>
+ </emphasis> under the chosen resource.</para>
+
+ <figure>
+ <title>Renaming the folder</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/directory_structure/directory_structure_7.png"
+ scale="75"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>Use <emphasis>
+ <property>Refactor > Move...</property>
+ </emphasis> (or <emphasis>
+ <property>Shift + Alt + V</property>
+ </emphasis>), if you need to move
+ <emphasis><project_name>/WebContent</emphasis> folder,
+ <emphasis><project_name>/ejbModule</emphasis> folder or
+ <emphasis><project_name>/test-src</emphasis> folder in the other place
+ within the Project structure.</para>
+
+ <figure>
+ <title>Moving the folder</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/directory_structure/directory_structure_8.png"
+ scale="75"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+</chapter>
\ No newline at end of file
Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/generate_entities.xml
===================================================================
--- tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/generate_entities.xml 2010-06-09 00:21:45 UTC (rev 22660)
+++ tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/generate_entities.xml 2010-06-09 00:28:36 UTC (rev 22661)
@@ -40,7 +40,7 @@
<note>
<title>Note:</title>
<para>The entities are generated from a database based on the console configuration that is created automatically during a Seam project creation.
- (Read more about console configuration). The created console configuration is based on the
+ (Read more about the console configuration in the Hibernate guides). The created console configuration is based on the
connection profile set on the <link linkend="seamFacet">Seam Facets wizard page</link> while creating a project.
Configured connection profile settings are hold in the generated <literal>hibernate-console.properties</literal>. To change the connection
profile, double-click the console configuration. It could be found in the <property>Hibernate Configurations</property> view
Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_1.png
===================================================================
(Binary files differ)
Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_11.png
===================================================================
(Binary files differ)
Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_12.png
===================================================================
(Binary files differ)
Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_13.png
===================================================================
(Binary files differ)
Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_15.png
===================================================================
(Binary files differ)
Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_16.png
===================================================================
(Binary files differ)
Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_20.png
===================================================================
(Binary files differ)
Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_21.png
===================================================================
(Binary files differ)
Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_7.png
===================================================================
(Binary files differ)
Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/create_new_seam/create_seam_8.png
===================================================================
(Binary files differ)
Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/crud_database_application/crud_database_application_15.png
===================================================================
(Binary files differ)
Added: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/directory_structure/directory_structure_7.png
===================================================================
(Binary files differ)
Property changes on: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/directory_structure/directory_structure_7.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/directory_structure/directory_structure_8.png
===================================================================
(Binary files differ)
Property changes on: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/directory_structure/directory_structure_8.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_editors/seam_editors_1c.png
===================================================================
(Binary files differ)
Property changes on: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_editors/seam_editors_1c.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_wizards/seam_wizards_11.png
===================================================================
(Binary files differ)
Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_wizards/seam_wizards_14.png
===================================================================
(Binary files differ)
Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_wizards/seam_wizards_15.png
===================================================================
(Binary files differ)
Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_wizards/seam_wizards_5.png
===================================================================
(Binary files differ)
Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/images/seam_wizards/seam_wizards_8.png
===================================================================
(Binary files differ)
Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/intro.xml
===================================================================
--- tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/intro.xml 2010-06-09 00:21:45 UTC (rev 22660)
+++ tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/intro.xml 2010-06-09 00:28:36 UTC (rev 22661)
@@ -138,7 +138,7 @@
<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 JBoss Developer Studio/JBoss Tools release documentation you can find at<ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para>
+ <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at <ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para>
<para>There is some extra information on <ulink url="http://www.jboss.org/community/wiki/JBossSeam">JBoss Wiki. </ulink></para>
<para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs</ulink>.</para>
<para>You can find a set of screencasts on how to search/find references and use Seam refactoring tools in the following Max Andersen's
Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/master.xml
===================================================================
--- tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/master.xml 2010-06-09 00:21:45 UTC (rev 22660)
+++ tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/master.xml 2010-06-09 00:28:36 UTC (rev 22661)
@@ -63,7 +63,7 @@
<holder>JBoss by Red Hat</holder>
</copyright>
<releaseinfo>
- Version: 3.1.0.GA
+ Version: 3.1.1.GA
</releaseinfo>
<abstract>
@@ -79,7 +79,7 @@
&intro;
&creating_new_seam;
-<!--&creating_mavenized_seam;-->
+&creating_mavenized_seam;
&directory_structure;
&menus_and_actions;
&seam_wizards;
Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/master_output.xml
===================================================================
--- tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/master_output.xml 2010-06-09 00:21:45 UTC (rev 22660)
+++ tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/master_output.xml 2010-06-09 00:28:36 UTC (rev 22661)
@@ -2,23 +2,23 @@
<!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 creating_mavenized_seam SYSTEM "modules/creating_mavenized_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_refactoring SYSTEM "modules/seam_refactoring.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 seam_faq SYSTEM "modules/seam_faq.xml">
+[<!ENTITY intro SYSTEM "intro.xml">
+<!ENTITY creating_new_seam SYSTEM "creating_new_seam.xml">
+<!ENTITY creating_mavenized_seam SYSTEM "creating_mavenized_seam.xml">
+<!ENTITY directory_structure SYSTEM "directory_structure.xml">
+<!ENTITY menus_and_actions SYSTEM "seam_menus_and_actions.xml">
+<!ENTITY seam_wizards SYSTEM "seam_wizards.xml">
+<!ENTITY generate_entities SYSTEM "generate_entities.xml">
+<!ENTITY seam_refactoring SYSTEM "seam_refactoring.xml">
+<!ENTITY seam_editors SYSTEM "seam_editors.xml">
+<!ENTITY seam_view SYSTEM "seam_view.xml">
+<!ENTITY seam_preferences SYSTEM "seam_preferences.xml">
+<!ENTITY adding_seam_support_to_ear_project SYSTEM "adding_seam_support_to_ear_project.xml">
+<!ENTITY crud_database_application SYSTEM "crud_database_application.xml">
+<!ENTITY crud_application_walkthrough SYSTEM "crud_application_walkthrough.xml">
+<!ENTITY business_application SYSTEM "business_application.xml">
+<!ENTITY testng SYSTEM "testng.xml">
+<!ENTITY seam_faq SYSTEM "seam_faq.xml">
<!ENTITY seamlink "../../seam/html_single/index.html">
<!ENTITY aslink "../../as/html_single/index.html">
@@ -37,7 +37,7 @@
<bookinfo>
- <title>Seam Dev Tools Reference Guide</title>
+ <title>Seam Developer Tools Reference Guide</title>
<corpauthor>
<inlinemediaobject>
<imageobject role="fo">
@@ -62,7 +62,7 @@
<holder>JBoss by Red Hat</holder>
</copyright>
<releaseinfo><diffmk:wrapper diffmk:change="changed">
- Version: 3.1.0.GA
+ Version: 3.1.1.GA
</diffmk:wrapper></releaseinfo>
<abstract>
@@ -77,7 +77,7 @@
<toc></toc>
-<chapter id="intro" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/intro.xml" xreflabel="intro">
+<chapter id="intro" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/intro.xml" xreflabel="intro">
<?dbhtml filename="intro.html"?>
<chapterinfo>
<keywordset>
@@ -216,7 +216,7 @@
<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 JBoss Developer Studio/JBoss Tools release documentation you can find at<ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para>
+ <para><diffmk:wrapper diffmk:change="changed">All JBoss Developer Studio/JBoss Tools release documentation you can find at </diffmk:wrapper><ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para>
<para>There is some extra information on <ulink url="http://www.jboss.org/community/wiki/JBossSeam">JBoss Wiki. </ulink></para>
<para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs</ulink>.</para>
<para>You can find a set of screencasts on how to search/find references and use Seam refactoring tools in the following Max Andersen's
@@ -225,7 +225,7 @@
</chapter>
-<chapter id="create_seam" role="updated" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/creating_new_seam.xml" xreflabel="create_seam">
+<chapter id="create_seam" role="updated" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/creating_new_seam.xml" xreflabel="create_seam">
<?dbhtml filename="create_new_seam.html"?>
<chapterinfo>
<keywordset>
@@ -362,8 +362,8 @@
wizard</property>.</para>
<tip>
<title>Tip:</title>
- <para>We suggest that you look through <ulink url="../../as/html_single/index.html">AS manager guide</ulink> to
- find out more about runtimes and servers.</para>
+ <para><diffmk:wrapper diffmk:change="changed">We suggest that you look through the Application Server Manager Guide to
+ find out more about runtimes and servers.</diffmk:wrapper></para>
</tip>
<figure float="0">
<title>Completion of Runtime and Server Configuration</title>
@@ -606,12 +606,26 @@
</imageobject>
</mediaobject>
</figure>
+
<itemizedlist>
<listitem>
<para>Select EAR or WAR deployment by checking a necessary radio button.</para>
</listitem>
<listitem>
- <para>Select a <emphasis>
+ <para><diffmk:wrapper diffmk:change="added">Enter EJB project name and EAR project name in case of EAR radio button is checked.</diffmk:wrapper></para>
+ </listitem>
+ </itemizedlist>
+
+ <tip diffmk:change="added">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Tip:</diffmk:wrapper></title>
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If you want to name your web project "MyProject-war" note that the EJB project should not be "MyProject-war-ejb",
+ it should be "MyProject-ejb". The same for EAR and Test projects' names. They should be respectively "MyProject-ear"
+ and "MyProject-test".</diffmk:wrapper></para>
+ </tip>
+
+ <itemizedlist diffmk:change="added">
+ <listitem diffmk:change="added">
+ <para diffmk:change="added">Select a <emphasis>
<property moreinfo="none">Database Type</property>
</emphasis></para>
</listitem>
@@ -684,181 +698,10 @@
</emphasis> to generate a project.</para>
<para></para>
</section>
-</chapter>
-
-<chapter id="mavenized_seam" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/creating_mavenized_seam.xml" xreflabel="mavenized_seam">
- <?dbhtml filename="create_mavenized_seam.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Seam</keyword>
- <keyword>JBDS</keyword>
- </keywordset>
- </chapterinfo>
- <title>Maven Integration for Seam Projects</title>
- <para>Starting from 3.1 M2 version <property moreinfo="none">JBoss Tools</property> includes new Jboss Maven
- Integration plug-in which for now allows to create mavenized Seam projects and enable Seam
- tools support for imported Maven projects.</para>
- <para>The Jboss Maven Integration requires <ulink url="http://m2eclipse.sonatype.org/">m2eclipse</ulink> to be installed.</para>
- <note>
- <title>Note:</title>
- <para>For M2 release of <property moreinfo="none">Jboss Tools</property> it is important to use m2eclipse
- <ulink url="http://m2eclipse.sonatype.org/update/">stable updatesite</ulink> or the
- <ulink url="http://m2eclipse.sonatype.org/releases/0.9.9.200906081351">latest
- integration build</ulink> that M2 was developed against. If you want to use the
- latest development release of m2eclipse you need to use the <ulink url="http://download.jboss.org/jbosstools/updates/nightly/trunk/">nightly
- builds</ulink> of <property moreinfo="none">JBoss Tools</property>.</para>
- </note>
- <section id="create_mavenized_project">
- <title>Creating Maven ready Seam project</title>
- <para>Maven Integration makes the Seam Wizard capable of creating Maven ready projects to
- let Maven get the libraries instead of using the Seam runtime.</para>
- <para>To create a mavenized Seam project you should perform the following steps:</para>
- <itemizedlist>
- <listitem>
- <para>Navigate to <emphasis>
- <property moreinfo="none">File > New Seam Project</property>.</emphasis> Give the project
- a meaningful name, specify a target runtime and server and select the proper
- configuration for your Seam project:</para>
- <figure float="0">
- <title>Starting the Mavenized Seam Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_mavenized_seam/createMavenizedSeamProject.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para>Click the <emphasis>
- <property moreinfo="none">Modify</property></emphasis> button to enable the <emphasis>
- <property moreinfo="none">Jboss Maven Integration</property></emphasis> facet:</para>
- <figure float="0">
- <title>Enabling the Jboss Maven Integration Facet</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_mavenized_seam/jbossMavenIntegrationFacet.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para>On the <property moreinfo="none">JBoss M2 capabilities</property> page you'll be prompted
- to add the following maven properties: groupId, artifactId, version, packaging,
- name and description. Here it's possible to set a maven version of Seam and
- also decide whether to remove WTP classpath containers (where the path starts
- with org.eclipse.jst). </para>
- <figure float="0">
- <title>Adjusting JBoss M2 Capabilities</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_mavenized_seam/jbossM2capabilities.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para> On the <property moreinfo="none">JSF Capabilities</property> page you can choose Maven as
- libraries provider. This is possible when you use Maven JSF 1.2 Libraries as
- type of JSF Implementing Library. Also it gives you capability to edit
- Dependencies and Exclusions for the mavenized Seam project directly from the
- wizard. </para>
- <figure float="0">
- <title>Using JSF Implementation libraries provided by Maven</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_mavenized_seam/seamJSFImplementation.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- <listitem>
- <para>On the <property moreinfo="none">Seam Facet</property> page configure the Seam Facet settings
- and click <emphasis>
- <property moreinfo="none">Finish</property>:</emphasis></para>
- <figure float="0">
- <title>Seam Facet Settings</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_mavenized_seam/seamFacetPage.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- </itemizedlist>
- <para>The organized Seam project contains five projects with the Maven nature, builder,
- Maven classpath and the <emphasis>
- <property moreinfo="none">pom.xml</property></emphasis> files added: projectname, projectname-ear,
- projectname-ejb, projectname-parent and projectname-test.</para>
- <figure float="0">
- <title>Mavenized Seam Project</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_mavenized_seam/mavenizedProjectStructure.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <section id="import_maven_project">
- <title>Existing Maven Projects Import</title>
- <para>Maven Integration includes the Seam Maven configurator which is called when importing
- a project, changing <emphasis>
- <property moreinfo="none">pom.xml</property></emphasis> and/or calling <emphasis>
- <property moreinfo="none">Maven > Update Project Configuration</property>.</emphasis> When
- importing a Maven Seam project, the Seam Maven configurator picks up the settings set up
- in <emphasis>
- <property moreinfo="none">pom.xml</property></emphasis> and adds to the project the
- following:</para>
- <itemizedlist>
- <listitem>
- <para>Seam nature</para>
- </listitem>
- <listitem>
- <para>Seam facet and dependent facets to the EJB, EAR and WAR projects</para>
- </listitem>
- <listitem>
- <para>JBoss Maven Integration facet if the Maven project contains a dependency with
- the org.jboss.seam groupId and an artifactId starting with 'jboss-seam'</para>
- </listitem>
- <listitem>
- <para>other required facets (Web Module, Java, JSF, etc.)</para>
- </listitem>
- </itemizedlist>
- <para>If the Seam version from <emphasis>
- <property moreinfo="none">pom.xml</property></emphasis> matches a version of a Seam runtime
- configured in the workspace, Seam configurator will set that runtime, otherwise no Seam
- runtime will be set and you'll have to set it manually under <link linkend="project_pref">Seam Settings in the project preferences</link>.</para>
- <para>Seam configurator recognizes the Seam artifacts in the following way: the view folder
- is a web content folder from the WAR project, the source folder is the first Eclipse
- source folder. If there is a folder containing "hot" in the name, it will be
- chosen as the action source folder. Package is the first package that has children or
- doesn't have any subpackage. </para>
- <para>Configuring the Seam when importing a Maven project as well as a Seam Runtime, Seam
- artifacts and some facets could be suspended in the JBoss Maven Integration preferences
- (<emphasis>
- <property moreinfo="none">Window > Preferences > JBoss Tools > JBoss Maven
- Integration</property></emphasis>).</para>
- <figure float="0">
- <title>JBoss Maven Integration Preferences</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/create_mavenized_seam/configure_maven_integration.png"></imagedata>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- <section>
- <title>Relevant Resources Links</title>
- <para>In the <ulink url="http://in.relation.to/Bloggers/UsingMavenWithJBossTools">Using
- Maven with JBoss Tools</ulink> article written by Max Andersen you'll find
- references to the screencasts on how to use the examples of mavenized Seam projects
- provided by <property moreinfo="none">JBoss Tools</property>.</para>
- </section>
+ <!--&creating_mavenized_seam;-->
</chapter>
-
-
-<chapter id="directory_str" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/directory_structure.xml" xreflabel="directory_str">
+<chapter id="directory_str" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/directory_structure.xml" xreflabel="directory_str">
<?dbhtml filename="directory_structure.html"?>
<chapterinfo>
<keywordset>
@@ -951,8 +794,8 @@
<title>Changing the Seam Version</title>
- <para><diffmk:wrapper diffmk:change="added">To upgrade or downgrade your projects Seam version use the facet preferences. You
- should right-click your project, open its </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Properties</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> and choose </diffmk:wrapper><emphasis>
+ <para>To upgrade or downgrade your projects Seam version use the facet preferences. You
+ should right-click your project, open its <property moreinfo="none">Properties</property> and choose <emphasis>
<property moreinfo="none">Project Facets</property>
</emphasis> category. Next select <emphasis>
<property moreinfo="none">Seam</property>
@@ -1035,9 +878,9 @@
<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><diffmk:wrapper diffmk:change="changed"><project_name>-ear</diffmk:wrapper></emphasis>,
+ <emphasis><diffmk:wrapper diffmk:change="changed"><project_name>-ejb</diffmk:wrapper></emphasis> or
+ <emphasis><diffmk:wrapper diffmk:change="changed"><project_name>-test</diffmk:wrapper></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
@@ -1048,6 +891,15 @@
</emphasis> or just pressing <emphasis>
<property moreinfo="none">Shift + Alt + R</property>
</emphasis> under the chosen resource.</para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Renaming the folder</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/directory_structure/directory_structure_7.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
<para>Use <emphasis>
<property moreinfo="none">Refactor > Move...</property>
@@ -1056,13 +908,22 @@
</emphasis>), if you need to move
<emphasis><project_name>/WebContent</emphasis> folder,
<emphasis><project_name>/ejbModule</emphasis> folder or
- <emphasis><project_name>/test-src</emphasis> folder in the other place
- within the Project structure.</para>
+ <emphasis><project_name>/test-src</emphasis><diffmk:wrapper diffmk:change="changed"> folder in the other place
+ within the Project structure.</diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Moving the folder</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/directory_structure/directory_structure_8.png" scale="75"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
</section>
</chapter>
-
-<chapter id="menus_and_actions" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/seam_menus_and_actions.xml" xreflabel="menus_and_actions">
+<chapter id="menus_and_actions" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/seam_menus_and_actions.xml" xreflabel="menus_and_actions">
<?dbhtml filename="seam_menus_and_actions.html"?>
<chapterinfo>
<keywordset>
@@ -1425,7 +1286,7 @@
</chapter>
-<chapter id="seam_wizards" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/seam_wizards.xml" xreflabel="seam_wizards">
+<chapter id="seam_wizards" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/seam_wizards.xml" xreflabel="seam_wizards">
<?dbhtml filename="seam_wizards.html"?>
<chapterinfo>
<keywordset>
@@ -1767,7 +1628,7 @@
</chapter>
-<chapter id="generate_entities" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/generate_entities.xml" xreflabel="generate_entities">
+<chapter id="generate_entities" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/generate_entities.xml" xreflabel="generate_entities">
<?dbhtml filename="generate_entities.html"?>
<chapterinfo>
<keywordset>
@@ -1807,9 +1668,9 @@
<note>
<title>Note:</title>
- <para>The entities are generated from a database based on the console configuration that is created automatically during a Seam project creation.
- (Read more about <ulink url="../../hibernatetools/html_single/index.html#console_conf">console configuration</ulink>). The created console configuration is based on the
- connection profile set on the <link linkend="seamFacet">Seam Facets wizard page</link> while creating a project.
+ <para><diffmk:wrapper diffmk:change="changed">The entities are generated from a database based on the console configuration that is created automatically during a Seam project creation.
+ (Read more about the console configuration in the Hibernate guides). The created console configuration is based on the
+ connection profile set on the </diffmk:wrapper><link linkend="seamFacet">Seam Facets wizard page</link> while creating a project.
Configured connection profile settings are hold in the generated <literal moreinfo="none">hibernate-console.properties</literal>. To change the connection
profile, double-click the console configuration. It could be found in the <property moreinfo="none">Hibernate Configurations</property> view
(<emphasis><property moreinfo="none">Window > Show view > Other > Hibernate > Hibernate Configurations</property></emphasis>
@@ -1823,7 +1684,7 @@
<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/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/seam_editors.xml" xreflabel="seam_editors">
+<chapter id="seam_editors" role="updated" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/seam_editors.xml" xreflabel="seam_editors">
<?dbhtml filename="seam_editors.html"?>
<chapterinfo>
<keywordset>
@@ -2283,6 +2144,21 @@
</figure>
</section>
+ <section diffmk:change="added" id="named_beans_code_assist" role="new">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Content assist for @Named beans</diffmk:wrapper></title>
+
+ <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">To the nice code completion you can also use Content assist for all occurrences where @Named beans are used.
+ </diffmk:wrapper></para>
+
+ <figure diffmk:change="added" float="0">
+ <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Content assist for @Named beans</diffmk:wrapper></title>
+ <mediaobject diffmk:change="added">
+ <imageobject diffmk:change="added">
+ <imagedata diffmk:change="added" fileref="images/seam_editors/seam_editors_1c.png"></imagedata>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
</section>
<section>
@@ -2502,10 +2378,9 @@
</section>
</section>
-</chapter>
-
-<chapter id="seam_view" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/seam_view.xml" xreflabel="seam_view">
+</chapter>
+<chapter id="seam_view" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/seam_view.xml" xreflabel="seam_view">
<?dbhtml filename="seam_view.html"?>
<chapterinfo>
<keywordset>
@@ -2633,7 +2508,7 @@
</chapter>
-<chapter id="seam_preferences" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/seam_preferences.xml" xreflabel="seam_preferences">
+<chapter id="seam_preferences" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/seam_preferences.xml" xreflabel="seam_preferences">
<!-- mark as new -->
<?dbhtml filename="seam_preferences.html"?>
<chapterinfo>
@@ -2872,7 +2747,7 @@
</chapter>
-<chapter id="seam_refactoring" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/seam_refactoring.xml" xreflabel="seam_refactoring">
+<chapter id="seam_refactoring" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/seam_refactoring.xml" xreflabel="seam_refactoring">
<?dbhtml filename="seam_refactoring.html"?>
<chapterinfo>
<keywordset>
@@ -3104,7 +2979,7 @@
-<chapter id="adding_seam_support_to_ear_project" role="new" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/adding_seam_support_to_ear_project.xml" xreflabel="adding_seam_support_to _ear_project">
+<chapter id="adding_seam_support_to_ear_project" role="new" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/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>
@@ -3228,7 +3103,7 @@
</chapter>
-<chapter id="crud_database_application" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/crud_database_application.xml" xreflabel="crud_database_application">
+<chapter id="crud_database_application" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/crud_database_application.xml" xreflabel="crud_database_application">
<?dbhtml filename="crud_database_application.html"?>
<chapterinfo>
<keywordset>
@@ -3712,7 +3587,7 @@
</chapter>
-<chapter id="crud_application_walkthrough" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/crud_application_walkthrough.xml" xreflabel="crud_application_walkthrough">
+<chapter id="crud_application_walkthrough" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/crud_application_walkthrough.xml" xreflabel="crud_application_walkthrough">
<?dbhtml filename="crud_application_walkthrough.html"?>
<chapterinfo>
<keywordset>
@@ -3843,7 +3718,7 @@
</chapter>
-<chapter id="testNG" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/testng.xml" xreflabel="testNG">
+<chapter id="testNG" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/testng.xml" xreflabel="testNG">
<?dbhtml filename="testNG.html"?>
<chapterinfo>
<keywordset>
@@ -4092,7 +3967,7 @@
</chapter>
-<chapter id="seam_faq" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en/modules/seam_faq.xml" xreflabel="seam_faq">
+<chapter id="seam_faq" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/seam/docs/reference/en-US/seam_faq.xml" xreflabel="seam_faq">
<?dbhtml filename="vwt_faq.html"?>
<title>FAQ</title>
@@ -4154,11 +4029,13 @@
<property moreinfo="none">Edit</property></emphasis> to change their output location.</para>
<para>In conclusion, the main goal of this document is to get you know with a full featureset
- that <property 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
+ that <property>JBoss Tools</property> provides to support Seam development. Thus if you have
+ some questions, comments or suggestions on the topic, please fell free to ask in the <ulink
+ url="http://www.jboss.com/index.html?module=bb&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 the article <ulink url="http://wiki.jboss.org/wiki/JBossToolsDocsFuture">Overview of the improvements required by JBossTools/JBDS Docs users</ulink>. </para>
+ future leaving your vote on the article <ulink
+ url="http://wiki.jboss.org/wiki/JBossToolsDocsFuture"
+ >Overview of the improvements required by JBossTools/JBDS Docs users</ulink>. </para>
<para>A set of movies on Seam tooling is available on <ulink url="http://docs.jboss.org/tools/movies">Seam movies page</ulink>.</para>
</section>
Modified: tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/seam_editors.xml
===================================================================
--- tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/seam_editors.xml 2010-06-09 00:21:45 UTC (rev 22660)
+++ tags/jbosstools-3.1.1.GA/seam/docs/reference/en-US/seam_editors.xml 2010-06-09 00:28:36 UTC (rev 22661)
@@ -1,682 +1,697 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<chapter id="seam_editors" xreflabel="seam_editors" role="updated">
- <?dbhtml filename="seam_editors.html"?>
- <chapterinfo>
- <keywordset>
- <keyword>JBoss Tools</keyword>
- <keyword>Seam</keyword>
- <keyword>JBDS</keyword>
- </keywordset>
- </chapterinfo>
-
- <title>Seam Editors</title>
-
-
- <para>This chapter tells about Seam Editors and their features.</para>
-
- <section>
- <title>Visual Page Editor</title>
- <para>Visual Page Editor fits perfectly for authoring view Seam pages. The major features of VPE are listed in <link linkend="SeamEditors">Main Features of Seam Editors</link> </para>
- <para>You can also read more about Visual Page Editor in <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf/html/editors.html#visual_page">Visual Page Editor</ulink> chapter of "Visual Web Tools Reference Guide".</para>
- </section>
-
-
-
-
- <section>
- <title>Seam Pages Editor</title>
-
-
- <para>
- <property>Seam Pages Editor</property> provides a handy way to edit the <property>pages.xml</property> file.
-
- </para>
-
- <para>
- You can edit the pages.xml file in three modes: Graphical, Tree and Source.
-
- </para>
- <para>
- Seam Pages Editor supports synchronization with Package Explorer.This means that while renaming files in the Package Explorer all the changes immediately affect the pages.xml file.
-
- </para>
- <section>
- <title>Graphical Mode</title>
-
-
- <para>Graphical mode provides you with a set of visual tools to organize your project pageflow, exception handling etc.</para>
- <figure>
- <title>Seam Pages Editor: Graphical View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_7.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The Graphical part of the editor has some visual elements. The table below shows graphical representation of the elements and explains their meanings. </para>
-
-<table>
- <title>Pages Editor: Graphical View. Visual elements</title>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Element</entry>
-
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/element_page.png"/>
- </imageobject>
- </mediaobject>
- </entry>
- <entry><para>A yellow box with a solid border represents a <code>
- <page>
- </code> element.
- </para></entry>
- </row>
- <row>
- <entry>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/element_param.png"/>
- </imageobject>
- </mediaobject></entry>
- <entry>
- <para>Pressing on the plus icon (<inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/icon_plus.png"/>
- </imageobject>
- </inlinemediaobject>)
-
-
- on the <code>
- <page>
- </code> element reveals a box that lists the parameters for the page.</para>
- </entry>
-
- </row>
-
- <row>
- <entry> <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/element_page2.png"/>
- </imageobject>
- </mediaobject></entry>
- <entry>
- <para>A red cross in the upper left corner of the page box indicates that the view-id is not found in the project.</para>
- </entry>
- </row>
-
- <row>
- <entry><mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/element_page1.png"/>
- </imageobject>
- </mediaobject></entry>
- <entry> <para>
- A gray box with a dashed border represents a page that has navigation
- (navigation rule) to but the page is not defined in the page.xml file.
- </para></entry>
- </row>
-
-
- <row>
- <entry> <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/element_exception.png"/>
- </imageobject>
- </mediaobject></entry>
- <entry> <para>An <code><exception></code> is represented by a blue box with a orange diamond.</para></entry>
- </row>
-
-
-
-
-
- </tbody>
- </tgroup>
-</table>
-
-
- <para>Pageflow relations are shown with gray arrows, when you select a relationship the arrow is changed to orange. </para>
-
-
-
- <para>On the lefthand side of the Graphical view of <property>Seam Page Editor</property> you can find a toolbar with a set of icons for the most frequently used commands. </para>
-
- <table>
- <title>Pages Editor: Graphical View. Commands Icons</title>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Icon Image</entry>
-
- <entry>Command</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/icon_select.png"/>
- </imageobject>
- </inlinemediaobject>
-
- </entry>
- <entry>Select a page element</entry>
-
- </row>
-
- <row>
- <entry><inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/icon_marquee.png"/>
- </imageobject>
- </inlinemediaobject></entry>
- <entry>Marquee a page item</entry>
- </row>
-
-
- <row>
- <entry>
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/icon_new_link.png"/>
- </imageobject>
- </inlinemediaobject>
-
- </entry>
- <entry>Add a page relationship</entry>
- </row>
-
-
- <row>
- <entry>
- <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/icon_exception.png"/>
- </imageobject>
- </inlinemediaobject>
-
- </entry>
- <entry>Add an exception rule</entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
-
- <para>Context menus are also available when you click either on an item or a blank space.</para>
-
-
- <para>A context menu called on a blank space of the diagram provides the following options:</para>
- <itemizedlist>
- <listitem><para><emphasis role="bold">Page</emphasis> creates a new page element on the diagram</para></listitem>
- <listitem><para><emphasis role="bold">Exception</emphasis> creates a new exception element on the diagram</para></listitem>
- <listitem><para><emphasis role="bold">Auto Layout</emphasis> formats the layout of the diagram automatically</para></listitem>
- <listitem><para><emphasis role="bold">Select Element</emphasis> calls the <property>Select Element Wizard</property> with a filter to perform a quick search through the <property>pages.xml</property> file </para></listitem>
- </itemizedlist>
- <para>Rightclicking on a selected
- <code><page></code>
- element calls a context menu where you can choose the following options if you click on the <emphasis role="bold">New</emphasis> menu item: </para>
-
-
-
- <itemizedlist>
- <listitem><para><emphasis role="bold">Rule</emphasis> opens the <property>Add Navigation Rule</property> dialog in which you can browse your project for a view page to set the view-id in the navigation rule and specify <emphasis role="bold">render</emphasis> or <emphasis role="bold">redirect</emphasis> navigation options </para></listitem>
- <listitem><para><emphasis role="bold">Param</emphasis> calls a dialog box where you can define a parameter (using the
- <code><param></code>
- tag) for the
- <code><page></code>
- element</para></listitem>
- </itemizedlist>
-
-
- <section>
- <title>Seam Pages Diagram Preferences</title>
-
-
-
- <para>In order to customize the layout of Diagram you can go to
- <property>Window > Preferences > JBoss Tools > Web > Seam > Editors > Seam Pages Diagram</property>.
- </para>
-
- <figure>
- <title>Preferences of Seam Pages Diagram</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_11.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
- </section>
-
-
- <section>
- <title>Tree Mode</title>
-
- <para>Tree Mode provides a wider range of options and way to edit and modify the pages.xml file.</para>
-
-
-
- <figure>
- <title>Seam Pages Editor: Tree View</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_8.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>
- In this mode all elements and attributes of the page.xml
- file can be viewed and edited in a visual, user friendly way.
- </para>
-
- </section>
-
-
- <section>
- <title>Outline Support for Seam Pages Editor</title>
-
-
- <para>Seam Pages Editor provides <property>Outline</property> view support.
- You can explore the pages.xml using Outline view in two modes: <property>Tree</property> ( <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/outline_tree.png"/>
- </imageobject>
- </inlinemediaobject> ) and <property>Diagram Navigation</property> ( <inlinemediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/outline_navigation.png"/>
- </imageobject>
- </inlinemediaobject> ).</para>
-
- <para>
- The Diagram Navigation mode of Outline view gives a birds-view of the layout to allow quick navigation for large-scale applications.
- </para>
-
- <figure>
- <title>Outline view: Diagram Navigation mode</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_9.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
-
- <para>The Tree mode shows a tree for every element in the pages.xml file. You can get a quick overview of the whole file. When selecting an element in the Outline view the related element is highlighted in the Graphical, Tree or Source page of Seam Pages Editor.</para>
-
-
-
- <figure>
- <title>Outline view: Tree mode</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_10.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
-
-
-
- </section>
-
-
-
- </section>
-
-
-
-
- <section>
-
-
- <title>Seam Components Editor</title>
-
- <para>When editing <property>components.xml</property> a structured tree editor is available
- in addition to pure source editing. It has a graphical view (Tree tab) and source
- (Source tab).</para>
-
- <figure>
- <title>component.xml Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_4.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <note>
- <title>Note:</title>
-
- <para>You can view and edit <property>components.xml</property> and other xml files
- directly in the Project Explorer and Properties sheet without opening the
- components.xml editor.</para>
- </note>
- <figure>
- <title>component.xml Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_5.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- </section>
-
-
-
- <section id="SeamEditors">
- <title>Main Features of Seam Editors</title>
-
- <para>In this chapter you will know what Seam Editors features are and how to work with them. </para>
-
- <section id="ContentAssist">
-
- <title>Content Assist</title>
-
- <para><property>Content Assist</property> (Ctrl + Space) is available when using EL expressions in the following file formats:</para>
- <itemizedlist>
- <listitem>
- <para>JSP</para>
- </listitem>
- <listitem>
- <para>XHTML</para>
- </listitem>
- <listitem>
- <para>XML</para>
- </listitem>
- <listitem>
- <para>JAVA</para>
- </listitem>
- </itemizedlist>
-
- <para>Notice, the code completion for the Seam components shows the proposals marked with Seam icon.</para>
-
- <figure>
- <title>Content Assist</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_1.png" scale="70"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para> Content Assist is also available for the <emphasis
- role="italic">
- <property>"jsfc "</property>
- </emphasis> attribute, it lets you select from a list of possible attribute values. Whereas, JSF components appear above all other components in the list.</para>
- <figure>
- <title>Content Assist for the "jsfc" attribute</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_12.png" scale="70"/>
- </imageobject>
- </mediaobject>
- </figure>
- <note>
- <title>Note:</title>
-
- <para>To get Code Assist available for an externally generated and imported project,
- don'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>components.xml</property>
- </emphasis> file you can make use of the Content Assist for inserting needed
- elements.</para>
-
- <figure>
- <title>Content Assist in the component.xml Editor</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_1a.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The editor also makes code completion aware of methods/attributes for EntityQuery
- component.</para>
-
- <figure>
- <title>Content Assist for EntityQuery Component</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_1b.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
-
-
- </section>
- <section>
- <title>Content Assist for Page Descriptors</title>
-
- <para>Content Assist ( CA ) is available for Page Descriptors,
- <property>.page.xml</property> and <property>page.xml</property> files.
- Content Assist lets you easily compose a Page Descriptor file by suggesting elements and attributes. The suggestions are context dependent, which means that CA provides only the elements, attributes and in some cases values for the attributes, suitable in a particular place of your Page Descriptor.
-
- </para>
- <para>
- Seam Pages Editor also supports code completion in EL-expressions suggesting you possible bean properties and methods.
- </para>
- </section>
- <section id="OpenOn">
- <title>OpenOn</title>
-
- <para><property>OpenOn</property> lets you easily navigate through your project without
- using the Package Explorer or Project Explorer. After pressing <emphasis>
- <property>Ctrl + left click</property>
- </emphasis> (or just F3) you will see a corresponding method or class.</para>
-
- <figure>
- <title>OpenOn</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>OpenOn is available for the following files:</para>
- <itemizedlist>
- <listitem>
- <para>
- <link linkend="xmlFiles">XML files</link>
- </para>
- </listitem>
- <listitem>
- <para>
- <link linkend="xhtmlFiles">JSP/XHTML Pages</link>
- </para>
- </listitem>
- <listitem>
- <para> <link linkend="javaFiles">Java files</link></para>
- </listitem>
- </itemizedlist>
- <note>
- <title>Note:</title>
-
- <para>In this section were described only use cases special for Seam applications.For general information please read
- <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf/html/editors.html#OpenOnSelection4Hyperlinknavigation">OpenOn section in Visual Web Tools Reference Guide</ulink>.</para>
- </note>
- <itemizedlist>
- <listitem id="xhtmlFiles"> <para>Using OpenOn in .xhtml files you can open:</para>
- <itemizedlist>
- <listitem><para>components or properties resolved using an EL expression;</para></listitem>
- <listitem><para>all actions described in pages.xml;</para></listitem>
- <listitem><para>other .xhtml files that paths are specified in a current file;</para></listitem>
- <listitem><para>image files that paths are set in the <emphasis>
- <property>value</property></emphasis> property.The files will be opened in the default system graphical editor.</para></listitem>
- </itemizedlist>
- </listitem>
- <listitem id="xmlFiles">
- <para>OpenOn is also supported in Page Descriptors (<property>.page.xml</property> and <property>pages.xml</property>). OpenOn allows you to navigate to Java beans as well as to view pages.
- You can <property>Ctrl + left click</property> on a bean or on view page file (e.g. XTML file) to navigate to the file you clicked on. </para>
-
- <figure>
- <title>OpenOn in .page.xml file</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_2a.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>If you use Rule-based authorization with Drools in your Seam application you can apply OpenOn
- in <emphasis>
- <property>components.xml</property></emphasis> to open the files containing rule definitions in the <emphasis>
- <property>"rule-files"</property></emphasis> tag.
- </para>
- <figure>
- <title>OpenOn in components.xml file</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_2c.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- <para>You can also use OpenOn to open jBPM components that are described in Seam component descriptor.
- Two places where it works are available: </para>
- <itemizedlist>
- <listitem><para>inside <emphasis>
- <property><component></property></emphasis> definition;</para>
- <figure>
- <title>OpenOn in components.xml file</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_2d.png"/>
- </imageobject>
- </mediaobject>
- </figure></listitem>
- <listitem><para>inside <emphasis>
- <property>jbpm</property></emphasis> tags;</para>
- <figure>
- <title>OpenOn in components.xml file</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_2e.png"/>
- </imageobject>
- </mediaobject>
- </figure></listitem>
- </itemizedlist>
- </listitem>
- <listitem id="javaFiles">
- <para>
- OpenOn is also supported in seam components where <property> In annotation</property> is presented.
- After pressing <property>Ctrl + left click</property> on the seam component specified in <code>@In </code> you will get the possibility to open the file where the component is declarated as well as
- all of the seam components where it is used in the next declarations:</para>
- <itemizedlist>
- <listitem><para>@Out</para></listitem>
- <listitem><para>@DataModel</para></listitem>
- <listitem><para>@Role</para></listitem>
- <listitem><para>@Roles</para></listitem>
- </itemizedlist>
-
- <figure>
- <title>OpenOn in Seam Component</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_2b.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </listitem>
- </itemizedlist>
- </section>
-
- <section id="SeamValidation">
- <title>Seam Validation</title>
-
- <para>Validation of various possible problematic definitions is implemented for Seam
- applications.</para>
-
- <para>If an issue is found it will be shown in the standard <property>Problems
- View</property>.</para>
-
- <figure>
- <title>Seam Validation</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_6.png" scale="70"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <note>
- <title>Note:</title>
- <para>Please note, only files within source path and web content are validated, meaning temporary files or test files are not included.</para>
- </note>
-
- <para>In the preferences page for Seam Validator you can see and modify the validator
- behavior. Go to <emphasis>
- <property>Window > Preferences > JBoss Tools > Web > Seam > Validator</property>
- </emphasis> and select the severity level for the optional Seam Validator
- problem.</para>
-
- <figure>
- <title>Seam Validator Preferences</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/seam_editors_3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>On WTP projects validation are enabled by default and thus executed automatically, but
- on normal Java projects you will have to go and add the Validation builder of your
- project . It is available in the properties of your project under
- <emphasis><property>Validation</property>.</emphasis></para>
-
- <figure>
- <title>Enabling the Validation Builder</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/validator1.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>The validations can be run manually by clicking
- <emphasis><property>Validate</property></emphasis> via the context menu on your project (folder or file inside your project) which will
- execute all the active WTP validations. Following to the project's preferences under <emphasis>
- <property>Validation</property></emphasis> it's possible to enable/disable any validator.
- </para>
-
- <para>It's also possible to turn off the validation for some resource (a file, folder) inside your project via the <emphasis>
- <property>Exclude Validation</property></emphasis> context menu option.</para>
-
- <figure>
- <title>Excluding Validation for the WebContent Folder</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/validator2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
-
- <para>As a result, if you've turned off the validation for a folder (or file), it is put to the excluded group of the Validation filters and be ignored during the validation.</para>
-
- <figure>
- <title>Validation Filters</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/seam_editors/validator3.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
-
-</section>
-</chapter>
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="seam_editors" xreflabel="seam_editors" role="updated">
+ <?dbhtml filename="seam_editors.html"?>
+ <chapterinfo>
+ <keywordset>
+ <keyword>JBoss Tools</keyword>
+ <keyword>Seam</keyword>
+ <keyword>JBDS</keyword>
+ </keywordset>
+ </chapterinfo>
+
+ <title>Seam Editors</title>
+
+
+ <para>This chapter tells about Seam Editors and their features.</para>
+
+ <section>
+ <title>Visual Page Editor</title>
+ <para>Visual Page Editor fits perfectly for authoring view Seam pages. The major features of VPE are listed in <link linkend="SeamEditors">Main Features of Seam Editors</link> </para>
+ <para>You can also read more about Visual Page Editor in <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf/html/editors.html#visual_page">Visual Page Editor</ulink> chapter of "Visual Web Tools Reference Guide".</para>
+ </section>
+
+
+
+
+ <section>
+ <title>Seam Pages Editor</title>
+
+
+ <para>
+ <property>Seam Pages Editor</property> provides a handy way to edit the <property>pages.xml</property> file.
+
+ </para>
+
+ <para>
+ You can edit the pages.xml file in three modes: Graphical, Tree and Source.
+
+ </para>
+ <para>
+ Seam Pages Editor supports synchronization with Package Explorer.This means that while renaming files in the Package Explorer all the changes immediately affect the pages.xml file.
+
+ </para>
+ <section>
+ <title>Graphical Mode</title>
+
+
+ <para>Graphical mode provides you with a set of visual tools to organize your project pageflow, exception handling etc.</para>
+ <figure>
+ <title>Seam Pages Editor: Graphical View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_7.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The Graphical part of the editor has some visual elements. The table below shows graphical representation of the elements and explains their meanings. </para>
+
+<table>
+ <title>Pages Editor: Graphical View. Visual elements</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Element</entry>
+
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/element_page.png"/>
+ </imageobject>
+ </mediaobject>
+ </entry>
+ <entry><para>A yellow box with a solid border represents a <code>
+ <page>
+ </code> element.
+ </para></entry>
+ </row>
+ <row>
+ <entry>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/element_param.png"/>
+ </imageobject>
+ </mediaobject></entry>
+ <entry>
+ <para>Pressing on the plus icon (<inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/icon_plus.png"/>
+ </imageobject>
+ </inlinemediaobject>)
+
+
+ on the <code>
+ <page>
+ </code> element reveals a box that lists the parameters for the page.</para>
+ </entry>
+
+ </row>
+
+ <row>
+ <entry> <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/element_page2.png"/>
+ </imageobject>
+ </mediaobject></entry>
+ <entry>
+ <para>A red cross in the upper left corner of the page box indicates that the view-id is not found in the project.</para>
+ </entry>
+ </row>
+
+ <row>
+ <entry><mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/element_page1.png"/>
+ </imageobject>
+ </mediaobject></entry>
+ <entry> <para>
+ A gray box with a dashed border represents a page that has navigation
+ (navigation rule) to but the page is not defined in the page.xml file.
+ </para></entry>
+ </row>
+
+
+ <row>
+ <entry> <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/element_exception.png"/>
+ </imageobject>
+ </mediaobject></entry>
+ <entry> <para>An <code><exception></code> is represented by a blue box with a orange diamond.</para></entry>
+ </row>
+
+
+
+
+
+ </tbody>
+ </tgroup>
+</table>
+
+
+ <para>Pageflow relations are shown with gray arrows, when you select a relationship the arrow is changed to orange. </para>
+
+
+
+ <para>On the lefthand side of the Graphical view of <property>Seam Page Editor</property> you can find a toolbar with a set of icons for the most frequently used commands. </para>
+
+ <table>
+ <title>Pages Editor: Graphical View. Commands Icons</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Icon Image</entry>
+
+ <entry>Command</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/icon_select.png"/>
+ </imageobject>
+ </inlinemediaobject>
+
+ </entry>
+ <entry>Select a page element</entry>
+
+ </row>
+
+ <row>
+ <entry><inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/icon_marquee.png"/>
+ </imageobject>
+ </inlinemediaobject></entry>
+ <entry>Marquee a page item</entry>
+ </row>
+
+
+ <row>
+ <entry>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/icon_new_link.png"/>
+ </imageobject>
+ </inlinemediaobject>
+
+ </entry>
+ <entry>Add a page relationship</entry>
+ </row>
+
+
+ <row>
+ <entry>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/icon_exception.png"/>
+ </imageobject>
+ </inlinemediaobject>
+
+ </entry>
+ <entry>Add an exception rule</entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>Context menus are also available when you click either on an item or a blank space.</para>
+
+
+ <para>A context menu called on a blank space of the diagram provides the following options:</para>
+ <itemizedlist>
+ <listitem><para><emphasis role="bold">Page</emphasis> creates a new page element on the diagram</para></listitem>
+ <listitem><para><emphasis role="bold">Exception</emphasis> creates a new exception element on the diagram</para></listitem>
+ <listitem><para><emphasis role="bold">Auto Layout</emphasis> formats the layout of the diagram automatically</para></listitem>
+ <listitem><para><emphasis role="bold">Select Element</emphasis> calls the <property>Select Element Wizard</property> with a filter to perform a quick search through the <property>pages.xml</property> file </para></listitem>
+ </itemizedlist>
+ <para>Rightclicking on a selected
+ <code><page></code>
+ element calls a context menu where you can choose the following options if you click on the <emphasis role="bold">New</emphasis> menu item: </para>
+
+
+
+ <itemizedlist>
+ <listitem><para><emphasis role="bold">Rule</emphasis> opens the <property>Add Navigation Rule</property> dialog in which you can browse your project for a view page to set the view-id in the navigation rule and specify <emphasis role="bold">render</emphasis> or <emphasis role="bold">redirect</emphasis> navigation options </para></listitem>
+ <listitem><para><emphasis role="bold">Param</emphasis> calls a dialog box where you can define a parameter (using the
+ <code><param></code>
+ tag) for the
+ <code><page></code>
+ element</para></listitem>
+ </itemizedlist>
+
+
+ <section>
+ <title>Seam Pages Diagram Preferences</title>
+
+
+
+ <para>In order to customize the layout of Diagram you can go to
+ <property>Window > Preferences > JBoss Tools > Web > Seam > Editors > Seam Pages Diagram</property>.
+ </para>
+
+ <figure>
+ <title>Preferences of Seam Pages Diagram</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_11.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+ </section>
+
+
+ <section>
+ <title>Tree Mode</title>
+
+ <para>Tree Mode provides a wider range of options and way to edit and modify the pages.xml file.</para>
+
+
+
+ <figure>
+ <title>Seam Pages Editor: Tree View</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_8.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ In this mode all elements and attributes of the page.xml
+ file can be viewed and edited in a visual, user friendly way.
+ </para>
+
+ </section>
+
+
+ <section>
+ <title>Outline Support for Seam Pages Editor</title>
+
+
+ <para>Seam Pages Editor provides <property>Outline</property> view support.
+ You can explore the pages.xml using Outline view in two modes: <property>Tree</property> ( <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/outline_tree.png"/>
+ </imageobject>
+ </inlinemediaobject> ) and <property>Diagram Navigation</property> ( <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/outline_navigation.png"/>
+ </imageobject>
+ </inlinemediaobject> ).</para>
+
+ <para>
+ The Diagram Navigation mode of Outline view gives a birds-view of the layout to allow quick navigation for large-scale applications.
+ </para>
+
+ <figure>
+ <title>Outline view: Diagram Navigation mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_9.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+ <para>The Tree mode shows a tree for every element in the pages.xml file. You can get a quick overview of the whole file. When selecting an element in the Outline view the related element is highlighted in the Graphical, Tree or Source page of Seam Pages Editor.</para>
+
+
+
+ <figure>
+ <title>Outline view: Tree mode</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_10.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+
+
+
+ </section>
+
+
+
+ </section>
+
+
+
+
+ <section>
+
+
+ <title>Seam Components Editor</title>
+
+ <para>When editing <property>components.xml</property> a structured tree editor is available
+ in addition to pure source editing. It has a graphical view (Tree tab) and source
+ (Source tab).</para>
+
+ <figure>
+ <title>component.xml Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note>
+ <title>Note:</title>
+
+ <para>You can view and edit <property>components.xml</property> and other xml files
+ directly in the Project Explorer and Properties sheet without opening the
+ components.xml editor.</para>
+ </note>
+ <figure>
+ <title>component.xml Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_5.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ </section>
+
+
+
+ <section id="SeamEditors">
+ <title>Main Features of Seam Editors</title>
+
+ <para>In this chapter you will know what Seam Editors features are and how to work with them. </para>
+
+ <section id="ContentAssist">
+
+ <title>Content Assist</title>
+
+ <para><property>Content Assist</property> (Ctrl + Space) is available when using EL expressions in the following file formats:</para>
+ <itemizedlist>
+ <listitem>
+ <para>JSP</para>
+ </listitem>
+ <listitem>
+ <para>XHTML</para>
+ </listitem>
+ <listitem>
+ <para>XML</para>
+ </listitem>
+ <listitem>
+ <para>JAVA</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Notice, the code completion for the Seam components shows the proposals marked with Seam icon.</para>
+
+ <figure>
+ <title>Content Assist</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_1.png" scale="70"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para> Content Assist is also available for the <emphasis
+ role="italic">
+ <property>"jsfc "</property>
+ </emphasis> attribute, it lets you select from a list of possible attribute values. Whereas, JSF components appear above all other components in the list.</para>
+ <figure>
+ <title>Content Assist for the "jsfc" attribute</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_12.png" scale="70"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <note>
+ <title>Note:</title>
+
+ <para>To get Code Assist available for an externally generated and imported project,
+ don'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>components.xml</property>
+ </emphasis> file you can make use of the Content Assist for inserting needed
+ elements.</para>
+
+ <figure>
+ <title>Content Assist in the component.xml Editor</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_1a.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The editor also makes code completion aware of methods/attributes for EntityQuery
+ component.</para>
+
+ <figure>
+ <title>Content Assist for EntityQuery Component</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_1b.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section id="named_beans_code_assist" role="new">
+ <title>Content assist for @Named beans</title>
+
+ <para>To the nice code completion you can also use Content assist for all occurrences where @Named beans are used.
+ </para>
+
+ <figure>
+ <title>Content assist for @Named beans</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_1c.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ </section>
+ <section>
+ <title>Content Assist for Page Descriptors</title>
+
+ <para>Content Assist ( CA ) is available for Page Descriptors,
+ <property>.page.xml</property> and <property>page.xml</property> files.
+ Content Assist lets you easily compose a Page Descriptor file by suggesting elements and attributes. The suggestions are context dependent, which means that CA provides only the elements, attributes and in some cases values for the attributes, suitable in a particular place of your Page Descriptor.
+
+ </para>
+ <para>
+ Seam Pages Editor also supports code completion in EL-expressions suggesting you possible bean properties and methods.
+ </para>
+ </section>
+ <section id="OpenOn">
+ <title>OpenOn</title>
+
+ <para><property>OpenOn</property> lets you easily navigate through your project without
+ using the Package Explorer or Project Explorer. After pressing <emphasis>
+ <property>Ctrl + left click</property>
+ </emphasis> (or just F3) you will see a corresponding method or class.</para>
+
+ <figure>
+ <title>OpenOn</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>OpenOn is available for the following files:</para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <link linkend="xmlFiles">XML files</link>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link linkend="xhtmlFiles">JSP/XHTML Pages</link>
+ </para>
+ </listitem>
+ <listitem>
+ <para> <link linkend="javaFiles">Java files</link></para>
+ </listitem>
+ </itemizedlist>
+ <note>
+ <title>Note:</title>
+
+ <para>In this section were described only use cases special for Seam applications.For general information please read
+ <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf/html/editors.html#OpenOnSelection4Hyperlinknavigation">OpenOn section in Visual Web Tools Reference Guide</ulink>.</para>
+ </note>
+ <itemizedlist>
+ <listitem id="xhtmlFiles"> <para>Using OpenOn in .xhtml files you can open:</para>
+ <itemizedlist>
+ <listitem><para>components or properties resolved using an EL expression;</para></listitem>
+ <listitem><para>all actions described in pages.xml;</para></listitem>
+ <listitem><para>other .xhtml files that paths are specified in a current file;</para></listitem>
+ <listitem><para>image files that paths are set in the <emphasis>
+ <property>value</property></emphasis> property.The files will be opened in the default system graphical editor.</para></listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem id="xmlFiles">
+ <para>OpenOn is also supported in Page Descriptors (<property>.page.xml</property> and <property>pages.xml</property>). OpenOn allows you to navigate to Java beans as well as to view pages.
+ You can <property>Ctrl + left click</property> on a bean or on view page file (e.g. XTML file) to navigate to the file you clicked on. </para>
+
+ <figure>
+ <title>OpenOn in .page.xml file</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_2a.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>If you use Rule-based authorization with Drools in your Seam application you can apply OpenOn
+ in <emphasis>
+ <property>components.xml</property></emphasis> to open the files containing rule definitions in the <emphasis>
+ <property>"rule-files"</property></emphasis> tag.
+ </para>
+ <figure>
+ <title>OpenOn in components.xml file</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_2c.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ <para>You can also use OpenOn to open jBPM components that are described in Seam component descriptor.
+ Two places where it works are available: </para>
+ <itemizedlist>
+ <listitem><para>inside <emphasis>
+ <property><component></property></emphasis> definition;</para>
+ <figure>
+ <title>OpenOn in components.xml file</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_2d.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure></listitem>
+ <listitem><para>inside <emphasis>
+ <property>jbpm</property></emphasis> tags;</para>
+ <figure>
+ <title>OpenOn in components.xml file</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_2e.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure></listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem id="javaFiles">
+ <para>
+ OpenOn is also supported in seam components where <property> In annotation</property> is presented.
+ After pressing <property>Ctrl + left click</property> on the seam component specified in <code>@In </code> you will get the possibility to open the file where the component is declarated as well as
+ all of the seam components where it is used in the next declarations:</para>
+ <itemizedlist>
+ <listitem><para>@Out</para></listitem>
+ <listitem><para>@DataModel</para></listitem>
+ <listitem><para>@Role</para></listitem>
+ <listitem><para>@Roles</para></listitem>
+ </itemizedlist>
+
+ <figure>
+ <title>OpenOn in Seam Component</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_2b.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <section id="SeamValidation">
+ <title>Seam Validation</title>
+
+ <para>Validation of various possible problematic definitions is implemented for Seam
+ applications.</para>
+
+ <para>If an issue is found it will be shown in the standard <property>Problems
+ View</property>.</para>
+
+ <figure>
+ <title>Seam Validation</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_6.png" scale="70"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <note>
+ <title>Note:</title>
+ <para>Please note, only files within source path and web content are validated, meaning temporary files or test files are not included.</para>
+ </note>
+
+ <para>In the preferences page for Seam Validator you can see and modify the validator
+ behavior. Go to <emphasis>
+ <property>Window > Preferences > JBoss Tools > Web > Seam > Validator</property>
+ </emphasis> and select the severity level for the optional Seam Validator
+ problem.</para>
+
+ <figure>
+ <title>Seam Validator Preferences</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/seam_editors_3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>On WTP projects validation are enabled by default and thus executed automatically, but
+ on normal Java projects you will have to go and add the Validation builder of your
+ project . It is available in the properties of your project under
+ <emphasis><property>Validation</property>.</emphasis></para>
+
+ <figure>
+ <title>Enabling the Validation Builder</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/validator1.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>The validations can be run manually by clicking
+ <emphasis><property>Validate</property></emphasis> via the context menu on your project (folder or file inside your project) which will
+ execute all the active WTP validations. Following to the project's preferences under <emphasis>
+ <property>Validation</property></emphasis> it's possible to enable/disable any validator.
+ </para>
+
+ <para>It's also possible to turn off the validation for some resource (a file, folder) inside your project via the <emphasis>
+ <property>Exclude Validation</property></emphasis> context menu option.</para>
+
+ <figure>
+ <title>Excluding Validation for the WebContent Folder</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/validator2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>As a result, if you've turned off the validation for a folder (or file), it is put to the excluded group of the Validation filters and be ignored during the validation.</para>
+
+ <figure>
+ <title>Validation Filters</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/seam_editors/validator3.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+</section>
+</chapter>
\ No newline at end of file
More information about the jbosstools-commits
mailing list