Creating a New Seam Project via the New Seam Project wizard</ti= tle> - <para><diffmk:wrapper diffmk:change=3D"changed">In this chapter we pro= vide you with the necessary steps to start working with Seam - Framework.</diffmk:wrapper></para> - <para><diffmk:wrapper diffmk:change=3D"changed">At first, we suggest t= o set the specific Seam perspective that combines a number of + <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 c= ombines a number of different views and editors needed for work with resources concern= ed. For that select - </diffmk:wrapper><emphasis> + <emphasis> <property moreinfo=3D"none">Window > Open Perspective > = Other > Seam</property> </emphasis> or you can also access it through the button in the ri= ght top corner.</para> <figure float=3D"0"> @@ -250,8 +251,8 @@ </mediaobject> </figure> <para>Also the <emphasis> - <property moreinfo=3D"none">Open Web Browser</property></empha= sis><diffmk:wrapper diffmk:change=3D"changed"> action is directly available= in the - </diffmk:wrapper><property moreinfo=3D"none">Seam perspective<= /property>.</para> + <property moreinfo=3D"none">Open Web Browser</property></empha= sis> action is directly available in the + <property moreinfo=3D"none">Seam perspective</property>.</para> <figure float=3D"0"> <title>Embedded Web Browser Button

+ @@ -234,11 +235,11 @@ Creating a New Seam Project via the New Seam Project wizard</ti= tle> - <para><diffmk:wrapper diffmk:change=3D"changed">In this chapter we pro= vide you with the necessary steps to start working with Seam - Framework.</diffmk:wrapper></para> - <para><diffmk:wrapper diffmk:change=3D"changed">At first, we suggest t= o set the specific Seam perspective that combines a number of + <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 c= ombines a number of different views and editors needed for work with resources concern= ed. For that select - </diffmk:wrapper><emphasis> + <emphasis> <property moreinfo=3D"none">Window > Open Perspective > = Other > Seam</property> </emphasis> or you can also access it through the button in the ri= ght top corner.</para> <figure float=3D"0"> @@ -250,8 +251,8 @@ </mediaobject> </figure> <para>Also the <emphasis> - <property moreinfo=3D"none">Open Web Browser</property></empha= sis><diffmk:wrapper diffmk:change=3D"changed"> action is directly available= in the - </diffmk:wrapper><property moreinfo=3D"none">Seam perspective<= /property>.</para> + <property moreinfo=3D"none">Open Web Browser</property></empha= sis> action is directly available in the + <property moreinfo=3D"none">Seam perspective</property>.</para> <figure float=3D"0"> <title>Embedded Web Browser Button @@ -262,8 +263,8 @@

Create standalone Seam Web Project - The best way to ge= t started with Seam is to create a simple Seam Project and - experiment with it. + The best way to get started with Seam is to create a simple = Seam Project and + experiment with it. Thus, you should select File > New > Seam Web Pr= oject to run the New Seam Pr= oject wizard. The wizard form @@ -272,8 +273,8 @@ Seam Web Project wizard has an option for selecting the actu= al Server (not just WTP runtime) that will be used for the project. This allows the wi= zard to identify correctly where the required datasource and driver libraries need to go.= - Let's get through = the wizard step-by-step. First, you should enter a name and a - location directory for your new project. + Let's get through the wizard step-by-step. First, you should= enter a name and a + location directory for your new project.

New Seam Project Wizard @@ -285,10 +286,10 @@ On the figure above you can see the runtime and the server a= lready created. If you need to create a new runtime, click on the New... - button in the Target R= untime section. It bri= ngs up the + button in the Target R= untime section. It brings up the wizard where you can specify a new JBoss Server Runtime enviro= nment or the other type of runtime appropriate for your project configuration. Let's crea= te one more JBoss 4.2 - Runtime. Hence, after choosing it click on + Runtime. Hence, after choosing it click on Next button.

@@ -314,15 +315,15 @@ Clicking on Finish - returns you to the New Seam Project - wizard page. - The next step is t= o define a Server by clicking on + returns you to the New Seam Project + wizard page. + The next step is to define a Server by clicking on New... button in the Target S= erver section. In appeared New Server dialog t= he last server which matches the runtime will be selected. - All declared runti= mes are listed in the combo-box under the servers view. Here, you - can indicate a server runtime that you need. Click + All declared runtimes are listed in the combo-box under the = servers view. Here, you + can indicate a server runtime that you need. Click Add if you want to add a new Server Runtime.

@@ -333,8 +334,8 @@ - Next page allows y= ou to verify the information for a chosen server. Leave everything as - it is and click on + Next page allows y= ou to verify the information for a chosen server. Leave everything + as it is and click on Next .

@@ -361,8 +362,8 @@ wizard. Tip: - We suggest tha= t you look through AS manager - guide to find out more about runtimes and serv= ers. + We suggest that you look through AS manage= r guide = to + find out more about runtimes and servers.=

Completion of Runtime and Server Configuration @@ -382,10 +383,10 @@ Pass to the next section to find out more details on this di= alog.

- <diffmk:wrapper diffmk:change=3D"changed">Selecting the Pro= ject Facets</diffmk:wrapper> + Selecting the Project Facets The Project Facets wizard allows you to enable or disa= ble - specific facets which define necessary features for the projec= t. When you - switch to this wizard form, all critical facets are already ch= ecked for the chosen + specific facets which define necessary features for the projec= t. When you switch to this + wizard form, all critical facets are already checked for the c= hosen Configuration. Notice that this page of the wizard also allows you to set t= he necessary version for any facet. @@ -412,12 +413,12 @@ To see all available Server runtimes click on Runtimes tab on the left. You can create a new one using the New - button. = If more than one runtime is checked here, the + button. If more than one runtime is checked here, = the Make Primary - button w= on't be dimmed yet. Thus, you can make use of it to mark primary - runtime. + button w= on't be dimmed yet. Thus, you can make use of it to mark + primary runtime.

- <diffmk:wrapper diffmk:change=3D"changed">Setting Runti= me</diffmk:wrapper> + Setting Runtime @@ -428,28 +429,53 @@ Ok button will bring you to the Web Module wizard form again. +

+ <diffmk:wrapper diffmk:change= =3D"added">Seam project with JPA facets</diffmk:wrapper> + For creating Seam project with JPA support you need to select Java + Persistent facet on Projec= t Facets page and + click OK. + Then you should press Next and may leave= the default value on + Java application bui= lding p= age and Web Module + Settings page. + After that you will see JPA fa= cet pag= e. +

+ <diffmk:wrapper diffmk:chan= ge=3D"added">JPA Facet page</diffmk:wrapper> + + + + + + + On this page you can choose Platf= orm (ve= ndor-specific JPA + implementation) for your project, type of JPA Implementati= on, and configure the + Connection to database in t= he Connection= area. + More about JPA facet page you can read i= n Eclipse documentation. + On the next step you will see JSF= Capabilities and Seam + facet pages, which are mostly the same as in general Seam + project. +

- <diffmk:wrapper diffmk:change=3D"ad= ded">Java application building configuration</diffmk:wrapper> - With this wizard you can define Java source directories which will be g= enerated on +

+ Java application building configuration + With this wizard you can define Java source directories whic= h will be generated on build path. Also you can specify a default output folder. If y= ou are agree with default - values, press Next -

- <diffmk:wrapper diffmk:change= =3D"added">Java application building Wizard</diffmk:wrapper> - - - + values, press Next +

+ Java application building Wizard + + +

How to Configure Web Module Settings - As we deal with a= Dynamic Web Application, we should at first specify the top level + As we deal with a Dynamic Web Application, we should at fir= st specify the top level directory of our application for deploying it to a server afte= rwards. You know, this kind of application contains Web resources. Thus, it's importa= nt to indicate the content directory. The wizard will put all those values itself, so you= can leave everything as - is. + is.

Web Module Settings @@ -464,11 +490,11 @@

Adding JSF Capabilities - This wizard helps = you to add JSF capabilities to your project. - Choose - Library provided by Target Runtime - from Lib= rary Type list if you'd like to use a default JSF implementation - given by the present runtime. + This wizard helps you to add JSF capabilities to your projec= t. + Choose + Library provided by Target Run= time + from Library Type list if you'd like to use a defa= ult JSF implementation + given by the present runtime.

Adding JSF Capabilities to Web Project @@ -477,56 +503,58 @@ - In case if you prefe= r to use your custom JSF implementation, choose User - Library Item from Library Type list. In User Library list you can= check - required library. -

- <diffmk:wrapper diffmk:change= =3D"added">Using Custom JSF implementation Library </diffmk:wrapper> - - - + In case if you prefer to use your custom JSF implementation,= choose User + Library Item from Library Type list. In User Li= brary list you can check + required library. +

+ Using Custom JSF implementation Library + + + - If a new library is= required, click Manage libraries... ( - - + If a new library is required, click Manage libraries... ( + + + - ) = button. Then you should click = New. -

- <diffmk:wrapper diffmk:change= =3D"added">Using Custom JSF implementation Library </diffmk:wrapper> - - - + ) button. Then you should click New. +

+ Using Custom JSF implementation Library + + + - Here, it's necessary to type a Library Name. + Here, it's necessary to type a = Library Name.

- <diffmk:wrapper diffmk:change=3D"changed">Entering New = User Library Name</diffmk:wrapper> + Entering New User Library Name - To add proper Library JARs, click Add JARs... - button and select the JARs on your hard drive. -

- <diffmk:wrapper diffmk:change= =3D"added">Selection Library JARs</diffmk:wrapper> - - - + To add proper Library JARs, click Add + JARs... button and select the JARs on your hard drive. +

+ Selection Library JARs + + + - You can download necessary JSF implementation libraries provided by Sun= and Apache Foundation as well. Click Download... (= - - - - ) butt= on and choose one of proposed libraries. + You can download n= ecessary JSF implementation libraries provided by Sun and Apache + Foundation as well. Click Download... ( + + + + ) button and choose one of proposed librar= ies.

- <diffmk:wrapper diffmk:change=3D"changed">Download JSF = Implementation Library</diffmk:wrapper> + Download JSF Implementation Library @@ -544,8 +572,8 @@ - Since we are arran= ging the Seam Web project, the last step we should do is to - adjust project configurations associated with the Seam. + Since we are arran= ging the Seam Web project, the last step we should do is to adjust + project configurations associated with the Seam.

Configure Seam Facet Settings @@ -566,10 +594,10 @@ For that click on Add - button in the General<= /property> section. Note, in the - wizard shown below you can create a Seam runtime only for the = version that was - selected in the Project Facets wizard (version 1.2 - in our case). + button in the General<= /property> section. Note, in the = wizard + shown below you can create a Seam runtime only for the version= that was selected in the + Project F= acets wizard (version 1.2 = in our + case).

Seam Runtime Creation @@ -624,8 +652,8 @@ - On the dialog you'= ll be asked to enter its name and description. And then - you should select a proper driver and adjust connection detail= s. Press + 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. P= ress Next to preview all the adjusted settings and complete = the creation of the new profile. @@ -639,10 +667,10 @@ The next block of settings in the Seam Facet wizard are desc= ribing a Database and a connection to it. - In the Code Generation section the wizard has already = provided the - names for your Se= ssion Bean, Entity Bean a= nd - Test packages. Of course, you can change them on oth= ers - of your choice. + In the Code Generation section the wizard has already = provided + the names for your Session Bean, Entity Bean + and Test packages generation (optional)= . Of course, you can change + them on others of your choice.

Code Generation Section @@ -659,7 +687,7 @@ = = - + @@ -668,136 +696,149 @@ JBDS - = Maven Integration for Seam Projects - Starting from 3.1 M2 version JBoss Tool= s includes new Jboss Maven Integration plug-in which for now all= ows - to create mavenized Seam projects and enable Seam tools support for impo= rted Maven projects. - = + Starting from 3.1 M2 version JBoss Tool= s includes new Jboss M= aven + Integration plug-in which for now allows to create mavenized Seam projec= ts and enable Seam + tools support for imported Maven projects. The Jboss Maven Integration requires m2eclipse to be installed. - = Note: - For M2 release of Jboss Tools it is important to use m2eclipse stable updatesite or the latest integration build that M2 was - developed against. If you want to use the latest development release of= m2eclipse you need to use the nightly builds of - JBoss Tools. + For M2 release of Jboss Tools it is important to use m2eclip= se + = stable updatesite or the + latest + integration build that M2 was developed against. If you want to use the + latest development release of m2eclipse you need to use the nightly + builds of JBoss Tools.= - = -

- Creating Maven ready Seam project - - Maven Integration makes the Seam Wizard capable of creating - Maven ready projects to let Maven get the libraries instead of using the= Seam runtime. - = - To create a mavenized Seam project you should perform the following= steps: - = - - - Navigate to - File > New Seam Project. Give the project a meaningful name, specify a target runtime and se= rver - and select the proper configuration for your Seam project: - = -

- Starting the Mavenized Seam Project - - - - - - - - = - - Click the - Modify button to ena= ble the - Jboss Maven Integration facet: - = -

- Enabling the Jboss Maven Integration Facet - - - - - - - - = - - On the JBoss M2 capabilities 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). - - = -

- Adjusting JBoss M2 Capabilities - - - - - - - - = - - On the Seam Facet page con= figure the Seam Facet settings and click - Finish: - = -

- Seam Facet Settings - - - - - - - - - = - The organized Seam project contains five projects with the Maven na= ture, builder, Maven classpath and the - pom.xml files added: = - projectname, projectname-ear, projectname-ejb, projectname-parent and pr= ojectname-test. - = -

- Mavenized Seam Project - - - - - - +

+ Creating Maven ready Seam project + Maven Integration makes = the Seam Wizard capable of creating Maven ready projects to + let Maven get the libraries instead of using the Seam runtime. + To create a mavenized Seam project you should perform the followin= g steps: + + + Navigate to + File > New Seam Project. Give the project + a meaningful name, specify a target runtime and server and select the= proper + configuration for your Seam project: +

+ Starting the Mavenized Seam Project + + + + + + + + + Click the + Modify button to e= nable the + Jboss Maven Integration facet: +

+ Enabling the Jboss Maven Integration Facet + + + + + + + + + On the JBoss M2 capabilities 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 Se= am and + also decide whether to remove WTP classpath containers (where the pat= h starts + with org.eclipse.jst). +

+ Adjusting JBoss M2 Capabilities + + + + + + + + + = On the JSF Capabilities= page you can choose Mav= en as + libraries provider. This is possible when you use Maven JSF 1.2 Libra= ries as + type of JSF Implementing Library. Also it gives you capability to edit + Dependencies and Exclusions for the mavenized Seam project directly f= rom the + wizard. +

+ <diffmk:wrapper diffmk:change=3D"added= ">Using JSF Implementation libraries provided by Maven</diffmk:wrapper></ti= tle> + <mediaobject diffmk:change=3D"added"> + <imageobject diffmk:change=3D"added"> + <imagedata diffmk:change=3D"added" fileref=3D"images/create_maveniz= ed_seam/seamJSFImplementation.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem diffmk:change=3D"added"> + <para>On the <property moreinfo=3D"none">Seam Facet</property><diffmk:= wrapper diffmk:change=3D"changed"> page configure the Seam Facet settings + and click </diffmk:wrapper><emphasis> + <property moreinfo=3D"none">Finish</property>:</emphasis></para> + <figure diffmk:change=3D"added" float=3D"0"> + <title>Seam Facet Settings + + + + + + + + + The organized Seam proje= ct contains five projects with the Maven nature, builder, + Maven classpath and the + pom.xml files added: projectname, projectname-ear, + projectname-ejb, projectname-parent and projectname-test. +

+ Mavenized Seam Project + + + + + +

- =

Existing Maven Projects Import - = - Maven Integration includes the Seam Maven configurator which is ca= lled when importing a project, changing = - + Maven Integration includ= es the Seam Maven configurator which is called when importing + a project, changing pom.xml and/or calli= ng - Maven > Update Project Configuration. When importing a Maven Seam project, the Seam Maven = configurator = - picks up the settings set up in - pom.xml and adds to = the project the following: - = + Maven > Update Project Configuration. When + importing a Maven Seam project, the Seam Maven configurator picks up th= e settings set up + in + pom.xml and adds to the project the + following: - Seam nature - Seam facet and dependent facets to the EJB, EAR and WAR= projects - JBoss Maven Integration facet if the Maven project cont= ains a dependency with the = - org.jboss.seam groupId and an artifactId starting with 'jboss-seam' - other required facets (Web Module, Java, JSF, etc.) + + Seam nature + + + Seam facet and dependent facets to the EJB, EAR and WAR projects= + + + JBoss Maven Integratio= n facet if the Maven project contains a dependency with + the org.jboss.seam groupId and an artifactId starting with 'jboss-sea= m' + + + other required facets (Web Module, Java, JSF, etc.) + - = If the Seam version from - pom.xml matches a ver= sion 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 = - Seam Settings in the project preferences= . - = - Seam configurator recognizes the Seam artifacts in the following w= ay: 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 fol= der containing "hot" in the name, it will be chosen as the action source fo= lder. = - Package is the first package that has children or doesn't have any subp= ackage. - - = - Configuring the Seam when importing a Maven project as well as a S= eam Runtime, Seam artifacts and some facets could be suspended - in the JBoss Maven Integration preferences ( - Window > Preferences > JBoss Tools &= gt; JBoss Maven Integration). - = + pom.xml matches a version of a Seam runtime + configured in the workspace, Seam configurator will set that runtime, o= therwise no Seam + runtime will be set and you'll have to set it manually under Seam Settings in the project preferen= ces. + Seam configurator recogn= izes 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 wi= ll be + chosen as the action source folder. Package is the first package that h= as children or + doesn't have any subpackage. + Configuring the Seam whe= n importing a Maven project as well as a Seam Runtime, Seam + artifacts and some facets could be suspended in the JBoss Maven Integra= tion preferences + ( + = Window > Preferences > JBoss Tools > JBoss Maven + Integration).

JBoss Maven Integration Preferences @@ -807,18 +848,17 @@

- =

Relevant Resources Links - = - In the Using Maven with JBoss Tools = - article written by Max Andersen you'll find references to the = - screencasts on how to use the examples of mavenized Seam projects provid= ed by JBoss Tools. + In the Using + Maven with JBoss Tools article written by Max Andersen you'll find + references to the screencasts on how to use the examples of mavenized S= eam projects + provided by JBoss Tools.

= = - + @@ -1022,7 +1062,7 @@ = = - + @@ -1385,7 +1425,7 @@ = = - + @@ -1727,7 +1767,7 @@ = = - = + = @@ -1740,8 +1780,8 @@ Seam Generate Entities = The main purpose of this chapter is to tell you about Seam Gener= ate Entities. - Generate Entities is a= vailable directly from Eclipse using Hibernate Tools plugin for the standar= d seam-gen generation. - The wizard generates a= set of CRUD Seam components and web pages based on existing tables in a da= tabase or on existing entities in your application. + Generate Entities is available directly from Eclipse using Hiber= nate Tools plugin for the standard seam-gen generation. + The wizard generates a set of CRUD Seam components and web pages= based on existing tables in a database or on existing entities in your app= lication. = =

@@ -1753,37 +1793,37 @@ = - By default, the generation = mode is set to Reverse engine= er from database. = - The reverse engineering from a database could be described in four steps= : + By default, the generation mode is set to Reverse engineer from database. = + The reverse engineering from a database could be described in four steps= : The wizard gets in database, extracts the tables a= nd = their connections - On basis o= f this metainfomation the Entity classes are generated into = - org.domain.project.entity package - For the entities from step 2 the classes EntityList and En= tityHome are generated - into org.domain.project.session package + On basis of this metainfomation the Entity classes= are generated into = + org.domain.project.entity pa= ckage + For the entities from step 2 the classes EntityList and En= tityHome are generated + into org.domain.project.session package The xhtml pages are generated. = - - <diffmk:wrapper diffmk:change=3D"added">= Note:</diffmk:wrapper> - T= he entities are generated from a database based on the console configuratio= n that is created automatically during a Seam project creation. = - (Read more about console configuration). The created console configuration = is based on the = - connection profile set on the Seam F= acets wizard page while creating a project. = - Configured connection profile settings are hold in the generated hibernate-console.properties. To change the connection - profile, double-click the console configuration. It could be found in = the Hibernate Configurations view = - (W= indow > Show view > Other > Hibernate > Hibernate Configuration= s - or just switch to the Hibernate perspective= ). + + Note: + The entities are generated from a database based on the console c= onfiguration that is created automatically during a Seam project creation. = + (Read more about console configuration). The created console conf= iguration is based on the = + connection profile set on the Seam Facets = wizard page while creating a project. = + Configured connection profile settings are hold in the generated hibernate-console.properties. To change the= connection + profile, double-click the console configuration. It could be found in = the Hibernate Configurations view = + (Window > Show view > Othe= r > Hibernate > Hibernate Configurations + or just switch to the Hibernate= perspective). - - Checking the Use existing entities mode the= wizard executes only 3 and 4 steps. It generates missing classes and + + Checking the Use existing entit= ies mode the wizard executes only 3 and 4 steps. It g= enerates missing classes and xhtml pages. = = Read the Generate a = CRUD Database Application chapter in order to see how the Generate Seam Entities wizard can be used. = - + @@ -1794,40 +1834,40 @@ = Seam Editors - - + = + = This chapter tells about Seam Editors and their features. - + =

Visual Page Editor Visual Page Editor fits perfectly for authoring view Seam pa= ges. The major features of VPE are listed in = Main Features of Seam Editors You can also read more about Visual Page Editor in Visual Page Editor chapter of "Visual Web Tools R= eference Guide".

- - - - + = + = + = + =

Seam Pages Editor - - + = + = Seam Pages Editor provid= es a handy way to edit the pages.xml= file. - + = - + = You can edit the pages.xml file in three modes: Graphical, Tre= e and Source. - + = Seam Pages Editor supports synchronization with Package Explor= er.This means that while renaming files in the Package Explorer all the cha= nges immediately affect the pages.xml file. - + =

Graphical Mode - - + = + = Graphical mode provides you with a set of visual tools to or= ganize your project pageflow, exception handling etc.

Seam Pages Editor: Graphical View @@ -1837,22 +1877,22 @@ - + = The Graphical part of the editor has some visual elements. T= he table below shows graphical representation of the elements and explains = their meanings. = - Pages Editor: Graphical View. Visual elements + Pages Editor: Graphical View. Visual elements = Element - + = Description - + = @@ -1863,9 +1903,9 @@ <page> element. - + = - + = @@ -1877,26 +1917,26 @@ ) - - + = + = on the


                         <page>

element reveals a box that lists the parameter= s for the page. - - - + = + = + = - + = A red cross in the upper left corner of the = page box indicates that the view-id is not found in the project. - - + = + = @@ -1904,12 +1944,12 @@ - A gray box with a dashed border represents a page = that has navigation + A gray box with a dashed border represents a page = that has navigation = (navigation rule) to but the page is not defined i= n the page.xml file. - - - + = + = + = @@ -1917,30 +1957,30 @@ An <exception> is re= presented by a blue box with a orange diamond. - - - - - - + = + = + = + = + = + =

+ = + = + Pageflow relations are shown with gray arrows, when you select a= relationship the arrow is changed to orange. = + = + = + = + On the lefthand side of the Graphical view of Seam Page Editor you can find a toolbar with a set= of icons for the most frequently used commands. = = - - Pageflow relations are shown with gray arrows, when you select a= relationship the arrow is changed to orange. - - - - On the lefthand side of the Graphical view of Seam Page Editor you can find a toolbar with a set= of icons for the most frequently used commands. - - Pages Editor: Graphical View. Commands Icons + Pages Editor: Graphical View. Commands Icons = Icon Image - + = Command @@ -1952,12 +1992,12 @@ - + = Select a page element - - - + = + = + = @@ -1965,9 +2005,9 @@ Marquee a page item - - - + = + = + = @@ -1975,31 +2015,31 @@ - + = Add a page relationship - - - + = + = + = - - + = + = Add an exception rule - - + = + = -

- + = + = Context menus are also available when you click either on= an item or a blank space. - - + = + = A context menu called on a blank space of the diagram pro= vides the following options: Page crea= tes a new page element on the diagram @@ -2010,28 +2050,28 @@ Rightclicking on a selected <page> element calls a context menu where you can choose the= following options if you click on the New menu item: - - - + = + = + = Rule opens th= e Add Navigation Rule dialog in whic= h you can browse your project for a view page to set the view-id in the nav= igation rule and specify render or redirect navigation options - Param calls a= dialog box where you can define a parameter (using the - <param> - tag) for the + Param calls a= dialog box where you can define a parameter (using the = + <param> = + tag) for the = <page> element - - + = + =

Seam Pages Diagram Preferences - - - - In order to customize the layout of Diagram you can go= to + = + = + = + In order to customize the layout of Diagram you can go= to = Window > Preferences >= JBoss Tools > Web > Seam > Editors > Seam Pages Diagram. - + =

Preferences of Seam Pages Diagram @@ -2042,15 +2082,15 @@

- - + = + =

Tree Mode - + = Tree Mode provides a wider range of options and way to e= dit and modify the pages.xml file. - - - + = + = + =

Seam Pages Editor: Tree View @@ -2059,19 +2099,19 @@ - + = In this mode all elements and attributes of the page.xml file can be viewed and edited in a visual, user friendly w= ay. - + =

- - + = + =

Outline Support for Seam Pages Editor - - + = + = Seam Pages Editor provides O= utline view support. You can explore the pages.xml using Outline view in two mo= des: Tree ( @@ -2082,11 +2122,11 @@ ). - + = - The Diagram Navigation mode of Outline view gives a birds-= view of the layout to allow quick navigation for large-scale applications. + The Diagram Navigation mode of Outline view gives a birds-= view of the layout to allow quick navigation for large-scale applications. = - + =

Outline view: Diagram Navigation mode @@ -2095,12 +2135,12 @@ - - + = + = The Tree mode shows a tree for every element in the page= s.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 G= raphical, Tree or Source page of Seam Pages Editor. - - - + = + = + =

Outline view: Tree mode @@ -2109,28 +2149,28 @@ - - - - + = + = + = + =

= - - + = + =

- - - - + = + = + = + =

- - + = + = Seam Components Editor - + = When editing components.xml a structured tree editor is available in addition to pure source editing. It has a graphical view (T= ree tab) and source (Source tab). - + =

component.xml Editor @@ -2139,10 +2179,10 @@ - + = Note: - + = You can view and edit compon= ents.xml and other xml files directly in the Project Explorer and Properties sheet with= out opening the components.xml editor. @@ -2155,11 +2195,11 @@

- + =

- - - + = + = + =

Main Features of Seam Editors = @@ -2243,18 +2283,18 @@

= - + =

Content Assist for Page Descriptors - - Content Assist ( CA ) is available for Page Descriptors, - .page.xml and page.xml files. - Content Assist lets you easily compose a Page Descriptor f= ile by suggesting elements and attributes. The suggestions are context depe= ndent, which means that CA provides only the elements, attributes and in so= me cases values for the attributes, suitable in a particular place of your= Page Descriptor. - + = + Content Assist ( CA ) is available for Page Descriptors, = + .page.xml and page.xml files. = + Content Assist lets you easily compose a Page Descriptor f= ile by suggesting elements and attributes. The suggestions are context depe= ndent, which means that CA provides only the elements, attributes and in so= me cases values for the attributes, suitable in a particular place of your= Page Descriptor. = + = - Seam Pages Editor also supports code completion in EL-exp= ressions suggesting you possible bean properties and methods. + Seam Pages Editor also supports code completion in EL-exp= ressions suggesting you possible bean properties and methods. =

@@ -2291,7 +2331,7 @@ Note: - + = In this section were described only use cases special fo= r Seam applications.For general information please read OpenOn = section in Visual Web Tools Reference Guide. @@ -2300,12 +2340,12 @@ components or properties resolved using an EL = expression; all actions described in pages.xml; - other .xhtml files that paths are specified in= a current file; + other .xhtml files that paths are specified in= a current file; = image files that paths are set in the - value pr= operty.The files will be opened in the default system graphical editor. + value pr= operty.The files will be opened in the default system graphical editor. = - + = OpenOn is also supported in Page Descriptors (.page.xml and = pages.xml). OpenOn allows you to navigate to Java beans as well = as to view pages. You can Ctrl + left click on a bean or on view page file (e.g. XTML file) to navigate to the file= you clicked on. = @@ -2317,7 +2357,7 @@ - If you use Rule-based authorization with Drools in your Seam= application you can apply OpenOn + If you use Rule-based authorization with Drools in your Seam= application you can apply OpenOn = in components.xml to open the files containing rule definitions in the "rule-files" tag. @@ -2331,7 +2371,7 @@ You can also use OpenOn to open jBPM components that are des= cribed in Seam component descriptor. - Two places where it works are available: + Two places where it works are available: = inside <component> definition; @@ -2354,19 +2394,19 @@ - - + = + = OpenOn is also supported in seam components where In annotation is presented. - After pressing Ctrl + left click on the seam component specified in @In you will get the po= ssibility to open the file where the component is declarated as well as + After pressing Ctrl + left click on the seam component specified in @In you will get the po= ssibility 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> @Out @DataModel @Role - @Roles + @Roles = - + =

OpenOn in Seam Component @@ -2421,7 +2461,7 @@ on normal Java projects you will have to go and add the Valida= tion builder of your project . It is available in the properties of your project un= der Validation. - + =

Enabling the Validation Builder @@ -2430,16 +2470,16 @@ - + = The validations can be run manually by clicking Validate via the context menu on your project (folder or file inside your proje= ct) which will execute all the active WTP validations. Following to the project= 's preferences under - Validation it= 's possible to enable/disable any validator. + Validation it= 's possible to enable/disable any validator. = - + = It's also possible to turn off the validation for some resource= (a file, folder) inside your project via the Exclude Validation= context menu option. - + =

Excluding Validation for the WebContent Folder @@ -2448,9 +2488,9 @@ - + = 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. - + =

Validation Filters @@ -2465,7 +2505,7 @@ = = - + @@ -2474,126 +2514,126 @@ JBDS - + = Seam Views - + =

Seam Components View - + = This chapter introduces you with Seam Components View. The Seam Components View is available from Seam perspective. It provides a list of seam componen= ts found in a project. - + =

Seam Components View - + = - + = The Seam Components View can show a components default scope= in two ways: - + = as labels on each component (click on the tria= ngular symbol at the top of the Seam Components View page and select Scope Presentation > Label) - + =

Label Scope Presentation of Seam Components - + = - + = as a node per scope where the components are g= rouped under a node representing its default scope. - + =

Node Scope Presentation of Seam Components - + = - + = The Seam Packages can be presented in two ways: - + = Flat - + =

Flat Presentation of Seam Packages - + = - + = Hierarchical - + =

Hierarchical Presentation of Seam Packages - + = - + = The Seam Component View can be filtered by choosing Customize View. - + =

Customize View - + = - - Select the Seam Compon= ents from Libraries under the Filters tab. + = + Select the Seam Compon= ents from Libraries under the Filters tab. = This will make the view ignore components defined in jars. Thi= s will hide the many built-in Seam components and leave only those that are= actually defined in the project or have been actively configured via compo= nents.xml. Therefore, deselecting the filter will show you all available co= mponents. Selecting the Seam Com= ponents from Referenced Projects will hide the compon= ents that dependent on other project. - + =

Available Seam Component View Customizations - + = - + =

- + =

Project Explorer integration - + = If you don't like to have a view for every piece of informat= ion in Eclipse, the content of the Seam Components view is also available a= s a node in the built-in Project Explorer (not Package Explorer!) view in E= clipse. - + =

Seam Components in Project Explorer - + = - + =

- + = = = - + @@ -2676,8 +2716,8 @@ can select whether the Seam validator displays an error, a= warning or just ignore the EL Syntax error. There are references made between each EL and vari= able name, so you can revalidate a particular EL if a context variable was = changed. This makes parsing of each resource with referenced ELs much fast= er. - - + = + =

Severity Preference for EL Syntax @@ -2686,9 +2726,9 @@ - + = The - Revalidate unresolved ELs automatica= lly option is enabled by default. + Revalidate unresolved ELs automatica= lly option is enabled by default. = If necessary, you can uncheck it. It may increase a performance = for big complex projects. = In the upper right corner of the Seam Validator preferences= page there is a Configure Project @@ -2775,8 +2815,8 @@ = Tip: - On the figure = above fields for configuring Seam artifacts are unavailable because Seam - Runtime is not selected. + On the figure above fields for configuring Seam artifact= s are unavailable because Seam + Runtime is not selected. = In Seam Wizards (New Action, Form, Entity, Conversation, Gen= erate Entities) you can @@ -2806,7 +2846,7 @@ To enable it, you should call the context menu for a Seam pr= oject and select JBoss Tools > Add Custom Capabilities. Then= check the needed modules and press Finish. - + =

Custom Capabilities be added to Seam Project @@ -2817,7 +2857,7 @@ = The next page displays all the updates that have been made t= o the project. - + =

Adding Custom Capabilities to Seam Project @@ -2826,13 +2866,13 @@ - + =

= = = - + @@ -2842,70 +2882,71 @@ rename - <diffmk:wrapper diffmk:change=3D"changed">Seam Refactoring Tool= s</diffmk:wrapper> - The goal of Seam compone= nts refactoring is to make system-wide code changes without affecting the b= ehavior of the program. - The Seam module of = JBoss Tools provides assistance in easil= y code refactoring. - - Starting from Jboss To= ols M4 refactoring functionality became also available for managed beans, = method and properties used in ELs. - Thus now Seam refactoring tools include the next refactoring operatio= ns: - + Seam Refactoring Tools + The goal of Seam components refactoring is to make system-wide c= ode changes without affecting the behavior of the program. + The Seam module of JBoss Tools provides assistance in easily code refactoring. + = + Starting from Jboss Tools M4 refactoring functionality became al= so available for managed beans, method and properties used in ELs. + Thus now Seam refactoring tools include the next refactoring operatio= ns: + = - Renaming Seam compon= ents - Renaming Seam cont= ext variables in EL + Renaming = Seam components + Renamin= g Seam context variables in EL - - Refactoring commands are a= vailable from the context menus of several views and editors and use a stan= dard Eclipse refactoring wizard. - For details, see "Using the R= efactoring Wizard" later in this chapter. - - - <diffmk:wrapper diffmk:change=3D"added">N= ote:</diffmk:wrapper> - Seam refactoring could be = only performed in the file that is not marked as Read only in its properties.<= /diffmk:wrapper> + = + Refactoring commands are available from the context menus of sever= al views and editors and use a standard Eclipse refactoring wizard. + For details, see "Using the Refacto= ring Wizard" later in this chapter. = + = + + Note: + Seam refactoring could be only performed in the file that is not m= arked as Read only in its properties. - -

- <diffmk:wrapper diffmk:change=3D"added">P= roperties View for Java File</diffmk:wrapper> - - - + = +

+ Properties View for Java File + + + - + =

- <diffmk:wrapper diffmk:change=3D"changed">Using the Refacto= rinig Wizard</diffmk:wrapper> - This wizard is opened always when the user clicks Rename Seam Component/Rename Seam Context Variable/Ren= ame command in any - of the mentioned views. - - + Using the Refactorinig Wizard + This wizard is opene= d always when the user clicks the Rename Seam Component, + Ren= ame Seam Context Variable + or Rename command in any of the views/editors mentioned later in this cha= pter. + + =

- Refactoring Seam wizard + <diffmk:wrapper diffmk:change=3D"changed">Refactoring W= izard</diffmk:wrapper> - - In the Seam Components name field you should enter a new name of the c= omponent, - then click Next and follow the next wizard steps: + = + In the Seam Components name field you should enter a new name of the component, + then click Next and fol= low the next wizard steps: - + =

- Navigating between the differences + <diffmk:wrapper diffmk:change=3D"changed">Navigating Be= tween the Differences</diffmk:wrapper> - - As you see, when performing a refactoring operation, you can preview all = of the changes resulting from a refactoring - action before you choose to carry them out. - - The view represents two windows: one with the original source code and = the other with refactored one. - - With the help of - + = + As you see, when performing a refactoring operation, you can p= review all of the changes resulting from a refactoring = + action before you choose to carry them out. + = + The view represents two windows: one with the original sourc= e code and the other with refactored one. + = + With the help of + <= /imagedata> , @@ -2916,10 +2957,10 @@ , <= /imagedata> - buttons you can quickly navigate between the differences in = the code. - If you don't agree with some changes you can't undo them but y= ou can remove the class from the list of classes that need refactoring. - - + buttons you can quickly nav= igate between the differences in the code. + If you don't agree with some changes you can't undo them but y= ou can remove the class from the list of classes that need refactoring. = + + =

List of classes that need refactoring @@ -2929,111 +2970,265 @@ - - To apply the changes click Finish. - - Renaming the selected seam component also corrects all references to the + = + To apply the changes click Finish. + = + Renaming the selected= seam component corrects all references to the = component (also in other files in the project). Renaming a type does= n't allow to rename similarly named variables and methods.

- -

- <diffmk:wrapper diffmk:change=3D"changed">Renaming Seam Component= s</diffmk:wrapper> - + = +

+ Renaming Seam Components + = Renaming a Seam component could be performed in the: - + = Java editor<= /listitem> Seam Components view Tree view of th= e components.xml editor - + =

- <diffmk:wrapper diffmk:change=3D"changed">Renaming Seam Componen= ts in the Java Editor</diffmk:wrapper> - If you want to rename c= ertain seam component using Java Editor,first of all it's necessary to open= it. - If you don't know ,where the seam component is declared,use Open Seam Components icon. - - - To open the rename Seam Component command in Java Editor it's ne= cessary to left click the file >S= eam Refactor>Rename Seam Component. - + Renaming Seam Components in the Java Editor + If you want to rename c= ertain seam component using Java editor, first of all it's necessary to ope= n it. = + If you don't know, where the seam component is declared, use Open Seam Components icon. + To rename a Seam compon= ent in the Java editor it's necessary to select the component, left click = the file and then select + Seam Refactor > Rename Seam Component. +

- Opening Refactoring wizard in Java Editor + <diffmk:wrapper diffmk:change=3D"changed">Opening Refactoring W= izard in Java Editor</diffmk:wrapper> + = + F= or details, see also the movie, = + "Renaming a Seam compon= ent in the Java Editor".

- + =

- <diffmk:wrapper diffmk:change=3D"changed">Renaming Seam Componen= ts in the Seam Components View</diffmk:wrapper> - To open Refactoring wizard in the Seam Components v= iew - you should left click the component you wants to open and choose Rename Seam Component op= tion. - + Renaming Seam Components in the Seam Components View + To open the Refactoring wizard in the Seam Components view = + you should left click the component you want to open and choose Rename Seam Component opt= ion. + =

- <diffmk:wrapper diffmk:change=3D"changed">Opening Refactoring W= izard in Seam Components View</diffmk:wrapper> + Opening Refactoring Wizard in Seam Components View + = + F= or details, see also the movie, = + "Renaming a S= eam component in the Seam Components view".

- -

- <diffmk:wrapper diffmk:change=3D"changed">Renaming Seam Componen= ts in the Seam Components Editor</diffmk:wrapper> - When you open = components.xml file using= JBossTools XML Editor, open the - Refactoring wizard in the Tree tab by left-clicking the component= in - components area and choosing <= property moreinfo=3D"none">Rename option. - + = +

+ Renaming Seam Components in the Seam Components Editor + When you open components.xml= file using JBoss Tools XML Editor, open the = + Refactoring wizard in the Tree = tab by left-clicking the component in = + components area and choosing Rename option. + =

- <diffmk:wrapper diffmk:change=3D"changed">Opening Refactoring= Wizard in </diffmk:wrapper><emphasis><property moreinfo=3D"none">component= s.xml</property></emphasis><diffmk:wrapper diffmk:change=3D"changed"> File<= /diffmk:wrapper> + Opening Refactoring Wizard in <emphasis><property moreinfo=3D= "none">components.xml</property></emphasis> File = -

- <diffmk:wrapper diffmk:change=3D"added">R= enaming Seam Context Variables in EL</diffmk:wrapper> + = + F= or details, see also the movie, = + "Renaming a Sea= m component in the components.xml file". +

+ = +

+ Renaming Seam Context Variables in EL + = + Renaming a Seam context variables in EL could be executed in .java, .xml, .jsp, = + .xhtml and .properties files in Seam projects using = + the context menu command Seam Ref= actor > Rename Seam Context Variable. = - Renaming a Seam context va= riables in EL could be executed in .java<= /diffmk:wrapper>, .xml, .jsp, - .xhtml and .p= roperties files in Seam projects using - the context menu command = Seam Refactor > Rename Seam Context Variable= . -

- <diffmk:wrapper diffmk:change=3D"changed">Refactoring Seam Cont= ext Variable in .properties File</diffmk:wrapper> + Refactoring Seam Context Variable in .properties File - + =

- <diffmk:wrapper diffmk:change=3D"changed">Opening Refactoring wi= zard in components.xml file</diffmk:wrapper> + Opening Refactoring wizard in components.xml file - + - + =

- <diffmk:wrapper diffmk:change=3D"changed">Opening Refactoring wi= zard in .html file</diffmk:wrapper> + Opening Refactoring wizard in .html file - + + = + Fo= r details, see also a set of movies about renaming Seam context variables i= n EL in different locations: + + + In the= Java editor + + + In the JBoss Tools Properties Editor + + + In the X= ML editor + + + In the V= isual Page Editor + +

- + + + + + + + + + EAR + Seam + + + + + = + Adding Seam support to EAR project + From this chapter you will find out how to add Seam support to E= AR project + For example you have several WTP projects: + = + = + seamproject-ear (You can create WTP EAR project u= sing New -> Project -> Java EE -> Enterprise Application Project w= izard) + seamproject-ejb (You can create WTP EJB project u= sing New -> Project -> EJB -> EJB Project wizard) + seamproject-war (You can create WTP WEB project u= sing New -> Project -> Web -> Dynamic Web Project wizard) + + = + Tip + You can add as many EJBs modules as you want just doing the = same for each EJB project. + = +

+ WTP Projects + + + + + + + = + Make sure EJB and WAR are included in EAR as modules (Properties= for seamproject-ear -> Java EE Module Dependencies) + = +

+ Java EE Module Dependencies + + + + + + + = + Make sure there is jboss-seam.jar in application.xml as well: + = +

+ Java EE Module Dependencies + + + + + + + = + = + Then include libs from EAR to EJB Manifest Class-Path (Propertie= s for seamproject-ejb -> Java EE Module Dependencies) + = +

+ Including Libs from EAR to EJB Manifest Class-Path + + + + + + + = + Include libs from EAR and seamproject-ejb.jar to WAR Manifest Cl= ass-Path (Properties for seamproject-war -> Java EE Module Dependencies)= = + = +

+ Including Libs from EAR and seamproject-ejb.jar to WAR Mani= fest Class-Path + + + + + + + = + Thus we have set our WTP EAR/EJB/WAR projects and now we are rea= dy to add Seam support to them: + = + First you have to add Seam support to WAR project: Properties fo= r seamproject-war -> Seam Settings + = + = +

+ Adding Seam Support to WAR Project + + + + + + + = + = + Set seamproject-war as Main Seam project. All other settings mos= tly are used by New Seam Entity/Action/Form/Conversation/... Wizards. Thus = you can set them as you wish. + = + Then you can add Seam support to EJB project: Properties for sea= mproject-war -> Seam Settings + = +

+ Adding Seam Support to EJB Project + + + + + + + = + It&s important to set seamproject-war project as main Seam p= roject there. + It will allow Seam Tools to use one common Seam model for se= amproject-ejb and seamproject-war projects. + = + The last step is to clean/build the projects + = + That is all. You have added Seam support to your EAR project. + = +

+ Added Seam Support to EAR Project + + + + + + + = + + + @@ -3516,7 +3711,8 @@ = = - + + @@ -3647,7 +3843,7 @@ = = - + @@ -3742,27 +3938,27 @@ = -

Seam-test Project - + = - Add Seam Action to your project via File > New > Seam + Add Seam Action to your project via File > New > Seam Action. = -

Seam Action Creation - + @@ -3774,28 +3970,28 @@ = -

New Seam Action Wizard - + = - When Action is created you will see action= Page.xhtml in - Package Explorer view. ActionBean.java will be + When Action is created you will see actionPage.xhtml in + Package Explorer view. Act= ionBean.java will be automatically opened in Java Editor. = -

Created Action - + @@ -3803,28 +3999,28 @@ = - Select ActionLocalTest.xml in S= eam-test project and run - the test with right click Run As >= TestNG + Select ActionLocalTest.x= ml in Seam-test project and run + the test with right click Run As > TestNG Suite. OpenOn is available in testNG XML files opened in JBoss= XML Editor -

Running TestNG - + = The test process will start and its output will be written i= n Console View. = -

Test is Finished - + @@ -3833,20 +4029,20 @@ After running TestNG you will have the test results = in - test-output + test-output folder in Seam-test project (press F5 to r= efresh the Package - Explorer view). Open index.html f= ile with Web Browser or + Explorer view). Open index= .html file with Web Browser or simply use the TestNG view. = The below view shows a successful run of the test. = -

Viewing the Test Results - + @@ -3854,24 +4050,24 @@ = You can see the test results in Web Browser. = -

Test Results in Browser - + = After clicking on - ActionLocal Tests + ActionLocal Tests link you will see the Results for ActionLocal Test= s. = -

Test Information - + @@ -3879,11 +4075,11 @@ Select a result on the left-hand pane and its details will b= e displayed on the right-hand one. = -

ActionLocal Test Details - + @@ -3891,80 +4087,83 @@ Thus with Seam tooling you can easily take advantage of Test= NG framework. As you can see, it generates its own TestNG project as a separate module = within which you can easily monitor the tests execution and their output. - + =

- + + + FAQ - + =

How to get Code Assist for Seam specific resources in an ex= ternally generated project? - + = To get Code Assist for Seam specific resources in an externa= lly generated project, you should enable Seam features in Project Preferences. Right clic= k an imported project and navigate - Properties > Seam Settings. Check - Seam support + Properties > Seam Settings<= /property>. Check + Seam support box to enable all available Seam Settings.

- + =

How to import an example Seam project from jboss-eap direct= ory? - + = To import an example Seam project from - jboss-eap + jboss-eap into your working directory, you should perform the fo= llowing steps: - + = Go to - New > Other > Java Project from Existing Bui= ldfile + New > Other > Java P= roject from Existing Buildfile - + = Point to the - build.xml + build.xml of any chosen project by pressing - Browse + Browse button - + = Hit - Finish + Finish to open the project - + = As these seam examples are non WTP projects, next you should= enable Seam support for them. To do that, right click the project and go to - Properties > Seam Settings. + Properties > Seam Settings<= /property>.

- + =

How to change the deploy folders for Seam source code from = src/hot and src/main? - + = You should right-click the project, select - Properties > Java Build Path, then switch to the - Source tab, select the out= put folder for - src/hot ( - src/main) and cli= ck - Edit to change their o= utput location. - + Properties > Java Build Path, then switch to the + Source tab, select the output folder for + src/hot ( + src/main) and click + Edit= to change their output location. + = In conclusion, the main goal of this document is to get you = know with a full featureset - that JBoss Tools provides to support Seam= development. Thus if you have - some questions, comments or suggestions on the topic, please f= ell free to ask in the JBoss + that JBoss Tools provid= es to support Seam development. Thus if you have + some questions, comments or suggestions on the topic, please f= ell free to ask in the + JBoss Tools Forum. You can also influence on how you wan= t to see JBoss Tools docs in - future leaving your vote on the article Overview of the improvements required by JBossTools/JBDS = Docs users. - + future leaving your vote on the article Overview of the improvements requi= red by JBossTools/JBDS Docs users. + = A set of movies on Seam tooling is available on Seam movies page.

- \ No newline at end of file + + + = + --===============8594408132294264836==--