March 2011 - jbosstools-commits - Jboss List Archives

JBoss Tools SVN: r29860 - in branches/jbosstools-3.2.x/deltacloud/plugins/org.jboss.tools.deltacloud.ui: src/org/jboss/tools/deltacloud/ui/commands and 1 other directory.

by jbosstools-commits＠lists.jboss.org

Author: adietish Date: 2011-03-17 05:12:42 -0400 (Thu, 17 Mar 2011) New Revision: 29860 Modified: branches/jbosstools-3.2.x/deltacloud/plugins/org.jboss.tools.deltacloud.ui/ChangeLog branches/jbosstools-3.2.x/deltacloud/plugins/org.jboss.tools.deltacloud.ui/plugin.xml branches/jbosstools-3.2.x/deltacloud/plugins/org.jboss.tools.deltacloud.ui/src/org/jboss/tools/deltacloud/ui/commands/FilterImagesHandler.java branches/jbosstools-3.2.x/deltacloud/plugins/org.jboss.tools.deltacloud.ui/src/org/jboss/tools/deltacloud/ui/commands/FilterInstancesHandler.java Log: [JBIDE-8594] enabled handlers when image-/instance-view is active or cloud is selected in cloud viewer, changed handlers to be able to adapt image-/instance-view to DeltaCloud instance Modified: branches/jbosstools-3.2.x/deltacloud/plugins/org.jboss.tools.deltacloud.ui/ChangeLog =================================================================== --- branches/jbosstools-3.2.x/deltacloud/plugins/org.jboss.tools.deltacloud.ui/ChangeLog 2011-03-17 04:18:41 UTC (rev 29859) +++ branches/jbosstools-3.2.x/deltacloud/plugins/org.jboss.tools.deltacloud.ui/ChangeLog 2011-03-17 09:12:42 UTC (rev 29860) @@ -1,5 +1,24 @@ +2011-03-16 André Dietisheim <André Dietisheim@adietisheim-thinkpad> + + * src/org/jboss/tools/ * plugin.xml: + * src/org/jboss/tools/deltacloud/ui/commands/FilterImagesHandler.java (execute): + * src/org/jboss/tools/deltacloud/ui/commands/FilterInstancesHandler.java (execute): + [JBIDE-8594] enabled handlers when image-/instance-view is active or cloud is selected in cloud viewer, + changed handlers to be able to adapt image-/instance-view to DeltaCloud instance + deltacloud/ui/views/cloudelements/InstanceView.java: + * src/org/jboss/tools/deltacloud/ui/views/cloudelements/ImageView.java: + * src/org/jboss/tools/deltacloud/ui/views/cloudelements/AbstractCloudElementTableView.java + (dispose): + (addPropertyChangeListener): + [JBIDE-8590] removing propertyChangeListeners on disposal, + registering listeners for all props only (was: several for each property) + 2011-03-14 André Dietisheim <André Dietisheim@adietisheim-thinkpad> + * src/org/jboss/tools/deltacloud/ui/views/cloudelements/AbstractCloudElementTableView.java + (updateCloudSelector) (.run): + [JBIDE-7862] setting all items again so that the combo shrinks to the space needed to display the largest cloud name + * src/org/jboss/tools/deltacloud/ui/views/cloud/property/CVPropertySheetPage.java (cloudPropertyListener): (selectionChanged): Modified: branches/jbosstools-3.2.x/deltacloud/plugins/org.jboss.tools.deltacloud.ui/plugin.xml =================================================================== --- branches/jbosstools-3.2.x/deltacloud/plugins/org.jboss.tools.deltacloud.ui/plugin.xml 2011-03-17 04:18:41 UTC (rev 29859) +++ branches/jbosstools-3.2.x/deltacloud/plugins/org.jboss.tools.deltacloud.ui/plugin.xml 2011-03-17 09:12:42 UTC (rev 29860) @@ -296,41 +296,31 @@ <handler class="org.jboss.tools.deltacloud.ui.commands.FilterImagesHandler" commandId="org.jboss.tools.deltacloud.ui.filterimages"> - <activeWhen> - <with - variable="selection"> - <iterate operator="and"> - <adapt - type="org.jboss.tools.deltacloud.core.DeltaCloud"> - </adapt> - </iterate> - </with> - </activeWhen> <enabledWhen> - <with - variable="selection"> - <count value="+" /> - </with> + <or> + <with + variable="selection"> + <count value="1" /> + </with> + <with variable="activePartId"> + <equals value="org.jboss.tools.deltacloud.ui.views.ImageView"/> + </with> + </or> </enabledWhen> </handler> <handler class="org.jboss.tools.deltacloud.ui.commands.FilterInstancesHandler" commandId="org.jboss.tools.deltacloud.ui.filterinstances"> - <activeWhen> - <with - variable="selection"> - <iterate operator="and"> - <adapt - type="org.jboss.tools.deltacloud.core.DeltaCloud"> - </adapt> - </iterate> - </with> - </activeWhen> <enabledWhen> - <with - variable="selection"> - <count value="+" /> - </with> + <or> + <with + variable="selection"> + <count value="1" /> + </with> + <with variable="activePartId"> + <equals value="org.jboss.tools.deltacloud.ui.views.InstanceView"/> + </with> + </or> </enabledWhen> </handler> </extension> Modified: branches/jbosstools-3.2.x/deltacloud/plugins/org.jboss.tools.deltacloud.ui/src/org/jboss/tools/deltacloud/ui/commands/FilterImagesHandler.java =================================================================== --- branches/jbosstools-3.2.x/deltacloud/plugins/org.jboss.tools.deltacloud.ui/src/org/jboss/tools/deltacloud/ui/commands/FilterImagesHandler.java 2011-03-17 04:18:41 UTC (rev 29859) +++ branches/jbosstools-3.2.x/deltacloud/plugins/org.jboss.tools.deltacloud.ui/src/org/jboss/tools/deltacloud/ui/commands/FilterImagesHandler.java 2011-03-17 09:12:42 UTC (rev 29860) @@ -35,8 +35,14 @@ public Object execute(ExecutionEvent event) throws ExecutionException { ISelection selection = HandlerUtil.getCurrentSelection(event); if (selection instanceof IStructuredSelection) { - DeltaCloud cloud = UIUtils.getFirstAdaptedElement(selection, DeltaCloud.class); - createImagesFilter(cloud, HandlerUtil.getActiveShell(event)); + DeltaCloud deltaCloud = UIUtils.getFirstAdaptedElement(selection, DeltaCloud.class); + if (deltaCloud != null) { + createImagesFilter(deltaCloud, HandlerUtil.getActiveShell(event)); + } else { + // no item selected: try active part + deltaCloud = UIUtils.adapt(HandlerUtil.getActivePart(event), DeltaCloud.class); + createImagesFilter(deltaCloud, HandlerUtil.getActiveShell(event)); + } } return Status.OK_STATUS; @@ -44,15 +50,15 @@ private void createImagesFilter(final DeltaCloud cloud, final Shell shell) { if (cloud != null) { - Display.getDefault().asyncExec(new Runnable() { - @Override - public void run() { - IWizard wizard = new ImageFilterWizard(cloud); - WizardDialog dialog = new WizardDialog(shell, wizard); - dialog.create(); - dialog.open(); - } - }); + Display.getDefault().asyncExec(new Runnable() { + @Override + public void run() { + IWizard wizard = new ImageFilterWizard(cloud); + WizardDialog dialog = new WizardDialog(shell, wizard); + dialog.create(); + dialog.open(); + } + }); } } Modified: branches/jbosstools-3.2.x/deltacloud/plugins/org.jboss.tools.deltacloud.ui/src/org/jboss/tools/deltacloud/ui/commands/FilterInstancesHandler.java =================================================================== --- branches/jbosstools-3.2.x/deltacloud/plugins/org.jboss.tools.deltacloud.ui/src/org/jboss/tools/deltacloud/ui/commands/FilterInstancesHandler.java 2011-03-17 04:18:41 UTC (rev 29859) +++ branches/jbosstools-3.2.x/deltacloud/plugins/org.jboss.tools.deltacloud.ui/src/org/jboss/tools/deltacloud/ui/commands/FilterInstancesHandler.java 2011-03-17 09:12:42 UTC (rev 29860) @@ -36,7 +36,13 @@ ISelection selection = HandlerUtil.getCurrentSelection(event); if (selection instanceof IStructuredSelection) { DeltaCloud deltaCloud = UIUtils.getFirstAdaptedElement(selection, DeltaCloud.class); - createInstancesFilter(deltaCloud, HandlerUtil.getActiveShell(event)); + if (deltaCloud != null) { + createInstancesFilter(deltaCloud, HandlerUtil.getActiveShell(event)); + } else { + // no item selected: try active part + deltaCloud = UIUtils.adapt(HandlerUtil.getActivePart(event), DeltaCloud.class); + createInstancesFilter(deltaCloud, HandlerUtil.getActiveShell(event)); + } } return Status.OK_STATUS;

13 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r29859 - trunk/ws/docs/reference/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-03-17 00:18:41 -0400 (Thu, 17 Mar 2011) New Revision: 29859 Modified: trunk/ws/docs/reference/en-US/preference.xml trunk/ws/docs/reference/en-US/proc-jbt-generate_a_sample_restful_web_service.xml trunk/ws/docs/reference/en-US/proc-jbt-new_project_example.xml trunk/ws/docs/reference/en-US/proc-jbt-test_JAX-RS.xml trunk/ws/docs/reference/en-US/proc-jbt-test_JAX-WS.xml trunk/ws/docs/reference/en-US/proc-jbt-test_resteasy_JAX-RS.xml trunk/ws/docs/reference/en-US/proc-jbt-test_restfulsample_JAX-RS.xml trunk/ws/docs/reference/en-US/testing_a_restful_web_service-web_service_test_view.xml trunk/ws/docs/reference/en-US/testing_a_web_service-web_service_test_view.xml trunk/ws/docs/reference/en-US/topdown.xml Log: "Fixed spelling errors" Modified: trunk/ws/docs/reference/en-US/preference.xml =================================================================== --- trunk/ws/docs/reference/en-US/preference.xml 2011-03-17 04:00:50 UTC (rev 29858) +++ trunk/ws/docs/reference/en-US/preference.xml 2011-03-17 04:18:41 UTC (rev 29859) @@ -1,104 +1,110 @@ <?xml version="1.0" encoding="ISO-8859-1"?> <chapter id="preference" revisionflag="added"> - <title>JBoss WS and development environment</title> - - <para>In this chapter you will learn how to change JBossWS preferences and how to set default server and runtime.</para> - <section id="jbosswspreference"> - - - <title>JBossWS Preferences</title> - - <para>In this section you will know how JBossWS preferences can be modified during the - development process.</para> - - <para>JBossWS preferences can be set on the JBossWS preference page. Click on - <emphasis><property>Window > Preferences > JBoss Tools > Web > JBossWS - Preferences</property>.</emphasis></para> - - <para>On this page you can manage the JBossWS Runtime. Use the appropriate buttons to - <property>Add</property> more runtimes or to <property>Remove</property> those that - are not needed.</para> - - <figure> - <title>JBossWS Preferences Page</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/preference/Jbossws_preference.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Clicking on <emphasis> - <property>Add</property> - </emphasis> or <emphasis> - <property>Edit</property> - </emphasis> button will open the form where you can configure a new JBossWS runtime and - change the path to JBossWS runtime home folder, modify the name and version of the - existing JBossWS runtime settings. Press <property>Finish</property> to apply the - changes.</para> - - <figure> - <title>Edit JBossWS Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/preference/Jbossws_preference_new.png"/> - </imageobject> - </mediaobject> - </figure> - - - - - <para>WS container allows Source and JavaDoc locations to be set via the Properties dialog on each contained .jar: right-click on any .jar file in the Project Explorer view, select <emphasis><property>Properties</property></emphasis>. Choose <emphasis><property>Java Source Attachment</property></emphasis> and select location (folder, JAR or zip) containing new source for the chosen .jar using one of the suggested options (workspace, external folder or file) or enter the path manually:</para> - - <figure> - <title>Classpath Container: Java Source Attachment</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/preference/jbossws_container1.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Click on <emphasis><property>Apply</property></emphasis> and then on <emphasis><property>Ok</property></emphasis>.</para> - <para>To change JavaDoc Location choose <emphasis><property>Javadoc Location</property></emphasis> and specify URL to the documentation generated by Javadoc. The Javadoc location will contain a file called <emphasis><property>package-list</property></emphasis>:</para> - - <figure> - <title>Classpath Container: Javadoc Location</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/preference/jbossws_container2.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Click on <emphasis><property>Apply</property></emphasis> and then on <emphasis><property>Ok</property></emphasis>.</para> - - - - - - - </section> - <section id="serverruntime"> - <title>Default Server and Runtime</title> - <para>Open <emphasis> - <property>Window > Preferences > Web Services > Server and Runtime</property></emphasis>. On this page, you can specify a default server and runtime.</para> - <para>For ease of use, the better way is to set runtime to JBoss WS.</para> - <para>After server and runtime are specified, click on the <property>Apply</property> button - to save the values.</para> - <figure> - <title>Specifing a default server and runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/preference/jbossws_server_runtime.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>On the whole, this guide covers the fundamental concepts of work with tooling for - <property>JBossWS</property>. It describes how to easily create a Web Service and a Web Service Client using - JBossWS Runtime and adjust JBossWS and development environment as well.</para> - - <para>If the information on JBossWS tools in this guide isn't enough for you, ask - questions on our <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">forum</ulink>. Your comments and suggestions are also welcome.</para> - </section> + <title>JBoss WS and development environment</title> + <para> + In this chapter you will learn how to change JBossWS preferences and how to set default server and runtime. + </para> + + <section id="jbosswspreference"> + <title>JBossWS Preferences</title> + <para> + In this section you will know how JBossWS preferences can be modified during the development process. + </para> + + <para> + JBossWS preferences can be set on the JBossWS preference page. Click on <emphasis><property>Window > Preferences > JBoss Tools > Web > JBossWS Preferences</property>.</emphasis> + </para> + + <para> + On this page you can manage the JBossWS Runtime. Use the appropriate buttons to <property>Add</property> more runtimes or to <property>Remove</property> those that are not needed. + </para> + + <figure> + <title>JBossWS Preferences Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preference/Jbossws_preference.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Clicking on <emphasis> <property>Add</property> </emphasis> or <emphasis> <property>Edit</property> </emphasis> button will open the form where you can configure a new JBossWS runtime and change the path to JBossWS runtime home folder, modify the name and version of the existing JBossWS runtime settings. Press <property>Finish</property> to apply the changes. + </para> + + <figure> + <title>Edit JBossWS Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preference/Jbossws_preference_new.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + WS container allows Source and JavaDoc locations to be set via the Properties dialog on each contained .jar: right-click on any .jar file in the Project Explorer view, select <emphasis><property>Properties</property></emphasis>. Choose <emphasis><property>Java Source Attachment</property></emphasis> and select location (folder, JAR or zip) containing new source for the chosen .jar using one of the suggested options (workspace, external folder or file) or enter the path manually: + </para> + + <figure> + <title>Classpath Container: Java Source Attachment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preference/jbossws_container1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Click on <emphasis><property>Apply</property></emphasis> and then on <emphasis><property>Ok</property></emphasis>. + </para> + + <para> + To change JavaDoc Location choose <emphasis><property>Javadoc Location</property></emphasis> and specify URL to the documentation generated by Javadoc. The Javadoc location will contain a file called <emphasis><property>package-list</property></emphasis>: + </para> + + <figure> + <title>Classpath Container: Javadoc Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preference/jbossws_container2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Click on <emphasis><property>Apply</property></emphasis> and then on <emphasis><property>Ok</property></emphasis>. + </para> + </section> + + <section id="serverruntime"> + <title>Default Server and Runtime</title> + <para> + Open <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>Web Services</guimenuitem><guimenuitem>Server and Runtime</guimenuitem></menuchoice>. On this page, you can specify a default server and runtime. + </para> + + <para> + For ease of use, the better way is to set runtime to JBoss WS. + </para> + + <para> + After server and runtime are specified, click on the <property>Apply</property> button to save the values. + </para> + + <figure> + <title>Specifying a default server and runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preference/jbossws_server_runtime.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + On the whole, this guide covers the fundamental concepts of work with tooling for <property>JBossWS</property>. It describes how to easily create a Web Service and a Web Service Client using JBossWS Runtime and adjust JBossWS and development environment as well. + </para> + + <para> + If the information on JBossWS tools in this guide isn't enough for you, ask questions on our <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">forum</ulink>. Your comments and suggestions are also welcome. + </para> + </section> </chapter> Modified: trunk/ws/docs/reference/en-US/proc-jbt-generate_a_sample_restful_web_service.xml =================================================================== --- trunk/ws/docs/reference/en-US/proc-jbt-generate_a_sample_restful_web_service.xml 2011-03-17 04:00:50 UTC (rev 29858) +++ trunk/ws/docs/reference/en-US/proc-jbt-generate_a_sample_restful_web_service.xml 2011-03-17 04:18:41 UTC (rev 29859) @@ -209,7 +209,7 @@ </step> <step><title>Browse the web.xml deployment descriptor</title> <para> - Double click the <filename>web.xml</filename> file and note the <parameter>jax.ws.rs.Application</parameter> paramater mapped to the <application>Application</application> class. Note also that: + Double click the <filename>web.xml</filename> file and note the <parameter>jax.ws.rs.Application</parameter> parameter mapped to the <application>Application</application> class. Note also that: </para> <itemizedlist> <listitem> Modified: trunk/ws/docs/reference/en-US/proc-jbt-new_project_example.xml =================================================================== --- trunk/ws/docs/reference/en-US/proc-jbt-new_project_example.xml 2011-03-17 04:00:50 UTC (rev 29858) +++ trunk/ws/docs/reference/en-US/proc-jbt-new_project_example.xml 2011-03-17 04:18:41 UTC (rev 29859) @@ -124,7 +124,7 @@ </step> <step><title>Determine the URL for the web service</title> <para> - Double click the <filename>web.xml</filename> file and note the <parameter>jax.ws.rs.Application</parameter> paramater mapped to the <application>Application</application> class. Note also that: + Double click the <filename>web.xml</filename> file and note the <parameter>jax.ws.rs.Application</parameter> parameter mapped to the <application>Application</application> class. Note also that: </para> <itemizedlist> <listitem> Modified: trunk/ws/docs/reference/en-US/proc-jbt-test_JAX-RS.xml =================================================================== --- trunk/ws/docs/reference/en-US/proc-jbt-test_JAX-RS.xml 2011-03-17 04:00:50 UTC (rev 29858) +++ trunk/ws/docs/reference/en-US/proc-jbt-test_JAX-RS.xml 2011-03-17 04:18:41 UTC (rev 29859) @@ -216,7 +216,7 @@ </para> </formalpara> <figure id="figure-jbt-test_resteasy_JAX-RS_09"> - <title>Custmer data updated</title> + <title>Customer data updated</title> <mediaobject> <imageobject> <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_09.png" format="PNG"/> @@ -263,7 +263,7 @@ </para> </formalpara> <figure id="figure-jbt-test_resteasy_JAX-RS_10"> - <title>Custmer data deleted</title> + <title>Customer data deleted</title> <mediaobject> <imageobject> <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_10.png" format="PNG"/> Modified: trunk/ws/docs/reference/en-US/proc-jbt-test_JAX-WS.xml =================================================================== --- trunk/ws/docs/reference/en-US/proc-jbt-test_JAX-WS.xml 2011-03-17 04:00:50 UTC (rev 29858) +++ trunk/ws/docs/reference/en-US/proc-jbt-test_JAX-WS.xml 2011-03-17 04:18:41 UTC (rev 29859) @@ -59,7 +59,7 @@ <step> <title>Select the required service attributes</title> <para> - Select the <guilabel>Service</guilabel>, <guibutton>Port</guibutton> and <guibutton>Operation</guibutton> from the combo boxes and click <guibutton>OK</guibutton>. + Select the <guilabel>Service</guilabel>, <guibutton>Port</guibutton> and <guibutton>Operation</guibutton> from the comboboxes and click <guibutton>OK</guibutton>. </para> <formalpara><title>Results:</title> <para> Modified: trunk/ws/docs/reference/en-US/proc-jbt-test_resteasy_JAX-RS.xml =================================================================== --- trunk/ws/docs/reference/en-US/proc-jbt-test_resteasy_JAX-RS.xml 2011-03-17 04:00:50 UTC (rev 29858) +++ trunk/ws/docs/reference/en-US/proc-jbt-test_resteasy_JAX-RS.xml 2011-03-17 04:18:41 UTC (rev 29859) @@ -216,7 +216,7 @@ </para> </formalpara> <figure id="figure-jbt-test_resteasy_JAX-RS_09"> - <title>Custmer data updated</title> + <title>Customer data updated</title> <mediaobject> <imageobject> <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_09.png" format="PNG"/> @@ -263,7 +263,7 @@ </para> </formalpara> <figure id="figure-jbt-test_resteasy_JAX-RS_10"> - <title>Custmer data deleted</title> + <title>Customer data deleted</title> <mediaobject> <imageobject> <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_10.png" format="PNG"/> Modified: trunk/ws/docs/reference/en-US/proc-jbt-test_restfulsample_JAX-RS.xml =================================================================== --- trunk/ws/docs/reference/en-US/proc-jbt-test_restfulsample_JAX-RS.xml 2011-03-17 04:00:50 UTC (rev 29858) +++ trunk/ws/docs/reference/en-US/proc-jbt-test_restfulsample_JAX-RS.xml 2011-03-17 04:18:41 UTC (rev 29859) @@ -9,7 +9,7 @@ <substeps> <step><title>Query the available options</title> <para> - Select <guilabel>OPTIONS</guilabel> from the available combo box options. + Select <guilabel>OPTIONS</guilabel> from the available combobox options. </para> </step> <step> @@ -46,7 +46,7 @@ <substeps> <step> <para> - Having established that the <guilabel>GET</guilabel> request is valid, select <guilabel>GET</guilabel> from the available combo box options. + Having established that the <guilabel>GET</guilabel> request is valid, select <guilabel>GET</guilabel> from the available combobox options. </para> </step> <step> Modified: trunk/ws/docs/reference/en-US/testing_a_restful_web_service-web_service_test_view.xml =================================================================== --- trunk/ws/docs/reference/en-US/testing_a_restful_web_service-web_service_test_view.xml 2011-03-17 04:00:50 UTC (rev 29858) +++ trunk/ws/docs/reference/en-US/testing_a_restful_web_service-web_service_test_view.xml 2011-03-17 04:18:41 UTC (rev 29859) @@ -4,31 +4,41 @@ %BOOK_ENTITIES; ]>--> <section id="web_service_test_view-testing_a_restful_web_service"> - <title>Testing a RESTful Web Service</title> + <title>Testing a RESTful Web Service</title> <para> - Testing a RESTful (<acronym>JAX-RS</acronym>) web service is achieved by following a similar procedure to testing a JAX-WS web service. Instead of selecting the JAX-WS option in the combo box, the JAX-RS service is invoked by sending HTTP method requests of the form OPTIONS, GET, POST, PUT and DELETE. As there is no WSDL file associated with a JAX-RS service, the available options can be determined by selecting <guilabel>OPTIONS</guilabel> in the combo box. + Testing a RESTful ( + <acronym> + JAX-RS + </acronym> + ) web service is achieved by following a similar procedure to testing a JAX-WS web service. Instead of selecting the JAX-WS option in the combobox, the JAX-RS service is invoked by sending HTTP method requests of the form OPTIONS, GET, POST, PUT and DELETE. As there is no WSDL file associated with a JAX-RS service, the available options can be determined by selecting <guilabel> OPTIONS </guilabel> in the combobox. </para> - <para> - A JAX-RS web service can be tested by using the <guilabel>Web Service Tester View </guilabel> displayed in <xref linkend="figure-jbt-web_service_test_view"/>. The JAX-RS test is specified by: + + <para> + A JAX-RS web service can be tested by using the <guilabel> Web Service Tester View </guilabel> displayed in <xref linkend="figure-jbt-web_service_test_view"/>. The JAX-RS test is specified by: </para> + <orderedlist> <listitem> <para> - Selecting the <guilabel>OPTIONS</guilabel> combo box option. + Selecting the <guilabel> OPTIONS </guilabel> combobox option. </para> </listitem> + <listitem id="restful_step2"> <para> Entering the url of the JAX-RS web service. </para> </listitem> - </orderedlist> - <para> - The test procedure is discussed in the following sections for both the <application>RestfulSample</application> and the <application>RESTEasy</application> sample projects developed earlier. - </para> - <xi:include href="restfulsample_project-web_service_test_view.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include href="resteasy_sample_project-web_service_test_view.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> -  -</section> \ No newline at end of file +</section> Modified: trunk/ws/docs/reference/en-US/testing_a_web_service-web_service_test_view.xml =================================================================== --- trunk/ws/docs/reference/en-US/testing_a_web_service-web_service_test_view.xml 2011-03-17 04:00:50 UTC (rev 29858) +++ trunk/ws/docs/reference/en-US/testing_a_web_service-web_service_test_view.xml 2011-03-17 04:18:41 UTC (rev 29859) @@ -11,7 +11,7 @@ <orderedlist> <listitem> <para> - Selecting the <guilabel>JAX-WS</guilabel> combo box option. + Selecting the <guilabel>JAX-WS</guilabel> combobox option. </para> </listitem> <listitem id="step2"> Modified: trunk/ws/docs/reference/en-US/topdown.xml =================================================================== --- trunk/ws/docs/reference/en-US/topdown.xml 2011-03-17 04:00:50 UTC (rev 29858) +++ trunk/ws/docs/reference/en-US/topdown.xml 2011-03-17 04:18:41 UTC (rev 29859) @@ -1,403 +1,537 @@ <?xml version="1.0" encoding="ISO-8859-1"?> <chapter id="create_ws_topdown"> - <?dbhtml filename="topdown.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Web Service</keyword> - <keyword>JBossWS Web Service runtime</keyword> - </keywordset> - </chapterinfo> - - <title>Creating a Web Service using JBossWS runtime</title> - <para>In this chapter we provide you with the necessary steps to create a Web Service using - JBossWS runtime. First you need to create a Dynamic Web project:</para> - - <section id="createproject"> - <title>Creating a Dynamic Web project</title> - - <para>Before creating a web service, you should have a Dynamic Web Project created:</para> - <figure> - <title>Dynamic Web Project</title> - <mediaobject> +<?dbhtml filename="topdown.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + + <keyword>Web Service</keyword> + + <keyword>JBossWS Web Service runtime</keyword> + </keywordset> + </chapterinfo> + <title>Creating a Web Service using JBossWS runtime</title> + <para> + In this chapter we provide you with the necessary steps to create a Web Service using JBossWS runtime. First you need to create a Dynamic Web project: + </para> + + <section id="createproject"> + <title>Creating a Dynamic Web project</title> + <para> + Before creating a web service, you should have a Dynamic Web Project created: + </para> + + <figure> + <title>Dynamic Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_webproject_1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Create a Web project by selecting <emphasis> <property>New > Project... > Dynamic Web project</property></emphasis>. Enter the following information: + </para> + + <itemizedlist> + <listitem> + <para> + Project Name: enter a project name + </para> + </listitem> + + <listitem> + <para> + Target runtime: any server depending on your installation. If it is not listed, click <property>New</property> button and browse to the location where it is installed to. You may set <emphasis> <property>Target Runtime</property> </emphasis> to <emphasis> <property>None</property></emphasis>, in this case, you should read the section <xref linkend="addfacet"/>. + </para> + + <figure> + <title>Dynamic Web Project Wizard</title> + <mediaobject> <imageobject> - <imagedata fileref="images/topdown/jbossws_webproject_1.png"/> + <imagedata fileref="images/topdown/jbossws_webproject_2.png"/> </imageobject> - </mediaobject> - </figure> - <para>Create a Web project by selecting <emphasis> - <property>New > Project... > Dynamic Web project</property></emphasis>. Enter the following information: </para> - <itemizedlist> - <listitem> - <para>Project Name: enter a project name</para> - </listitem> - <listitem> - <para>Target runtime: any server depending on your installation. If it is not listed, - click <property>New</property> button and browse to the location where it is installed to. You may set <emphasis> - <property>Target Runtime</property> - </emphasis> to <emphasis> - <property>None</property></emphasis>, in this case, you should read the section <xref linkend="addfacet"/>.</para> - <figure> - <title>Dynamic Web Project Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_webproject_2.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>Configuration: You may <xref linkend="addfacet"/> by clicking the <property>Modify...</property> button. The opened page is like <property>Figure 2.4</property>.</para> - </listitem> - <listitem> - <para>Configure Web Module values:</para> - <figure> - <title>Web Module Settings Configuration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_webproject_3.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - <para>If you added the JBoss Web Service facet to the project, now the <property>Finish</property> button is unavailable. You must click <property>Next</property> button to set more information about the JBoss Web Service facet. The page is like <property>Figure 2.5</property>. Then click on the <property>Finish</property> button.</para> - <para>If you didn't add the JBoss Web Service facet to the project, click on the <property>Finish</property> button. Next you will need to add JBoss Web Service facet to the project.</para> - </section> - - <section id="addfacet"> - <title>Configure JBoss Web Service facet settings</title> - <para>If you have already created a new Dynamic Web project and not set the JBoss Web Service facet to the project, the next step is to add JBoss Web - Service facet to the project. Right-click on the project, select its <emphasis><property>Properties</property></emphasis> and then find <emphasis>Project Facets</emphasis> in the tree-view on the left-side of the project properties dialog. - Tick on the check box for JBoss Web Services. You will see what like this: </para> - <figure id="figure_addfacet_0"> - <title>Choose JBoss Web Service Facet</title> - <mediaobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para> + Configuration: You may <xref linkend="addfacet"/> by clicking the <property>Modify...</property> button. The opened page is like <property>Figure 2.4</property>. + </para> + </listitem> + + <listitem> + <para> + Configure Web Module values: + </para> + + <figure> + <title>Web Module Settings Configuration</title> + <mediaobject> <imageobject> - <imagedata fileref="images/topdown/jbossws_facet_0.png"/> + <imagedata fileref="images/topdown/jbossws_webproject_3.png"/> </imageobject> - </mediaobject> - </figure> - <para>At the bottom-left of the right-side of the project properties dialog, there is a error link: <emphasis><property>Further configuration required...</property></emphasis> . You must click the link to set more information about JBoss Web Service facet.</para> - <para>Click on the <emphasis><property>Further configuration required...</property></emphasis> link. In the opened window</para> - <figure id="figure_addfacet"> - <title>Configure JBoss Web Service Facet</title> - <mediaobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + + <para> + If you added the JBoss Web Service facet to the project, now the <property>Finish</property> button is unavailable. You must click <property>Next</property> button to set more information about the JBoss Web Service facet. The page is like <property>Figure 2.5</property>. Then click on the <property>Finish</property> button. + </para> + + <para> + If you didn't add the JBoss Web Service facet to the project, click on the <property>Finish</property> button. Next you will need to add JBoss Web Service facet to the project. + </para> + </section> + + <section id="addfacet"> + <title>Configure JBoss Web Service facet settings</title> + <para> + If you have already created a new Dynamic Web project and not set the JBoss Web Service facet to the project, the next step is to add JBoss Web Service facet to the project. Right-click on the project, select its <emphasis><property>Properties</property></emphasis> and then find <emphasis>Project Facets</emphasis> in the tree-view on the left-side of the project properties dialog. Tick on the check box for JBoss Web Services. You will see what like this: + </para> + + <figure id="figure_addfacet_0"> + <title>Choose JBoss Web Service Facet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_facet_0.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + At the bottom-left of the right-side of the project properties dialog, there is a error link: <emphasis><property>Further configuration required...</property></emphasis> . You must click the link to set more information about JBoss Web Service facet. + </para> + + <para> + Click on the <emphasis><property>Further configuration required...</property></emphasis> link. In the opened window + </para> + + <figure id="figure_addfacet"> + <title>Configure JBoss Web Service Facet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_facet.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Server Supplied JBossWS Runtime: If you have already set a JBoss runtime to the project's target runtime, you may choose <emphasis> <property>Server Supplied JBossWS Runtime</property> </emphasis> and then click <emphasis> <property>Ok</property> </emphasis> to finish the configuration of JBoss Web Service facet. + </para> + + <para> + If the project has no <emphasis> <property>Target Runtime</property> </emphasis> settings, you should check the second radio button and specify a JBossWS runtime from the list. You also can create a new JBossWS runtime, click on the <emphasis> <property>New...</property> </emphasis> button will bring you to another dialog to configure new JBossWS runtime. + </para> + + <figure id="figure_addfacet1"> + <title>Configure JBossWS Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_newruntime.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + See how to configure a new JBossWS runtime in the <xref linkend="preference"/> section. + </para> + + <para> + After setting the information about JBoss Web Service facet, for saving the result, you should click the <property>Apply</property> or <property>OK</property> button at the bottom-right of the right-side of the project properties dialog. + </para> + </section> + + <section id="topdownwebservice"> + <title>Creating a Web Service from a WSDL document using JBossWS runtime</title> + <para> + In this chapter we provide you with the necessary steps to create a Web Service from a WSDL document using JBossWS runtime. + </para> + + <para> + At first, please make sure that you have already created a dynamic Web project with JBoss Web Service facet installed. + </para> + + <para> + See how to make it in the <xref linkend="createproject"/> section and in the <xref + linkend="addfacet"/> section. + </para> + + <note> + <para> + To use the + <guilabel> + Simple Web Service + </guilabel> + wizard to create this Web Service, replace the + <guilabel> + Class + </guilabel> + and + <guilabel> + Applicaiton Class + </guilabel> + fields with your specific classes, within the instructions in <xref linkend="simple_web_service" />. + </para> + </note> + + <para> + To create a Web Service using JBossWS runtime select<emphasis> <property>File > New > Other > Web Services > Web Service</property> </emphasis> to run Web Service creation wizard. + </para> + + <para> + Let's get through the wizard step-by-step: + </para> + + <figure id="figure_create_ws_topdown"> + <title>New Web Service Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_ws_creation1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + First, please select <property>Top down Java bean Web Service</property> from the Web Service type list, and select a WSDL document from workspace, click on the Server name link on the page will bring you to another dialog. Here you can specify the server to a JBoss Server and Web Service runtime to JBossWS runtime: + </para> + + <figure id="figure_create_ws_topdown_setserver"> + <title>Select Server and Web Service runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_ws_creation1_1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Click on the <emphasis> <property>Finish</property> </emphasis> button to see the next wizard view opened: + </para> + + <figure id="figure_create_ws_topdown1"> + <title>New Web Service Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_ws_creation1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Click on the <emphasis> <property>Next</property> </emphasis> button to proceed: + </para> + + <figure id="figure_create_ws_topdown_codegen"> + <title>New Web Service Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_ws_creation2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + On this page, the default package name comes from the namespace of the WSDL document, you also can change it to any valid package name you want. JAX-WS specification should be set to 2.0 if your JBossWS runtime in JBoss Server is JBossWS native runtime. You can specify a catalog file and binding files if you have them. If you want the wizard to generate empty implementation classes for the Web Service, check the <emphasis> <property>Generate default Web Service implementation classes</property> </emphasis> check box. If you want to update the default Web.xml file with the Web Service servlets configured, check the <emphasis> <property>Update the default Web.xml</property> </emphasis> check box. Click on the <emphasis> <property>Next</property> </emphasis> or on the <emphasis> <property>Finish</property> </emphasis> button to generate code. + </para> + + <para> + Once the Web Service code is generated, you can view the implementation class and add business logic to each method. + </para> + + <figure id="figure_impl_code"> + <title>The generated implementation Java code</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_ws_Impl_code_view.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + View the Web.xml file: + </para> + + <figure id="figure_webxml"> + <title>Web.xml</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_ws_webxml.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + In the next chapter you will find out how to create a Web service from a Java bean. + </para> + </section> + + <section id="bottomupws"> + <title>Creating a Web service from a Java bean using JBossWS runtime</title> + <para> + The Web Service wizard assists you in creating a new Web service, configuring it for deployment, and then deploying it to the server. + </para> + + <para> + To create a Web service from a bean using JBoss WS: + </para> + + <para> + Setup <xref linkend="preference"/>. + </para> + + <para> + Create <xref linkend="createproject"/>. + </para> + + <note> + <para> + To use the + <guilabel> + Simple Web Service + </guilabel> + wizard to create this Web Service, replace the + <guilabel> + Class + </guilabel> + and + <guilabel> + Applicaiton Class + </guilabel> + fields with your specific classes, within the instructions in <xref linkend="simple_web_service" />. + </para> + </note> + + <para> + <xref linkend="addfacet"/> + </para> + + <para> + Create a Web Service from a java bean: + </para> + + <itemizedlist> + <listitem> + <para> + Switch to the Java EE perspective <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Open Perspective</guimenuitem><guimenuitem>Java EE</guimenuitem></menuchoice>. + </para> + </listitem> + + <listitem> + <para> + In the Project Explorer view, select the bean that you created or imported into the source folder of your Web project. + </para> + + <figure> + <title>Select the Bean Created</title> + <mediaobject> <imageobject> - <imagedata fileref="images/topdown/jbossws_facet.png"/> + <imagedata scale="80" fileref="images/topdown/jbossws_bottomup.png"/> </imageobject> - </mediaobject> - </figure> - <para>Server Supplied JBossWS Runtime: If you have already set a JBoss runtime to the - project's target runtime, you may choose <emphasis> - <property>Server Supplied JBossWS Runtime</property> - </emphasis> and then click <emphasis> - <property>Ok</property> - </emphasis> to finish the configuration of JBoss Web Service facet. </para> - <para>If the project has no <emphasis> - <property>Target Runtime</property> - </emphasis> settings, you should check the second radio button and specify a JBossWS - runtime from the list. You also can create a new JBossWS runtime, click on the <emphasis> - <property>New...</property> - </emphasis> button will bring you to another dialog to configure new JBossWS runtime.</para> - <figure id="figure_addfacet1"> - <title>Configure JBossWS Runtime</title> - <mediaobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para> + Click <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice>. Select Web Services in order to display various Web service wizards. Select the Web Service wizard. Click on the <property>Next</property> button. + </para> + + <figure> + <title>New Web Service</title> + <mediaobject> <imageobject> - <imagedata fileref="images/topdown/jbossws_newruntime.png"/> + <imagedata fileref="images/topdown/jbossws_bottomup_1.png"/> </imageobject> - </mediaobject> - </figure> - <para>See how to configure a new JBossWS runtime in the <xref linkend="preference"/> section.</para> - <para>After setting the information about JBoss Web Service facet, for saving the result, you should click the <property>Apply</property> or <property>OK</property> button at the bottom-right of the right-side of the project properties dialog.</para> - </section> - - - <section id="topdownwebservice"> - <title>Creating a Web Service from a WSDL document using JBossWS runtime</title> - <para>In this chapter we provide you with the necessary steps to create a Web Service from a - WSDL document using JBossWS runtime.</para> - <para>At first, please make sure that you have already created a dynamic Web project with - JBoss Web Service facet installed. </para> - <para>See how to make it in the <xref linkend="createproject"/> section and in the <xref - linkend="addfacet"/> section.</para> - <note> - <para> - To use the <guilabel>Simple Web Service</guilabel> wizard to create this Web Service, replace the <guilabel>Class</guilabel> and <guilabel>Applicaiton Class</guilabel> fields with your specific classes, within the instructions in <xref linkend="simple_web_service" />. - </para> - </note> - <para>To create a Web Service using JBossWS runtime select<emphasis> - <property>File > New > Other > Web Services > Web Service</property> - </emphasis> to run Web Service creation wizard. </para> - <para>Let's get through the wizard step-by-step:</para> - <figure id="figure_create_ws_topdown"> - <title>New Web Service Wizard</title> - <mediaobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para> + On the first Web Service wizard page: select <property>Bottom up Java bean Web service</property> as your Web service type, and select the Java bean from which the service will be created: + </para> + + <figure> + <title>Set Web Service Common values</title> + <mediaobject> <imageobject> - <imagedata fileref="images/topdown/jbossws_ws_creation1.png"/> + <imagedata fileref="images/topdown/jbossws_bottomup_2.png"/> </imageobject> - </mediaobject> - </figure> - <para>First, please select <property>Top down Java bean Web Service</property> from the Web - Service type list, and select a WSDL document from workspace, click on the Server name - link on the page will bring you to another dialog. Here you can specify the server to a - JBoss Server and Web Service runtime to JBossWS runtime:</para> - <figure id="figure_create_ws_topdown_setserver"> - <title>Select Server and Web Service runtime</title> - <mediaobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + Select the stages of Web service development that you want to complete using the slider: + </para> + + <itemizedlist> + <listitem> + <para> + Develop: this will develop the WSDL definition and implementation of the Web service. This includes such tasks as creating modules that will contain generated code, WSDL files, deployment descriptors, and Java files when appropriate. + </para> + </listitem> + + <listitem> + <para> + Assemble: this ensures the project that will host the Web service or client gets associated to an EAR when required by the target application server. + </para> + </listitem> + + <listitem> + <para> + Deploy: this will create the deployment code for the service. + </para> + </listitem> + + <listitem> + <para> + Install: this will install and configure the Web module and EARs on the target server. + </para> + </listitem> + + <listitem> + <para> + Start: this will start the server once the service has been installed on it. The server-config.wsdd file will be generated. + </para> + </listitem> + + <listitem> + <para> + Test: this will provide various options for testing the service, such as using the Web Service Explorer or sample JSPs. + </para> + </listitem> + </itemizedlist> + </listitem> + + <listitem> + <para> + Select your server: the default server is displayed. If you want to deploy your service to a different server click the link to specify a different server. + </para> + </listitem> + + <listitem> + <para> + Select your runtime: ensure the JBoss WS runtime is selected. + </para> + </listitem> + + <listitem> + <para> + Select the service project: the project selected in your workspace is displayed. To select a different project click on the project link. If you are deploying to JBoss Application Server you will also be asked to select the EAR associated with the project. Ensure that the project selected as the Client Web Project is different from the Service Web Project, or the service will be overwritten by the client's generated artifacts. + </para> + </listitem> + + <listitem> + <para> + If you want to create a client, select the type of proxy to be generated and repeat the above steps for the client. The better way is to create a web service client project separately. + </para> + </listitem> + </itemizedlist> + + <para> + Click on the <property>Next</property> button. + </para> + </listitem> + + <listitem> + <para> + On the JBoss Web Service Code Generation Configuration page, set the following values: + </para> + + <figure> + <title>Set Web Service values for Code Generation</title> + <mediaobject> <imageobject> - <imagedata fileref="images/topdown/jbossws_ws_creation1_1.png"/> + <imagedata fileref="images/topdown/jbossws_bottomup_3.png"/> </imageobject> - </mediaobject> - </figure> - - <para>Click on the <emphasis> - <property>Finish</property> - </emphasis> button to see the next wizard view opened:</para> - - <figure id="figure_create_ws_topdown1"> - <title>New Web Service Wizard</title> - <mediaobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + Generate WSDL file: select it, you will get a generated WSDL file in your project. But this wsdl's service address location values are not a real address. + </para> + </listitem> + + <listitem> + <para> + After the Web service has been created, the following option can become available depending on the options you selected: Update the default web.xml file. If selected, you may test the web service by Explorer. + </para> + </listitem> + </itemizedlist> + + <para> + Click on the <property>Next</property> button. + </para> + </listitem> + + <listitem> + <para> + On this page, the project is deployed to the server. You can start the server and test the web service. If you want to publish the web service to a UDDI registry, you may click the <property>Next</property> button to publish it. If not, you may click the <property>Finish</property> button. + </para> + + <figure> + <title>Start a Server</title> + <mediaobject> <imageobject> - <imagedata fileref="images/topdown/jbossws_ws_creation1.png"/> + <imagedata fileref="images/topdown/jbossws_bottomup_4.png"/> </imageobject> - </mediaobject> - </figure> - - <para>Click on the <emphasis> - <property>Next</property> - </emphasis> button to proceed:</para> - <figure id="figure_create_ws_topdown_codegen"> - <title>New Web Service Wizard</title> - <mediaobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + + <para> + After the Web Service has been created, the following options may become available depending on the options selected: + </para> + + <itemizedlist> + <listitem> + <para> + the generated web services code + </para> + </listitem> + + <listitem> + <para> + If you selected to generate a WSDL file, you will get the file in your project's wsdl folder. + </para> + + <figure> + <title>The Generated HelloWorldService.wsdl File in the wsdl Folder</title> + <mediaobject> <imageobject> - <imagedata fileref="images/topdown/jbossws_ws_creation2.png"/> + <imagedata scale="80" fileref="images/topdown/jbossws_bottomup_6.png"/> </imageobject> - </mediaobject> - </figure> - <para>On this page, the default package name comes from the namespace of the WSDL document, - you also can change it to any valid package name you want. JAX-WS specification should be - set to 2.0 if your JBossWS runtime in JBoss Server is JBossWS native runtime. You can - specify a catalog file and binding files if you have them. If you want the wizard to - generate empty implementation classes for the Web Service, check the <emphasis> - <property>Generate default Web Service implementation classes</property> - </emphasis> check box. If you want to update the default Web.xml file with the Web Service - servlets configured, check the <emphasis> - <property>Update the default Web.xml</property> - </emphasis> check box. Click on the <emphasis> - <property>Next</property> - </emphasis> or on the <emphasis> - <property>Finish</property> - </emphasis> button to generate code.</para> - - <para>Once the Web Service code is generated, you can view the implementation class and add - business logic to each method.</para> - <figure id="figure_impl_code"> - <title>The generated implementation Java code</title> - <mediaobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para> + If you selected to update the default web.xml, you will test the web service in the browser. Open the Explorer, input the url for the web service according to web.xml plus <property>?wsdl</property>, you will get the WSDL file from Explorer. + </para> + + <figure> + <title>The Updated web.xml file</title> + <mediaobject> <imageobject> - <imagedata fileref="images/topdown/jbossws_ws_Impl_code_view.png"/> + <imagedata scale="80" fileref="images/topdown/jbossws_bottomup_5.png"/> </imageobject> - </mediaobject> - </figure> - <para>View the Web.xml file:</para> - <figure id="figure_webxml"> - <title>Web.xml</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_ws_webxml.png"/> - </imageobject> - </mediaobject> - </figure> -<para>In the next chapter you will find out how to create a Web service from a Java bean.</para> - </section> - - <section id="bottomupws"> - <title>Creating a Web service from a Java bean using JBossWS runtime</title> - <para>The Web Service wizard assists you in creating a new Web service, configuring it for - deployment, and then deploying it to the server.</para> - <para>To create a Web service from a bean using JBoss WS:</para> - <para>Setup <xref linkend="preference"/>.</para> - <para>Create <xref linkend="createproject"/>.</para> - <note> - <para> - To use the <guilabel>Simple Web Service</guilabel> wizard to create this Web Service, replace the <guilabel>Class</guilabel> and <guilabel>Applicaiton Class</guilabel> fields with your specific classes, within the instructions in <xref linkend="simple_web_service" />. - </para> - </note> - <para><xref linkend="addfacet"/></para> - <para>Create a Web Service from a java bean: </para> - <itemizedlist> - <listitem> - <para>Switch to the Java EE perspective <emphasis> - <property>Window > Open Perspective > Java EE</property></emphasis>.</para> - </listitem> - <listitem> - <para>In the Project Explorer view, select the bean that you created or imported into - the source folder of your Web project.</para> - <figure> - <title>Select the Bean Created</title> - <mediaobject> - <imageobject> - <imagedata scale="80" fileref="images/topdown/jbossws_bottomup.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>Click <emphasis> - <property>File > New > Other</property></emphasis>. Select Web Services in order to display various Web service wizards. - Select the Web Service wizard. Click on the <property>Next</property> button.</para> - <figure> - <title>New Web Service</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_bottomup_1.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>On the first Web Service wizard page: select <property>Bottom up Java bean Web - service</property> as your Web service type, and select the Java bean from which - the service will be created:</para> - <figure> - <title>Set Web Service Common values</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_bottomup_2.png"/> - </imageobject> - </mediaobject> - </figure> - <itemizedlist> - <listitem> - <para>Select the stages of Web service development that you want to complete using - the slider: </para> - <itemizedlist> - <listitem> - <para>Develop: this will develop the WSDL definition and implementation of - the Web service. This includes such tasks as creating modules that will - contain generated code, WSDL files, deployment descriptors, and Java - files when appropriate.</para> - </listitem> - <listitem> - <para>Assemble: this ensures the project that will host the Web service or - client gets associated to an EAR when required by the target application - server.</para> - </listitem> - <listitem> - <para>Deploy: this will create the deployment code for the service.</para> - </listitem> - <listitem> - <para>Install: this will install and configure the Web module and EARs on - the target server.</para> - </listitem> - <listitem> - <para>Start: this will start the server once the service has been installed - on it. The server-config.wsdd file will be generated.</para> - </listitem> - <listitem> - <para>Test: this will provide various options for testing the service, such - as using the Web Service Explorer or sample JSPs.</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>Select your server: the default server is displayed. If you want to deploy - your service to a different server click the link to specify a different server. - </para> - </listitem> - <listitem> - <para>Select your runtime: ensure the JBoss WS runtime is selected.</para> - </listitem> - <listitem> - <para>Select the service project: the project selected in your workspace is - displayed. To select a different project click on the project link. If you are - deploying to JBoss Application Server you will also be asked to select the EAR - associated with the project. Ensure that the project selected as the Client Web - Project is different from the Service Web Project, or the service will be - overwritten by the client's generated artifacts.</para> - </listitem> - <listitem> - <para>If you want to create a client, select the type of proxy to be generated - and repeat the above steps for the client. The better way is to create a web - service client project separately.</para> - </listitem> - </itemizedlist> - <para>Click on the <property>Next</property> button.</para> - </listitem> - <listitem> - <para>On the JBoss Web Service Code Generation Configuration page, set the following - values:</para> - <figure> - <title>Set Web Service values for Code Generation</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_bottomup_3.png"/> - </imageobject> - </mediaobject> - </figure> - <itemizedlist> - <listitem> - <para>Generate WSDL file: select it, you will get a generated WSDL file in your - project. But this wsdl's service address location values are not a real - address. </para> - </listitem> - <listitem> - <para>After the Web service has been created, the following option can become - available depending on the options you selected: Update the default web.xm - file. If selected, you may test the web service by Explorer.</para> - </listitem> - </itemizedlist> - <para>Click on the <property>Next</property> button.</para> - </listitem> - <listitem> - <para>On this page, the project is deployed to the server. You can start the server and - test the web service. If you want to publish the web service to a UDDI registry, you - may click the <property>Next</property> button to publish it. If not, you may click - the <property>Finish</property> button.</para> - <figure> - <title>Start a Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_bottomup_4.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - <para>After the Web Service has been created, the following options may become available - depending on the options selected:</para> - <itemizedlist> - <listitem> - <para>the generated web services code</para> - </listitem> - <listitem> - <para>If you selected to generate a WSDL file, you will get the file in your project's wsdl folder.</para> - <figure> - <title>The Generated HelloWorldService.wsdl File in the wsdl Folder</title> - <mediaobject> - <imageobject> - <imagedata scale="80" fileref="images/topdown/jbossws_bottomup_6.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>If you selected to update the default web.xml, you will test the web service in - the browser. Open the Explorer, input the url for the web service according to - web.xml plus <property>?wsdl</property>, you will get the WSDL file from Explorer. </para> - <figure> - <title>The Updated web.xml file</title> - <mediaobject> - <imageobject> - <imagedata scale="80" fileref="images/topdown/jbossws_bottomup_5.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - <para>In the next chapter you will be able to create a Web Service Client from a WSDL document using JBoss WS.</para> - - </section> - + </mediaobject> + </figure> + </listitem> + </itemizedlist> + + <para> + In the next chapter you will be able to create a Web Service Client from a WSDL document using JBoss WS. + </para> + </section> </chapter>

13 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r29858 - trunk/struts/docs/struts_tools_tutorial/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-03-17 00:00:50 -0400 (Thu, 17 Mar 2011) New Revision: 29858 Modified: trunk/struts/docs/struts_tools_tutorial/en-US/coding_files.xml trunk/struts/docs/struts_tools_tutorial/en-US/generating_stub.xml trunk/struts/docs/struts_tools_tutorial/en-US/introduction.xml trunk/struts/docs/struts_tools_tutorial/en-US/struts_application.xml trunk/struts/docs/struts_tools_tutorial/en-US/struts_validation.xml Log: "Fixed spelling errors" Modified: trunk/struts/docs/struts_tools_tutorial/en-US/coding_files.xml =================================================================== --- trunk/struts/docs/struts_tools_tutorial/en-US/coding_files.xml 2011-03-17 03:49:19 UTC (rev 29857) +++ trunk/struts/docs/struts_tools_tutorial/en-US/coding_files.xml 2011-03-17 04:00:50 UTC (rev 29858) @@ -1,433 +1,514 @@ -<?xml version='1.0' encoding='UTF-8'?> -<chapter id="coding_files"> - <?dbhtml filename="coding_files.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Struts</keyword> - <keyword>Struts Application</keyword> - </keywordset> - </chapterinfo> - - <title>Coding the Various Files</title> - <para>We will now code both the Java stub classes just generated, the JSP files left in as - placeholders from previous steps, and a new start JSP page we will have to create.</para> - <section id="JavaStubClasses"> - <title>Java Stub Classes</title> - <itemizedlist> - <listitem> - <para>To finish the two Java classes, switch to the <emphasis> - <property>Package Explorer</property> - </emphasis> view and expand the <emphasis> - <property>JavaSource > sample</property> - </emphasis> folder</para> - </listitem> - </itemizedlist> - <section id="GetNameForm.java"> - <title>GetNameForm.java</title> - <itemizedlist> - <listitem> - <para>Double-click <emphasis> - <property>GetNameForm.java</property> - </emphasis> for editing</para> - </listitem> - - <listitem> - <para>You are looking at a Java stub class that was generated by JBoss - Tools. Now we are going to edit the file</para> - </listitem> - - <listitem> - <para>Add the following attributes at the beginning of the class:</para> - </listitem> - </itemizedlist> - <programlisting role="JAVA"><![CDATA[private String name = ""; -]]></programlisting> - - <itemizedlist> - <listitem> - <para>Inside the reset method, delete the TO DO and throw lines and - add:</para> - </listitem> - </itemizedlist> - <programlisting role="JAVA"><![CDATA[this.name = ""; -]]></programlisting> - - <itemizedlist> - <listitem> - <para>Inside the validate method, delete the TO DO and throw lines and - add:</para> - </listitem> - </itemizedlist> - <programlisting role="JAVA"><![CDATA[ActionErrors errors = new ActionErrors(); - return errors; -]]></programlisting> - - <itemizedlist> - <listitem> - <para>Right-click and select <emphasis> - <property>Source > Generate Getters and Setters</property> - </emphasis>from the context menu</para> - </listitem> - <listitem> - <para>In the dialog box, check the check box for <emphasis> - <property>name</property>,</emphasis> - select First method for Insertion point, and click on the <emphasis> - <property>OK</property> - </emphasis> button</para> - </listitem> - </itemizedlist> - <para>The final <emphasis> - <property>GetNameForm.java</property></emphasis> file should look like this:</para> - <programlisting role="JAVA"><![CDATA[package sample; -import javax.servlet.http.HttpServletRequest; -import org.apache.struts.action.ActionErrors; -import org.apache.struts.action.ActionMapping; - -public class GetNameForm extends org.apache.struts.action.ActionForm -{ - - private String name = ""; - - public String getName() - { - return name; - } - public void setName(String name) - { - this.name = name; - } - - public GetNameForm() - { - } - - public void reset(ActionMapping actionMapping, HttpServletRequest request) - { - this.name = ""; - } - - public ActionErrors validate(ActionMapping actionMapping, - HttpServletRequest request) - { - ActionErrors errors = new ActionErrors(); - return errors; - } -} -]]></programlisting> - - <itemizedlist> - <listitem> - <para>Save the file</para> - </listitem> - </itemizedlist> - </section> - <section id="GreetingAction.java"> - <title>GreetingAction.java</title> - <itemizedlist> - <listitem> - <para>Open <emphasis> - <property>GreetingAction.java</property></emphasis> for editing</para> - </listitem> - <listitem> - <para>Inside the execute method, delete the TO DO lines and add the - following:</para> - </listitem> - </itemizedlist> - - <programlisting role="JAVA"><![CDATA[String name = ((GetNameForm)form).getName(); -String greeting = "Hello, "+name+"!"; -((GetNameForm)form).setName(greeting); -return mapping.findForward(FORWARD_sayHello); -]]></programlisting> - - <para>The final version of <emphasis> - <property>GreetingAction.java</property></emphasis> should look like this:</para> - - <programlisting role="JAVA"><![CDATA[package sample; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import org.apache.struts.action.ActionForm; -import org.apache.struts.action.ActionForward; -import org.apache.struts.action.ActionMapping; - -public class GreetingAction extends org.apache.struts.action.Action -{ - - // Global Forwards - public static final String GLOBAL_FORWARD_getName = "getName"; - - // Local Forwards - public static final String FORWARD_sayHello = "sayHello"; - - public GreetingAction() - { - } - public ActionForward execute(ActionMapping mapping, ActionForm form, - HttpServletRequest request, HttpServletResponse response) throws Exception - { - String name = ((GetNameForm)form).getName(); - String greeting = "Hello, "+name+"!"; - ((GetNameForm)form).setName(greeting); - return mapping.findForward(FORWARD_sayHello); - } -} -]]></programlisting> - <itemizedlist> - <listitem> - <para>Save the file</para> - </listitem> - <listitem> - <para>Close the editors for the two Java files</para> - </listitem> - </itemizedlist> - <para>The last thing left to do is to code the JSP files whose editors should still - be open from having been created as placeholders.</para> - </section> - </section> - <section id="JSPPages"> - <title>JSP Pages</title> - <section id="inputname.jsp"> - <title>inputname.jsp</title> - <para>In this page, the user will enter any name and click the <emphasis> - <property>submit</property> - </emphasis> button. Then, the greeting action will be called through the form.</para> - <itemizedlist> - <listitem> - <para>Click on the <emphasis> - <property>inputname.jsp</property> - </emphasis> tab in the Editing area to bring its editor forward</para> - </listitem> - <listitem> - <para>In the Web Projects view, expand <emphasis> - <property>StrutsHello > Configuration > default - > struts-config.xml > action-mappings</property> - </emphasis> and select <emphasis> - <property>/greeting</property> - </emphasis></para> - </listitem> - <listitem> - <para>Drag it and drop it between the quotes for the <emphasis role="italic"> - <property>"action"</property> - </emphasis> attribute to the - <code><html:form></code> - element in the Source pane of the editor</para> - </listitem> - <listitem> - <para>Then type this text on a new line just below this line:</para> - <programlisting role="XML"><![CDATA[Input name: - ]]></programlisting> - </listitem> - - <listitem> - <para>Select the <emphasis> - <property>Visual</property> - </emphasis> pane of the editor</para> - </listitem> - <listitem> - <para>Then, in the JBoss Tools Palette, expand the <emphasis> - <property>Struts Form</property> - </emphasis> library, select <emphasis> - <property>text</property> - </emphasis>, and drag it onto the box - <note> - <title>Note:</title> - <para>By default there are only four groups on the JBoss Tools - Palette. If you wish to make some group visible click the <emphasis> - <property>Show/Hide</property> - </emphasis> button on the top of palette and in the prompted - dialog check the group (or groups) you want to be shown.</para> - </note> - </para> - </listitem> - </itemizedlist> - <figure> - <title>JBoss Tools Palette</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/struts_application/struts_application_3.png" - /> - </imageobject> - </mediaobject> - </figure> - <itemizedlist> - <listitem> - <para>In the Insert Tag dialog box, type in name for property and select <emphasis> - <property>Finish</property> - </emphasis></para> - </listitem> - <listitem> - <para>In the StrutsForm library in the <property>JBoss Tools Palette</property>, select <emphasis> - <property>submit</property> - </emphasis>, and drag it to right after the text box in the Visual pane - of the editor</para> - </listitem> - <listitem> - <para>Right-click the <emphasis> - <property>submit</property> - </emphasis> button and select - <code><html:submit></code> - Attributes from the context menu</para> - </listitem> - <listitem> - <para>In the Attributes dialog box, select the <emphasis> - <property>value</property> - </emphasis> field and type in "Say Hello!" for its - value</para> - </listitem> - </itemizedlist> - <para>After tidying the page source, the Editor window for the file should look - something like this:</para> - <figure> - <title>Editor Window</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/struts_application/struts_application_4.png" - /> - </imageobject> - </mediaobject> - </figure> - </section> - <section id="greeting.jsp"> - <title>greeting.jsp</title> - <para>Next, we will fill in the result page.</para> - <itemizedlist> - <listitem> - <para>Click on the <emphasis> - <property>greeting.jsp</property> - </emphasis> tab in the Editing area to bring its editor forward</para> - </listitem> - <listitem> - <para>Type in the following code:</para> - </listitem> - </itemizedlist> - <programlisting role="XML"><![CDATA[<html> -<head> - <title>Greeting</title> -</head> - <body> - <p> - </p> - </body> -</html> -]]></programlisting> - - <para>To complete editing of this file, we will use macros from the <property>JBoss Tools - Palette</property>. This palette is a view that should be available to the right of the - editing area.</para> - <itemizedlist> - <listitem> - <para>Click on the <emphasis> - <property>Struts Common</property> - </emphasis> folder in the <property>JBoss Tools Palette</property> to open it</para> - </listitem> - <listitem> - <para>Position the cursor at the beginning of the <emphasis> - <property>greeting.jsp</property></emphasis> file in the - Source pane and then click on <emphasis> - <property>bean taglib</property></emphasis> in the <property>JBoss Tools - Palette</property></para> - </listitem> - </itemizedlist> - <para>This will insert the following line at the top of the file:</para> - <programlisting role="JAVA"><![CDATA[ -<%@ taglib uri="/WEB-INF/struts-bean.tld" prefix="bean" %> -]]></programlisting> - <itemizedlist> - <listitem> - <para>Click on the <emphasis> - <property>Struts Bean</property> - </emphasis> folder in the <property>JBoss Tools Palette</property> to open it</para> - </listitem> - <listitem> - <para>Position the cursor inside the - <code><p></code> - element</para> - </listitem> - <listitem> - <para>Click on <emphasis> - <property>write</property></emphasis> in the <property>JBoss Tools Palette</property></para> - </listitem> - <listitem> - <para>Type in "GetNameForm" for the <emphasis - role="italic"> - <property>name</property> - </emphasis> attribute and add a <emphasis role="italic"> - <property>property</property> - </emphasis> attribute with "name" as its - value</para> - </listitem> - </itemizedlist> - <para>The editor should now look like this:</para> - <figure> - <title>Editor Window</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/struts_application/struts_application_5.png" - /> - </imageobject> - </mediaobject> - </figure> - </section> - <section id="index.jsp"> - <title>index.jsp</title> - <para>Finally, we will need to create and edit an <emphasis> - <property>index.jsp</property></emphasis> page. This page will use - a Struts forward to simply redirect us to the getName global forward.</para> - <itemizedlist> - <listitem> - <para>In the Web Projects view, right-click on <emphasis> - <property>StrutsHello > WEB-ROOT(WebContent)</property> - </emphasis> node and select <emphasis> - <property>New > File > JSP</property> - </emphasis></para> - </listitem> - <listitem> - <para>Type <emphasis> - <property>index</property></emphasis> for Name and click on the <emphasis> - <property>Finish</property> - </emphasis> button</para> - </listitem> - <listitem> - <para>On the <property>JBoss Tools Palette</property>, select the <emphasis> - <property>Struts Common</property> - </emphasis> folder of macros by clicking on it in the palette</para> - </listitem> - <listitem> - <para>Click on the <emphasis> - <property>logic taglib</property></emphasis> icon</para> - </listitem> - <listitem> - <para>Press the <emphasis> - <property>Enter</property> - </emphasis> key in the editor to go to the next line</para> - </listitem> - <listitem> - <para>Back on the palette, select the <emphasis> - <property>Struts Logic</property> - </emphasis> folder of macros</para> - </listitem> - <listitem> - <para>Click on <emphasis> - <property>redirect</property></emphasis></para> - </listitem> - <listitem> - <para>Delete the ending tag, put a forward slash in front of the closing - angle bracket, and type "forward=getName" in front of - the slash</para> - </listitem> - </itemizedlist> - <para>The finished code for the page is shown below:</para> - <programlisting role="JAVA"><![CDATA[<%@ taglib uri="/WEB-INF/struts-logic.tld" prefix="logic" %> -<logic:redirect forward="getName"/> -]]></programlisting> - <itemizedlist> - <listitem> - <para>To save all the edits to files, select <emphasis> - <property>File>Save All</property> - </emphasis> from the menu bar</para> - </listitem> - </itemizedlist> - </section> - </section> - </chapter> \ No newline at end of file +<?xml version='1.0' encoding='UTF-8'?> +<chapter id="coding_files"> +<?dbhtml filename="coding_files.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + + <keyword>Struts</keyword> + + <keyword>Struts Application</keyword> + </keywordset> + </chapterinfo> + <title>Coding the Various Files</title> + <para> + We will now code both the Java stub classes just generated, the JSP files left in as placeholders from previous steps, and a new start JSP page we will have to create. + </para> + + <section id="JavaStubClasses"> + <title>Java Stub Classes</title> + <itemizedlist> + <listitem> + <para> + To finish the two Java classes, switch to the <emphasis> <property>Package Explorer</property> </emphasis> view and expand the <menuchoice><guimenuitem>JavaSource</guimenuitem><guimenuitem>sample</guimenuitem></menuchoice> folder + </para> + </listitem> + </itemizedlist> + + <section id="GetNameForm.java"> + <title>GetNameForm.java</title> + <itemizedlist> + <listitem> + <para> + Double-click <emphasis> <property>GetNameForm.java</property> </emphasis> for editing + </para> + </listitem> + + <listitem> + <para> + You are looking at a Java stub class that was generated by JBoss Tools. Now we are going to edit the file + </para> + </listitem> + + <listitem> + <para> + Add the following attributes at the beginning of the class: + </para> + </listitem> + </itemizedlist> + + <programlisting role="JAVA"> +<![CDATA[private String name = ""; +]]> + </programlisting> + + <itemizedlist> + <listitem> + <para> + Inside the reset method, delete the TO DO and throw lines and add: + </para> + </listitem> + </itemizedlist> + + <programlisting role="JAVA"> +<![CDATA[this.name = ""; +]]> + </programlisting> + + <itemizedlist> + <listitem> + <para> + Inside the validate method, delete the TO DO and throw lines and add: + </para> + </listitem> + </itemizedlist> + + <programlisting role="JAVA"> +<![CDATA[ActionErrors errors = new ActionErrors(); + return errors; +]]> + </programlisting> + + <itemizedlist> + <listitem> + <para> + Right-click and select <menuchoice><guimenuitem>Source</guimenuitem><guimenuitem>Generate Getters and Setters</guimenuitem></menuchoice>from the context menu + </para> + </listitem> + + <listitem> + <para> + In the dialog box, check the check box for <emphasis> <property>name</property>,</emphasis> select First method for Insertion point, and click on the <emphasis> <property>OK</property> </emphasis> button + </para> + </listitem> + </itemizedlist> + + <para> + The final <emphasis> <property>GetNameForm.java</property></emphasis> file should look like this: + </para> + + <programlisting role="JAVA"> +<![CDATA[package sample; +import javax.servlet.http.HttpServletRequest; +import org.apache.struts.action.ActionErrors; +import org.apache.struts.action.ActionMapping; + +public class GetNameForm extends org.apache.struts.action.ActionForm +{ + + private String name = ""; + + public String getName() + { + return name; + } + public void setName(String name) + { + this.name = name; + } + + public GetNameForm() + { + } + + public void reset(ActionMapping actionMapping, HttpServletRequest request) + { + this.name = ""; + } + + public ActionErrors validate(ActionMapping actionMapping, + HttpServletRequest request) + { + ActionErrors errors = new ActionErrors(); + return errors; + } +} +]]> + </programlisting> + + <itemizedlist> + <listitem> + <para> + Save the file + </para> + </listitem> + </itemizedlist> + </section> + + <section id="GreetingAction.java"> + <title>GreetingAction.java</title> + <itemizedlist> + <listitem> + <para> + Open <emphasis> <property>GreetingAction.java</property></emphasis> for editing + </para> + </listitem> + + <listitem> + <para> + Inside the execute method, delete the TO DO lines and add the following: + </para> + </listitem> + </itemizedlist> + + <programlisting role="JAVA"> +<![CDATA[String name = ((GetNameForm)form).getName(); +String greeting = "Hello, "+name+"!"; +((GetNameForm)form).setName(greeting); +return mapping.findForward(FORWARD_sayHello); +]]> + </programlisting> + + <para> + The final version of <emphasis> <property>GreetingAction.java</property></emphasis> should look like this: + </para> + + <programlisting role="JAVA"> +<![CDATA[package sample; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import org.apache.struts.action.ActionForm; +import org.apache.struts.action.ActionForward; +import org.apache.struts.action.ActionMapping; + +public class GreetingAction extends org.apache.struts.action.Action +{ + + // Global Forwards + public static final String GLOBAL_FORWARD_getName = "getName"; + + // Local Forwards + public static final String FORWARD_sayHello = "sayHello"; + + public GreetingAction() + { + } + public ActionForward execute(ActionMapping mapping, ActionForm form, + HttpServletRequest request, HttpServletResponse response) throws Exception + { + String name = ((GetNameForm)form).getName(); + String greeting = "Hello, "+name+"!"; + ((GetNameForm)form).setName(greeting); + return mapping.findForward(FORWARD_sayHello); + } +} +]]> + </programlisting> + + <itemizedlist> + <listitem> + <para> + Save the file + </para> + </listitem> + + <listitem> + <para> + Close the editors for the two Java files + </para> + </listitem> + </itemizedlist> + + <para> + The last thing left to do is to code the JSP files whose editors should still be open from having been created as placeholders. + </para> + </section> + </section> + + <section id="JSPPages"> + <title>JSP Pages</title> + <section id="inputname.jsp"> + <title>inputname.jsp</title> + <para> + In this page, the user will enter any name and click the <emphasis> <property>submit</property> </emphasis> button. Then, the greeting action will be called through the form. + </para> + + <itemizedlist> + <listitem> + <para> + Click on the <emphasis> <property>inputname.jsp</property> </emphasis> tab in the Editing area to bring its editor forward + </para> + </listitem> + + <listitem> + <para> + In the Web Projects view, expand <menuchoice><guimenuitem>StrutsHello</guimenuitem><guimenuitem>Configuration</guimenuitem><guimenuitem>default</guimenuitem><guimenuitem>struts-config.xml</guimenuitem><guimenuitem>action-mappings</guimenuitem></menuchoice> and select <emphasis> <property>/greeting</property> </emphasis> + </para> + </listitem> + + <listitem> + <para> + Drag it and drop it between the quotes for the <emphasis role="italic"> <property>"action"</property> </emphasis> attribute to the <code><html:form></code> element in the Source pane of the editor + </para> + </listitem> + + <listitem> + <para> + Then type this text on a new line just below this line: + </para> + + <programlisting role="XML"> +<![CDATA[Input name: + ]]> + </programlisting> + </listitem> + + <listitem> + <para> + Select the <emphasis> <property>Visual</property> </emphasis> pane of the editor + </para> + </listitem> + + <listitem> + <para> + Then, in the JBoss Tools Palette, expand the <emphasis> <property>Struts Form</property> </emphasis> library, select <emphasis> <property>text</property> </emphasis>, and drag it onto the box + <note> + <title>Note:</title> + <para> + By default there are only four groups on the JBoss Tools Palette. If you wish to make some group visible click the <emphasis> <property>Show/Hide</property> </emphasis> button on the top of palette and in the prompted dialog check the group (or groups) you want to be shown. + </para> + </note> + </para> + </listitem> + </itemizedlist> + + <figure> + <title>JBoss Tools Palette</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/struts_application/struts_application_3.png" + /> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + In the Insert Tag dialog box, type in name for property and select <emphasis> <property>Finish</property> </emphasis> + </para> + </listitem> + + <listitem> + <para> + In the StrutsForm library in the <property>JBoss Tools Palette</property>, select <emphasis> <property>submit</property> </emphasis>, and drag it to right after the text box in the Visual pane of the editor + </para> + </listitem> + + <listitem> + <para> + Right-click the <emphasis> <property>submit</property> </emphasis> button and select <code><html:submit></code> Attributes from the context menu + </para> + </listitem> + + <listitem> + <para> + In the Attributes dialog box, select the <emphasis> <property>value</property> </emphasis> field and type in "Say Hello!" for its value + </para> + </listitem> + </itemizedlist> + + <para> + After tidying the page source, the Editor window for the file should look something like this: + </para> + + <figure> + <title>Editor Window</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/struts_application/struts_application_4.png" + /> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="greeting.jsp"> + <title>greeting.jsp</title> + <para> + Next, we will fill in the result page. + </para> + + <itemizedlist> + <listitem> + <para> + Click on the <emphasis> <property>greeting.jsp</property> </emphasis> tab in the Editing area to bring its editor forward + </para> + </listitem> + + <listitem> + <para> + Type in the following code: + </para> + </listitem> + </itemizedlist> + + <programlisting role="XML"> +<![CDATA[<html> +<head> + <title>Greeting</title> +</head> + <body> + <p> + </p> + </body> +</html> +]]> + </programlisting> + + <para> + To complete editing of this file, we will use macros from the <property>JBoss Tools Palette</property>. This palette is a view that should be available to the right of the editing area. + </para> + + <itemizedlist> + <listitem> + <para> + Click on the <emphasis> <property>Struts Common</property> </emphasis> folder in the <property>JBoss Tools Palette</property> to open it + </para> + </listitem> + + <listitem> + <para> + Position the cursor at the beginning of the <emphasis> <property>greeting.jsp</property></emphasis> file in the Source pane and then click on <emphasis> <property>bean taglib</property></emphasis> in the <property>JBoss Tools Palette</property> + </para> + </listitem> + </itemizedlist> + + <para> + This will insert the following line at the top of the file: + </para> + + <programlisting role="JAVA"> +<![CDATA[ +<%@ taglib uri="/WEB-INF/struts-bean.tld" prefix="bean" %> +]]> + </programlisting> + + <itemizedlist> + <listitem> + <para> + Click on the <emphasis> <property>Struts Bean</property> </emphasis> folder in the <property>JBoss Tools Palette</property> to open it + </para> + </listitem> + + <listitem> + <para> + Position the cursor inside the <code><p></code> element + </para> + </listitem> + + <listitem> + <para> + Click on <emphasis> <property>write</property></emphasis> in the <property>JBoss Tools Palette</property> + </para> + </listitem> + + <listitem> + <para> + Type in "GetNameForm" for the <emphasis + role="italic"> <property>name</property> </emphasis> attribute and add a <emphasis role="italic"> <property>property</property> </emphasis> attribute with "name" as its value + </para> + </listitem> + </itemizedlist> + + <para> + The editor should now look like this: + </para> + + <figure> + <title>Editor Window</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/struts_application/struts_application_5.png" + /> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="index.jsp"> + <title>index.jsp</title> + <para> + Finally, we will need to create and edit an <emphasis> <property>index.jsp</property></emphasis> page. This page will use a Struts forward to simply redirect us to the getName global forward. + </para> + + <itemizedlist> + <listitem> + <para> + In the Web Projects view, right-click on <menuchoice><guimenuitem>StrutsHello</guimenuitem><guimenuitem>WEB-ROOT(WebContent)</guimenuitem></menuchoice> node and select <emphasis> <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>File</guimenuitem><guimenuitem>JSP</guimenuitem></menuchoice> </emphasis> + </para> + </listitem> + + <listitem> + <para> + Type <emphasis> <property>index</property></emphasis> for Name and click on the <emphasis> <property>Finish</property> </emphasis> button + </para> + </listitem> + + <listitem> + <para> + On the <property>JBoss Tools Palette</property>, select the <emphasis> <property>Struts Common</property> </emphasis> folder of macros by clicking on it in the palette + </para> + </listitem> + + <listitem> + <para> + Click on the <emphasis> <property>logic taglib</property></emphasis> icon + </para> + </listitem> + + <listitem> + <para> + Press the <emphasis> <property>Enter</property> </emphasis> key in the editor to go to the next line + </para> + </listitem> + + <listitem> + <para> + Back on the palette, select the <emphasis> <property>Struts Logic</property> </emphasis> folder of macros + </para> + </listitem> + + <listitem> + <para> + Click on <emphasis> <property>redirect</property></emphasis> + </para> + </listitem> + + <listitem> + <para> + Delete the ending tag, put a forward slash in front of the closing angle bracket, and type "forward=getName" in front of the slash + </para> + </listitem> + </itemizedlist> + + <para> + The finished code for the page is shown below: + </para> + + <programlisting role="JAVA"> +<![CDATA[<%@ taglib uri="/WEB-INF/struts-logic.tld" prefix="logic" %> +<logic:redirect forward="getName"/> +]]> + </programlisting> + + <itemizedlist> + <listitem> + <para> + To save all the edits to files, select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>Save All</guimenuitem></menuchoice> from the menu bar + </para> + </listitem> + </itemizedlist> + </section> + </section> +</chapter> Modified: trunk/struts/docs/struts_tools_tutorial/en-US/generating_stub.xml =================================================================== --- trunk/struts/docs/struts_tools_tutorial/en-US/generating_stub.xml 2011-03-17 03:49:19 UTC (rev 29857) +++ trunk/struts/docs/struts_tools_tutorial/en-US/generating_stub.xml 2011-03-17 04:00:50 UTC (rev 29858) @@ -1,51 +1,65 @@ -<?xml version='1.0' encoding='UTF-8'?> -<chapter id="generating_stub"> - <?dbhtml filename="generating_stub.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Struts</keyword> - <keyword>Struts Application</keyword> - </keywordset> - </chapterinfo> - - <title>Generating Stub Coding</title> - <para>We are done with designing the application through the diagram. Now we need to write - code for the action component. We also need to write an action class for the <emphasis> - <property>/greeting</property> - </emphasis> mapping along with a FormBean. To aid in the coding phase, JBoss Developer - Studio can generate Java class stubs for all of the components shown in the diagram.</para> - <itemizedlist> - <listitem> - <para>Switch back to the diagram, by selecting the <emphasis> - <property>Diagram</property> - </emphasis> tab at the bottom of the editor window</para> - </listitem> - <listitem> - <para>Right-click a blank space in the diagram and select <emphasis> - <property>Generate Java Code</property> - </emphasis></para> - </listitem> - <listitem> - <para>Leave everything as is in the dialog box and click <emphasis> - <property>Generate</property> - </emphasis></para> - </listitem> - </itemizedlist> - <para>You should see a screen that says:</para> - <para>Generated classes: 2</para> - <para>Actions: 1</para> - <para>Form beans: 1</para> - <itemizedlist> - <listitem> - <para>Click <emphasis> - <property>Finish</property> - </emphasis></para> - </listitem> - </itemizedlist> - <para>The Java files will be generated in a <emphasis> - <property>JavaSource > sample</property> - </emphasis> folder that you can see in the <property>Package Explorer view</property> under the - "StrutsHello" node. One Action stub and one FormBean stub will have - been generated.</para> - </chapter> \ No newline at end of file +<?xml version='1.0' encoding='UTF-8'?> +<chapter id="generating_stub"> +<?dbhtml filename="generating_stub.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + + <keyword>Struts</keyword> + + <keyword>Struts Application</keyword> + </keywordset> + </chapterinfo> + <title>Generating Stub Coding</title> + <para> + We are done with designing the application through the diagram. Now we need to write code for the action component. We also need to write an action class for the <emphasis> <property>/greeting</property> </emphasis> mapping along with a FormBean. To aid in the coding phase, JBoss Developer Studio can generate Java class stubs for all of the components shown in the diagram. + </para> + + <itemizedlist> + <listitem> + <para> + Switch back to the diagram, by selecting the <emphasis> <property>Diagram</property> </emphasis> tab at the bottom of the editor window + </para> + </listitem> + + <listitem> + <para> + Right-click a blank space in the diagram and select <emphasis> <property>Generate Java Code</property> </emphasis> + </para> + </listitem> + + <listitem> + <para> + Leave everything as is in the dialog box and click <emphasis> <property>Generate</property> </emphasis> + </para> + </listitem> + </itemizedlist> + + <para> + You should see a screen that says: + </para> + + <para> + Generated classes: 2 + </para> + + <para> + Actions: 1 + </para> + + <para> + Form beans: 1 + </para> + + <itemizedlist> + <listitem> + <para> + Click <emphasis> <property>Finish</property> </emphasis> + </para> + </listitem> + </itemizedlist> + + <para> + The Java files will be generated in a <menuchoice><guimenuitem>JavaSource</guimenuitem><guimenuitem>sample</guimenuitem></menuchoice> folder that you can see in the <property>Package Explorer view</property> under the "StrutsHello" node. One Action stub and one FormBean stub will have been generated. + </para> +</chapter> Modified: trunk/struts/docs/struts_tools_tutorial/en-US/introduction.xml =================================================================== --- trunk/struts/docs/struts_tools_tutorial/en-US/introduction.xml 2011-03-17 03:49:19 UTC (rev 29857) +++ trunk/struts/docs/struts_tools_tutorial/en-US/introduction.xml 2011-03-17 04:00:50 UTC (rev 29858) @@ -1,100 +1,124 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="introduction"> - <?dbhtml filename="introduction.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Eclipse</keyword> - <keyword>Java</keyword> - <keyword>JBoss</keyword> - </keywordset> - </chapterinfo> - <title>Introduction</title> - <para>The following chapters describe how to deal with classic/old style of Struts development. We - recommend users to use JBoss Seam to - simplify development, but until then you can read about classical Struts usage here.</para> - - <para>We are going to show you how to create a simple <emphasis> - <property>Struts application</property> - </emphasis> using the JBoss Tools. The completed application will ask a user to enter - a name and click a button. The resulting new page will display the familiar message, - "Hello <name>!"</para> - <para>This document will show you how to create such an application from the beginning, along the - way demonstrating some of the powerful features of JBoss Tools. With the help of our tutorial you will design the - application, generate stub code for the application, fill in the stub coding, compile the - application, and finally run it all from inside the Eclipse.</para> - - <section> - <title>Key Features Struts Tools</title> - - <para>For a start, we propose you to look through the table of main features of Struts - Tools:</para> - <table> - - <title>Key Functionality of Struts Tools</title> - <tgroup cols="2"> - - <colspec colnum="1" align="left" colwidth="2*"/> - <colspec colnum="2" colwidth="4*"/> - - - <thead> - <row> - <entry>Feature</entry> - <entry>Benefit</entry> - - </row> - </thead> - <tbody> - <row> - <entry><para>Struts Support</para></entry> - <entry><para>Step-by-step wizards for creating a new struts project with a number - of predefined templates, importing existing ones and adding struts - capabilities to non-struts web projects.</para></entry> - - </row> - - <row> - <entry><para>Support for Struts Configuration File</para></entry> - <entry><para>Working on file using three modes: diagram, tree and source. - Synchronization between the modes and full control over the code. Easy - moving around the diagram using the Diagram Navigator. Working with - struts projects that have multiple modules. Possibility to use Struts - configuration file debugger allowing to set break points on struts - diagram and then launch the server in debug mode.</para></entry> - - </row> - - <row> - <entry><para>Support for Struts modules</para></entry> - <entry><para>A Struts module (struts-config.xml) is automatically created while - creating a new project. There is also possibility to add new ones or edit - already existing modules in your existing project or while importing Struts project.</para></entry> - - </row> - - <row> - <entry><para>Verification and Validation</para></entry> - <entry><para>All occurring errors will be immediately reported by verification - feature, no matter in what view you are working. Constant validation and - errors checking allows to catch many of the errors during development - process that significantly reduces development time.</para></entry> - - - </row> - </tbody> - </tgroup> - </table> - </section> - - - - <section> - <title>Other relevant resources on the topic</title> - - <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at<ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para> - <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs</ulink>.</para> - - </section> - -</chapter> +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="introduction"> +<?dbhtml filename="introduction.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + + <keyword>Eclipse</keyword> + + <keyword>Java</keyword> + + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + <title>Introduction</title> + <para> + The following chapters describe how to deal with classic/old style of Struts development. We recommend users to use JBoss Seam to simplify development, but until then you can read about classical Struts usage here. + </para> + + <para> + We are going to show you how to create a simple <emphasis> <property>Struts application</property> </emphasis> using the JBoss Tools. The completed application will ask a user to enter a name and click a button. The resulting new page will display the familiar message, "Hello <name>!" + </para> + + <para> + This document will show you how to create such an application from the beginning, along the way demonstrating some of the powerful features of JBoss Tools. With the help of our tutorial you will design the application, generate stub code for the application, fill in the stub coding, compile the application, and finally run it all from inside the Eclipse. + </para> + + <section> + <title>Key Features Struts Tools</title> + <para> + For a start, we propose you to look through the table of main features of Struts Tools: + </para> + + <table> + <title>Key Functionality of Struts Tools</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="2*"/> + + <colspec colnum="2" colwidth="4*"/> + + <thead> + <row> + <entry> + Feature + </entry> + + <entry> + Benefit + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para> + Struts Support + </para> + </entry> + + <entry> + <para> + Step-by-step wizards for creating a new struts project with a number of predefined templates, importing existing ones and adding struts capabilities to non-struts web projects. + </para> + </entry> + </row> + + <row> + <entry> + <para> + Support for Struts Configuration File + </para> + </entry> + + <entry> + <para> + Working on file using three modes: diagram, tree and source. Synchronization between the modes and full control over the code. Easy moving around the diagram using the Diagram Navigator. Working with struts projects that have multiple modules. Possibility to use Struts configuration file debugger allowing to set break points on struts diagram and then launch the server in debug mode. + </para> + </entry> + </row> + + <row> + <entry> + <para> + Support for Struts modules + </para> + </entry> + + <entry> + <para> + A Struts module (struts-config.xml) is automatically created while creating a new project. There is also possibility to add new ones or edit already existing modules in your existing project or while importing Struts project. + </para> + </entry> + </row> + + <row> + <entry> + <para> + Verification and Validation + </para> + </entry> + + <entry> + <para> + All occurring errors will be immediately reported by verification feature, no matter in what view you are working. Constant validation and errors checking allows to catch many of the errors during development process that significantly reduces development time. + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section> + <title>Other relevant resources on the topic</title> + <para> + All JBoss Developer Studio/JBoss Tools release documentation you can find at <ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory. + </para> + + <para> + The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs</ulink>. + </para> + </section> +</chapter> Modified: trunk/struts/docs/struts_tools_tutorial/en-US/struts_application.xml =================================================================== --- trunk/struts/docs/struts_tools_tutorial/en-US/struts_application.xml 2011-03-17 03:49:19 UTC (rev 29857) +++ trunk/struts/docs/struts_tools_tutorial/en-US/struts_application.xml 2011-03-17 04:00:50 UTC (rev 29858) @@ -1,453 +1,527 @@ -<?xml version='1.0' encoding='UTF-8'?> -<chapter id="struts_application"> - <?dbhtml filename="struts_application.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Struts</keyword> - <keyword>Struts Application</keyword> - </keywordset> - </chapterinfo> - - <title>Creating a Simple Struts Application</title> - - <para>Firstly, we assume that you have already launched Eclipse with <property>JBoss Tools</property> installed and - also that the <property>Web Development perspective</property> is the current perspective. (If not, make it - active by selecting <emphasis> - <property>Window > Open Perspective > Other > Web - Development</property> - </emphasis> from the menu bar.)</para> - - <section id="StartingUp"> - <title>Starting Up</title> - <para>We are first going to create a new project for the application.</para> - <itemizedlist> - <listitem> - <para>Go to the menu bar and select <emphasis> - <property>File > New > Struts Project</property> - </emphasis></para> - </listitem> - <listitem> - <para>Next enter "StrutsHello" as the project name</para> - </listitem> - <listitem> - <para>Leave everything else as it is, and click <emphasis> - <property>Next</property> - </emphasis></para> - </listitem> - <listitem> - <para>If you have server runtime already defined, just pass to next point. Otherwise in the <emphasis> - <property>Runtime</property></emphasis> section click the <emphasis> - <property>New</property></emphasis> button and target at needed server runtime environment. Click <emphasis> - <property>Finish</property>.</emphasis></para> - </listitem> - <listitem> - <para>Click <emphasis> - <property>Next</property> - </emphasis></para> - </listitem> - <listitem> - <para>Make sure that <emphasis> - <property>struts-bean.tld</property> - </emphasis>, <emphasis> - <property>struts-html.tld</property> - </emphasis>, and <emphasis> - <property>struts-logic.tld</property> - </emphasis> are checked in the list of included tag libraries and then hit <emphasis> - <property>Finish</property> - </emphasis></para> - </listitem> - </itemizedlist> - <para>A "StrutsHello" node should appear in the <property>Package - Explorer view</property>.</para> - <itemizedlist> - <listitem> - <para>Click the plus sign next to <emphasis> - <property>StrutsHello</property> - </emphasis> to reveal the child nodes</para> - </listitem> - <listitem> - <para>Click the plus sign next to <emphasis> - <property>WebContent</property> - </emphasis> under <emphasis> - <property>StrutsHello</property></emphasis></para> - </listitem> - <listitem> - <para>Click the plus sign next to <emphasis> - <property>WEB-INF</property> - </emphasis> under <emphasis> - <property>WebContent</property></emphasis></para> - </listitem> - <listitem> - <para>Then, double-click on the <emphasis> - <property>struts-config.xml</property> - </emphasis> node to display a diagram of the Struts application configuration - file in the editing area</para> - </listitem> - </itemizedlist> - <para>At this point, its empty except for the background grid lines.</para> - </section> - - <section id="CreatingtheApplicationComponents"> - <?dbhtml filename="CreatingtheApplicationComponents.html"?> - <title>Creating the Application Components</title> - <para>Now, we will design the application by creating the individual components as - placeholders first. (We don't have to complete all of the details inside the components - until afterwards.)</para> - <section id="CreatingJSPPagePlaceholders"> - <title>Creating JSP Page Placeholders</title> - <para>Next, let's create and place two JSP pages. We will not write anything more than basic template code - for the files; they will serve only as placeholders so that we can create links to - them in the diagram. We will write some custom code a little bit later.</para> - <section id="CreatingthePagePlaceholders"> - <title>Creating the Page Placeholders</title> - <itemizedlist> - <listitem> - <para>Bring the <property moreinfo="none">Web Projects view</property> to the front of the <property moreinfo="none">Package Explorer view</property> - by selecting the <emphasis> - <property moreinfo="none">Web Projects</property> - </emphasis> tab next to that tab.</para> - </listitem> - <listitem> - <para>Right-click the <emphasis> - <property moreinfo="none">StrutsHello > WEB-ROOT (WebContent)</property> - </emphasis> folder in the <property moreinfo="none">Web Projects view</property> and select <emphasis> - <property moreinfo="none">New > Folder...</property> - </emphasis></para> - </listitem> - <listitem> - <para>Enter <emphasis> - <property moreinfo="none">pages</property> - </emphasis> for a folder name and click <emphasis> - <property moreinfo="none">Finish</property> - </emphasis></para> - </listitem> - - <listitem> - <para>We will keep our presentation files in this folder</para> - </listitem> - - <listitem> - <para>Right-click the <emphasis> - <property moreinfo="none">pages</property></emphasis> folder and select <emphasis> - <property moreinfo="none">New > File > JSP...</property> - </emphasis> - </para> - </listitem> - <listitem> - <para>For Name type in <emphasis> - <property moreinfo="none">inputname</property> - </emphasis> (the JSP extension will be automatically added to the file), and then click on the <emphasis> - <property moreinfo="none">Next</property> - </emphasis> button</para> - </listitem> - <listitem> - <para> - Untick the <emphasis><property moreinfo="none">use JSP Template</property></emphasis> checkbox, and then click on the - <emphasis><property moreinfo="none">Finish</property></emphasis> button - </para> - </listitem> - <listitem> - <para>Right-click the <emphasis> - <property moreinfo="none">pages</property></emphasis> folder again and select <emphasis> - <property moreinfo="none">New > File > JSP...</property> - </emphasis></para> - </listitem> - <listitem> - <para>For Name type in <emphasis> - <property moreinfo="none">greeting</property> - </emphasis>, and then click on the <emphasis> - <property moreinfo="none">Next</property> - </emphasis> button</para> - </listitem> - <listitem> - <para> - Untick the <emphasis><property moreinfo="none">use JSP Template</property></emphasis> checkbox, and then click on the - <emphasis><property moreinfo="none">Finish</property></emphasis> button - </para> - </listitem> - </itemizedlist> - </section> - - <section id="UpdatingInputnameJSP"> - <title>Adding Template Code to the inputname.jsp File</title> - <para> - The <emphasis><property moreinfo="none">inputname.jsp</property></emphasis> file needs to be populated with some template code. Click on the <emphasis> - <property moreinfo="none">inputname.jsp</property> - </emphasis> page in the <property moreinfo="none">Web Projects view</property>, and then modify the file so it looks like this: - <programlisting><![CDATA[<%@ taglib uri="/WEB-INF/struts-html" prefix="html" %> -<html:html> -<head> - <title></title> -</head> -<body> - <html:form action=""> - </html:form> -</body> -</html:html>]]></programlisting> - </para> - </section> - <section id="PlacingthePagePlaceholders"> - <title>Placing the Page Placeholders</title> - <para>Lets now place the two pages just created on the diagram.</para> - <itemizedlist> - <listitem> - <para>Click on the <emphasis> - <property>struts-config.xml</property> - </emphasis> tab in the editing area to bring the diagram to the - front</para> - </listitem> - <listitem> - <para>Click on the <emphasis> - <property>inputname.jsp</property> - </emphasis> page in the <property>Web Projects view</property>, drag it onto the diagram, and - drop it</para> - </listitem> - <listitem><para>Click on the <emphasis> - <property>greeting.jsp</property> - </emphasis> page in the <property>Web Projects view</property>, drag it onto the diagram, and - drop it to the right of the <emphasis> - <property>/pages/inputname.jsp</property> - </emphasis> icon with some extra space</para></listitem> - </itemizedlist> - <para>You should now have two JSP pages in the diagram.</para> - </section> - </section> - <section id="CreatinganActionMappings"> - <title>Creating an Action Mappings</title> - <para>Using a context menu on the diagram, we are next going to create an Action - mapping.</para> - <itemizedlist> - <listitem> - <para>Right-click between the two icons and select <emphasis> - <property>New > Action</property> - </emphasis></para> - </listitem> - <listitem> - <para>Enter the following values:</para> - </listitem> - </itemizedlist> - <table> - <title>Action values</title> - <tgroup cols="2"> - <tbody> - <row> - <entry>path</entry> - <entry>/greeting</entry> - </row> - <row> - <entry>name</entry> - <entry>GetNameForm</entry> - </row> - <row> - <entry>scope</entry> - <entry>request</entry> - </row> - <row> - <entry>type</entry> - <entry>sample.GreetingAction</entry> - </row> - <row> - <entry>validate</entry> - <entry><leave blank></entry> - </row> - </tbody> - </tgroup> - </table> - <para>("GetNameForm" is the name for a form bean that we will create - later.)</para> - <itemizedlist> - <listitem> - <para>Click <emphasis> - <property>Finish</property> - </emphasis></para> - </listitem> - </itemizedlist> - - <para>The <emphasis> - <property>/greeting</property> - </emphasis> action should appear in four places, in the diagram, under the - <emphasis> - <property>action-mappings</property></emphasis> node, under the <emphasis> - <property>struts-config.xml</property></emphasis> node in Tree view, in <property>Web Projects - view</property> and in the <property>Outline view</property>. Also, note the asterisk to the right of the name, - <emphasis> - <property>struts-config.xml</property>,</emphasis> in the <property>Outline view</property> showing that the file has been changed, but - not saved to disk.</para> - </section> - <section id="CreatingaLink"> - <title>Creating a Link</title> - <para>Let's now create a link from the <emphasis> - <property>inputname.jsp</property></emphasis> page to the action.</para> - <itemizedlist> - <listitem> - <para>On the left-hand side of the diagram in the column of icons, click on the Create New Connection - icon( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/struts_application/struts_application_1.png"/> - </imageobject> - </inlinemediaobject>).</para> - </listitem> - </itemizedlist> - <itemizedlist> - <listitem> - <para>In the connect-the-components mode you are in now, click on the <emphasis> - <property>/pages/inputname.jsp</property> - </emphasis> icon in the diagram and then click on the <emphasis> - <property>/greeting</property> - </emphasis> action</para> - </listitem> - </itemizedlist> - <para>A link will be created from the page to the action.</para> - </section> - <section id="CreatingaForward"> - <title>Creating a Forward</title> - <para>Next, we are going to create a forward for the action.</para> - <itemizedlist> - <listitem> - <para>On the left-hand side of the diagram in the column of icons, click on - the Create New Connection - icon( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/struts_application/struts_application_1.png"/> - </imageobject> - </inlinemediaobject>), again.</para> - </listitem> - </itemizedlist> - - <itemizedlist> - <listitem> - <para>Click on the <emphasis> - <property>/greeting</property> - </emphasis> action icon in the diagram and then click on the <emphasis> - <property>pages/greeting.jsp</property> - </emphasis> icon</para> - </listitem> - <listitem> - <para>That's it. A link will be drawn from the actions new greeting - forward to the <emphasis> - <property>greeting.jsp</property></emphasis> JSP page. Note that the forwards name will be - set based on the name of the target JSP file name. If you don't - like it, you can easily change it</para> - </listitem> - <listitem> - <para>Select the <emphasis> - <property>Tree</property> - </emphasis> tab at the bottom of the editor window (between Diagram and - Source)</para> - </listitem> - <listitem> - <para>Expand the <emphasis> - <property>struts-config.xml/action-mappings/ /greeting</property> - </emphasis> node and then select the greeting forward</para> - </listitem> - <listitem> - <para>In the Properties Editor to the right, change the text to - "sayHello" in the <emphasis> - <property>Name</property></emphasis> field</para> - </listitem> - <listitem> - <para>Select the <emphasis> - <property>Diagram</property> - </emphasis> tab at the bottom of the editor window and see how the diagram - is also updated to reflect the change</para> - </listitem> - </itemizedlist> - </section> - <section id="CreatingaGlobalForward"> - <title>Creating a Global Forward</title> - <para>One last component that we need to create in the diagram is a global forward.</para> - <itemizedlist> - <listitem> - <para>Somewhere in the top-left corner of diagram, right-click and select <emphasis> - <property>New > Global Forward</property> - </emphasis></para> - </listitem> - <listitem> - <para>Enter <emphasis> - <property>getName</property> - </emphasis> in the <emphasis> - <property>Name</property></emphasis> field</para> - </listitem> - <listitem> - <para>Select the <emphasis> - <property>Change...</property> - </emphasis>button for Path</para> - </listitem> - <listitem> - <para>In the Edit Path window, switch to the <emphasis> - <property>Pages</property> - </emphasis> tab</para> - </listitem> - <listitem> - <para>Expand the <emphasis> - <property>StrutsHello > WEB-ROOT (WebContent) > pages</property> - </emphasis> node and then select the inputname.jsp page</para> - </listitem> - <listitem> - <para>Click <emphasis> - <property>Ok</property> - </emphasis>.</para> - </listitem> - <listitem> - <para>Leave the rest of the fields blank and click <emphasis> - <property>OK</property> - </emphasis></para> - </listitem> - </itemizedlist> - <para>A forward object now appears on the diagram and also in the global-forwards folder - in the Outline view.</para> - <itemizedlist> - <listitem> - <para>Tidy up the diagram, by clicking and dragging around each icon, so that - the diagram looks something like this:</para> - </listitem> - </itemizedlist> - <figure> - <title>Diagram View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/struts_application/struts_application_2.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - <section id="CreatingaFormBean"> - <title>Creating a Form Bean</title> - <para>One last thing that we need to do is to create a form bean.</para> - <itemizedlist> - <listitem> - <para>Switch to the Tree viewer in the editor for the <emphasis> - <property>struts-config.xml</property></emphasis> file, by - selecting the <emphasis> - <property>Tree</property> - </emphasis> tab at the bottom of the editor window</para> - </listitem> - <listitem> - <para>Right-click <emphasis> - <property>struts-config.xml > form-beans</property> - </emphasis> and select Create Form Bean</para> - </listitem> - <listitem> - <para>Enter <emphasis> - <property>GetNameForm</property> - </emphasis> in the name field and <emphasis> - <property>sample.GetNameForm</property> - </emphasis> for type</para> - </listitem> - <listitem> - <para>Click <emphasis> - <property>Finish</property> - </emphasis></para> - </listitem> - <listitem> - <para>To save your changes to struts-config.xml, select <emphasis> - <property>File > Save</property> - </emphasis> from the menu bar</para> - </listitem> - </itemizedlist> - <para>Note the disappearance of the asterisk next to the name, <emphasis> - <property>struts-config.xml</property>.</emphasis></para> - </section> - </section> -</chapter> +<?xml version='1.0' encoding='UTF-8'?> +<chapter id="struts_application"> +<?dbhtml filename="struts_application.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + + <keyword>Struts</keyword> + + <keyword>Struts Application</keyword> + </keywordset> + </chapterinfo> + <title>Creating a Simple Struts Application</title> + <para> + Firstly, we assume that you have already launched Eclipse with <property>JBoss Tools</property> installed and also that the <property>Web Development perspective</property> is the current perspective. (If not, make it active by selecting <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Open Perspective</guimenuitem><guimenuitem>Other</guimenuitem><guimenuitem>Web Development</guimenuitem></menuchoice> from the menu bar.) + </para> + + <section id="StartingUp"> + <title>Starting Up</title> + <para> + We are first going to create a new project for the application. + </para> + + <itemizedlist> + <listitem> + <para> + Go to the menu bar and select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Struts Project</guimenuitem></menuchoice> + </para> + </listitem> + + <listitem> + <para> + Next enter "StrutsHello" as the project name + </para> + </listitem> + + <listitem> + <para> + Leave everything else as it is, and click <emphasis> <property>Next</property> </emphasis> + </para> + </listitem> + + <listitem> + <para> + If you have server runtime already defined, just pass to next point. Otherwise in the <emphasis> <property>Runtime</property></emphasis> section click the <emphasis> <property>New</property></emphasis> button and target at needed server runtime environment. Click <emphasis> <property>Finish</property>.</emphasis> + </para> + </listitem> + + <listitem> + <para> + Click <emphasis> <property>Next</property> </emphasis> + </para> + </listitem> + + <listitem> + <para> + Make sure that <emphasis> <property>struts-bean.tld</property> </emphasis>, <emphasis> <property>struts-html.tld</property> </emphasis>, and <emphasis> <property>struts-logic.tld</property> </emphasis> are checked in the list of included tag libraries and then hit <emphasis> <property>Finish</property> </emphasis> + </para> + </listitem> + </itemizedlist> + + <para> + A "StrutsHello" node should appear in the <property>Package Explorer view</property>. + </para> + + <itemizedlist> + <listitem> + <para> + Click the plus sign next to <emphasis> <property>StrutsHello</property> </emphasis> to reveal the child nodes + </para> + </listitem> + + <listitem> + <para> + Click the plus sign next to <emphasis> <property>WebContent</property> </emphasis> under <emphasis> <property>StrutsHello</property></emphasis> + </para> + </listitem> + + <listitem> + <para> + Click the plus sign next to <emphasis> <property>WEB-INF</property> </emphasis> under <emphasis> <property>WebContent</property></emphasis> + </para> + </listitem> + + <listitem> + <para> + Then, double-click on the <emphasis> <property>struts-config.xml</property> </emphasis> node to display a diagram of the Struts application configuration file in the editing area + </para> + </listitem> + </itemizedlist> + + <para> + At this point, its empty except for the background grid lines. + </para> + </section> + + <section id="CreatingtheApplicationComponents"> +<?dbhtml filename="CreatingtheApplicationComponents.html"?> + <title>Creating the Application Components</title> + <para> + Now, we will design the application by creating the individual components as placeholders first. (We don't have to complete all of the details inside the components until afterwards.) + </para> + + <section id="CreatingJSPPagePlaceholders"> + <title>Creating JSP Page Placeholders</title> + <para> + Next, let's create and place two JSP pages. We will not write anything more than basic template code for the files; they will serve only as placeholders so that we can create links to them in the diagram. We will write some custom code a little bit later. + </para> + + <section id="CreatingthePagePlaceholders"> + <title>Creating the Page Placeholders</title> + <itemizedlist> + <listitem> + <para> + Bring the <property moreinfo="none">Web Projects view</property> to the front of the <property moreinfo="none">Package Explorer view</property> by selecting the <emphasis> <property moreinfo="none">Web Projects</property> </emphasis> tab next to that tab. + </para> + </listitem> + + <listitem> + <para> + Right-click the <menuchoice><guimenuitem>StrutsHello</guimenuitem><guimenuitem>WEB-ROOT (WebContent)</guimenuitem></menuchoice> folder in the <property moreinfo="none">Web Projects view</property> and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Folder...</guimenuitem></menuchoice> + </para> + </listitem> + + <listitem> + <para> + Enter <emphasis> <property moreinfo="none">pages</property> </emphasis> for a folder name and click <emphasis> <property moreinfo="none">Finish</property> </emphasis> + </para> + </listitem> + + <listitem> + <para> + We will keep our presentation files in this folder + </para> + </listitem> + + <listitem> + <para> + Right-click the <emphasis> <property moreinfo="none">pages</property></emphasis> folder and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>File</guimenuitem><guimenuitem>JSP...</guimenuitem></menuchoice> + </para> + </listitem> + + <listitem> + <para> + For Name type in <emphasis> <property moreinfo="none">inputname</property> </emphasis> (the JSP extension will be automatically added to the file), and then click on the <emphasis> <property moreinfo="none">Next</property> </emphasis> button + </para> + </listitem> + + <listitem> + <para> + Untick the <emphasis><property moreinfo="none">use JSP Template</property></emphasis> checkbox, and then click on the <emphasis><property moreinfo="none">Finish</property></emphasis> button + </para> + </listitem> + + <listitem> + <para> + Right-click the <emphasis> <property moreinfo="none">pages</property></emphasis> folder again and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>File</guimenuitem><guimenuitem>JSP...</guimenuitem></menuchoice> + </para> + </listitem> + + <listitem> + <para> + For Name type in <emphasis> <property moreinfo="none">greeting</property> </emphasis>, and then click on the <emphasis> <property moreinfo="none">Next</property> </emphasis> button + </para> + </listitem> + + <listitem> + <para> + Untick the <emphasis><property moreinfo="none">use JSP Template</property></emphasis> checkbox, and then click on the <emphasis><property moreinfo="none">Finish</property></emphasis> button + </para> + </listitem> + </itemizedlist> + </section> + + <section id="UpdatingInputnameJSP"> + <title>Adding Template Code to the inputname.jsp File</title> + <para> + The <emphasis><property moreinfo="none">inputname.jsp</property></emphasis> file needs to be populated with some template code. Click on the <emphasis> <property moreinfo="none">inputname.jsp</property> </emphasis> page in the <property moreinfo="none">Web Projects view</property>, and then modify the file so it looks like this: + <programlisting> +<![CDATA[<%@ taglib uri="/WEB-INF/struts-html" prefix="html" %> +<html:html> +<head> + <title></title> +</head> +<body> + <html:form action=""> + </html:form> +</body> +</html:html>]]> + </programlisting> + </para> + </section> + + <section id="PlacingthePagePlaceholders"> + <title>Placing the Page Placeholders</title> + <para> + Lets now place the two pages just created on the diagram. + </para> + + <itemizedlist> + <listitem> + <para> + Click on the <emphasis> <property>struts-config.xml</property> </emphasis> tab in the editing area to bring the diagram to the front + </para> + </listitem> + + <listitem> + <para> + Click on the <emphasis> <property>inputname.jsp</property> </emphasis> page in the <property>Web Projects view</property>, drag it onto the diagram, and drop it + </para> + </listitem> + + <listitem> + <para> + Click on the <emphasis> <property>greeting.jsp</property> </emphasis> page in the <property>Web Projects view</property>, drag it onto the diagram, and drop it to the right of the <emphasis> <property>/pages/inputname.jsp</property> </emphasis> icon with some extra space + </para> + </listitem> + </itemizedlist> + + <para> + You should now have two JSP pages in the diagram. + </para> + </section> + </section> + + <section id="CreatinganActionMappings"> + <title>Creating an Action Mappings</title> + <para> + Using a context menu on the diagram, we are next going to create an Action mapping. + </para> + + <itemizedlist> + <listitem> + <para> + Right-click between the two icons and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Action</guimenuitem></menuchoice> + </para> + </listitem> + + <listitem> + <para> + Enter the following values: + </para> + </listitem> + </itemizedlist> + + <table> + <title>Action values</title> + <tgroup cols="2"> + <tbody> + <row> + <entry> + path + </entry> + + <entry> + /greeting + </entry> + </row> + + <row> + <entry> + name + </entry> + + <entry> + GetNameForm + </entry> + </row> + + <row> + <entry> + scope + </entry> + + <entry> + request + </entry> + </row> + + <row> + <entry> + type + </entry> + + <entry> + sample.GreetingAction + </entry> + </row> + + <row> + <entry> + validate + </entry> + + <entry> + <leave blank> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + ("GetNameForm" is the name for a form bean that we will create later.) + </para> + + <itemizedlist> + <listitem> + <para> + Click <emphasis> <property>Finish</property> </emphasis> + </para> + </listitem> + </itemizedlist> + + <para> + The <emphasis> <property>/greeting</property> </emphasis> action should appear in four places, in the diagram, under the <emphasis> <property>action-mappings</property></emphasis> node, under the <emphasis> <property>struts-config.xml</property></emphasis> node in Tree view, in <property>Web Projects view</property> and in the <property>Outline view</property>. Also, note the asterisk to the right of the name, <emphasis> <property>struts-config.xml</property>,</emphasis> in the <property>Outline view</property> showing that the file has been changed, but not saved to disk. + </para> + </section> + + <section id="CreatingaLink"> + <title>Creating a Link</title> + <para> + Let's now create a link from the <emphasis> <property>inputname.jsp</property></emphasis> page to the action. + </para> + + <itemizedlist> + <listitem> + <para> + On the left-hand side of the diagram in the column of icons, click on the Create New Connection icon( + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/struts_application/struts_application_1.png"/> + </imageobject> + </inlinemediaobject> + ). + </para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para> + In the connect-the-components mode you are in now, click on the <emphasis> <property>/pages/inputname.jsp</property> </emphasis> icon in the diagram and then click on the <emphasis> <property>/greeting</property> </emphasis> action + </para> + </listitem> + </itemizedlist> + + <para> + A link will be created from the page to the action. + </para> + </section> + + <section id="CreatingaForward"> + <title>Creating a Forward</title> + <para> + Next, we are going to create a forward for the action. + </para> + + <itemizedlist> + <listitem> + <para> + On the left-hand side of the diagram in the column of icons, click on the Create New Connection icon( + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/struts_application/struts_application_1.png"/> + </imageobject> + </inlinemediaobject> + ), again. + </para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para> + Click on the <emphasis> <property>/greeting</property> </emphasis> action icon in the diagram and then click on the <emphasis> <property>pages/greeting.jsp</property> </emphasis> icon + </para> + </listitem> + + <listitem> + <para> + That's it. A link will be drawn from the actions new greeting forward to the <emphasis> <property>greeting.jsp</property></emphasis> JSP page. Note that the forwards name will be set based on the name of the target JSP file name. If you don't like it, you can easily change it + </para> + </listitem> + + <listitem> + <para> + Select the <emphasis> <property>Tree</property> </emphasis> tab at the bottom of the editor window (between Diagram and Source) + </para> + </listitem> + + <listitem> + <para> + Expand the <emphasis> <property>struts-config.xml/action-mappings/ /greeting</property> </emphasis> node and then select the greeting forward + </para> + </listitem> + + <listitem> + <para> + In the Properties Editor to the right, change the text to "sayHello" in the <emphasis> <property>Name</property></emphasis> field + </para> + </listitem> + + <listitem> + <para> + Select the <emphasis> <property>Diagram</property> </emphasis> tab at the bottom of the editor window and see how the diagram is also updated to reflect the change + </para> + </listitem> + </itemizedlist> + </section> + + <section id="CreatingaGlobalForward"> + <title>Creating a Global Forward</title> + <para> + One last component that we need to create in the diagram is a global forward. + </para> + + <itemizedlist> + <listitem> + <para> + Somewhere in the top-left corner of diagram, right-click and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Global Forward</guimenuitem></menuchoice> + </para> + </listitem> + + <listitem> + <para> + Enter <emphasis> <property>getName</property> </emphasis> in the <emphasis> <property>Name</property></emphasis> field + </para> + </listitem> + + <listitem> + <para> + Select the <emphasis> <property>Change...</property> </emphasis>button for Path + </para> + </listitem> + + <listitem> + <para> + In the Edit Path window, switch to the <emphasis> <property>Pages</property> </emphasis> tab + </para> + </listitem> + + <listitem> + <para> + Expand the <menuchoice><guimenuitem>StrutsHello</guimenuitem><guimenuitem>WEB-ROOT (WebContent)</guimenuitem><guimenuitem>pages</guimenuitem></menuchoice> node and then select the inputname.jsp page + </para> + </listitem> + + <listitem> + <para> + Click <emphasis> <property>Ok</property> </emphasis>. + </para> + </listitem> + + <listitem> + <para> + Leave the rest of the fields blank and click <emphasis> <property>OK</property> </emphasis> + </para> + </listitem> + </itemizedlist> + + <para> + A forward object now appears on the diagram and also in the global-forwards folder in the Outline view. + </para> + + <itemizedlist> + <listitem> + <para> + Tidy up the diagram, by clicking and dragging around each icon, so that the diagram looks something like this: + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Diagram View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/struts_application/struts_application_2.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="CreatingaFormBean"> + <title>Creating a Form Bean</title> + <para> + One last thing that we need to do is to create a form bean. + </para> + + <itemizedlist> + <listitem> + <para> + Switch to the Tree viewer in the editor for the <emphasis> <property>struts-config.xml</property></emphasis> file, by selecting the <emphasis> <property>Tree</property> </emphasis> tab at the bottom of the editor window + </para> + </listitem> + + <listitem> + <para> + Right-click <menuchoice><guimenuitem>struts-config.xml</guimenuitem><guimenuitem>form-beans</guimenuitem></menuchoice> and select Create Form Bean + </para> + </listitem> + + <listitem> + <para> + Enter <emphasis> <property>GetNameForm</property> </emphasis> in the name field and <emphasis> <property>sample.GetNameForm</property> </emphasis> for type + </para> + </listitem> + + <listitem> + <para> + Click <emphasis> <property>Finish</property> </emphasis> + </para> + </listitem> + + <listitem> + <para> + To save your changes to struts-config.xml, select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>Save</guimenuitem></menuchoice> from the menu bar + </para> + </listitem> + </itemizedlist> + + <para> + Note the disappearance of the asterisk next to the name, <emphasis> <property>struts-config.xml</property>.</emphasis> + </para> + </section> + </section> +</chapter> Modified: trunk/struts/docs/struts_tools_tutorial/en-US/struts_validation.xml =================================================================== --- trunk/struts/docs/struts_tools_tutorial/en-US/struts_validation.xml 2011-03-17 03:49:19 UTC (rev 29857) +++ trunk/struts/docs/struts_tools_tutorial/en-US/struts_validation.xml 2011-03-17 04:00:50 UTC (rev 29858) @@ -1,239 +1,499 @@ -<?xml version='1.0' encoding='UTF-8'?> -<chapter id="struts_validation"> - <?dbhtml filename="struts_validation.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Developer Studio</keyword> - <keyword>Struts</keyword> - <keyword>Struts Validation</keyword> - </keywordset> - </chapterinfo> -<title>Struts Validation Examples</title> - -<para><property>Validation</property> of input is an important part of any Web application. All Apache Jakarta frameworks, -including Struts, can use a common Jakarta Validation Framework for streamlining this aspect of Web -application development. The Validation Framework allows you to define validation rules and then apply these rules on the client-side or the server-side.</para> - - <para>JBoss Developer Studio makes using the <property>Validation Framework</property> in Struts even easier with the help of a specialized editor for the XML files that controls validation in a project. In this document, we'll show you how this all works by creating some simple client-side validation and server-side validation examples.</para> - -<section id="StartingPoint"> -<?dbhtml filename="StartingPoint.html"?> -<title>Starting Point</title> -<para>The example assumes that you have already created our sample "StrutsHello" application from the -Getting Started Guide for Creating a Struts Application. You should have the JBoss Developer Studio perspective - open on this StrutsHello project.</para> -</section> - -<section id="DefiningTheValidationRule"> -<?dbhtml filename="DefiningTheValidationRule.html"?> -<title>Defining the Validation Rule</title> -<para>In these steps you will set up the validation that can be used for either client-side or -server side validation. You need to enable validation as a part of the project, define an error message, and tie it into an appropriate part of the application.</para> - -<itemizedlist> -<listitem><para>Right-click on a "plug-ins" node under the <emphasis><property>StrutsHello > Configuration > default > struts-config.xml</property></emphasis> node in the Web Projects view and select <emphasis><property>Create Special Plugin > Validators</property></emphasis> from the context menu</para></listitem> -<listitem><para>Further down in the Web Projects view, right-click on the -<emphasis><property>StrutsHello > ResourceBundles</property></emphasis> node and select <emphasis><property> New > Properties File...</property></emphasis>from the context menu</para></listitem> -<listitem><para>In the dialog box, click on the <emphasis><property>Browse...</property></emphasis>button next to the Folder field, expand the - JavaSource folder in this next dialog box, select the sample subfolder, and click on the <emphasis><property>OK</property></emphasis> button</para></listitem> - <listitem><para>Back in the first dialog box, type in "applResources" for the Name field and click on the <emphasis><property>Finish</property></emphasis> button</para></listitem> -<listitem><para>Right-click on a newly created file and select <emphasis><property>New > Default Error Messages</property></emphasis> - from the context menu</para></listitem> - -<listitem><para>Drag up the sample.applResources icon until you can drop it on the resources folder under struts-config.xml</para></listitem> -<listitem><para>Select<emphasis><property> File > Save </property></emphasis>All from the menu bar</para></listitem> -<listitem><para>Select validation.xml under the <emphasis><property>StrutsHello > Validation</property></emphasis> node and double-click it to open it with the JBoss Tools XML Editor</para></listitem> -<listitem><para>Here you must create a Formset.</para></listitem> -<listitem><para>In the validation.xml file editor click the button <emphasis><property>Create Formset</property></emphasis> on the panel <emphasis><property>Formsets</property></emphasis></para></listitem> -<listitem><para>In the dialog <emphasis><property>Add Formset</property></emphasis> fill the fields <emphasis><property>Language</property></emphasis> and <emphasis><property>Country</property></emphasis> or just leave them empty to create a default formset. Click <emphasis><property>OK</property></emphasis></para></listitem> -</itemizedlist> -<figure> - <title>Create Formset</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/struts_validation/struts_validation.png"/> - </imageobject> -</mediaobject> -</figure> -<itemizedlist> -<listitem><para>Expand the "form-beans" node under the <emphasis><property>StrutsHello > Configuration > default > struts-config.xml node.</property></emphasis> Then, drag the form bean "GetNameForm" and drop it onto a formset in the <property>XML</property> Editor</para></listitem> -<listitem><para>In the Validation Editor, expand the formset node, right-click GetNameForm, and select <emphasis><property>Create Field...</property></emphasis> from the context menu</para></listitem> -<listitem><para>Enter a name for Property in the dialog box. A new property will be created:</para></listitem> -</itemizedlist> -<figure> - <title>New Property Is Added</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/struts_validation/struts_validation_2.png"/> - </imageobject> -</mediaobject> -</figure> -<itemizedlist> -<listitem><para>In the Properties view for the name field to the right of the "tree" for the validation.xml file, click on the <emphasis><property>Change...</property></emphasis>button next to the Depends entry field</para></listitem> -<listitem><para>In the displayed double list, select <emphasis><property>required</property></emphasis> from the left list and then click <emphasis><property>Add</property></emphasis></para></listitem> - <listitem><para>Click <emphasis><property>Ok</property></emphasis></para></listitem> -<listitem><para>Right-click name and select <emphasis><property>Add Arg...</property></emphasis> from the context menu</para></listitem> -<listitem><para>In the Add Arg dialog box, click on the <emphasis><property>Change...</property></emphasis>button next to the <emphasis><property>Key</property></emphasis> field</para></listitem> - <listitem><para>In the Key dialog box that appears now, click on the <emphasis><property>Add</property></emphasis> button</para></listitem> - <listitem><para>Enter "name.required" in the Name field, and enter a person's name in the Value field</para></listitem> - <listitem><para>Click <emphasis><property>Finish</property></emphasis>, then <emphasis><property>Ok</property></emphasis>, and then <emphasis><property>Ok</property></emphasis> again</para></listitem> -<listitem><para>Select <emphasis><property>File > Save All</property></emphasis> from the menu bar</para></listitem> -</itemizedlist> -</section> - -<section id="Client-SideValidation"> -<?dbhtml filename="Client-SideValidation.html"?> -<title>Client-Side Validation</title> -<para>Client-side <property>validation</property> uses a scripting language (like JavaScript) running in the client browser to actually do the <property>validation</property>. In a Struts application using the <property>Validation</property> Framework, however, you don't actually have to do any of the script coding. The <property>Validation</property> Framework handles this.</para> -<para>To see how this works in our application, you'll just need to make a couple of modifications to one of the JSP files.</para> -<itemizedlist> -<listitem><para>Double-click inputname.jsp under <emphasis><property>StrutsHello > WEB-ROOT(WebContent) > pages</property></emphasis> to open it for editing</para></listitem> -<listitem><para>Find the tag near the top and hit Return to make a new line under it</para></listitem> - <listitem><para>In the JBoss Tools Palette view to the right, open the Struts HTML folder and click on the javascript tag</para></listitem> -<listitem><para>Back in the editor, just in front of the closing slash for this inserted tag, hit Ctrl+Space and select "formName" from the prompting menu</para></listitem> -<listitem><para>Over in the Web Projects view, select GetNameForm under the <emphasis><property>StrutsHello > Configuration > default > struts-config.xml > form-beans</property></emphasis> node, drag it, and drop it between the quotes in the editor</para></listitem> -<listitem><para>Modify the <code><html:form></code> tag by inserting this attribute:</para></listitem> -</itemizedlist> -<programlisting role="XML"><![CDATA[onsubmit="return validateGetNameForm(this)" -]]></programlisting> -<para></para> -<para>The file should now look like this:</para> -<programlisting role="XML"><![CDATA[ -<%@ taglib uri="/WEB-INF/struts-html" prefix="html" %> - -<html:html > - <head> - <html:javascript formName="GetNameForm"/> - <title></title> - </head> - <body> - <html:form action="/greeting.do" onsubmit="return validateGetNameForm(this)"> - Input name:<html:text property="name"/><html:submit value="Say Hello!"/> - </html:form> - </body> -</html:html> -]]></programlisting> -<itemizedlist> -<listitem><para>Select<emphasis><property> File > Save </property></emphasis>from the menu bar</para></listitem> -<listitem><para>Start JBoss Application Server by clicking on its icon (a right-pointing arrow) in the toolbar</para></listitem> - <listitem><para>Click the Run icon(<inlinemediaobject> <imageobject> - <imagedata fileref="images/struts_validation/struts_validation_1.png"/> - </imageobject></inlinemediaobject>) or right click your project folder and select <emphasis><property>Run As > Run on Server</property></emphasis></para></listitem> -</itemizedlist> - -<itemizedlist><listitem><para>In the browser window, click on the "Say Hello!" button without having entered any name in the form</para></listitem></itemizedlist> -<para>A JavaScript error message should be displayed in an alert box.</para> -</section> -<section id="Server-SideValidation"> -<?dbhtml filename="Server-SideValidation.html"?> -<title>Server Side Validation</title> -<para>Server side validation does the validation inside the application on the server. In a Struts application using the Validation Framework, you still don't have to do any of the actual validation coding. The Validation Framework handles this. You will though have to make a few changes to the JSP file you modified for client-side validation along with a change to an action and a few changes to the form bean class.</para> -</section> - -<section id="EditingTheJSPFile"> -<?dbhtml filename="EditingTheJSPFile.html"?> -<title>Editing the JSP File</title> -<itemizedlist> -<listitem><para>Reopen inputname.jsp for editing</para></listitem> -<listitem><para>Delete the <emphasis role="italic"><property>"onsubmit"</property></emphasis> attribute in the <code><html:form></code> element that you put in for client-side validation</para></listitem> - -<listitem><para>Add an <code><html:errors/></code> tag after the - <code><html:form></code> - tag</para></listitem> -</itemizedlist> -<para>The JSP file should now look like this:</para> - - <programlisting role="XML"><![CDATA[<%@ taglib uri="/WEB-INF/struts-html" prefix="html" %> -<html:html > -<head> - <html:javascript formName="GetNameForm"/> - <title></title> - </head> - <body> - <html:form action="/greeting.do" >Input name:<html:text property="name"/> - <html:submit value="Say Hello!"/> - </html:form> - <html:errors/> - </body> -</html:html> -]]></programlisting> - -</section> - -<section id="EditingTheAction"> -<?dbhtml filename="EditingTheAction.html"?> -<title>Editing the Action</title> -<itemizedlist> -<listitem><para>In the Web Projects view, expand the node under the <emphasis><property>StrutsHello > Configuration > default > struts-config.xml > action-mappings</property></emphasis> node, right-click the <emphasis><property>/greeting</property></emphasis> action, and then select <emphasis><property>Properties...</property></emphasis>from the context menu</para></listitem> - - <listitem><para>In the Edit Properties window, insert the cursor into the value column for the input property and click on the <property>...</property> button</para></listitem> - - <listitem><para>In the dialog box, make sure the Pages tab is selected, select <emphasis><property>StrutsHello > WEB-ROOT(WebContent) > pages > inputname.jsp</property></emphasis>, click the <emphasis><property>Ok</property></emphasis> button, and then click on the <emphasis><property>Close</property></emphasis> button</para></listitem> -</itemizedlist> -</section> -<section id="EditingTheFormBean"> -<?dbhtml filename="EditingTheFormBean.html"?> - -<title>Editing the Form Bean</title> -<itemizedlist> -<listitem><para>Right-click the <emphasis><property>/greeting</property></emphasis> action again and select Open Form-bean Source to open the GetNameForm.java file for editing</para></listitem> -<listitem><para>Change the class that it extends from: <emphasis><property>org.apache.struts.action.ActionForm</property></emphasis> to <emphasis><property>org.apache.struts.validator.ValidatorForm</property></emphasis></para></listitem> -<listitem><para>Comment out a validate method</para></listitem> -</itemizedlist> -<para>The file should now look like this:</para> -<programlisting role="JAVA"><![CDATA[package sample; -import javax.servlet.http.HttpServletRequest; -import org.apache.struts.action.ActionErrors; -import org.apache.struts.action.ActionMapping; -public class GetNameForm extends - -org.apache.struts.validator.ValidatorForm -{ - - private String name = ""; - - /** - * @return Returns the name. - */ - public String getName() - { - return name; - } - - /** - * @param name The name to set. - */ - public void setName(String name) - { - this.name = name; - } - - public GetNameForm () - { - } - - public void reset(ActionMapping actionMapping, - HttpServletRequest request) - { - this.name = ""; - } - - // public ActionErrors validate(ActionMapping actionMapping, - // HttpServletRequest request) - //{ - // ActionErrors errors = new ActionErrors(); - // return errors; - // } - } -]]></programlisting> - -<itemizedlist> -<listitem><para>Select <emphasis><property>File > Save All </property></emphasis>from the menu bar</para></listitem> -<listitem><para>Reload the application into JBoss AS by clicking on the "Change Time Stamp" icon (a finger pointing with a little star) in the toolbar</para></listitem> -<listitem><para>Run the application</para></listitem> -<listitem><para>In the browser window, click on the "Say Hello!" button without having entered any name in the form</para></listitem> -</itemizedlist> -<para>The error message should appear in a refreshed version of the form.</para> -</section> - -</chapter> \ No newline at end of file +<?xml version='1.0' encoding='UTF-8'?> +<chapter id="struts_validation"> +<?dbhtml filename="struts_validation.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + + <keyword>Struts</keyword> + + <keyword>Struts Validation</keyword> + </keywordset> + </chapterinfo> + <title>Struts Validation Examples</title> + <para> + <property>Validation</property> of input is an important part of any Web application. All Apache Jakarta frameworks, including Struts, can use a common Jakarta Validation Framework for streamlining this aspect of Web application development. The Validation Framework allows you to define validation rules and then apply these rules on the client-side or the server-side. + </para> + + <para> + JBoss Developer Studio makes using the <property>Validation Framework</property> in Struts even easier with the help of a specialized editor for the XML files that controls validation in a project. In this document, we'll show you how this all works by creating some simple client-side validation and server-side validation examples. + </para> + + <section id="StartingPoint"> +<?dbhtml filename="StartingPoint.html"?> + <title>Starting Point</title> + <para> + The example assumes that you have already created our sample "StrutsHello" application from the Getting Started Guide for Creating a Struts Application. You should have the JBoss Developer Studio perspective open on this StrutsHello project. + </para> + </section> + + <section id="DefiningTheValidationRule"> +<?dbhtml filename="DefiningTheValidationRule.html"?> + <title>Defining the Validation Rule</title> + <para> + In these steps you will set up the validation that can be used for either client-side or server side validation. You need to enable validation as a part of the project, define an error message, and tie it into an appropriate part of the application. + </para> + + <itemizedlist> + <listitem> + <para> + Right-click on a "plug-ins" node under the <menuchoice><guimenuitem>StrutsHello</guimenuitem><guimenuitem>Configuration</guimenuitem><guimenuitem>default</guimenuitem><guimenuitem>struts-config.xml</guimenuitem></menuchoice> node in the Web Projects view and select <menuchoice><guimenuitem>Create Special Plugin</guimenuitem><guimenuitem>Validators</guimenuitem></menuchoice> from the context menu + </para> + </listitem> + + <listitem> + <para> + Further down in the Web Projects view, right-click on the <menuchoice><guimenuitem>StrutsHello</guimenuitem><guimenuitem>ResourceBundles</guimenuitem></menuchoice> node and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Properties File...</guimenuitem></menuchoice> from the context menu + </para> + </listitem> + + <listitem> + <para> + In the dialog box, click on the <emphasis><property>Browse...</property></emphasis>button next to the Folder field, expand the JavaSource folder in this next dialog box, select the sample subfolder, and click on the <emphasis><property>OK</property></emphasis> button + </para> + </listitem> + + <listitem> + <para> + Back in the first dialog box, type in "applResources" for the Name field and click on the <emphasis><property>Finish</property></emphasis> button + </para> + </listitem> + + <listitem> + <para> + Right-click on a newly created file and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Default Error Messages</guimenuitem></menuchoice> from the context menu + </para> + </listitem> + + <listitem> + <para> + Drag up the sample.applResources icon until you can drop it on the resources folder under struts-config.xml + </para> + </listitem> + + <listitem> + <para> + Select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>Save All</guimenuitem></menuchoice> from the menu bar + </para> + </listitem> + + <listitem> + <para> + Select validation.xml under the <menuchoice><guimenuitem>StrutsHello</guimenuitem><guimenuitem>Validation</guimenuitem></menuchoice> node and double-click it to open it with the JBoss Tools XML Editor + </para> + </listitem> + + <listitem> + <para> + Here you must create a Formset. + </para> + </listitem> + + <listitem> + <para> + In the validation.xml file editor click the button <emphasis><property>Create Formset</property></emphasis> on the panel <emphasis><property>Formsets</property></emphasis> + </para> + </listitem> + + <listitem> + <para> + In the dialog <emphasis><property>Add Formset</property></emphasis> fill the fields <emphasis><property>Language</property></emphasis> and <emphasis><property>Country</property></emphasis> or just leave them empty to create a default formset. Click <emphasis><property>OK</property></emphasis> + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Create Formset</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/struts_validation/struts_validation.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + Expand the "form-beans" node under the <menuchoice><guimenuitem>StrutsHello</guimenuitem><guimenuitem>Configuration</guimenuitem><guimenuitem>default</guimenuitem><guimenuitem>struts-config.xml node.</guimenuitem></menuchoice> Then, drag the form bean "GetNameForm" and drop it onto a formset in the <property>XML</property> Editor + </para> + </listitem> + + <listitem> + <para> + In the Validation Editor, expand the formset node, right-click GetNameForm, and select <emphasis><property>Create Field...</property></emphasis> from the context menu + </para> + </listitem> + + <listitem> + <para> + Enter a name for Property in the dialog box. A new property will be created: + </para> + </listitem> + </itemizedlist> + + <figure> + <title>New Property Is Added</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/struts_validation/struts_validation_2.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + In the Properties view for the name field to the right of the "tree" for the validation.xml file, click on the <emphasis><property>Change...</property></emphasis>button next to the Depends entry field + </para> + </listitem> + + <listitem> + <para> + In the displayed double list, select <emphasis><property>required</property></emphasis> from the left list and then click <emphasis><property>Add</property></emphasis> + </para> + </listitem> + + <listitem> + <para> + Click <emphasis><property>Ok</property></emphasis> + </para> + </listitem> + + <listitem> + <para> + Right-click name and select <emphasis><property>Add Arg...</property></emphasis> from the context menu + </para> + </listitem> + + <listitem> + <para> + In the Add Arg dialog box, click on the <emphasis><property>Change...</property></emphasis>button next to the <emphasis><property>Key</property></emphasis> field + </para> + </listitem> + + <listitem> + <para> + In the Key dialog box that appears now, click on the <emphasis><property>Add</property></emphasis> button + </para> + </listitem> + + <listitem> + <para> + Enter "name.required" in the Name field, and enter a person's name in the Value field + </para> + </listitem> + + <listitem> + <para> + Click <emphasis><property>Finish</property></emphasis>, then <emphasis><property>Ok</property></emphasis>, and then <emphasis><property>Ok</property></emphasis> again + </para> + </listitem> + + <listitem> + <para> + Select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>Save All</guimenuitem></menuchoice> from the menu bar + </para> + </listitem> + </itemizedlist> + </section> + + <section id="Client-SideValidation"> +<?dbhtml filename="Client-SideValidation.html"?> + <title>Client-Side Validation</title> + <para> + Client-side <property>validation</property> uses a scripting language (like JavaScript) running in the client browser to actually do the <property>validation</property>. In a Struts application using the <property>Validation</property> Framework, however, you don't actually have to do any of the script coding. The <property>Validation</property> Framework handles this. + </para> + + <para> + To see how this works in our application, you'll just need to make a couple of modifications to one of the JSP files. + </para> + + <itemizedlist> + <listitem> + <para> + Double-click inputname.jsp under <menuchoice><guimenuitem>StrutsHello</guimenuitem><guimenuitem>WEB-ROOT(WebContent)</guimenuitem><guimenuitem>pages</guimenuitem></menuchoice> to open it for editing + </para> + </listitem> + + <listitem> + <para> + Find the tag near the top and hit Return to make a new line under it + </para> + </listitem> + + <listitem> + <para> + In the JBoss Tools Palette view to the right, open the Struts HTML folder and click on the javascript tag + </para> + </listitem> + + <listitem> + <para> + Back in the editor, just in front of the closing slash for this inserted tag, hit Ctrl+Space and select "formName" from the prompting menu + </para> + </listitem> + + <listitem> + <para> + Over in the Web Projects view, select GetNameForm under the <menuchoice><guimenuitem>StrutsHello</guimenuitem><guimenuitem>Configuration</guimenuitem><guimenuitem>default</guimenuitem><guimenuitem>struts-config.xml</guimenuitem><guimenuitem>form-beans</guimenuitem></menuchoice> node, drag it, and drop it between the quotes in the editor + </para> + </listitem> + + <listitem> + <para> + Modify the <code><html:form></code> tag by inserting this attribute: + </para> + </listitem> + </itemizedlist> + + <programlisting role="XML"> +<![CDATA[onsubmit="return validateGetNameForm(this)" +]]> + </programlisting> + + <para></para> + + <para> + The file should now look like this: + </para> + + <programlisting role="XML"> +<![CDATA[ +<%@ taglib uri="/WEB-INF/struts-html" prefix="html" %> + +<html:html > + <head> + <html:javascript formName="GetNameForm"/> + <title></title> + </head> + <body> + <html:form action="/greeting.do" onsubmit="return validateGetNameForm(this)"> + Input name:<html:text property="name"/><html:submit value="Say Hello!"/> + </html:form> + </body> +</html:html> +]]> + </programlisting> + + <itemizedlist> + <listitem> + <para> + Select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>Save</guimenuitem></menuchoice> from the menu bar + </para> + </listitem> + + <listitem> + <para> + Start JBoss Application Server by clicking on its icon (a right-pointing arrow) in the toolbar + </para> + </listitem> + + <listitem> + <para> + Click the Run icon( + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/struts_validation/struts_validation_1.png"/> + </imageobject> + </inlinemediaobject> + ) or right click your project folder and select <menuchoice><guimenuitem>Run As</guimenuitem><guimenuitem>Run on Server</guimenuitem></menuchoice> + </para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para> + In the browser window, click on the "Say Hello!" button without having entered any name in the form + </para> + </listitem> + </itemizedlist> + + <para> + A JavaScript error message should be displayed in an alert box. + </para> + </section> + + <section id="Server-SideValidation"> +<?dbhtml filename="Server-SideValidation.html"?> + <title>Server Side Validation</title> + <para> + Server side validation does the validation inside the application on the server. In a Struts application using the Validation Framework, you still don't have to do any of the actual validation coding. The Validation Framework handles this. You will though have to make a few changes to the JSP file you modified for client-side validation along with a change to an action and a few changes to the form bean class. + </para> + </section> + + <section id="EditingTheJSPFile"> +<?dbhtml filename="EditingTheJSPFile.html"?> + <title>Editing the JSP File</title> + <itemizedlist> + <listitem> + <para> + Reopen inputname.jsp for editing + </para> + </listitem> + + <listitem> + <para> + Delete the <emphasis role="italic"><property>"onsubmit"</property></emphasis> attribute in the <code><html:form></code> element that you put in for client-side validation + </para> + </listitem> + + <listitem> + <para> + Add an <code><html:errors/></code> tag after the <code><html:form></code> tag + </para> + </listitem> + </itemizedlist> + + <para> + The JSP file should now look like this: + </para> + + <programlisting role="XML"> +<![CDATA[<%@ taglib uri="/WEB-INF/struts-html" prefix="html" %> +<html:html > +<head> + <html:javascript formName="GetNameForm"/> + <title></title> + </head> + <body> + <html:form action="/greeting.do" >Input name:<html:text property="name"/> + <html:submit value="Say Hello!"/> + </html:form> + <html:errors/> + </body> +</html:html> +]]> + </programlisting> + </section> + + <section id="EditingTheAction"> +<?dbhtml filename="EditingTheAction.html"?> + <title>Editing the Action</title> + <itemizedlist> + <listitem> + <para> + In the Web Projects view, expand the node under the <menuchoice><guimenuitem>StrutsHello</guimenuitem><guimenuitem>Configuration</guimenuitem><guimenuitem>default</guimenuitem><guimenuitem>struts-config.xml</guimenuitem><guimenuitem>action-mappings</guimenuitem></menuchoice> node, right-click the <emphasis><property>/greeting</property></emphasis> action, and then select <emphasis><property>Properties...</property></emphasis>from the context menu + </para> + </listitem> + + <listitem> + <para> + In the Edit Properties window, insert the cursor into the value column for the input property and click on the <property>...</property> button + </para> + </listitem> + + <listitem> + <para> + In the dialog box, make sure the Pages tab is selected, select <menuchoice><guimenuitem>StrutsHello</guimenuitem><guimenuitem>WEB-ROOT(WebContent)</guimenuitem><guimenuitem>pages</guimenuitem><guimenuitem>inputname.jsp</guimenuitem></menuchoice>, click the <emphasis><property>Ok</property></emphasis> button, and then click on the <emphasis><property>Close</property></emphasis> button + </para> + </listitem> + </itemizedlist> + </section> + + <section id="EditingTheFormBean"> +<?dbhtml filename="EditingTheFormBean.html"?> + <title>Editing the Form Bean</title> + <itemizedlist> + <listitem> + <para> + Right-click the <emphasis><property>/greeting</property></emphasis> action again and select Open Form-bean Source to open the GetNameForm.java file for editing + </para> + </listitem> + + <listitem> + <para> + Change the class that it extends from: <emphasis><property>org.apache.struts.action.ActionForm</property></emphasis> to <emphasis><property>org.apache.struts.validator.ValidatorForm</property></emphasis> + </para> + </listitem> + + <listitem> + <para> + Comment out a validate method + </para> + </listitem> + </itemizedlist> + + <para> + The file should now look like this: + </para> + + <programlisting role="JAVA"> +<![CDATA[package sample; +import javax.servlet.http.HttpServletRequest; +import org.apache.struts.action.ActionErrors; +import org.apache.struts.action.ActionMapping; +public class GetNameForm extends + +org.apache.struts.validator.ValidatorForm +{ + + private String name = ""; + + /** + * @return Returns the name. + */ + public String getName() + { + return name; + } + + /** + * @param name The name to set. + */ + public void setName(String name) + { + this.name = name; + } + + public GetNameForm () + { + } + + public void reset(ActionMapping actionMapping, + HttpServletRequest request) + { + this.name = ""; + } + + // public ActionErrors validate(ActionMapping actionMapping, + // HttpServletRequest request) + //{ + // ActionErrors errors = new ActionErrors(); + // return errors; + // } + } +]]> + </programlisting> + + <itemizedlist> + <listitem> + <para> + Select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>Save All</guimenuitem></menuchoice> from the menu bar + </para> + </listitem> + + <listitem> + <para> + Reload the application into JBoss AS by clicking on the "Change Time Stamp" icon (a finger pointing with a little star) in the toolbar + </para> + </listitem> + + <listitem> + <para> + Run the application + </para> + </listitem> + + <listitem> + <para> + In the browser window, click on the "Say Hello!" button without having entered any name in the form + </para> + </listitem> + </itemizedlist> + + <para> + The error message should appear in a refreshed version of the form. + </para> + </section> +</chapter>

13 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r29857 - trunk/struts/docs/struts_tools_ref_guide/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-03-16 23:49:19 -0400 (Wed, 16 Mar 2011) New Revision: 29857 Modified: trunk/struts/docs/struts_tools_ref_guide/en-US/editors.xml trunk/struts/docs/struts_tools_ref_guide/en-US/rel_resources_links.xml Log: "Fixed spelling errors" Modified: trunk/struts/docs/struts_tools_ref_guide/en-US/editors.xml =================================================================== --- trunk/struts/docs/struts_tools_ref_guide/en-US/editors.xml 2011-03-17 03:46:37 UTC (rev 29856) +++ trunk/struts/docs/struts_tools_ref_guide/en-US/editors.xml 2011-03-17 03:49:19 UTC (rev 29857) @@ -416,7 +416,7 @@ <para>The Constants view let you set constant values for your validation rules.</para> <figure> - <title>Constansts View</title> + <title>Constants View</title> <mediaobject> <imageobject> <imagedata fileref="images/struts/struts_35.png"/> Modified: trunk/struts/docs/struts_tools_ref_guide/en-US/rel_resources_links.xml =================================================================== --- trunk/struts/docs/struts_tools_ref_guide/en-US/rel_resources_links.xml 2011-03-17 03:46:37 UTC (rev 29856) +++ trunk/struts/docs/struts_tools_ref_guide/en-US/rel_resources_links.xml 2011-03-17 03:49:19 UTC (rev 29857) @@ -16,7 +16,7 @@ <para>More information on Struts can be found on the <ulink url="http://struts.apache.org/">Struts website</ulink>.</para> <para> - This reference has been desogned to help you become familiar with those parts of <property>JBoss Tools</property> which assist in developing using Struts technology. It covers how to create and import Struts projects, enable Struts capabilities for an existing web project, as well as organize and edit all necessary the necessary files in your Struts application using the views and editors provided by <property>JBoss Tools</property>. + This reference has been designed to help you become familiar with those parts of <property>JBoss Tools</property> which assist in developing using Struts technology. It covers how to create and import Struts projects, enable Struts capabilities for an existing web project, as well as organize and edit all necessary the necessary files in your Struts application using the views and editors provided by <property>JBoss Tools</property>. </para> <para>

13 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r29856 - trunk/smooks/docs/reference/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-03-16 23:46:37 -0400 (Wed, 16 Mar 2011) New Revision: 29856 Modified: trunk/smooks/docs/reference/en-US/references.xml Log: "Fixed spelling errors" Modified: trunk/smooks/docs/reference/en-US/references.xml =================================================================== --- trunk/smooks/docs/reference/en-US/references.xml 2011-03-17 03:29:51 UTC (rev 29855) +++ trunk/smooks/docs/reference/en-US/references.xml 2011-03-17 03:46:37 UTC (rev 29856) @@ -1,799 +1,1740 @@ <?xml version="1.0" encoding="UTF-8"?> <chapter id="references"> - <?dbhtml filename="reference.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Smooks</keyword> - <keyword>JBDS</keyword> - </keywordset> - </chapterinfo> - <title>Reference</title> - <para>This chapter includes detailed reference information on all tabs in the Smooks Configuration Editor.</para> - <section id="process_tab"> - <title>Process tab</title> - <para>The Process tab of the Smooks Configuration Editor provides a way to configure different types of transformations. By default the smooks configuration file is opened in this editor. If you have set another editor to open the file by default, you should right click on the smooks configuration file and select <menuchoice><guimenuitem>Open With</guimenuitem><guimenuitem>Smooks Configuration Editor</guimenuitem></menuchoice>.</para> - <para>The Process tab has two sections:</para> - <itemizedlist> - <listitem><para><xref linkend="processing_task_section"/></para></listitem> - <listitem><para><xref linkend="selected_task_details"/></para></listitem> - </itemizedlist> - <para>You can see them on the picture below.</para> - <figure> - <title>Two Sections of the Process tab.</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/reference/reference_1.png" scale="90"/> - </imageobject> - </mediaobject> - </figure> - <section id="processing_task_section"> - <title>Processing Task section</title> - <para>Using the popup menu in the Processing Task section you can select which types of technologies (templating or mapping ones) you will use for transformation: </para> - <para>The descriptions of the popup menu options are in the following table.</para> - <table> - <title>Process Tab. Processing Task section.</title> - <tgroup cols="3"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" align="left" colwidth="3*"/> - <colspec colnum="3" align="left" colwidth="1*"/> - - <thead> - <row> - <entry>Option</entry> - <entry>Description</entry> - <entry>Default</entry> - </row> - </thead> - <tbody> - <row> - <entry>Add Task</entry> - <entry>Select one of the following tasks according to the required Source and Result file types: - <itemizedlist> - <listitem><para><emphasis>Input</emphasis> - this task is required and appears automatically when Smooks config file is created. You should just configure it properly.</para></listitem> - <listitem><para><emphasis>Java Mapping</emphasis></para></listitem> - <listitem><para><emphasis>Apply Template</emphasis></para></listitem> - </itemizedlist> - </entry> - <entry></entry> - </row> - - <row> - <entry>Delete</entry> - <entry>Click this option if you want to delete some task from the section. Note:you can't delete input task because it's required.</entry> - <entry></entry> - - </row> - - <row> - <entry>Input Methods</entry> - <entry>Choose one of the following methods: - <itemizedlist> - <listitem><para>System</para></listitem> - <listitem><para>Simple</para></listitem> - <listitem><para>IBus (Inteligent Input Bus)</para></listitem> - <listitem><para>Amharic(EZ+)</para></listitem> - <listitem><para>Cedilla</para></listitem> - <listitem><para>Cyrillic</para></listitem> - <listitem><para>Inuktitut</para></listitem> - <listitem><para>IPA</para></listitem> - <listitem><para>Multipress</para></listitem> - <listitem><para>SCIM Bridge Input Method</para></listitem> - <listitem><para>SCIM Input Method</para></listitem> - <listitem><para>Thai-Lio</para></listitem> - <listitem><para>Tigrigna-Eritrean(EZ+)</para></listitem> - <listitem><para>Tigrigna-Ethiopian(EZ+)</para></listitem> - <listitem><para>Vietnamese</para></listitem> - <listitem><para>X input Method</para></listitem> - <listitem><para>None</para></listitem> - </itemizedlist> - </entry> - <entry>System</entry> - </row> - </tbody> - </tgroup> - </table> - </section> - <section id="selected_task_details"> - <title>Selected Task Details Section</title> - <para>The options available in this section depends on the selected task in the Processing Task section. Because there are 3 types of tasks there are 3 different sets of its options in the Selected Task Details Section. They will be described one by one. </para> - <section> - <title>Selected Task Details Section for Input Task.</title> - <para>On the picture below you can find an example of the Selected Task Details Section view if XML is selected as input type.</para> - - <figure> - <title>Selected Task Details Section for Input XML Task.</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/reference/reference_2.png" scale="90"/> - </imageobject> - </mediaobject> - </figure> - <para>As you can see on the picture above the Input Configuration section is empty for XML input file. However, this section has special configuration options for CSV,EDI,JSON,Custom input files.</para> - - <para>Here are the screens of these configuration options:</para> +<?dbhtml filename="reference.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + + <keyword>Smooks</keyword> + + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + <title>Reference</title> + <para> + This chapter includes detailed reference information on all tabs in the Smooks Configuration Editor. + </para> + + <section id="process_tab"> + <title>Process tab</title> + <para> + The Process tab of the Smooks Configuration Editor provides a way to configure different types of transformations. By default the smooks configuration file is opened in this editor. If you have set another editor to open the file by default, you should right click on the smooks configuration file and select <menuchoice><guimenuitem>Open With</guimenuitem><guimenuitem>Smooks Configuration Editor</guimenuitem></menuchoice>. + </para> + + <para> + The Process tab has two sections: + </para> + + <itemizedlist> + <listitem> + <para> + <xref linkend="processing_task_section"/> + </para> + </listitem> + + <listitem> + <para> + <xref linkend="selected_task_details"/> + </para> + </listitem> + </itemizedlist> + + <para> + You can see them on the picture below. + </para> + + <figure> + <title>Two Sections of the Process tab.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_1.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + <section id="processing_task_section"> + <title>Processing Task section</title> + <para> + Using the popup menu in the Processing Task section you can select which types of technologies (templating or mapping ones) you will use for transformation: + </para> + + <para> + The descriptions of the popup menu options are in the following table. + </para> + + <table> + <title>Process Tab. Processing Task section.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + + <colspec colnum="2" align="left" colwidth="3*"/> + + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry> + Option + </entry> + + <entry> + Description + </entry> + + <entry> + Default + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + Add Task + </entry> + + <entry> + Select one of the following tasks according to the required Source and Result file types: <itemizedlist> - <listitem><para>CSV:</para> - <figure> - <title>Selected Task Details Section for Input CSV Task.</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/reference/reference_3.png" /> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem><para>EDI:</para> - <figure> - <title>Selected Task Details Section for Input EDI Task.</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/reference/reference_4.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem><para>JSON:</para> - <figure> - <title>Selected Task Details Section for Input JSON Task.</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/reference/reference_5.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem><para>Custom:</para> - <figure> - <title>Selected Task Details Section for Input Custom Task.</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/reference/reference_6.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> + <listitem> + <para> + <emphasis>Input</emphasis> - this task is required and appears automatically when Smooks config file is created. You should just configure it properly. + </para> + </listitem> + + <listitem> + <para> + <emphasis>Java Mapping</emphasis> + </para> + </listitem> + + <listitem> + <para> + <emphasis>Apply Template</emphasis> + </para> + </listitem> </itemizedlist> - <para>All the input task configuration positions can be found in the table below:</para> - <table> - <title>Selected Task Details Section. Options for Input Task.</title> - <tgroup cols="3"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" align="left" colwidth="3*"/> - <colspec colnum="3" align="left" colwidth="1*"/> - <thead> - <row> - <entry>Option</entry> - <entry>Description</entry> - <entry>Default</entry> - </row> - </thead> - <tbody> - <row> - <entry>Input type</entry> - <entry>Select your type of input file. - If you don't find your type in the list, you should use Custom type: - <itemizedlist> - <listitem><para>No Input</para></listitem> - <listitem><para>XML</para></listitem> - <listitem><para>Java</para></listitem> - <listitem><para>XSD/WSDL</para></listitem> - <listitem><para>CSV</para></listitem> - <listitem><para>EDI</para></listitem> - <listitem><para>JSON</para></listitem> - <listitem><para>Custom</para></listitem> - </itemizedlist> - </entry> - <entry>XML</entry> - </row> - - <row> - <entry>Input configuration - - </entry> - <entry> - <itemizedlist> - <listitem><para><emphasis>No Input</emphasis> - no info required</para></listitem> - <listitem><para><emphasis>XML</emphasis> - no info required</para></listitem> - <listitem><para><emphasis>Java</emphasis> - no info required</para></listitem> - <listitem><para><emphasis>XSD/WSDL</emphasis> - no info required</para></listitem> - <listitem><para><emphasis>CSV</emphasis></para><itemizedlist> - <listitem><para><emphasis>Fields</emphasis> - Comma separated list of CSV record field names - </para></listitem> - <listitem><para><emphasis>Separator Character</emphasis> - Field separator character. - </para></listitem> - <listitem><para><emphasis>Quote Character</emphasis> - Quote character. - </para></listitem> - <listitem><para><emphasis>Record Name</emphasis> - Name of csv record element.</para></listitem> - <listitem><para><emphasis>Root Name</emphasis> - Name of csv root element.</para></listitem> - <listitem><para><emphasis>indent</emphasis> - Add indentation character data to the generated event stream. This simply makes the generated event stream easier to read in its serialized form. Useful for testing etc. - </para></listitem> - <listitem><para><emphasis>Skip Lines</emphasis> - Number of lines to skip before processing starts. - </para></listitem> - </itemizedlist> - </listitem> - <listitem><para><emphasis>EDI</emphasis></para> - <itemizedlist> - <listitem><para><emphasis>Target Profile</emphasis> - Defines the output transformation profile - </para></listitem> - <listitem><para><emphasis>Encoding</emphasis> - The character encoding.</para></listitem> - <listitem><para><emphasis>Mapping Model</emphasis> - Defines the EDI Mapping Model configuration for processing the EDI message stream to a stream of SAX events that can be processed by Smooks.</para></listitem> - <listitem><para><emphasis>Validate</emphasis> - This attribute turns on/off datatype validation in the EDI Parser. Validation is on by default. It makes sense to turn datatype validation off on the EDI Reader if the EDI data is being bound into a Java Object model. - </para></listitem> - </itemizedlist> - </listitem> - <listitem><para><emphasis>JSON</emphasis></para> - <itemizedlist> - <listitem><para><emphasis>Target Profile</emphasis> - Defines the output transformation profile</para></listitem> - <listitem><para><emphasis>Array Element Name</emphasis> - The element name of an array element. - </para></listitem> - <listitem><para><emphasis>Encoding</emphasis> - encoding: The default encoding of any JSON message InputStream processed by this Reader.</para></listitem> - <listitem><para><emphasis>Illegal Element Name Char Replacement</emphasis> - If illegal characters are encountered in a JSON element name then they are replaced with this value. By default this is not defined, so that the reader doesn't doesn't search for illegal characters. - </para></listitem> - <listitem><para><emphasis>Indent</emphasis> - Add indentation character data to the generated event stream. This simply makes the generated event stream easier to read in its serialized form. Useful for testing etc. - </para></listitem> - <listitem><para><emphasis>Key Prefix on Numeric</emphasis> - The prefix character to add if the JSON node name starts with a number. By default this is not defined, so that the reader doesn't search for element names that start with a number. - </para></listitem> - <listitem><para><emphasis>Key Whitespace Replacement</emphasis> - The replacement character for whitespaces in a JSON map key. By default this not defined, so that the reader doesn't search for whitespaces. - </para></listitem> - <listitem><para><emphasis>Null Value Replacement</emphasis> - The replacement string for JSON NULL values.</para></listitem> - <listitem><para><emphasis>Root Name</emphasis> - The element name of the document root. - </para></listitem> - <listitem><para><emphasis>Key Maps</emphasis> - Defines a JSON element name mapping The "from" key will be replaced with the "to" key or the contents of the element. - </para></listitem> - </itemizedlist> - </listitem> - <listitem><para><emphasis>Custom</emphasis></para> - <itemizedlist> - <listitem><para><emphasis>Target Profile</emphasis> - Defines the output transformation profile</para></listitem> - <listitem><para><emphasis>Class</emphasis> - Custom reader class.</para></listitem> - <listitem><para><emphasis>Handlers</emphasis> - Set a handler on the reader instance e.g. an EntityResolver, ErrorHandler etc. - </para></listitem> - <listitem><para><emphasis>Features</emphasis> - Reader Features List</para></listitem> - <listitem><para><emphasis>Parametres</emphasis> - Resource Parameters</para></listitem> - - </itemizedlist> - </listitem> - </itemizedlist></entry> - <entry><itemizedlist> - <listitem><para><emphasis>CSV</emphasis></para><itemizedlist> - <listitem><para>not defined</para></listitem> - <listitem><para>','</para></listitem> - <listitem><para>'"'</para></listitem> - <listitem><para>csv-record</para></listitem> - <listitem><para>csv-set</para></listitem> - <listitem><para>true</para></listitem> - <listitem><para>0</para></listitem> - </itemizedlist> - </listitem> - <listitem><para><emphasis>EDI</emphasis></para> - <itemizedlist> - <listitem><para>not defined</para></listitem> - <listitem><para>UTF-8</para></listitem> - <listitem><para>not defined</para></listitem> - <listitem><para>true</para></listitem> - </itemizedlist> - </listitem> - <listitem><para><emphasis>JSON</emphasis></para> - <itemizedlist> - <listitem><para>not defined</para></listitem> - <listitem><para>element</para></listitem> - <listitem><para>UTF-8</para></listitem> - <listitem><para>not defined</para></listitem> - <listitem><para>false</para></listitem> - <listitem><para>not defined</para></listitem> - <listitem><para>not defined</para></listitem> - <listitem><para>""(an empty string)</para></listitem> - <listitem><para>'json'</para></listitem> - <listitem><para>not defined</para></listitem> - </itemizedlist> - </listitem> - <listitem><para><emphasis>Custom</emphasis></para> - <itemizedlist> - <listitem><para>no defaults</para></listitem> - - </itemizedlist> - </listitem> - </itemizedlist></entry> - </row> - <row> - <entry>Input Data</entry> - <entry>You should select a data file using the <guibutton>Add</guibutton> and <guibutton>Delete</guibutton> buttons</entry> - <entry></entry> - </row> - <row> - <entry>Input Model View</entry> - <entry>Using this view you can see the structure of your input file.If the file has been changed, to see the changes click the <emphasis>Refresh</emphasis>link.</entry> - <entry></entry> - </row> - </tbody> - </tgroup> - </table> - </section> - <section id="mapping_task"><title>Selected Task Details section for Java Mapping Task.</title> - <para>Selected Task Details section for this task is presented by the graph, which eases the process of java mapping. </para> - <figure> - <title>Selected Task Details Section for Mapping Task.</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/reference/reference_7.png" scale="90"/> - </imageobject> - </mediaobject> - </figure> - <para>This graphical editor allows you to perform drag&drop operations with the nodes of transformed data to map the source data to target data. When you save the changes in the graphical editor the correct Smooks configuration file content will be generated. </para> - <para>Using the popup menu in the <emphasis>Selected Task Details</emphasis> section you can manage the diagram elements on the canvas. </para> - <para>The descriptions of the popup menu options are in the following table.</para> - <table id="popup"> - <title>Popup menu. Selected Task Details section.</title> - <tgroup cols="3"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" align="left" colwidth="3*"/> - <colspec colnum="3" align="left" colwidth="1*"/> - - <thead> - <row> - <entry>Option</entry> - <entry>Description</entry> - <entry>Default</entry> - </row> - </thead> - <tbody> - <row> - <entry>Add</entry> - <entry>Select one of the following tasks: - <itemizedlist> - <listitem><para><emphasis>Java Class</emphasis> - adds a bean context item to the config file. This option is available when no elements are selected and a user right clicks on the canvas. - </para></listitem> - <listitem><para><emphasis>Expession Binding</emphasis> - adds expression based binding to selected java binding element.</para></listitem> - <listitem><para><emphasis>Value Binding</emphasis> - adds Value binding (<jb:value>) to the selected java binding element.</para></listitem> - <listitem><para><emphasis>Bean Binding</emphasis> - adds Wiring binding (<jb:wiring>) to the selected java binding element.</para></listitem> - </itemizedlist> - </entry> - <entry></entry> - </row> - <row> - <entry>Undo</entry> - <entry>This option allows you to revert any changes made in the previous step. - </entry> - <entry></entry> - - </row> - <row> - <entry>Redo</entry> - <entry>This option allows you to redo the changes made at the previous step. - </entry> - <entry></entry> - - </row> - <row> - <entry>Delete</entry> - <entry>This option is available only if you select an element on the canvas. Click this option if you want to delete the element from it. - </entry> - <entry></entry> - - </row> - <row> - <entry>Auto Layout</entry> - <entry>Sets the default layout of the elements on the canvas.</entry> - <entry></entry> - - </row> - <row> - <entry>Properties</entry> - <entry>Click this option if you want to add the <emphasis>Properties view</emphasis> to the current perspective. The <emphasis>Properties view</emphasis> - will automatically display the properties of the selected diagram element. - </entry> - <entry></entry> - </row> - - <row> - <entry>Input Methods</entry> - <entry>Choose one of the following methods: - <itemizedlist> - <listitem><para>System</para></listitem> - <listitem><para>Simple</para></listitem> - <listitem><para>Amharic(EZ+)</para></listitem> - <listitem><para>Cedilla</para></listitem> - <listitem><para>Cyrillic</para></listitem> - <listitem><para>Inuktitut</para></listitem> - <listitem><para>IPA</para></listitem> - <listitem><para>Multipress</para></listitem> - <listitem><para>SCIM Bridge Input Method</para></listitem> - <listitem><para>SCIM Input Method</para></listitem> - <listitem><para>Thai-Lio</para></listitem> - <listitem><para>Tigrigna-Eritrean(EZ+)</para></listitem> - <listitem><para>Tigrigna-Ethiopian(EZ+)</para></listitem> - <listitem><para>Vietnamese</para></listitem> - <listitem><para>X input Method</para></listitem> - </itemizedlist> - </entry> - <entry>System</entry> - </row> - </tbody> - </tgroup> - </table> - </section> - <section><title>Selected Task Details section for Template Task.</title> - <para>Selected Task Details section for this task is presented by the graph, which is similar to what is described in the section <xref linkend="mapping_task"/>. - </para> - <figure> - <title>Selected Task Details Section for Template Task.</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/reference/reference_7a.png" scale="90"/> - </imageobject> - </mediaobject> - </figure> - <para>Popup menu similar to <xref linkend="popup"/>.</para> - </section> - </section> - + </entry> + + <entry></entry> + </row> + + <row> + <entry> + Delete + </entry> + + <entry> + Click this option if you want to delete some task from the section. Note:you can't delete input task because it's required. + </entry> + + <entry></entry> + </row> + + <row> + <entry> + Input Methods + </entry> + + <entry> + Choose one of the following methods: + <itemizedlist> + <listitem> + <para> + System + </para> + </listitem> + + <listitem> + <para> + Simple + </para> + </listitem> + + <listitem> + <para> + IBus (Inteligent Input Bus) + </para> + </listitem> + + <listitem> + <para> + Amharic(EZ+) + </para> + </listitem> + + <listitem> + <para> + Cedilla + </para> + </listitem> + + <listitem> + <para> + Cyrillic + </para> + </listitem> + + <listitem> + <para> + Inuktitut + </para> + </listitem> + + <listitem> + <para> + IPA + </para> + </listitem> + + <listitem> + <para> + Multipress + </para> + </listitem> + + <listitem> + <para> + SCIM Bridge Input Method + </para> + </listitem> + + <listitem> + <para> + SCIM Input Method + </para> + </listitem> + + <listitem> + <para> + Thai-Lio + </para> + </listitem> + + <listitem> + <para> + Tigrigna-Eritrean(EZ+) + </para> + </listitem> + + <listitem> + <para> + Tigrigna-Ethiopian(EZ+) + </para> + </listitem> + + <listitem> + <para> + Vietnamese + </para> + </listitem> + + <listitem> + <para> + X input Method + </para> + </listitem> + + <listitem> + <para> + None + </para> + </listitem> + </itemizedlist> + </entry> + + <entry> + System + </entry> + </row> + </tbody> + </tgroup> + </table> </section> - <section id="options_tab"> - <title>Options Tab</title> - <para>This section describes Options tab of the Smooks Configuration File editor, and gives short recommendations how this tab can be used during the project configuring.</para> + + <section id="selected_task_details"> + <title>Selected Task Details Section</title> + <para> + The options available in this section depends on the selected task in the Processing Task section. Because there are 3 types of tasks there are 3 different sets of its options in the Selected Task Details Section. They will be described one by one. + </para> + + <section> + <title>Selected Task Details Section for Input Task.</title> + <para> + On the picture below you can find an example of the Selected Task Details Section view if XML is selected as input type. + </para> + <figure> - <title> Options tab of the Smooks Configuration File editor</title> - <mediaobject> + <title>Selected Task Details Section for Input XML Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_2.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + <para> + As you can see on the picture above the Input Configuration section is empty for XML input file. However, this section has special configuration options for CSV,EDI,JSON,Custom input files. + </para> + + <para> + Here are the screens of these configuration options: + </para> + + <itemizedlist> + <listitem> + <para> + CSV: + </para> + + <figure> + <title>Selected Task Details Section for Input CSV Task.</title> + <mediaobject> <imageobject> - <imagedata fileref="images/reference/reference_8.png" scale="90"/> + <imagedata fileref="images/reference/reference_3.png" /> </imageobject> - </mediaobject> - </figure> - <section> - <title>Smooks Configuration section</title> - <para> - The <property>Smooks Configuration</property> section in the <property>Options Tab</property> displays only the Smooks Platform Version value. - </para> - <figure> - <title>Smooks Configuration section of Options tab</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/reference/reference_9.png" scale="90"/> - </imageobject> - </mediaobject> + </mediaobject> </figure> - <para>This value can not be modified, and is set according to the version of the Smooks libraries that are added to the project. + </listitem> + + <listitem> + <para> + EDI: </para> - </section> - - <section> - <title>Filter Settings Filter section</title> - <para> - In Filter Settings section you can set the following global options responsible for the Smooks filtering configuration:</para> + <figure> - <title>Filter Settings section of Options tab</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/reference/reference_10.png" scale="90"/> - </imageobject> - </mediaobject> + <title>Selected Task Details Section for Input EDI Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_4.png"/> + </imageobject> + </mediaobject> </figure> - <para>This behavior can be turned off using this global configuration parameter and can be overridden on a per fragment basis by targeting a Visitor implementation at that fragment that takes ownership of the Result writer (in the case of SAX filtering), or simply modifies the DOM (in the case of DOM filtering). As an example of this, see the FreeMarkerTemplateProcessor. + </listitem> + + <listitem> + <para> + JSON: </para> - <table> - <title>Options Tab. Filter Settings section.</title> - <tgroup cols="3"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" align="left" colwidth="3*"/> - <colspec colnum="3" align="left" colwidth="1*"/> - - <thead> - <row> - <entry>Option</entry> - <entry>Description</entry> - <entry>Default</entry> - </row> - </thead> - <tbody> - <row> - <entry>Stream Filter Type</entry> - <entry>Determines the type of processing model that will be used. Please refer to the <ulink url="http://www.smooks.org/mediawiki/index.php?title=V1.2:Smooks_v1.2_User_Gui..."> Filtering Process Selection section</ulink> of the official Smooks User Guide for more information about these models: - <itemizedlist> - <listitem><para><emphasis>SAX</emphasis></para></listitem> - <listitem><para><emphasis>DOM</emphasis></para></listitem> - </itemizedlist> - </entry> - <entry>SAX</entry> - </row> - - <row> - <entry>Default Serialization is On</entry> - <entry>Defines whether the default serialization should be switched on. Default serialization being enabled leads to locating StreamResult/DOMResult to the Result objects provided to the Smooks.filterSource method and to serialization all the events to that Result.</entry> - <entry>false</entry> - - </row> - </tbody> - </tgroup> - </table> - </section> - </section> - <section id="smooksformeditor_sourcetab"> - - <title>Source Tab</title> - <para>This section provides information about the Smooks Source Editor Page.</para> - <section> - <title>XML Source Editor</title> - <para>You can use this editor to edit the Smooks Configuration file directly. </para> + <figure> - <title>Graphical Editor</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/source_editor/source_editor1.png" scale="90"/> - </imageobject> - </mediaobject> + <title>Selected Task Details Section for Input JSON Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_5.png"/> + </imageobject> + </mediaobject> </figure> - </section> - <section> - <title>Error underlining in Graphical Editor</title> - <para>If the <property>Smooks tools</property> can't understand the configuration file or the configuration file is illegal (e.g. XML structure isn't valid for a Smooks Configuration file), the error is underlined.</para> - <figure> - <title>Graphical Editor</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/reference/reference_11.png" scale="90"/> - </imageobject> - </mediaobject> - </figure> - - </section> - - <section> - <title>Smooks Configuration File Validator</title> + </listitem> + + <listitem> <para> - The Smooks configuration file validator will validate your Smooks configuration file. Just right-click on the file and then click on the <guibutton>Validate</guibutton> button. The validator can be enabled/disabled by selecting <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>Validation</guimenuitem></menuchoice>, as you can see in the image below: + Custom: </para> - + <figure> - <title>Validation: Smooks Configuration File Validator</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/source_editor/smooks_conf_validator.png" scale="90"/> - </imageobject> - </mediaobject> + <title>Selected Task Details Section for Input Custom Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_6.png"/> + </imageobject> + </mediaobject> </figure> - - <para>You can set up your Smooks validator to include and exclude groups to validate, and specify rules for validation. Just click on the <guibutton>Settings</guibutton> button and use the options provided, which you can see in the image below:</para> - - <figure> - <title>Smooks Configuration File Validator Settings</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/source_editor/smooks_conf_validator_settings.png" scale="90"/> - </imageobject> - </mediaobject> - </figure> - </section> - </section> - <section> - <title>Properties View</title> - <para><emphasis><property>Properties View</property></emphasis> is available for some elements on the canvas of Java Mapping and Apply Template Tasks, like:</para> - <itemizedlist> - <listitem><para><emphasis><property>Java mapping</property></emphasis>:java class members,its fields, - links between input values and the class members;</para></listitem> - <listitem><para><emphasis><property>Apply Template</property></emphasis>:output template.</para></listitem> + </listitem> </itemizedlist> - <para>To add <emphasis><property>Properties View</property></emphasis> - to the opened perspective the user can either open <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Preferences</guimenuitem></menuchoice> in the toolbar or right click the element which properties he wants to inspect and select <property>Properties</property> in the popup menu. On the picture below you can see how this view looks like when some csv template is selected. + + <para> + All the input task configuration positions can be found in the table below: </para> + + <table> + <title>Selected Task Details Section. Options for Input Task.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + + <colspec colnum="2" align="left" colwidth="3*"/> + + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry> + Option + </entry> + + <entry> + Description + </entry> + + <entry> + Default + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + Input type + </entry> + + <entry> + Select your type of input file. If you don't find your type in the list, you should use Custom type: + <itemizedlist> + <listitem> + <para> + No Input + </para> + </listitem> + + <listitem> + <para> + XML + </para> + </listitem> + + <listitem> + <para> + Java + </para> + </listitem> + + <listitem> + <para> + XSD/WSDL + </para> + </listitem> + + <listitem> + <para> + CSV + </para> + </listitem> + + <listitem> + <para> + EDI + </para> + </listitem> + + <listitem> + <para> + JSON + </para> + </listitem> + + <listitem> + <para> + Custom + </para> + </listitem> + </itemizedlist> + </entry> + + <entry> + XML + </entry> + </row> + + <row> + <entry> + Input configuration + </entry> + + <entry> + <itemizedlist> + <listitem> + <para> + <emphasis>No Input</emphasis> - no info required + </para> + </listitem> + + <listitem> + <para> + <emphasis>XML</emphasis> - no info required + </para> + </listitem> + + <listitem> + <para> + <emphasis>Java</emphasis> - no info required + </para> + </listitem> + + <listitem> + <para> + <emphasis>XSD/WSDL</emphasis> - no info required + </para> + </listitem> + + <listitem> + <para> + <emphasis>CSV</emphasis> + </para> + <itemizedlist> + <listitem> + <para> + <emphasis>Fields</emphasis> - Comma separated list of CSV record field names + </para> + </listitem> + + <listitem> + <para> + <emphasis>Separator Character</emphasis> - Field separator character. + </para> + </listitem> + + <listitem> + <para> + <emphasis>Quote Character</emphasis> - Quote character. + </para> + </listitem> + + <listitem> + <para> + <emphasis>Record Name</emphasis> - Name of csv record element. + </para> + </listitem> + + <listitem> + <para> + <emphasis>Root Name</emphasis> - Name of csv root element. + </para> + </listitem> + + <listitem> + <para> + <emphasis>indent</emphasis> - Add indentation character data to the generated event stream. This simply makes the generated event stream easier to read in its serialized form. Useful for testing etc. + </para> + </listitem> + + <listitem> + <para> + <emphasis>Skip Lines</emphasis> - Number of lines to skip before processing starts. + </para> + </listitem> + </itemizedlist> + </listitem> + + <listitem> + <para> + <emphasis>EDI</emphasis> + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis>Target Profile</emphasis> - Defines the output transformation profile + </para> + </listitem> + + <listitem> + <para> + <emphasis>Encoding</emphasis> - The character encoding. + </para> + </listitem> + + <listitem> + <para> + <emphasis>Mapping Model</emphasis> - Defines the EDI Mapping Model configuration for processing the EDI message stream to a stream of SAX events that can be processed by Smooks. + </para> + </listitem> + + <listitem> + <para> + <emphasis>Validate</emphasis> - This attribute turns on/off datatype validation in the EDI Parser. Validation is on by default. It makes sense to turn datatype validation off on the EDI Reader if the EDI data is being bound into a Java Object model. + </para> + </listitem> + </itemizedlist> + </listitem> + + <listitem> + <para> + <emphasis>JSON</emphasis> + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis>Target Profile</emphasis> - Defines the output transformation profile + </para> + </listitem> + + <listitem> + <para> + <emphasis>Array Element Name</emphasis> - The element name of an array element. + </para> + </listitem> + + <listitem> + <para> + <emphasis>Encoding</emphasis> - encoding: The default encoding of any JSON message InputStream processed by this Reader. + </para> + </listitem> + + <listitem> + <para> + <emphasis>Illegal Element Name Char Replacement</emphasis> - If illegal characters are encountered in a JSON element name then they are replaced with this value. By default this is not defined, so that the reader doesn't doesn't search for illegal characters. + </para> + </listitem> + + <listitem> + <para> + <emphasis>Indent</emphasis> - Add indentation character data to the generated event stream. This simply makes the generated event stream easier to read in its serialized form. Useful for testing etc. + </para> + </listitem> + + <listitem> + <para> + <emphasis>Key Prefix on Numeric</emphasis> - The prefix character to add if the JSON node name starts with a number. By default this is not defined, so that the reader doesn't search for element names that start with a number. + </para> + </listitem> + + <listitem> + <para> + <emphasis>Key Whitespace Replacement</emphasis> - The replacement character for whitespaces in a JSON map key. By default this not defined, so that the reader doesn't search for whitespaces. + </para> + </listitem> + + <listitem> + <para> + <emphasis>Null Value Replacement</emphasis> - The replacement string for JSON NULL values. + </para> + </listitem> + + <listitem> + <para> + <emphasis>Root Name</emphasis> - The element name of the document root. + </para> + </listitem> + + <listitem> + <para> + <emphasis>Key Maps</emphasis> - Defines a JSON element name mapping The "from" key will be replaced with the "to" key or the contents of the element. + </para> + </listitem> + </itemizedlist> + </listitem> + + <listitem> + <para> + <emphasis>Custom</emphasis> + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis>Target Profile</emphasis> - Defines the output transformation profile + </para> + </listitem> + + <listitem> + <para> + <emphasis>Class</emphasis> - Custom reader class. + </para> + </listitem> + + <listitem> + <para> + <emphasis>Handlers</emphasis> - Set a handler on the reader instance e.g. an EntityResolver, ErrorHandler etc. + </para> + </listitem> + + <listitem> + <para> + <emphasis>Features</emphasis> - Reader Features List + </para> + </listitem> + + <listitem> + <para> + <emphasis>Parameters</emphasis> - Resource Parameters + </para> + </listitem> + </itemizedlist> + </listitem> + </itemizedlist> + </entry> + + <entry> + <itemizedlist> + <listitem> + <para> + <emphasis>CSV</emphasis> + </para> + <itemizedlist> + <listitem> + <para> + not defined + </para> + </listitem> + + <listitem> + <para> + ',' + </para> + </listitem> + + <listitem> + <para> + '"' + </para> + </listitem> + + <listitem> + <para> + csv-record + </para> + </listitem> + + <listitem> + <para> + csv-set + </para> + </listitem> + + <listitem> + <para> + true + </para> + </listitem> + + <listitem> + <para> + 0 + </para> + </listitem> + </itemizedlist> + </listitem> + + <listitem> + <para> + <emphasis>EDI</emphasis> + </para> + + <itemizedlist> + <listitem> + <para> + not defined + </para> + </listitem> + + <listitem> + <para> + UTF-8 + </para> + </listitem> + + <listitem> + <para> + not defined + </para> + </listitem> + + <listitem> + <para> + true + </para> + </listitem> + </itemizedlist> + </listitem> + + <listitem> + <para> + <emphasis>JSON</emphasis> + </para> + + <itemizedlist> + <listitem> + <para> + not defined + </para> + </listitem> + + <listitem> + <para> + element + </para> + </listitem> + + <listitem> + <para> + UTF-8 + </para> + </listitem> + + <listitem> + <para> + not defined + </para> + </listitem> + + <listitem> + <para> + false + </para> + </listitem> + + <listitem> + <para> + not defined + </para> + </listitem> + + <listitem> + <para> + not defined + </para> + </listitem> + + <listitem> + <para> + ""(an empty string) + </para> + </listitem> + + <listitem> + <para> + 'json' + </para> + </listitem> + + <listitem> + <para> + not defined + </para> + </listitem> + </itemizedlist> + </listitem> + + <listitem> + <para> + <emphasis>Custom</emphasis> + </para> + + <itemizedlist> + <listitem> + <para> + no defaults + </para> + </listitem> + </itemizedlist> + </listitem> + </itemizedlist> + </entry> + </row> + + <row> + <entry> + Input Data + </entry> + + <entry> + You should select a data file using the + <guibutton> + Add + </guibutton> + and + <guibutton> + Delete + </guibutton> + buttons + </entry> + + <entry></entry> + </row> + + <row> + <entry> + Input Model View + </entry> + + <entry> + Using this view you can see the structure of your input file.If the file has been changed, to see the changes click the <emphasis>Refresh</emphasis>link. + </entry> + + <entry></entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="mapping_task"> + <title>Selected Task Details section for Java Mapping Task.</title> + <para> + Selected Task Details section for this task is presented by the graph, which eases the process of java mapping. + </para> + <figure> - <title>Properties View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/reference/reference_12.png" scale="90"/> - </imageobject> - </mediaobject> + <title>Selected Task Details Section for Mapping Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_7.png" scale="90"/> + </imageobject> + </mediaobject> </figure> + <para> - This view is fully synchronized with the canvas of the <emphasis><property>Smooks Configuration Editor</property></emphasis>. This means that when you change the selected element by clicking on it, the properties of a new element are immediately displayed in it. Using <emphasis><property>Properties View</property></emphasis> you can then edit all the properties of the selected item. + This graphical editor allows you to perform drag&drop operations with the nodes of transformed data to map the source data to target data. When you save the changes in the graphical editor the correct Smooks configuration file content will be generated. </para> + + <para> + Using the popup menu in the <emphasis>Selected Task Details</emphasis> section you can manage the diagram elements on the canvas. + </para> + + <para> + The descriptions of the popup menu options are in the following table. + </para> + + <table id="popup"> + <title>Popup menu. Selected Task Details section.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + + <colspec colnum="2" align="left" colwidth="3*"/> + + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry> + Option + </entry> + + <entry> + Description + </entry> + + <entry> + Default + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + Add + </entry> + + <entry> + Select one of the following tasks: + <itemizedlist> + <listitem> + <para> + <emphasis>Java Class</emphasis> - adds a bean context item to the config file. This option is available when no elements are selected and a user right clicks on the canvas. + </para> + </listitem> + + <listitem> + <para> + <emphasis>Expression Binding</emphasis> - adds expression based binding to selected java binding element. + </para> + </listitem> + + <listitem> + <para> + <emphasis>Value Binding</emphasis> - adds Value binding (<jb:value>) to the selected java binding element. + </para> + </listitem> + + <listitem> + <para> + <emphasis>Bean Binding</emphasis> - adds Wiring binding (<jb:wiring>) to the selected java binding element. + </para> + </listitem> + </itemizedlist> + </entry> + + <entry></entry> + </row> + + <row> + <entry> + Undo + </entry> + + <entry> + This option allows you to revert any changes made in the previous step. + </entry> + + <entry></entry> + </row> + + <row> + <entry> + Redo + </entry> + + <entry> + This option allows you to redo the changes made at the previous step. + </entry> + + <entry></entry> + </row> + + <row> + <entry> + Delete + </entry> + + <entry> + This option is available only if you select an element on the canvas. Click this option if you want to delete the element from it. + </entry> + + <entry></entry> + </row> + + <row> + <entry> + Auto Layout + </entry> + + <entry> + Sets the default layout of the elements on the canvas. + </entry> + + <entry></entry> + </row> + + <row> + <entry> + Properties + </entry> + + <entry> + Click this option if you want to add the <emphasis>Properties view</emphasis> to the current perspective. The <emphasis>Properties view</emphasis> will automatically display the properties of the selected diagram element. + </entry> + + <entry></entry> + </row> + + <row> + <entry> + Input Methods + </entry> + + <entry> + Choose one of the following methods: + <itemizedlist> + <listitem> + <para> + System + </para> + </listitem> + + <listitem> + <para> + Simple + </para> + </listitem> + + <listitem> + <para> + Amharic(EZ+) + </para> + </listitem> + + <listitem> + <para> + Cedilla + </para> + </listitem> + + <listitem> + <para> + Cyrillic + </para> + </listitem> + + <listitem> + <para> + Inuktitut + </para> + </listitem> + + <listitem> + <para> + IPA + </para> + </listitem> + + <listitem> + <para> + Multipress + </para> + </listitem> + + <listitem> + <para> + SCIM Bridge Input Method + </para> + </listitem> + + <listitem> + <para> + SCIM Input Method + </para> + </listitem> + + <listitem> + <para> + Thai-Lio + </para> + </listitem> + + <listitem> + <para> + Tigrigna-Eritrean(EZ+) + </para> + </listitem> + + <listitem> + <para> + Tigrigna-Ethiopian(EZ+) + </para> + </listitem> + + <listitem> + <para> + Vietnamese + </para> + </listitem> + + <listitem> + <para> + X input Method + </para> + </listitem> + </itemizedlist> + </entry> + + <entry> + System + </entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section> + <title>Selected Task Details section for Template Task.</title> + <para> + Selected Task Details section for this task is presented by the graph, which is similar to what is described in the section <xref linkend="mapping_task"/>. + </para> + <figure> - <title>Synchronization between Properties View and the canvas</title> + <title>Selected Task Details Section for Template Task.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_7a.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Popup menu similar to <xref linkend="popup"/>. + </para> + </section> + </section> + </section> + + <section id="options_tab"> + <title>Options Tab</title> + <para> + This section describes Options tab of the Smooks Configuration File editor, and gives short recommendations how this tab can be used during the project configuring. + </para> + + <figure> + <title> Options tab of the Smooks Configuration File editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_8.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + <section> + <title>Smooks Configuration section</title> + <para> + The <property>Smooks Configuration</property> section in the <property>Options Tab</property> displays only the Smooks Platform Version value. + </para> + + <figure> + <title>Smooks Configuration section of Options tab</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_9.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + <para> + This value can not be modified, and is set according to the version of the Smooks libraries that are added to the project. + </para> + </section> + + <section> + <title>Filter Settings Filter section</title> + <para> + In Filter Settings section you can set the following global options responsible for the Smooks filtering configuration: + </para> + + <figure> + <title>Filter Settings section of Options tab</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_10.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + <para> + This behavior can be turned off using this global configuration parameter and can be overridden on a per fragment basis by targeting a Visitor implementation at that fragment that takes ownership of the Result writer (in the case of SAX filtering), or simply modifies the DOM (in the case of DOM filtering). As an example of this, see the FreeMarkerTemplateProcessor. + </para> + + <table> + <title>Options Tab. Filter Settings section.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + + <colspec colnum="2" align="left" colwidth="3*"/> + + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry> + Option + </entry> + + <entry> + Description + </entry> + + <entry> + Default + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + Stream Filter Type + </entry> + + <entry> + Determines the type of processing model that will be used. Please refer to the <ulink url="http://www.smooks.org/mediawiki/index.php?title=V1.2:Smooks_v1.2_User_Gui..."> Filtering Process Selection section</ulink> of the official Smooks User Guide for more information about these models: + <itemizedlist> + <listitem> + <para> + <emphasis>SAX</emphasis> + </para> + </listitem> + + <listitem> + <para> + <emphasis>DOM</emphasis> + </para> + </listitem> + </itemizedlist> + </entry> + + <entry> + SAX + </entry> + </row> + + <row> + <entry> + Default Serialization is On + </entry> + + <entry> + Defines whether the default serialization should be switched on. Default serialization being enabled leads to locating StreamResult/DOMResult to the Result objects provided to the Smooks.filterSource method and to serialization all the events to that Result. + </entry> + + <entry> + false + </entry> + </row> + </tbody> + </tgroup> + </table> + </section> + </section> + + <section id="smooksformeditor_sourcetab"> + <title>Source Tab</title> + <para> + This section provides information about the Smooks Source Editor Page. + </para> + + <section> + <title>XML Source Editor</title> + <para> + You can use this editor to edit the Smooks Configuration file directly. + </para> + + <figure> + <title>Graphical Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/source_editor/source_editor1.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section> + <title>Error underlining in Graphical Editor</title> + <para> + If the <property>Smooks tools</property> can't understand the configuration file or the configuration file is illegal (e.g. XML structure isn't valid for a Smooks Configuration file), the error is underlined. + </para> + + <figure> + <title>Graphical Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_11.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section> + <title>Smooks Configuration File Validator</title> + <para> + The Smooks configuration file validator will validate your Smooks configuration file. Just right-click on the file and then click on the + <guibutton> + Validate + </guibutton> + button. The validator can be enabled/disabled by selecting <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>Validation</guimenuitem></menuchoice>, as you can see in the image below: + </para> + + <figure> + <title>Validation: Smooks Configuration File Validator</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/source_editor/smooks_conf_validator.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + <para> + You can set up your Smooks validator to include and exclude groups to validate, and specify rules for validation. Just click on the + <guibutton> + Settings + </guibutton> + button and use the options provided, which you can see in the image below: + </para> + + <figure> + <title>Smooks Configuration File Validator Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/source_editor/smooks_conf_validator_settings.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + + <section> + <title>Properties View</title> + <para> + <emphasis><property>Properties View</property></emphasis> is available for some elements on the canvas of Java Mapping and Apply Template Tasks, like: + </para> + + <itemizedlist> + <listitem> + <para> + <emphasis><property>Java mapping</property></emphasis>:java class members,its fields, links between input values and the class members; + </para> + </listitem> + + <listitem> + <para> + <emphasis><property>Apply Template</property></emphasis>:output template. + </para> + </listitem> + </itemizedlist> + + <para> + To add <emphasis><property>Properties View</property></emphasis> to the opened perspective the user can either open <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Preferences</guimenuitem></menuchoice> in the toolbar or right click the element which properties he wants to inspect and select <property>Properties</property> in the popup menu. On the picture below you can see how this view looks like when some csv template is selected. + </para> + + <figure> + <title>Properties View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_12.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + <para> + This view is fully synchronized with the canvas of the <emphasis><property>Smooks Configuration Editor</property></emphasis>. This means that when you change the selected element by clicking on it, the properties of a new element are immediately displayed in it. Using <emphasis><property>Properties View</property></emphasis> you can then edit all the properties of the selected item. + </para> + + <figure> + <title>Synchronization between Properties View and the canvas</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_13.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + <section> + <title>Decode Configuration</title> + <para> + Smooks tools support decode parameter configuration through the Decode tab in <emphasis> <property>Properties View</property></emphasis> activated by clicking the connection between input model and bean items. + </para> + + <para> + On the picture below you can see an example of decode configurations for mapping an <property>Input Model</property> Item to a <property>Date</property> format: + </para> + + <figure> + <title>Decode Configuration tab in Properties View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_14.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + <para> + The descriptions of the <property>Decode Configuration</property> tab options are listed in the following table: + </para> + + <table> + <title>Decode Configuration tab in Properties View</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + + <colspec colnum="2" align="left" colwidth="3*"/> + + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry> + Option + </entry> + + <entry> + Description + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + Decoder + </entry> + + <entry> + Select from the dropdown list the type of decoder you need. + </entry> + </row> + + <row> + <entry> + Decoder Parameters + </entry> + + <entry> + For most of decoders the <emphasis><property>Decoder Parameters table</property></emphasis> is empty. But some of the decoders require additional configuration (like Date decoder on the picture above), so you should configure them by editing the corresponding line in the <property>Value</property> row. For example, for the Date Decoder: + <itemizedlist> + <listitem> + <para> + <property>format</property> - Date format string. + </para> + </listitem> + + <listitem> + <para> + <property>locale country</property> - ISO Country Code. Upper case two-letter code defined by ISO-3166. + </para> + </listitem> + + <listitem> + <para> + <property>locale language</property> - ISO Language Code. Lower case two-letter code defined by ISO-639. + </para> + </listitem> + </itemizedlist> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + The <property>Decoder Parameters</property> section for <property>EnumDecoder</property> quite differs from other types of decoders. See the picture below: + </para> + + <figure> + <title>EnumDecoder in Properties View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_15.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + <para> + The Decoder Parameters section for EnumDecoder in Properties View consists of 2 rows: + </para> + + <itemizedlist> + <listitem> + <para> + <property>From Data Value</property> - The lines in this row are editable. You can change them according to the names of enum types you used in input file. + </para> + </listitem> + + <listitem> + <para> + <property>To Enum Value</property> - The lines in this row are not editable. Here a set of all constants declared in mapped Enum type is listed. The user is responsible for correspondence between the values in these two rows. + </para> + </listitem> + </itemizedlist> + + <para> + For more information about different decoder parameters read the <ulink url="http://www.smooks.org/mediawiki/index.php?title=Main_Page">Smooks Technology Documentation</ulink>. + </para> + </section> + + <section> + <title>Apply Template Wizard</title> + <para> + The <property>Apply Template Wizard</property> helps you to add a new <property>Apply Template Task</property> to the Smooks configuration file. You can call it from the popup menu when the <property>Java Mapping</property> item in the Processing Task section is selected by following <menuchoice><guimenuitem>Add Task</guimenuitem><guimenuitem>Apply Template</guimenuitem></menuchoice> (see <xref linkend="apply_templ"/> picture). + </para> + + <para> + The wizard consists of several pages: + </para> + + <orderedlist> + <listitem> + <para> + The first one includes only one option to adjust.The user should select in which of the two formats(<property>XML</property> or <property>CSV</property>) he prefers to create an output message: + </para> + + <figure> + <title>The first page of Apply Template Wizard</title> <mediaobject> - <imageobject> - <imagedata fileref="images/reference/reference_13.png" scale="90"/> - </imageobject> + <imageobject> + <imagedata fileref="images/reference/reference_24.png"/> + </imageobject> </mediaobject> - </figure> - <section> - <title>Decode Configuration</title> - <para>Smooks tools support decode parameter configuration through the Decode tab in <emphasis> <property>Properties View</property></emphasis> activated by clicking the connection between input model and bean items. </para> - <para>On the picture below you can see an example of decode configurations for mapping an <property>Input Model</property> Item to a <property>Date</property> format:</para> - <figure> - <title>Decode Configuration tab in Properties View</title> + </figure> + </listitem> + + <listitem> + <para> + The second page is specific for each of the output message formats: + </para> + + <itemizedlist> + <listitem> + <para> + If the <property>CSV</property> output message type was selected in the previous step the second wizard page will be the following : + </para> + + <figure> + <title>CSV:The second page of Apply Template Wizard</title> <mediaobject> - <imageobject> - <imagedata fileref="images/reference/reference_14.png" scale="90"/> - </imageobject> + <imageobject> + <imagedata fileref="images/reference/reference_25.png"/> + </imageobject> </mediaobject> - </figure> - <para>The descriptions of the <property>Decode Configuration</property> tab options are listed in the following table:</para> - <table> - <title>Decode Configuration tab in Properties View</title> + </figure> + + <para> + The wizard page includes the next options to adjust: + </para> + + <table> + <title>Apply Template Wizard. Second Page Options if CSV output format is selected.</title> <tgroup cols="3"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" align="left" colwidth="3*"/> - <colspec colnum="3" align="left" colwidth="1*"/> - - <thead> - <row> - <entry>Option</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry>Decoder</entry> - <entry>Select from the dropdown list the type of decoder you need. - </entry> - </row> - - <row> - <entry>Decoder Parameters</entry> - <entry>For most of decoders the <emphasis><property>Decoder Parameters table</property></emphasis> is empty. But some of the decoders require additional configuration - (like Date decoder on the picture above), so you should configure them by editing the corresponding line in the <property>Value</property> row. For example, for the Date Decoder: - <itemizedlist> - <listitem><para><property>format</property> - Date format string.</para></listitem> - <listitem><para><property>locale country</property> - ISO Country Code. Upper case two-letter code defined by ISO-3166. </para></listitem> - <listitem><para><property>locale language</property> - ISO Language Code. Lower case two-letter code defined by ISO-639. </para></listitem> - </itemizedlist> - </entry> - </row> - </tbody> + <colspec colnum="1" align="left" colwidth="1*"/> + + <colspec colnum="2" colwidth="3*"/> + + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry> + Option + </entry> + + <entry> + Description + </entry> + + <entry> + Default + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + Fields + </entry> + + <entry> + Comma separated list of CSV record field names. + </entry> + + <entry> + Empty + </entry> + </row> + + <row> + <entry> + Separator Character + </entry> + + <entry> + Field separator character in the output message. + </entry> + + <entry> + , + </entry> + </row> + + <row> + <entry> + Quote Character + </entry> + + <entry> + Quote character in the output message. + </entry> + + <entry> + " + </entry> + </row> + + <row> + <entry> + Output Field name + </entry> + + <entry> + Click the checkbox if you want the output CSV message to also include field names. + </entry> + + <entry></entry> + </row> + </tbody> </tgroup> - </table> - <para>The <property>Decoder Parameters</property> section for <property>EnumDecoder</property> quite differs from other types of decoders. See the picture below:</para> - <figure> - <title>EnumDecoder in Properties View</title> + </table> + </listitem> + + <listitem> + <para> + The following second wizard page will appear if the <property>XML</property> output message type was selected in the previous step: + </para> + + <figure> + <title>Apply Template Wizard. Second Page Options if XML output format is selected.</title> <mediaobject> - <imageobject> - <imagedata fileref="images/reference/reference_15.png" scale="90"/> - </imageobject> + <imageobject> + <imagedata fileref="images/reference/reference_22.png"/> + </imageobject> </mediaobject> - </figure> - <para>The Decoder Parameters section for EnumDecoder in Properties View consists of 2 rows:</para> - <itemizedlist> - <listitem><para><property>From Data Value</property> - The lines in this row are editable. You can change them according to the names of enum types you used in input file. - </para></listitem> - <listitem><para><property>To Enum Value</property> - The lines in this row are not editable. Here a set of all constants declared in mapped Enum type is listed. The user is responsible for correspondence between the values in these two rows. </para></listitem> - </itemizedlist> - - <para>For more information about different decoder parameters read the <ulink url="http://www.smooks.org/mediawiki/index.php?title=Main_Page">Smooks Technology Documentation</ulink>.</para> - </section> - <section> - <title>Apply Template Wizard</title> - <para>The <property>Apply Template Wizard</property> helps you to add a new <property>Apply Template Task</property> to the Smooks configuration file. You can call it from the popup menu when the <property>Java Mapping</property> item in the Processing Task section is selected by following <menuchoice><guimenuitem>Add Task</guimenuitem><guimenuitem>Apply Template</guimenuitem></menuchoice> (see <xref linkend="apply_templ"/> picture).</para> - <para>The wizard consists of several pages:</para> - - <orderedlist> - <listitem> - <para>The first one includes only one option to adjust.The user should select in - which of the two formats(<property>XML</property> or <property>CSV</property>) - he prefers to create an output message:</para> - <figure> - <title>The first page of Apply Template Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/reference/reference_24.png"/> - </imageobject> - </mediaobject> - </figure> - - </listitem> - <listitem><para>The second page is specific for each of the output message formats:</para> - <itemizedlist> - <listitem><para>If the <property>CSV</property> output message type was selected in the previous step the second wizard page will be the following :</para> - <figure> - <title>CSV:The second page of Apply Template Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/reference/reference_25.png"/> - </imageobject> - </mediaobject> - </figure> - <para>The wizard page includes the next options to adjust:</para> - - <table> - <title>Apply Template Wizard. Second Page Options if CSV output format is selected.</title> - <tgroup cols="3"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" colwidth="3*"/> - <colspec colnum="3" align="left" colwidth="1*"/> - <thead> - <row> - <entry>Option</entry> - <entry>Description</entry> - <entry>Default</entry> - </row> - </thead> - <tbody> - <row> - <entry>Fields</entry> - <entry>Comma separated list of CSV record field names.</entry> - <entry>Empty</entry> - </row> - - <row> - <entry>Separator Character</entry> - <entry>Field separator character in the output message.</entry> - <entry>,</entry> - </row> - - <row> - <entry>Quote Character</entry> - <entry>Quote character in the output message.</entry> - <entry>"</entry> - </row> - - <row> - <entry>Output Field name</entry> - <entry>Click the checkbox if you want the output CSV message to also include field names.</entry> - <entry></entry> - </row> - - </tbody> - </tgroup> - </table> - </listitem> - <listitem> - <para>The following second wizard page will appear if the <property>XML</property> output message type was selected in the previous step:</para> - <figure> - <title>Apply Template Wizard. Second Page Options if XML output format is selected.</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/reference/reference_22.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Here you should first select the XSD or Sample XML output template format and then click the <property>Browse File System</property> - or the <property>Browse Workspace</property> button depending on what browse type you want to use. For example, if you click <property>Browse Workspace</property> - the following view will appear: - </para> - <figure> - <title>Browse Workspace</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/reference/reference_18.png"/> - </imageobject> - </mediaobject> - </figure> - <para>In the workspace you should select the template you want to use and click the <guibutton>OK</guibutton> button. - </para> - <para>If you selected XSD format after adjusting the template path you should click the <guibutton>Load</guibutton> button: - </para> - <figure> - <title>Load Button</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/reference/reference_19.png"/> - </imageobject> - </mediaobject> - </figure> - <para>After that it is necessary to select the root node for the template in the <property>Select Root Element</property>. Then click the <guibutton>Finish</guibutton> button.</para> - <figure> - <title>Load Button</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/reference/reference_20.png"/> - </imageobject> - </mediaobject> - </figure> - <para>If you have chosen Sample XML option after selecting the template XML file destination you should only click the <guibutton>Finish</guibutton> button: - </para> - <figure> - <title>Load Button</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/reference/reference_23.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - </listitem> - </orderedlist> - </section> - + </figure> + + <para> + Here you should first select the XSD or Sample XML output template format and then click the <property>Browse File System</property> or the <property>Browse Workspace</property> button depending on what browse type you want to use. For example, if you click <property>Browse Workspace</property> the following view will appear: + </para> + + <figure> + <title>Browse Workspace</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_18.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + In the workspace you should select the template you want to use and click the + <guibutton> + OK + </guibutton> + button. + </para> + + <para> + If you selected XSD format after adjusting the template path you should click the + <guibutton> + Load + </guibutton> + button: + </para> + + <figure> + <title>Load Button</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_19.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + After that it is necessary to select the root node for the template in the <property>Select Root Element</property>. Then click the + <guibutton> + Finish + </guibutton> + button. + </para> + + <figure> + <title>Load Button</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_20.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + If you have chosen Sample XML option after selecting the template XML file destination you should only click the + <guibutton> + Finish + </guibutton> + button: + </para> + + <figure> + <title>Load Button</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/reference_23.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + </listitem> + </orderedlist> </section> - + </section> </chapter>

13 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r29855 - trunk/seam/docs/reference/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-03-16 23:29:51 -0400 (Wed, 16 Mar 2011) New Revision: 29855 Modified: trunk/seam/docs/reference/en-US/seam_editors.xml Log: "Fixed spelling errors" Modified: trunk/seam/docs/reference/en-US/seam_editors.xml =================================================================== --- trunk/seam/docs/reference/en-US/seam_editors.xml 2011-03-17 03:21:58 UTC (rev 29854) +++ trunk/seam/docs/reference/en-US/seam_editors.xml 2011-03-17 03:29:51 UTC (rev 29855) @@ -1,697 +1,815 @@ <?xml version="1.0" encoding="UTF-8"?> <chapter id="seam_editors" role="updated"> - <?dbhtml filename="seam_editors.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Seam</keyword> - <keyword>JBDS</keyword> - </keywordset> - </chapterinfo> - - <title>Seam Editors</title> - - - <para>This chapter tells about Seam Editors and their features.</para> - +<?dbhtml filename="seam_editors.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + + <keyword>Seam</keyword> + + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + <title>Seam Editors</title> + <para> + This chapter tells about Seam Editors and their features. + </para> + + <section> + <title>Visual Page Editor</title> + <para> + Visual Page Editor fits perfectly for authoring view Seam pages. The major features of VPE are listed in <xref linkend="SeamEditors"/> + </para> + + <para> + You can also read more about Visual Page Editor in <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf/html/editors.htm...">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>Visual Page Editor</title> - <para>Visual Page Editor fits perfectly for authoring view Seam pages. The major features of VPE are listed in <xref linkend="SeamEditors"/></para> - <para>You can also read more about Visual Page Editor in <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf/html/editors.htm...">Visual Page Editor</ulink> chapter of "Visual Web Tools Reference Guide".</para> - </section> - - - - - <section> - <title>Seam Pages Editor</title> - + <title>Graphical Mode</title> + <para> + Graphical mode provides you with a set of visual tools to organize your project pageflow, exception handling etc. + </para> - <para> - <property>Seam Pages Editor</property> provides a handy way to edit the <property>pages.xml</property> file. - - </para> - - <para> - You can edit the pages.xml file in three modes: Graphical, Tree and Source. - - </para> - <para> - Seam Pages Editor supports synchronization with Package Explorer.This means that while renaming files in the Package Explorer all the changes immediately affect the pages.xml file. - - </para> - <section> - <title>Graphical Mode</title> - - - <para>Graphical mode provides you with a set of visual tools to organize your project pageflow, exception handling etc.</para> - <figure> - <title>Seam Pages Editor: Graphical View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_7.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The Graphical part of the editor has some visual elements. The table below shows graphical representation of the elements and explains their meanings. </para> - -<table> - <title>Pages Editor: Graphical View. Visual elements</title> - <tgroup cols="2"> - <thead> + <figure> + <title>Seam Pages Editor: Graphical View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + The Graphical part of the editor has some visual elements. The table below shows graphical representation of the elements and explains their meanings. + </para> + + <table> + <title>Pages Editor: Graphical View. Visual elements</title> + <tgroup cols="2"> + <thead> <row> - <entry>Element</entry> - - <entry>Description</entry> + <entry> + Element + </entry> + + <entry> + Description + </entry> </row> - </thead> - <tbody> + </thead> + + <tbody> <row> - <entry> - <mediaobject> + <entry> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/element_page.png"/> + </imageobject> + </mediaobject> + </entry> + + <entry> + <para> + A yellow box with a solid border represents a <code> <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/element_page.png"/> + <imagedata fileref="images/seam_editors/icon_plus.png"/> </imageobject> - </mediaobject> - </entry> - <entry><para>A yellow box with a solid border represents a <code> - <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> - + </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> - <para>Pageflow relations are shown with gray arrows, when you select a relationship the arrow is changed to orange. </para> - - - - <para>On the lefthand side of the Graphical view of <property>Seam Page Editor</property> you can find a toolbar with a set of icons for the most frequently used commands. </para> - + <entry> + <para> + A red cross in the upper left corner of the page box indicates that the view-id is not found in the project. + </para> + </entry> + </row> + + <row> + <entry> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/element_page1.png"/> + </imageobject> + </mediaobject> + </entry> + + <entry> + <para> + A gray box with a dashed border represents a page that has navigation (navigation rule) to but the page is not defined in the page.xml file. + </para> + </entry> + </row> + + <row> + <entry> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/element_exception.png"/> + </imageobject> + </mediaobject> + </entry> + + <entry> + <para> + An <code><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 left hand side of the Graphical view of <property>Seam Page Editor</property> you can find a toolbar with a set of icons for the most frequently used commands. + </para> + <table> - <title>Pages Editor: Graphical View. Commands Icons</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Icon Image</entry> - - <entry>Command</entry> - </row> - </thead> - <tbody> - <row> - <entry> - <inlinemediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/icon_select.png"/> - </imageobject> - </inlinemediaobject> - - </entry> - <entry>Select a page element</entry> - - </row> - - <row> - <entry><inlinemediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/icon_marquee.png"/> - </imageobject> - </inlinemediaobject></entry> - <entry>Marquee a page item</entry> - </row> - - - <row> - <entry> - <inlinemediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/icon_new_link.png"/> - </imageobject> - </inlinemediaobject> - - </entry> - <entry>Add a page relationship</entry> - </row> - - - <row> - <entry> - <inlinemediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/icon_exception.png"/> - </imageobject> - </inlinemediaobject> - - </entry> - <entry>Add an exception rule</entry> - </row> - - </tbody> - </tgroup> - </table> - - <para>Context menus are also available when you click either on an item or a blank space.</para> - - - <para>A context menu called on a blank space of the diagram provides the following options:</para> - <itemizedlist> - <listitem><para><emphasis role="bold">Page</emphasis> creates a new page element on the diagram</para></listitem> - <listitem><para><emphasis role="bold">Exception</emphasis> creates a new exception element on the diagram</para></listitem> - <listitem><para><emphasis role="bold">Auto Layout</emphasis> formats the layout of the diagram automatically</para></listitem> - <listitem><para><emphasis role="bold">Select Element</emphasis> calls the <property>Select Element Wizard</property> with a filter to perform a quick search through the <property>pages.xml</property> file </para></listitem> - </itemizedlist> - <para>Rightclicking on a selected - <code><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> - - - + <title>Pages Editor: Graphical View. Commands Icons</title> + <tgroup cols="2"> + <thead> + <row> + <entry> + Icon Image + </entry> + + <entry> + Command + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/icon_select.png"/> + </imageobject> + </inlinemediaobject> + </entry> + + <entry> + Select a page element + </entry> + </row> + + <row> + <entry> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/icon_marquee.png"/> + </imageobject> + </inlinemediaobject> + </entry> + + <entry> + Marquee a page item + </entry> + </row> + + <row> + <entry> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/icon_new_link.png"/> + </imageobject> + </inlinemediaobject> + </entry> + + <entry> + Add a page relationship + </entry> + </row> + + <row> + <entry> + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/icon_exception.png"/> + </imageobject> + </inlinemediaobject> + </entry> + + <entry> + Add an exception rule + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + Context menus are also available when you click either on an item or a blank space. + </para> + + <para> + A context menu called on a blank space of the diagram provides the following options: + </para> + <itemizedlist> - <listitem><para><emphasis role="bold">Rule</emphasis> opens the <property>Add Navigation Rule</property> dialog in which you can browse your project for a view page to set the view-id in the navigation rule and specify <emphasis role="bold">render</emphasis> or <emphasis role="bold">redirect</emphasis> navigation options </para></listitem> - <listitem><para><emphasis role="bold">Param</emphasis> calls a dialog box where you can define a parameter (using the - <code><param></code> - tag) for the - <code><page></code> - element</para></listitem> + <listitem> + <para> + <emphasis role="bold">Page</emphasis> creates a new page element on the diagram + </para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">Exception</emphasis> creates a new exception element on the diagram + </para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">Auto Layout</emphasis> formats the layout of the diagram automatically + </para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">Select Element</emphasis> calls the <property>Select Element Wizard</property> with a filter to perform a quick search through the <property>pages.xml</property> file + </para> + </listitem> </itemizedlist> - - - <section> - <title>Seam Pages Diagram Preferences</title> - - - - <para>In order to customize the layout of Diagram you can go to - <property>Window > Preferences > JBoss Tools > Web > Seam > Editors > Seam Pages Diagram</property>. - </para> - - <figure> - <title>Preferences of Seam Pages Diagram</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_11.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - </section> - - - <section> - <title>Tree Mode</title> - - <para>Tree Mode provides a wider range of options and way to edit and modify the pages.xml file.</para> - - - + + <para> + Right clicking on a selected <code><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>Seam Pages Editor: Tree View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_8.png"/> - </imageobject> - </mediaobject> + <title>Preferences of Seam Pages Diagram</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_11.png"/> + </imageobject> + </mediaobject> </figure> - - <para> - In this mode all elements and attributes of the page.xml - file can be viewed and edited in a visual, user friendly way. - </para> - - </section> - - - <section> - <title>Outline Support for Seam Pages Editor</title> - - - <para>Seam Pages Editor provides <property>Outline</property> view support. - You can explore the pages.xml using Outline view in two modes: <property>Tree</property> ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/outline_tree.png"/> - </imageobject> - </inlinemediaobject> ) and <property>Diagram Navigation</property> ( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/outline_navigation.png"/> - </imageobject> - </inlinemediaobject> ).</para> - - <para> - The Diagram Navigation mode of Outline view gives a birds-view of the layout to allow quick navigation for large-scale applications. - </para> - - <figure> - <title>Outline view: Diagram Navigation mode</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_9.png"/> - </imageobject> - </mediaobject> - </figure> - - - <para>The Tree mode shows a tree for every element in the pages.xml file. You can get a quick overview of the whole file. When selecting an element in the Outline view the related element is highlighted in the Graphical, Tree or Source page of Seam Pages Editor.</para> + </section> + </section> + <section> + <title>Tree Mode</title> + <para> + Tree Mode provides a wider range of options and way to edit and modify the pages.xml file. + </para> + + <figure> + <title>Seam Pages Editor: Tree View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_8.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + In this mode all elements and attributes of the page.xml file can be viewed and edited in a visual, user friendly way. + </para> + </section> + <section> + <title>Outline Support for Seam Pages Editor</title> + <para> + Seam Pages Editor provides <property>Outline</property> view support. You can explore the pages.xml using Outline view in two modes: <property>Tree</property> ( + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/outline_tree.png"/> + </imageobject> + </inlinemediaobject> + ) and <property>Diagram Navigation</property> ( + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/outline_navigation.png"/> + </imageobject> + </inlinemediaobject> + ). + </para> + + <para> + The Diagram Navigation mode of Outline view gives a birds-view of the layout to allow quick navigation for large-scale applications. + </para> + + <figure> + <title>Outline view: Diagram Navigation mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_9.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + The Tree mode shows a tree for every element in the pages.xml file. You can get a quick overview of the whole file. When selecting an element in the Outline view the related element is highlighted in the Graphical, Tree or Source page of Seam Pages Editor. + </para> + + <figure> + <title>Outline view: Tree mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_10.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + + <section> + <title>Seam Components Editor</title> + <para> + When editing <property>components.xml</property> a structured tree editor is available in addition to pure source editing. It has a graphical view (Tree tab) and source (Source tab). + </para> - <figure> - <title>Outline view: Tree mode</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_10.png"/> - </imageobject> - </mediaobject> - </figure> - - - - - </section> - - - - </section> - - - - - <section> - - - <title>Seam Components Editor</title> - - <para>When editing <property>components.xml</property> a structured tree editor is available - in addition to pure source editing. It has a graphical view (Tree tab) and source - (Source tab).</para> - + <figure> + <title>component.xml Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_4.png"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para> + You can view and edit <property>components.xml</property> and other xml files directly in the Project Explorer and Properties sheet without opening the components.xml editor. + </para> + </note> + + <figure> + <title>component.xml Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_5.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="SeamEditors"> + <title>Main Features of Seam Editors</title> + <para> + In this chapter you will know what Seam Editors features are and how to work with them. + </para> + + <section id="ContentAssist"> + <title>Content Assist</title> + <para> + <property>Content Assist</property> (Ctrl + Space) is available when using EL expressions in the following file formats: + </para> + + <itemizedlist> + <listitem> + <para> + JSP + </para> + </listitem> + + <listitem> + <para> + XHTML + </para> + </listitem> + + <listitem> + <para> + XML + </para> + </listitem> + + <listitem> + <para> + JAVA + </para> + </listitem> + </itemizedlist> + + <para> + Notice, the code completion for the Seam components shows the proposals marked with Seam icon. + </para> + + <figure> + <title>Content Assist</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_1.png" scale="70"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Content Assist is also available for the <emphasis + role="italic"> <property>"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 <xref linkend="project_pref"/>. + </para> + </note> + + <section id="components_code_assist" role="new"> + <title>Content Assist for components.xml</title> + <para> + While you are editing a <emphasis> <property>components.xml</property> </emphasis> file you can make use of the Content Assist for inserting needed elements. + </para> + <figure> - <title>component.xml Editor</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_4.png"/> - </imageobject> - </mediaobject> + <title>Content Assist in the component.xml Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_1a.png"/> + </imageobject> + </mediaobject> </figure> - - <note> - <title>Note:</title> - - <para>You can view and edit <property>components.xml</property> and other xml files - directly in the Project Explorer and Properties sheet without opening the - components.xml editor.</para> - </note> + + <para> + The editor also makes code completion aware of methods/attributes for EntityQuery component. + </para> + <figure> - <title>component.xml Editor</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_5.png"/> - </imageobject> - </mediaobject> + <title>Content Assist for EntityQuery Component</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_1b.png"/> + </imageobject> + </mediaobject> </figure> - + </section> + + <section id="named_beans_code_assist" role="new"> + <title>Content assist for @Named beans</title> + <para> + To the nice code completion you can also use Content assist for all occurrences where @Named beans are used. + </para> + + <figure> + <title>Content assist for @Named beans</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_1c.png"/> + </imageobject> + </mediaobject> + </figure> + </section> </section> - - - <section id="SeamEditors"> - <title>Main Features of Seam Editors</title> - - <para>In this chapter you will know what Seam Editors features are and how to work with them. </para> - - <section id="ContentAssist"> - - <title>Content Assist</title> - - <para><property>Content Assist</property> (Ctrl + Space) is available when using EL expressions in the following file formats:</para> - <itemizedlist> + <section> + <title>Content Assist for Page Descriptors</title> + <para> + Content Assist ( CA ) is available for Page Descriptors, <property>.page.xml</property> and <property>page.xml</property> files. Content Assist lets you easily compose a Page Descriptor file by suggesting elements and attributes. The suggestions are context dependent, which means that CA provides only the elements, attributes and in some cases values for the attributes, suitable in a particular place of your Page Descriptor. + </para> + + <para> + Seam Pages Editor also supports code completion in EL-expressions suggesting you possible bean properties and methods. + </para> + </section> + + <section id="OpenOn"> + <title>OpenOn</title> + <para> + <property>OpenOn</property> lets you easily navigate through your project without using the Package Explorer or Project Explorer. After pressing <emphasis> <property>Ctrl + left click</property> </emphasis> (or just F3) you will see a corresponding method or class. + </para> + + <figure> + <title>OpenOn</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + OpenOn is available for the following files: + </para> + + <itemizedlist> + <listitem> + <para> + <xref linkend="xmlFiles"/> + </para> + </listitem> + + <listitem> + <para> + <xref linkend="xhtmlFiles"/> + </para> + </listitem> + + <listitem> + <para> + <xref linkend="javaFiles"/> + </para> + </listitem> + </itemizedlist> + + <note> + <title>Note:</title> + <para> + In this section were described only use cases special for Seam applications.For general information please read <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf/html/editors.htm...">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>JSP</para> + <para> + components or properties resolved using an EL expression; + </para> </listitem> + <listitem> - <para>XHTML</para> + <para> + all actions described in pages.xml; + </para> </listitem> + <listitem> - <para>XML</para> + <para> + other .xhtml files that paths are specified in a current file; + </para> </listitem> + <listitem> - <para>JAVA</para> + <para> + image files that paths are set in the <emphasis> <property>value</property></emphasis> property.The files will be opened in the default system graphical editor. + </para> </listitem> - </itemizedlist> - - <para>Notice, the code completion for the Seam components shows the proposals marked with Seam icon.</para> - - <figure> - <title>Content Assist</title> + </itemizedlist> + </listitem> + + <listitem id="xmlFiles"> + <para> + OpenOn is also supported in Page Descriptors (<property>.page.xml</property> and <property>pages.xml</property>). OpenOn allows you to navigate to Java beans as well as to view pages. You can <property>Ctrl + left click</property> on a bean or on view page file (e.g. XTML file) to navigate to the file you clicked on. + </para> + + <figure> + <title>OpenOn in .page.xml file</title> <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_1.png" scale="70"/> - </imageobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_2a.png"/> + </imageobject> </mediaobject> - </figure> - <para> Content Assist is also available for the <emphasis - role="italic"> - <property>"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> + </figure> + + <para> + If you use Rule-based authorization with Drools in your Seam application you can apply OpenOn in <emphasis> <property>components.xml</property></emphasis> to open the files containing rule definitions in the <emphasis> <property>"rule-files"</property></emphasis> tag. + </para> + + <figure> + <title>OpenOn in components.xml file</title> <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_12.png" scale="70"/> - </imageobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_2c.png"/> + </imageobject> </mediaobject> - </figure> - <note> - <title>Note:</title> - - <para>To get Code Assist available for an externally generated and imported project, - don't forget to enable Seam features and configure Seam Settings in <xref linkend="project_pref"/>.</para> - </note> - - <section id="components_code_assist" role="new"> - <title>Content Assist for components.xml</title> - - <para>While you are editing a <emphasis> - <property>components.xml</property> - </emphasis> file you can make use of the Content Assist for inserting needed - elements.</para> - - <figure> - <title>Content Assist in the component.xml Editor</title> + </figure> + + <para> + You can also use OpenOn to open jBPM components that are described in Seam component descriptor. Two places where it works are available: + </para> + + <itemizedlist> + <listitem> + <para> + inside <emphasis> <property><component></property></emphasis> definition; + </para> + + <figure> + <title>OpenOn in components.xml file</title> <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_1a.png"/> - </imageobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_2d.png"/> + </imageobject> </mediaobject> - </figure> - - <para>The editor also makes code completion aware of methods/attributes for EntityQuery - component.</para> - - <figure> - <title>Content Assist for EntityQuery Component</title> + </figure> + </listitem> + + <listitem> + <para> + inside <emphasis> <property>jbpm</property></emphasis> tags; + </para> + + <figure> + <title>OpenOn in components.xml file</title> <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_1b.png"/> - </imageobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_2e.png"/> + </imageobject> </mediaobject> - </figure> - </section> - - <section id="named_beans_code_assist" role="new"> - <title>Content assist for @Named beans</title> - - <para>To the nice code completion you can also use Content assist for all occurrences where @Named beans are used. - </para> - - <figure> - <title>Content assist for @Named beans</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_1c.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - - </section> - <section> - <title>Content Assist for Page Descriptors</title> - - <para>Content Assist ( CA ) is available for Page Descriptors, - <property>.page.xml</property> and <property>page.xml</property> files. - Content Assist lets you easily compose a Page Descriptor file by suggesting elements and attributes. The suggestions are context dependent, which means that CA provides only the elements, attributes and in some cases values for the attributes, suitable in a particular place of your Page Descriptor. - - </para> - <para> - Seam Pages Editor also supports code completion in EL-expressions suggesting you possible bean properties and methods. - </para> - </section> - <section id="OpenOn"> - <title>OpenOn</title> - - <para><property>OpenOn</property> lets you easily navigate through your project without - using the Package Explorer or Project Explorer. After pressing <emphasis> - <property>Ctrl + left click</property> - </emphasis> (or just F3) you will see a corresponding method or class.</para> - - <figure> - <title>OpenOn</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_2.png"/> - </imageobject> - </mediaobject> - </figure> - <para>OpenOn is available for the following files:</para> - <itemizedlist> + </figure> + </listitem> + </itemizedlist> + </listitem> + + <listitem id="javaFiles"> + <para> + OpenOn is also supported in seam components where <property> In annotation</property> is presented. After pressing <property>Ctrl + left click</property> on the seam component specified in <code>@In </code> you will get the possibility to open the file where the component is declarated as well as all of the seam components where it is used in the next declarations: + </para> + + <itemizedlist> <listitem> - <para> - <xref linkend="xmlFiles"/> - </para> + <para> + @Out + </para> </listitem> + <listitem> - <para> - <xref linkend="xhtmlFiles"/> - </para> + <para> + @DataModel + </para> </listitem> + <listitem> - <para> <xref linkend="javaFiles"/></para> + <para> + @Role + </para> </listitem> - </itemizedlist> - <note> - <title>Note:</title> - - <para>In this section were described only use cases special for Seam applications.For general information please read - <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf/html/editors.htm...">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> + <para> + @Roles + </para> </listitem> - <listitem id="xmlFiles"> - <para>OpenOn is also supported in Page Descriptors (<property>.page.xml</property> and <property>pages.xml</property>). OpenOn allows you to navigate to Java beans as well as to view pages. - You can <property>Ctrl + left click</property> on a bean or on view page file (e.g. XTML file) to navigate to the file you clicked on. </para> - - <figure> - <title>OpenOn in .page.xml file</title> + </itemizedlist> + + <figure> + <title>OpenOn in Seam Component</title> <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_2a.png"/> - </imageobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_2b.png"/> + </imageobject> </mediaobject> - </figure> - <para>If you use Rule-based authorization with Drools in your Seam application you can apply OpenOn - in <emphasis> - <property>components.xml</property></emphasis> to open the files containing rule definitions in the <emphasis> - <property>"rule-files"</property></emphasis> tag. + </figure> + </listitem> + </itemizedlist> + </section> + + <section id="SeamValidation"> + <title>Seam Validation</title> + <para> + Validation of various possible problematic definitions is implemented for Seam applications. + </para> + + <para> + If an issue is found it will be shown in the standard <property>Problems View</property>. + </para> + + <figure> + <title>Seam Validation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_editors/seam_editors_6.png" scale="70"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para> + Please note, only files within source path and web content are validated, meaning temporary files or test files are not included. </para> - <figure> - <title>OpenOn in components.xml file</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_2c.png"/> - </imageobject> - </mediaobject> - </figure> - <para>You can also use OpenOn to open jBPM components that are described in Seam component descriptor. - Two places where it works are available: </para> - <itemizedlist> - <listitem><para>inside <emphasis> - <property><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> + </note> - <figure> - <title>OpenOn in Seam Component</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_2b.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - </section> - - <section id="SeamValidation"> - <title>Seam Validation</title> - - <para>Validation of various possible problematic definitions is implemented for Seam - applications.</para> - - <para>If an issue is found it will be shown in the standard <property>Problems - View</property>.</para> - - <figure> - <title>Seam Validation</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_6.png" scale="70"/> - </imageobject> - </mediaobject> - </figure> - - <note> - <title>Note:</title> - <para>Please note, only files within source path and web content are validated, meaning temporary files or test files are not included.</para> - </note> - - <para>In the preferences page for Seam Validator you can see and modify the validator - behavior. Go to <emphasis> - <property>Window > Preferences > JBoss Tools > Web > Seam > Validator</property> - </emphasis> and select the severity level for the optional Seam Validator - problem.</para> - - <figure> - <title>Seam Validator Preferences</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/seam_editors_3.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>On WTP projects validation are enabled by default and thus executed automatically, but - on normal Java projects you will have to go and add the Validation builder of your - project . It is available in the properties of your project under - <emphasis><property>Validation</property>.</emphasis></para> - - <figure> - <title>Enabling the Validation Builder</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_editors/validator1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The validations can be run manually by clicking - <emphasis><property>Validate</property></emphasis> via the context menu on your project (folder or file inside your project) which will - execute all the active WTP validations. Following to the project'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> + <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 + </section> +</chapter>

13 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r29854 - trunk/seam/docs/reference/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-03-16 23:21:58 -0400 (Wed, 16 Mar 2011) New Revision: 29854 Modified: trunk/seam/docs/reference/en-US/creating_mavenized_seam.xml trunk/seam/docs/reference/en-US/creating_new_seam.xml trunk/seam/docs/reference/en-US/intro.xml trunk/seam/docs/reference/en-US/seam_menus_and_actions.xml Log: "Fixed spelling errors" Modified: trunk/seam/docs/reference/en-US/creating_mavenized_seam.xml =================================================================== --- trunk/seam/docs/reference/en-US/creating_mavenized_seam.xml 2011-03-17 03:16:11 UTC (rev 29853) +++ trunk/seam/docs/reference/en-US/creating_mavenized_seam.xml 2011-03-17 03:21:58 UTC (rev 29854) @@ -1,181 +1,201 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="mavenized_seam"> - <?dbhtml filename="create_mavenized_seam.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Seam</keyword> - <keyword>JBDS</keyword> - </keywordset> - </chapterinfo> - <title>Maven Integration for Seam Projects</title> - <para>Starting from 3.1 M2 version <property>JBoss Tools</property> includes new Jboss Maven - Integration plug-in which for now allows to create mavenized Seam projects and enable Seam - tools support for imported Maven projects.</para> - <para>The Jboss Maven Integration requires <ulink url="http://m2eclipse.sonatype.org/" - >m2eclipse</ulink> to be installed.</para> - <note> - <title>Note:</title> - <para>For M2 release of <property>Jboss Tools</property> it is important to use m2eclipse - <ulink url="http://m2eclipse.sonatype.org/update/">stable updatesite</ulink> or the - <ulink url="http://m2eclipse.sonatype.org/releases/0.9.9.200906081351">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>JBoss Tools</property>.</para> - </note> - <section id="create_mavenized_project"> - <title>Creating Maven ready Seam project</title> - <para>Maven Integration makes the Seam Wizard capable of creating Maven ready projects to - let Maven get the libraries instead of using the Seam runtime.</para> - <para>To create a mavenized Seam project you should perform the following steps:</para> - <itemizedlist> - <listitem> - <para>Navigate to <emphasis> - <property>File > New Seam Project</property>.</emphasis> Give the project - a meaningful name, specify a target runtime and server and select the proper - configuration for your Seam project:</para> - <figure> - <title>Starting the Mavenized Seam Project</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/create_mavenized_seam/createMavenizedSeamProject.png" - /> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>Click the <emphasis> - <property>Modify</property></emphasis> button to enable the <emphasis> - <property>Jboss Maven Integration</property></emphasis> facet:</para> - <figure> - <title>Enabling the Jboss Maven Integration Facet</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/create_mavenized_seam/jbossMavenIntegrationFacet.png" - /> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>On the <property>JBoss M2 capabilities</property> page you'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> - <title>Adjusting JBoss M2 Capabilities</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/create_mavenized_seam/jbossM2capabilities.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para> On the <property>JSF Capabilities</property> page you can choose Maven as - libraries provider. This is possible when you use Maven JSF 1.2 Libraries as - type of JSF Implementing Library. Also it gives you capability to edit - Dependencies and Exclusions for the mavenized Seam project directly from the - wizard. </para> - <figure> - <title>Using JSF Implementation libraries provided by Maven</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/create_mavenized_seam/seamJSFImplementation.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>On the <property>Seam Facet</property> page configure the Seam Facet settings - and click <emphasis> - <property>Finish</property>:</emphasis></para> - <figure> - <title>Seam Facet Settings</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_mavenized_seam/seamFacetPage.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - <para>The organized Seam project contains five projects with the Maven nature, builder, - Maven classpath and the <emphasis> - <property>pom.xml</property></emphasis> files added: projectname, projectname-ear, - projectname-ejb, projectname-parent and projectname-test.</para> - <figure> - <title>Mavenized Seam Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_mavenized_seam/mavenizedProjectStructure.png" - /> - </imageobject> - </mediaobject> - </figure> - </section> - <section id="import_maven_project"> - <title>Existing Maven Projects Import</title> - <para>Maven Integration includes the Seam Maven configurator which is called when importing - a project, changing <emphasis> - <property>pom.xml</property></emphasis> and/or calling <emphasis> - <property>Maven > Update Project Configuration</property>.</emphasis> When - importing a Maven Seam project, the Seam Maven configurator picks up the settings set up - in <emphasis> - <property>pom.xml</property></emphasis> and adds to the project the - following:</para> - <itemizedlist> - <listitem> - <para>Seam nature</para> - </listitem> - <listitem> - <para>Seam facet and dependent facets to the EJB, EAR and WAR projects</para> - </listitem> - <listitem> - <para>JBoss Maven Integration facet if the Maven project contains a dependency with - the org.jboss.seam groupId and an artifactId starting with 'jboss-seam'</para> - </listitem> - <listitem> - <para>other required facets (Web Module, Java, JSF, etc.)</para> - </listitem> - </itemizedlist> - <para>If the Seam version from <emphasis> - <property>pom.xml</property></emphasis> matches a version of a Seam runtime - configured in the workspace, Seam configurator will set that runtime, otherwise no Seam - runtime will be set and you'll have to set it manually under <xref - linkend="project_pref"/>.</para> - <para>Seam configurator recognizes the Seam artifacts in the following way: the view folder - is a web content folder from the WAR project, the source folder is the first Eclipse - source folder. If there is a folder containing "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>Window > Preferences > JBoss Tools > JBoss Maven - Integration</property></emphasis>).</para> - <figure> - <title>JBoss Maven Integration Preferences</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/create_mavenized_seam/configure_maven_integration.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - <section> - <title>Relevant Resources Links</title> - <para>In the <ulink url="http://in.relation.to/Bloggers/UsingMavenWithJBossTools">Using - Maven with JBoss Tools</ulink> article written by Max Andersen you'll find - references to the screencasts on how to use the examples of mavenized Seam projects - provided by <property>JBoss Tools</property>.</para> - </section> -</chapter> +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="mavenized_seam"> +<?dbhtml filename="create_mavenized_seam.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + + <keyword>Seam</keyword> + + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + <title>Maven Integration for Seam Projects</title> + <para> + Starting from 3.1 M2 version <property>JBoss Tools</property> includes new Jboss Maven Integration plug-in which for now allows to create mavenized Seam projects and enable Seam tools support for imported Maven projects. + </para> + + <para> + The Jboss Maven Integration requires <ulink url="http://m2eclipse.sonatype.org/" + >m2eclipse</ulink> to be installed. + </para> + + <note> + <title>Note:</title> + <para> + For M2 release of <property>Jboss Tools</property> it is important to use m2eclipse <ulink url="http://m2eclipse.sonatype.org/update/">stable updatesite</ulink> or the <ulink url="http://m2eclipse.sonatype.org/releases/0.9.9.200906081351">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>JBoss Tools</property>. + </para> + </note> + + <section id="create_mavenized_project"> + <title>Creating Maven ready Seam project</title> + <para> + Maven Integration makes the Seam Wizard capable of creating Maven ready projects to let Maven get the libraries instead of using the Seam runtime. + </para> + + <para> + To create a mavenized Seam project you should perform the following steps: + </para> + + <itemizedlist> + <listitem> + <para> + Navigate to <emphasis> <property>File > New Seam Project</property>.</emphasis> Give the project a meaningful name, specify a target runtime and server and select the proper configuration for your Seam project: + </para> + + <figure> + <title>Starting the Mavenized Seam Project</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/create_mavenized_seam/createMavenizedSeamProject.png" + /> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para> + Click the <emphasis> <property>Modify</property></emphasis> button to enable the <emphasis> <property>Jboss Maven Integration</property></emphasis> facet: + </para> + + <figure> + <title>Enabling the Jboss Maven Integration Facet</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/create_mavenized_seam/jbossMavenIntegrationFacet.png" + /> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para> + On the <property>JBoss M2 capabilities</property> page you'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> + <title>Adjusting JBoss M2 Capabilities</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/create_mavenized_seam/jbossM2capabilities.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para> + On the <property>JSF Capabilities</property> page you can choose Maven as libraries provider. This is possible when you use Maven JSF 1.2 Libraries as type of JSF Implementing Library. Also it gives you capability to edit Dependencies and Exclusions for the mavenized Seam project directly from the wizard. + </para> + + <figure> + <title>Using JSF Implementation libraries provided by Maven</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/create_mavenized_seam/seamJSFImplementation.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para> + On the <property>Seam Facet</property> page configure the Seam Facet settings and click <emphasis> <property>Finish</property>:</emphasis> + </para> + + <figure> + <title>Seam Facet Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_mavenized_seam/seamFacetPage.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + + <para> + The organized Seam project contains five projects with the Maven nature, builder, Maven classpath and the <emphasis> <property>pom.xml</property></emphasis> files added: projectname, projectname-ear, projectname-ejb, projectname-parent and projectname-test. + </para> + + <figure> + <title>Mavenized Seam Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_mavenized_seam/mavenizedProjectStructure.png" + /> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="import_maven_project"> + <title>Existing Maven Projects Import</title> + <para> + Maven Integration includes the Seam Maven configurator which is called when importing a project, changing <emphasis> <property>pom.xml</property></emphasis> and/or calling <menuchoice><guimenuitem>Maven</guimenuitem><guimenuitem>Update Project Configuration.</guimenuitem></menuchoice> When importing a Maven Seam project, the Seam Maven configurator picks up the settings set up in <emphasis> <property>pom.xml</property></emphasis> and adds to the project the following: + </para> + + <itemizedlist> + <listitem> + <para> + Seam nature + </para> + </listitem> + + <listitem> + <para> + Seam facet and dependent facets to the EJB, EAR and WAR projects + </para> + </listitem> + + <listitem> + <para> + JBoss Maven Integration facet if the Maven project contains a dependency with the org.jboss.seam groupId and an artifactId starting with 'jboss-seam' + </para> + </listitem> + + <listitem> + <para> + other required facets (Web Module, Java, JSF, etc.) + </para> + </listitem> + </itemizedlist> + + <para> + If the Seam version from <emphasis> <property>pom.xml</property></emphasis> matches a version of a Seam runtime configured in the workspace, Seam configurator will set that runtime, otherwise no Seam runtime will be set and you'll have to set it manually under <xref + linkend="project_pref"/>. + </para> + + <para> + Seam configurator recognizes the Seam artifacts in the following way: the view folder is a web content folder from the WAR project, the source folder is the first Eclipse source folder. If there is a folder containing "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 (<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>JBoss Tools</guimenuitem><guimenuitem>JBoss Maven Integration</guimenuitem></menuchoice>). + </para> + + <figure> + <title>JBoss Maven Integration Preferences</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/create_mavenized_seam/configure_maven_integration.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section> + <title>Relevant Resources Links</title> + <para> + In the <ulink url="http://in.relation.to/Bloggers/UsingMavenWithJBossTools">Using Maven with JBoss Tools</ulink> article written by Max Andersen you'll find references to the screencasts on how to use the examples of mavenized Seam projects provided by <property>JBoss Tools</property>. + </para> + </section> +</chapter> Modified: trunk/seam/docs/reference/en-US/creating_new_seam.xml =================================================================== --- trunk/seam/docs/reference/en-US/creating_new_seam.xml 2011-03-17 03:16:11 UTC (rev 29853) +++ trunk/seam/docs/reference/en-US/creating_new_seam.xml 2011-03-17 03:21:58 UTC (rev 29854) @@ -1,477 +1,556 @@ <?xml version="1.0" encoding="UTF-8"?> <chapter id="create_seam" role="updated"> - <?dbhtml filename="create_new_seam.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Seam</keyword> - <keyword>JBDS</keyword> - </keywordset> - </chapterinfo> - <title>Creating a New Seam Project via the New Seam Project wizard</title> - <para>In this chapter we provide you with the necessary steps to start working with Seam - Framework.</para> - <para>At first, we suggest to set the specific Seam perspective that combines a number of - different views and editors needed for work with resources concerned. For that select - <emphasis> - <property>Window > Open Perspective > Other > Seam</property> - </emphasis> or you can also access it through the button in the right top corner.</para> +<?dbhtml filename="create_new_seam.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + + <keyword>Seam</keyword> + + <keyword>JBDS</keyword> + </keywordset> + </chapterinfo> + <title>Creating a New Seam Project via the New Seam Project wizard</title> + <para> + In this chapter we provide you with the necessary steps to start working with Seam Framework. + </para> + + <para> + At first, we suggest to set the specific Seam perspective that combines a number of different views and editors needed for work with resources concerned. For that select <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 <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Seam Web Project</guimenuitem></menuchoice> to run the <property>New Seam Project</property> wizard. The wizard form allows you to create runtime and server instances in order to get started creating, running, and debugging J2EE (only) applications. + </para> + + <para> + Seam Web Project wizard has an option for selecting the actual Server (not just WTP runtime) that will be used for the project. This allows the wizard to identify correctly where the required datasource and driver libraries need to go. + </para> + + <para> + Let's get through the wizard step-by-step. First, you should enter a name and a location directory for your new project. + </para> + + <figure id="figure_create_seam1"> + <title>New Seam Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + On the figure above you can see the runtime and the server already created. + </para> + + <para> + If you need to create a new runtime, click on the <emphasis> <property>New...</property> </emphasis> button in the <property>Target Runtime</property> section. It brings up the wizard where you can specify a new JBoss Server Runtime environment or the other type of runtime appropriate for your project configuration. Let's create one more JBoss 4.2 Runtime. Hence, after choosing it click on <emphasis> <property>Next</property> </emphasis> button. + </para> + <figure> - <title>Seam Perspective Icon</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_0.png"/> - </imageobject> - </mediaobject> + <title>Specifying Target Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_2.png"/> + </imageobject> + </mediaobject> </figure> - <para>Also the <emphasis> - <property>Open Web Browser</property></emphasis> action is directly available in the - <property>Seam perspective</property>.</para> + + <para> + All what you need here is to name runtime, type the path to its install directory or locate it by using <emphasis> <property>Browse</property> </emphasis> button, select a Java Runtime Environment, and select which configuration you want. + </para> + <figure> - <title>Embedded Web Browser Button</title> + <title>Specifying Target Runtime Configurations</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_3.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Clicking on <emphasis> <property>Finish</property> </emphasis> returns you to the <xref linkend="figure_create_seam1"/>. + </para> + + <para> + The next step is to define a Server by clicking on <emphasis> <property>New...</property> </emphasis> button in the <property>Target Server</property> section. In appeared <property>New Server dialog</property> the last server which matches the runtime will be selected. + </para> + + <para> + All declared runtimes are listed in the combobox under the servers view. Here, you can indicate a server runtime that you need. Click <emphasis> <property>Add</property> </emphasis> if you want to add a new Server Runtime. + </para> + + <figure> + <title>Specifying Target Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_4.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Next page allows you to verify the information for a chosen server. Leave everything as it is and click on <emphasis> <property>Next</property> </emphasis>. + </para> + + <figure> + <title>JBoss Runtime Summary</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_5.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + On the last wizard step you can modify your projects to configure them on the Server. + </para> + + <figure> + <title>Project Modification for Configuring on the Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_6.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Once you have the Target Server defined click on <emphasis> <property>Finish</property> </emphasis> button to return to the first page of the <property>New Seam Project wizard</property>. + </para> + + <note> + <title>Tip:</title> + <para> + We suggest that you look through the Application Server Manager Guide to find out more about runtimes and servers. + </para> + </note> + + <figure> + <title>Completion of Runtime and Server Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + The last section on this wizard step is <property>Configuration</property>. Here, you can select one of the predefined project configurations either associated with Seam 1.2, Seam 2.0 or with Seam 2.1. Furthermore, you can create your own configuration by pressing the <guibutton>Modify...</guibutton> button. It will open the dialog which allows to configure your own set of facets for adding extra functionality to your project. + </para> + + <para> + Pass to the next section to find out more details on this dialog. + </para> + </section> + + <section id="projectFacets"> + <title>Selecting the Project Facets</title> + <para> + The <property>Project Facets wizard</property> allows you to enable or disable specific facets which define necessary features for the project. When you switch to this wizard form, all critical facets are already checked for the chosen Configuration. + </para> + + <para> + Notice that this page of the wizard also allows you to set the necessary version for any facet. + </para> + + <figure> + <title>Project Facets Selection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_8.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Moreover, here you can specify your own preset of selected facets by checking needed ones in project facets window and clicking on <emphasis> <property>Save</property> </emphasis> button. + </para> + + <figure> + <title>Specifying Custom Facet Preset</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_15.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + To see all available Server runtimes click on <property>Runtimes</property> tab on the left. You can create a new one using the <emphasis> <property>New</property> </emphasis> button. If more than one runtime is checked here, the <emphasis> <property>Make Primary</property> </emphasis> button won't be dimmed yet. Thus, you can make use of it to mark primary runtime. + </para> + + <figure> + <title>Setting Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_16.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Clicking the <guibutton>OT</guibutton> button will bring you to the <property>Web Module</property> wizard form again. + </para> + + <section id="seamWithJPA"> + <title>Seam project with JPA facets</title> + <para> + For creating Seam project with JPA support you need to select<property> Java Persistent</property> facet on <property>Project Facets</property> page and click <property>OK</property>. + </para> + + <para> + Then you should press <property>Next</property> and may leave the default value on <property>Java application building</property> page and <property>Web Module Settings</property> page. + </para> + + <para> + After that you will see <property>JPA facet</property> page. + </para> + + <figure> + <title>JPA Facet page</title> <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_01.png"/> - </imageobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_16b.png"/> + </imageobject> </mediaobject> - </figure> - <section id="standaloneSeam" role="updated"> - <title>Create standalone Seam Web Project</title> - <para>The best way to get started with Seam is to create a simple Seam Project and - experiment with it.</para> - <para>Thus, you should select <emphasis> - <property>File > New > Seam Web Project</property> - </emphasis> to run the <property>New Seam Project</property> wizard. The wizard form - allows you to create runtime and server instances in order to get started creating, - running, and debugging J2EE (only) applications.</para> - <para>Seam Web Project wizard has an option for selecting the actual Server (not just WTP - runtime) that will be used for the project. This allows the wizard to identify correctly - where the required datasource and driver libraries need to go.</para> - <para>Let's get through the wizard step-by-step. First, you should enter a name and a - location directory for your new project.</para> - <figure id="figure_create_seam1"> - <title>New Seam Project Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_1.png"/> - </imageobject> - </mediaobject> - </figure> - <para>On the figure above you can see the runtime and the server already created.</para> - <para>If you need to create a new runtime, click on the <emphasis> - <property>New...</property> - </emphasis> button in the <property>Target Runtime</property> section. It brings up the - wizard where you can specify a new JBoss Server Runtime environment or the other type of - runtime appropriate for your project configuration. Let's create one more JBoss 4.2 - Runtime. Hence, after choosing it click on <emphasis> - <property>Next</property> - </emphasis> button.</para> - <figure> - <title>Specifying Target Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_2.png"/> - </imageobject> - </mediaobject> - </figure> - <para>All what you need here is to name runtime, type the path to its install directory or - locate it by using <emphasis> - <property>Browse</property> - </emphasis> button, select a Java Runtime Environment, and select which configuration - you want.</para> - <figure> - <title>Specifying Target Runtime Configurations</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_3.png"/> - </imageobject> - </mediaobject> - </figure> - <para> Clicking on <emphasis> - <property>Finish</property> - </emphasis> returns you to the <xref linkend="figure_create_seam1"/>.</para> - <para>The next step is to define a Server by clicking on <emphasis> - <property>New...</property> - </emphasis> button in the <property>Target Server</property> section. In appeared - <property>New Server dialog</property> the last server which matches the runtime - will be selected.</para> - <para>All declared runtimes are listed in the combo-box under the servers view. Here, you - can indicate a server runtime that you need. Click <emphasis> - <property>Add</property> - </emphasis> if you want to add a new Server Runtime.</para> - <figure> - <title>Specifying Target Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_4.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Next page allows you to verify the information for a chosen server. Leave everything - as it is and click on <emphasis> - <property>Next</property> - </emphasis>.</para> - <figure> - <title>JBoss Runtime Summary</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_5.png"/> - </imageobject> - </mediaobject> - </figure> - <para>On the last wizard step you can modify your projects to configure them on the - Server.</para> - <figure> - <title>Project Modification for Configuring on the Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_6.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Once you have the Target Server defined click on <emphasis> - <property>Finish</property> - </emphasis> button to return to the first page of the <property>New Seam Project - wizard</property>.</para> - <note> - <title>Tip:</title> - <para>We suggest that you look through the Application Server Manager Guide to - find out more about runtimes and servers.</para> - </note> - <figure> - <title>Completion of Runtime and Server Configuration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_7.png"/> - </imageobject> - </mediaobject> - </figure> - <para>The last section on this wizard step is <property>Configuration</property>. Here, you - can select one of the pre-defined project configurations either associated with Seam - 1.2, Seam 2.0 or with Seam 2.1. Furthermore, you can create your own configuration by - pressing the <emphasis> - <property>Modify...</property> - </emphasis> button. It will open the dialog which allows to configure your own set of - facets for adding extra functionality to your project.</para> - <para>Pass to the next section to find out more details on this dialog.</para> - </section> - <section id="projectFacets"> - <title>Selecting the Project Facets</title> - <para>The <property>Project Facets wizard</property> allows you to enable or disable - specific facets which define necessary features for the project. When you switch to this - wizard form, all critical facets are already checked for the chosen - Configuration.</para> - <para>Notice that this page of the wizard also allows you to set the necessary version for - any facet. </para> - <figure> - <title>Project Facets Selection</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_8.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Moreover, here you can specify your own preset of selected facets by checking needed - ones in project facets window and clicking on <emphasis> - <property>Save</property> - </emphasis> button.</para> - <figure> - <title>Specifying Custom Facet Preset</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_15.png"/> - </imageobject> - </mediaobject> - </figure> - <para>To see all available Server runtimes click on <property>Runtimes</property> tab on the - left. You can create a new one using the <emphasis> - <property>New</property> - </emphasis> button. If more than one runtime is checked here, the <emphasis> - <property>Make Primary</property> - </emphasis> button won't be dimmed yet. Thus, you can make use of it to mark - primary runtime.</para> - <figure> - <title>Setting Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_16.png"/> - </imageobject> - </mediaobject> - </figure> - <para><emphasis> - <property>Ok</property> - </emphasis> button will bring you to the <property>Web Module</property> wizard form - again.</para> - <section id="seamWithJPA"> - <title>Seam project with JPA facets</title> - <para>For creating Seam project with JPA support you need to select<property> Java - Persistent</property> facet on <property>Project Facets</property> page and - click <property>OK</property>.</para> - <para>Then you should press <property>Next</property> and may leave the default value on - <property>Java application building</property> page and <property>Web Module - Settings</property> page.</para> - <para>After that you will see <property>JPA facet</property> page.</para> - <figure> - <title>JPA Facet page</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_16b.png"/> - </imageobject> - </mediaobject> - </figure> - <para>On this page you can choose <property>Platform</property> (vendor-specific JPA - implementation) for your project, type of JPA Implementation, and configure the - <property>Connection</property> to database in the <property - >Connection</property> area.</para> - <para>More about <property>JPA facet</property> page you can read in <ulink + </figure> + + <para> + On this page you can choose <property>Platform</property> (vendor-specific JPA implementation) for your project, type of JPA Implementation, and configure the <property>Connection</property> to database in the <property + >Connection</property> area. + </para> + + <para> + More about <property>JPA facet</property> page you can read in <ulink url="http://help.eclipse.org/galileo/index.jsp?topic=/org.eclipse.jpt.doc.user..." - >Eclipse documentation</ulink>. </para> - <para>On the next step you will see <property>JSF Capabilities</property> and <property>Seam - facet</property> pages, which are mostly the same as in general Seam - project.</para> - </section> + >Eclipse documentation</ulink>. + </para> + + <para> + On the next step you will see <property>JSF Capabilities</property> and <property>Seam facet</property> pages, which are mostly the same as in general Seam project. + </para> </section> - <section id="configureJava"> - <title>Java application building configuration</title> - <para>With this wizard you can define Java source directories which will be generated on - build path. Also you can specify a default output folder. If you are agree with default - values, press <property>Next</property></para> - <figure> - <title>Java application building Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_16a.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - <section id="configureWebModule"> - <title>How to Configure Web Module Settings</title> - <para> As we deal with a Dynamic Web Application, we should at first specify the top level - directory of our application for deploying it to a server afterwards. You know, this - kind of application contains Web resources. Thus, it's important to indicate the content - directory. The wizard will put all those values itself, so you can leave everything as - is.</para> - <figure> - <title>Web Module Settings</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_9.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Choose <emphasis> - <property>Next</property> - </emphasis> to switch to the next wizard form.</para> - </section> - <section id="addJSFCapab"> - <title>Adding JSF Capabilities</title> - <para>This wizard helps you to add JSF capabilities to your project. </para> - <para>Choose <emphasis> - <property>Library provided by Target Runtime</property> - </emphasis> from Library Type list if you'd like to use a default JSF implementation - given by the present runtime.</para> - <figure> - <title>Adding JSF Capabilities to Web Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_10.png"/> - </imageobject> - </mediaobject> - </figure> - <para>In case if you prefer to use your custom JSF implementation, choose <property>User - Library</property> Item from Library Type list. In User Library list you can check - required library.</para> - <figure> - <title>Using Custom JSF implementation Library </title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_17.png"/> - </imageobject> - </mediaobject> - </figure> - <para> If a new library is required, click <property>Manage libraries...</property> ( - <inlinemediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_17a.png"/> - </imageobject> - </inlinemediaobject>) button. Then you should click <property>New</property>.</para> - <figure> - <title>Using Custom JSF implementation Library </title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_18.png"/> - </imageobject> - </mediaobject> - </figure> - <para> Here, it's necessary to type a <property>Library Name</property>. </para> - <figure> - <title>Entering New User Library Name</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_23.png"/> - </imageobject> - </mediaobject> - </figure> - <para>To add proper <property>Library JARs</property>, click <property>Add - JARs...</property> button and select the JARs on your hard drive. </para> - <figure> - <title>Selection Library JARs</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_25.png"/> - </imageobject> - </mediaobject> - </figure> - <para>You can download necessary JSF implementation libraries provided by Sun and Apache - Foundation as well. Click <property>Download...</property> (<inlinemediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_23a.png"/> - </imageobject> - </inlinemediaobject>) button and choose one of proposed libraries.</para> - <figure> - <title>Download JSF Implementation Library</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_24.png"/> - </imageobject> - </mediaobject> - </figure> - <para>The last wizard options allows to edit a path for <property>JSF Configuration - File</property>, a name for <property>JSF Servlet</property>, <property>JSF Servlet - Classname</property> and change <property>URL Mapping Patterns</property>.</para> - <figure> - <title>JSF Capabilities Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_19.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Since we are arranging the Seam Web project, the last step we should do is to adjust - project configurations associated with the Seam.</para> - </section> - <section id="seamFacet"> - <title>Configure Seam Facet Settings</title> - <para>The last wizard step is related to Seam facet and allows you to do the - following:</para> - <figure> - <title>Seam Facet Settings</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_11.png"/> - </imageobject> - </mediaobject> - </figure> - <itemizedlist> - <listitem> - <para>Create Seam runtime and define Seam home folder.</para> - </listitem> - </itemizedlist> - <para>For that click on <emphasis> - <property>Add</property> - </emphasis> button in the <property>General</property> section. Note, in the wizard - shown below you can create a Seam runtime only for the version that was selected in the - <xref linkend="projectFacets"/> wizard (version 1.2 in our - case).</para> - <figure> - <title>Seam Runtime Creation</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_12.png"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Select EAR or WAR deployment by checking a necessary radio button.</para> - </listitem> - <listitem> - <para>Enter EJB project name and EAR project name in case of EAR radio button is checked.</para> - </listitem> - </itemizedlist> - - <note> - <title>Tip:</title> - <para>If you want to name your web project "MyProject-war" note that the EJB project should not be "MyProject-war-ejb", - it should be "MyProject-ejb". The same for EAR and Test projects' names. They should be respectively "MyProject-ear" - and "MyProject-test".</para> - </note> - - <itemizedlist> - <listitem> - <para>Select a <emphasis> - <property>Database Type</property> - </emphasis></para> - </listitem> - </itemizedlist> - <figure> - <title>Database Type Selecting</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_20.png"/> - </imageobject> - </mediaobject> - </figure> - <itemizedlist> - <listitem> - <para>and then specify a <emphasis> - <property>Connection profile</property> - </emphasis> appropriate for your database.</para> - </listitem> - </itemizedlist> - <figure> - <title>Connection Profile Options</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_21.png"/> - </imageobject> - </mediaobject> - </figure> - <para>You can edit chosen profile by using <emphasis> - <property>Edit</property> - </emphasis> button or organise a new one by clicking on <emphasis> - <property>New</property> - </emphasis> button and selecting necessary for you type of connection profile.</para> - <figure> - <title>Connection Profile Selecting</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_13.png"/> - </imageobject> - </mediaobject> - </figure> - <para>On the dialog you'll be asked to enter its name and description. And then you - should select a proper driver and adjust connection details. Press <emphasis> - <property>Next</property> - </emphasis> to preview all the adjusted settings and complete the creation of the new - profile.</para> - <figure> - <title>Connection Details</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_22.png"/> - </imageobject> - </mediaobject> - </figure> - <para>The next block of settings in the Seam Facet wizard are describing a Database and a - connection to it.</para> - <para>In the <property>Code Generation</property> section the wizard has already provided - the names for your <property>Session Bean</property>, <property>Entity Bean</property> - and <property>Test</property> packages generation (optional). Of course, you can change - them on others of your choice.</para> - <figure> - <title>Code Generation Section</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/create_new_seam/create_seam_14.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Click on <emphasis> - <property>Finish</property> - </emphasis> to generate a project.</para> - <para/> - </section> -</chapter> \ No newline at end of file + </section> + + <section id="configureJava"> + <title>Java application building configuration</title> + <para> + With this wizard you can define Java source directories which will be generated on build path. Also you can specify a default output folder. If you are agree with default values, press <property>Next</property> + </para> + + <figure> + <title>Java application building Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_16a.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="configureWebModule"> + <title>How to Configure Web Module Settings</title> + <para> + As we deal with a Dynamic Web Application, we should at first specify the top level directory of our application for deploying it to a server afterwards. You know, this kind of application contains Web resources. Thus, it's important to indicate the content directory. The wizard will put all those values itself, so you can leave everything as is. + </para> + + <figure> + <title>Web Module Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_9.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Choose <emphasis> <property>Next</property> </emphasis> to switch to the next wizard form. + </para> + </section> + + <section id="addJSFCapab"> + <title>Adding JSF Capabilities</title> + <para> + This wizard helps you to add JSF capabilities to your project. + </para> + + <para> + Choose <emphasis> <property>Library provided by Target Runtime</property> </emphasis> from Library Type list if you'd like to use a default JSF implementation given by the present runtime. + </para> + + <figure> + <title>Adding JSF Capabilities to Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_10.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + In case if you prefer to use your custom JSF implementation, choose <property>User Library</property> Item from Library Type list. In User Library list you can check required library. + </para> + + <figure> + <title>Using Custom JSF implementation Library </title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_17.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + If a new library is required, click <property>Manage libraries...</property> ( + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_17a.png"/> + </imageobject> + </inlinemediaobject> + ) button. Then you should click <property>New</property>. + </para> + + <figure> + <title>Using Custom JSF implementation Library </title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_18.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Here, it's necessary to type a <property>Library Name</property>. + </para> + + <figure> + <title>Entering New User Library Name</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_23.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + To add proper <property>Library JARs</property>, click <property>Add JARs...</property> button and select the JARs on your hard drive. + </para> + + <figure> + <title>Selection Library JARs</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_25.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + You can download necessary JSF implementation libraries provided by Sun and Apache Foundation as well. Click <property>Download...</property> ( + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_23a.png"/> + </imageobject> + </inlinemediaobject> + ) button and choose one of proposed libraries. + </para> + + <figure> + <title>Download JSF Implementation Library</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_24.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + The last wizard options allows to edit a path for <property>JSF Configuration File</property>, a name for <property>JSF Servlet</property>, <property>JSF Servlet Classname</property> and change <property>URL Mapping Patterns</property>. + </para> + + <figure> + <title>JSF Capabilities Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_19.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Since we are arranging the Seam Web project, the last step we should do is to adjust project configurations associated with the Seam. + </para> + </section> + + <section id="seamFacet"> + <title>Configure Seam Facet Settings</title> + <para> + The last wizard step is related to Seam facet and allows you to do the following: + </para> + + <figure> + <title>Seam Facet Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_11.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + Create Seam runtime and define Seam home folder. + </para> + </listitem> + </itemizedlist> + + <para> + For that click on <emphasis> <property>Add</property> </emphasis> button in the <property>General</property> section. Note, in the wizard shown below you can create a Seam runtime only for the version that was selected in the <xref linkend="projectFacets"/> wizard (version 1.2 in our case). + </para> + + <figure> + <title>Seam Runtime Creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_12.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + Select EAR or WAR deployment by checking a necessary radio button. + </para> + </listitem> + + <listitem> + <para> + Enter EJB project name and EAR project name in case of EAR radio button is checked. + </para> + </listitem> + </itemizedlist> + + <note> + <title>Tip:</title> + <para> + If you want to name your web project "MyProject-war" note that the EJB project should not be "MyProject-war-ejb", it should be "MyProject-ejb". The same for EAR and Test projects' names. They should be respectively "MyProject-ear" and "MyProject-test". + </para> + </note> + + <itemizedlist> + <listitem> + <para> + Select a <emphasis> <property>Database Type</property> </emphasis> + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Database Type Selecting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_20.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para> + and then specify a <emphasis> <property>Connection profile</property> </emphasis> appropriate for your database. + </para> + </listitem> + </itemizedlist> + + <figure> + <title>Connection Profile Options</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_21.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + You can edit chosen profile by using <emphasis> <property>Edit</property> </emphasis> button or organize a new one by clicking on <emphasis> <property>New</property> </emphasis> button and selecting necessary for you type of connection profile. + </para> + + <figure> + <title>Connection Profile Selecting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_13.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + On the dialog you'll be asked to enter its name and description. And then you should select a proper driver and adjust connection details. Press <emphasis> <property>Next</property> </emphasis> to preview all the adjusted settings and complete the creation of the new profile. + </para> + + <figure> + <title>Connection Details</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_22.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + The next block of settings in the Seam Facet wizard are describing a Database and a connection to it. + </para> + + <para> + In the <property>Code Generation</property> section the wizard has already provided the names for your <property>Session Bean</property>, <property>Entity Bean</property> and <property>Test</property> packages generation (optional). Of course, you can change them on others of your choice. + </para> + + <figure> + <title>Code Generation Section</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_seam/create_seam_14.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Click on <emphasis> <property>Finish</property> </emphasis> to generate a project. + </para> + + <para/> + </section> +</chapter> Modified: trunk/seam/docs/reference/en-US/intro.xml =================================================================== --- trunk/seam/docs/reference/en-US/intro.xml 2011-03-17 03:16:11 UTC (rev 29853) +++ trunk/seam/docs/reference/en-US/intro.xml 2011-03-17 03:21:58 UTC (rev 29854) @@ -64,7 +64,7 @@ <row> <entry><para>New Seam Project wizard</para></entry> - <entry><para>An easy step-by-step wizard to create a standalone Seam Web Project with a form to create runtime and server instances in order to get started creating, running, and debugging J2EE (only) applications. You may also add JSF capabilities.</para></entry> + <entry><para>An easy step-by-step wizard to create a stand alone Seam Web Project with a form to create runtime and server instances in order to get started creating, running, and debugging J2EE (only) applications. You may also add JSF capabilities.</para></entry> <entry> <xref linkend="create_seam"/> </entry> Modified: trunk/seam/docs/reference/en-US/seam_menus_and_actions.xml =================================================================== --- trunk/seam/docs/reference/en-US/seam_menus_and_actions.xml 2011-03-17 03:16:11 UTC (rev 29853) +++ trunk/seam/docs/reference/en-US/seam_menus_and_actions.xml 2011-03-17 03:21:58 UTC (rev 29854) @@ -1,361 +1,363 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="menus_and_actions"> - <?dbhtml filename="seam_menus_and_actions.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Seam</keyword> - <keyword>JBDS</keyword> - <keyword>menus</keyword> - <keyword>actions</keyword> - </keywordset> - </chapterinfo> - - <title>Seam Menus and Actions</title> - - <para>In this chapter we provide a description of Seam actions that are available from</para> - <itemizedlist> - <listitem> - <para>Menu bar</para> - </listitem> - <listitem> - <para>Toolbar</para> - </listitem> - <listitem> - <para>Context menus in views</para> - </listitem> - </itemizedlist> - - - <section id="file_menu"> - - <title>File Menu Actions</title> - - <para>In a Seam perspective, by default there are the following actions in <emphasis> - <property>File > New</property> - </emphasis> submenu</para> - - <table> - <title>Seam Actions in the New Submenu</title> - <tgroup cols="2"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" colwidth="4*"/> - - <thead> - <row> - <entry align="center"> - <para>Name</para> - </entry> - - <entry align="center"> - <para>Function</para> - </entry> - - </row> - </thead> - - <tbody> - - - <row> - <entry> - <para> - <property>Seam Web Project</property> - </para> - - </entry> - - <entry> - <para>Runs <xref linkend="standaloneSeam"/> wizard - for creating a new Seam project </para> - </entry> - - - </row> - - - <row> - <entry> - <para> - <property>Seam Action</property> - </para> - - </entry> - - <entry> - <para>Runs <xref linkend="seam_action"/> wizard for - creating a new Seam action </para> - </entry> - - - </row> - - - - <row> - <entry> - <para> - <property>Seam Form</property> - </para> - - </entry> - - <entry> - <para>Runs <xref linkend="seam_form"/> wizard for - creating a new Seam form </para> - </entry> - - - </row> - - - <row> - <entry> - <para> - <property>Seam Entity</property> - </para> - - </entry> - - <entry> - <para>Runs <xref linkend="seam_entity"/> wizard for - creating a new Seam entity </para> - </entry> - - - </row> - - <row> - <entry> - <para> - <property>Seam Conversation</property> - </para> - - </entry> - - <entry> - <para>Runs <xref linkend="seam_conversation"/> wizard for creating a new Seam conversation - </para> - </entry> - - - - </row> - - <row> - <entry> - <para> - <property>Seam Generate Entities</property> - </para> - - </entry> - - <entry> - <para>Runs <xref linkend="generate_entities"/> wizard</para> - </entry> - - - - </row> - - - </tbody> - </tgroup> - </table> - - - </section> - - <section id="navigate_menu"> - <title>Navigate Menu Actions</title> - - <para>In the next sections we are going to describe Seam actions which can help you to - easily navigate through the source code.</para> - - <section id="find_seam_ref_decl"> - - <title>Find Seam References/Declarations</title> - - <para>To find EL expressions both in <emphasis> - <property>.java</property> - </emphasis> and <emphasis> - <property>.xhtml</property> - </emphasis> files use Find Seam References/Declarations actions. For that, in the main menu bar click on <emphasis> - <property>Search > Find Seam References</property> - </emphasis> or <emphasis><property>Find Seam Declarations</property>.</emphasis> - </para> - - <para>Look at the description of the actions in the table below.</para> - - <table> - <title>Find Seam References/Declarations actions</title> - <tgroup cols="3"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" colwidth="4*"/> - <colspec colnum="3" colwidth="2*"/> - - - <thead> - <row> - <entry align="center"> - <para>Name</para> - </entry> - - <entry align="center"> - <para>Function</para> - </entry> - - <entry align="center"> - <para>Keyboard Shortcut</para> - </entry> - </row> - </thead> - - <tbody> - - - <row> - <entry> - <para> - <property>Find Seam References</property> - </para> - <para> - <property>Find Seam Declarations</property> - </para> - </entry> - - <entry> - <para>Find all references and declarations to the selected element. - It's available for EL expressions in both .java and .xhtml - files. Differs from normal Eclipse Find References/Declarations - by showing an EL or Seam references in the Search View. </para> - </entry> - - <entry> - <para>Ctrl+G</para> - <para>Ctrl+Shift+G</para> - <para>also Ctrl + 1 for .java files</para> - - </entry> - - </row> - </tbody> - </tgroup> - </table> - - - <para>On the screenshot example below you could see that the search results are listed - in the - <property>Search view</property>. - </para> - - <figure> - <title>Find Seam Declaration for "Identity"</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_menus_and_actions/menus_and_actions1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>You can also use Ctrl + 1 in .java files to activate the actions:</para> - - <figure> - <title>Find Seam References for "Identity"</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_menus_and_actions/menus_and_actions2.png"/> - </imageobject> - </mediaobject> - </figure> - - </section> - - <section id="open_seam_component"> - <title>Open Seam Component</title> - - <para>To open Seam Components click on <emphasis><property>Navigate > Open Seam - Component</property></emphasis> in the main menu bar. This dialog is also available from toolbar - icon or with hot keys combination "Ctrl+Shift+Z ".</para> - - <figure> - <title>Open Seam Components icon</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_menus_and_actions/menus_and_actions3_0.png" - /> - </imageobject> - </mediaobject> - </figure> - - <para>In the table below read a description about the dialog.</para> - - <table> - <title>Open Seam Components Dialog</title> - <tgroup cols="3"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" colwidth="4*"/> - <colspec colnum="3" colwidth="2*"/> - - - <thead> - <row> - <entry align="center"> - <para>Name</para> - </entry> - - <entry align="center"> - <para>Function</para> - </entry> - - <entry align="center"> - <para>Keyboard Shortcut</para> - </entry> - </row> - </thead> - - <tbody> - - - <row> - <entry> - <para> - <property>Open Seam Components</property> - </para> - - </entry> - - <entry> - <para>Brings up the Open Seam Component dialog to open a component - in the editor. The Open Seam Component selection dialog shows - all Seam components existing in the workspace. You can search - the components via their short, imported or full name.</para> - </entry> - - <entry> - <para>Ctrl+Shift+Z</para> - - </entry> - - </row> - </tbody> - </tgroup> - </table> - - <para>Enter a name in the text field and see the results as it shown on screenshot: </para> - - <figure> - <title>Open Seam Components Dialog</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_menus_and_actions/menus_and_actions3.png"/> - </imageobject> - </mediaobject> - </figure> - <para>You can also open Seam Component from the other component where the required one is declared in <code>@In </code> by using - <xref linkend="OpenOn"/> (<property>Ctrl + left click</property> and select <property>Open Declaration of Seam Component for seam_component in Seam_class.java</property> ).</para> - </section> - - </section> - -</chapter> +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="menus_and_actions"> +<?dbhtml filename="seam_menus_and_actions.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + + <keyword>Seam</keyword> + + <keyword>JBDS</keyword> + + <keyword>menus</keyword> + + <keyword>actions</keyword> + </keywordset> + </chapterinfo> + <title>Seam Menus and Actions</title> + <para> + In this chapter we provide a description of Seam actions that are available from + </para> + + <itemizedlist> + <listitem> + <para> + Menu bar + </para> + </listitem> + + <listitem> + <para> + Toolbar + </para> + </listitem> + + <listitem> + <para> + Context menus in views + </para> + </listitem> + </itemizedlist> + + <section id="file_menu"> + <title>File Menu Actions</title> + <para> + In a Seam perspective, by default there are the following actions in <emphasis> <property>File > New</property> </emphasis> submenu + </para> + + <table> + <title>Seam Actions in the New Submenu</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="1*"/> + + <colspec colnum="2" colwidth="4*"/> + + <thead> + <row> + <entry align="center"> + <para> + Name + </para> + </entry> + + <entry align="center"> + <para> + Function + </para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para> + <property>Seam Web Project</property> + </para> + </entry> + + <entry> + <para> + Runs <xref linkend="standaloneSeam"/> wizard for creating a new Seam project + </para> + </entry> + </row> + + <row> + <entry> + <para> + <property>Seam Action</property> + </para> + </entry> + + <entry> + <para> + Runs <xref linkend="seam_action"/> wizard for creating a new Seam action + </para> + </entry> + </row> + + <row> + <entry> + <para> + <property>Seam Form</property> + </para> + </entry> + + <entry> + <para> + Runs <xref linkend="seam_form"/> wizard for creating a new Seam form + </para> + </entry> + </row> + + <row> + <entry> + <para> + <property>Seam Entity</property> + </para> + </entry> + + <entry> + <para> + Runs <xref linkend="seam_entity"/> wizard for creating a new Seam entity + </para> + </entry> + </row> + + <row> + <entry> + <para> + <property>Seam Conversation</property> + </para> + </entry> + + <entry> + <para> + Runs <xref linkend="seam_conversation"/> wizard for creating a new Seam conversation + </para> + </entry> + </row> + + <row> + <entry> + <para> + <property>Seam Generate Entities</property> + </para> + </entry> + + <entry> + <para> + Runs <xref linkend="generate_entities"/> wizard + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="navigate_menu"> + <title>Navigate Menu Actions</title> + <para> + In the next sections we are going to describe Seam actions which can help you to easily navigate through the source code. + </para> + + <section id="find_seam_ref_decl"> + <title>Find Seam References/Declarations</title> + <para> + To find EL expressions both in <emphasis> <property>.java</property> </emphasis> and <emphasis> <property>.xhtml</property> </emphasis> files use Find Seam References/Declarations actions. For that, in the main menu bar click on <menuchoice><guimenuitem>Search</guimenuitem><guimenuitem>Find Seam References</guimenuitem></menuchoice> or <emphasis><property>Find Seam Declarations</property>.</emphasis> + </para> + + <para> + Look at the description of the actions in the table below. + </para> + + <table> + <title>Find Seam References/Declarations actions</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + + <colspec colnum="2" colwidth="4*"/> + + <colspec colnum="3" colwidth="2*"/> + + <thead> + <row> + <entry align="center"> + <para> + Name + </para> + </entry> + + <entry align="center"> + <para> + Function + </para> + </entry> + + <entry align="center"> + <para> + Keyboard Shortcut + </para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para> + <property>Find Seam References</property> + </para> + + <para> + <property>Find Seam Declarations</property> + </para> + </entry> + + <entry> + <para> + Find all references and declarations to the selected element. It's available for EL expressions in both .java and .xhtml files. Differs from normal Eclipse Find References/Declarations by showing an EL or Seam references in the Search View. + </para> + </entry> + + <entry> + <para> + Ctrl+G + </para> + + <para> + Ctrl+Shift+G + </para> + + <para> + also Ctrl + 1 for .java files + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + On the screenshot example below you could see that the search results are listed in the <property>Search view</property>. + </para> + + <figure> + <title>Find Seam Declaration for "Identity"</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_menus_and_actions/menus_and_actions1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + You can also use Ctrl + 1 in .java files to activate the actions: + </para> + + <figure> + <title>Find Seam References for "Identity"</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_menus_and_actions/menus_and_actions2.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="open_seam_component"> + <title>Open Seam Component</title> + <para> + To open Seam Components click on <emphasis><property>Navigate > Open Seam Component</property></emphasis> in the main menu bar. This dialog is also available from toolbar icon or with hot keys combination "Ctrl+Shift+Z ". + </para> + + <figure> + <title>Open Seam Components icon</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_menus_and_actions/menus_and_actions3_0.png" + /> + </imageobject> + </mediaobject> + </figure> + + <para> + In the table below read a description about the dialog. + </para> + + <table> + <title>Open Seam Components Dialog</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + + <colspec colnum="2" colwidth="4*"/> + + <colspec colnum="3" colwidth="2*"/> + + <thead> + <row> + <entry align="center"> + <para> + Name + </para> + </entry> + + <entry align="center"> + <para> + Function + </para> + </entry> + + <entry align="center"> + <para> + Keyboard Shortcut + </para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para> + <property>Open Seam Components</property> + </para> + </entry> + + <entry> + <para> + Brings up the Open Seam Component dialog to open a component in the editor. The Open Seam Component selection dialog shows all Seam components existing in the workspace. You can search the components via their short, imported or full name. + </para> + </entry> + + <entry> + <para> + Ctrl+Shift+Z + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + Enter a name in the text field and see the results as it shown on screenshot: + </para> + + <figure> + <title>Open Seam Components Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_menus_and_actions/menus_and_actions3.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + You can also open Seam Component from the other component where the required one is declared in <code>@In </code> by using <xref linkend="OpenOn"/> (<property>Ctrl + left click</property> and select <property>Open Declaration of Seam Component for seam_component in Seam_class.java</property> ). + </para> + </section> + </section> +</chapter>

13 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r29853 - trunk/portlet/docs/reference/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-03-16 23:16:11 -0400 (Wed, 16 Mar 2011) New Revision: 29853 Modified: trunk/portlet/docs/reference/en-US/reference.xml trunk/portlet/docs/reference/en-US/starting_project.xml Log: "Fixed spelling errors" Modified: trunk/portlet/docs/reference/en-US/reference.xml =================================================================== --- trunk/portlet/docs/reference/en-US/reference.xml 2011-03-17 03:11:54 UTC (rev 29852) +++ trunk/portlet/docs/reference/en-US/reference.xml 2011-03-17 03:16:11 UTC (rev 29853) @@ -648,11 +648,7 @@ <section id="preferences"> <title>JBoss Portlet Preferences</title> - <para>To open <property>JBoss Portlet Preferences</property> property sheet, go to <emphasis> - <property>Window > Preferences</property> - </emphasis> and then <emphasis> - <property>JBoss Tools > JBoss Portlet</property>. - </emphasis></para> + <para>To open <property>JBoss Portlet Preferences</property> property sheet, go to <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem></menuchoice> and then <menuchoice><guimenuitem>JBoss Tools</guimenuitem><guimenuitem>JBoss Portlet.</guimenuitem></menuchoice></para> <figure> <title>JBoss Runtime Preferences</title> Modified: trunk/portlet/docs/reference/en-US/starting_project.xml =================================================================== --- trunk/portlet/docs/reference/en-US/starting_project.xml 2011-03-17 03:11:54 UTC (rev 29852) +++ trunk/portlet/docs/reference/en-US/starting_project.xml 2011-03-17 03:16:11 UTC (rev 29853) @@ -7,7 +7,7 @@ <section id="jboss_core_portlet"> <title>Creating a Web Project with JBoss Portlet Capabilities</title> - <para>Fallow the next procedure to create a Web project with JBoss Portlet capabilities pointed to the JBoss Portal runtime.</para> + <para>Follow the next procedure to create a Web project with JBoss Portlet capabilities pointed to the JBoss Portal runtime.</para> <orderedlist> <listitem>

13 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r29852 - trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-03-16 23:11:54 -0400 (Wed, 16 Mar 2011) New Revision: 29852 Modified: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/publish_or_unpublish_a_resource-task.xml Log: "Fixed spelling errors" Modified: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/publish_or_unpublish_a_resource-task.xml =================================================================== --- trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/publish_or_unpublish_a_resource-task.xml 2011-03-17 03:11:01 UTC (rev 29851) +++ trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/publish_or_unpublish_a_resource-task.xml 2011-03-17 03:11:54 UTC (rev 29852) @@ -38,7 +38,7 @@ The publishing wizard (shown in <xref linkend="ModeShape_publishing_wizard"/>) allows you to choose which ModeShape Java Content Repositories (JCR) type repository to interact with and displays the selected files the operation will be performed on. When a project or folder is selected all their included files are acted upon. </para> <para> - Publishing to a <guilabel>Publish Area</guilabel> will automatically sequence your files to extract usful informaiton and make it available to our repsitory users. Extracted information depends upon the type of file and the configuration of the ModeShape repository. The location where files will be published is constructed by appending the server URL, the names of the JCR repository and workspace, the path to the publish area, and the path of the files and folders within your Eclipse workspace. + Publishing to a <guilabel>Publish Area</guilabel> will automatically sequence your files to extract useful information and make it available to our repository users. Extracted information depends upon the type of file and the configuration of the ModeShape repository. The location where files will be published is constructed by appending the server URL, the names of the JCR repository and workspace, the path to the publish area, and the path of the files and folders within your Eclipse workspace. </para> <warning> <para>

13 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r29851 - trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-03-16 23:11:01 -0400 (Wed, 16 Mar 2011) New Revision: 29851 Modified: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/register_a_new_repository-task.xml Log: "Fixed spelling errors" Modified: trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/register_a_new_repository-task.xml =================================================================== --- trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/register_a_new_repository-task.xml 2011-03-17 03:06:43 UTC (rev 29850) +++ trunk/modeshape/docs/ModeShape_Tools_Reference_Guide/en-US/register_a_new_repository-task.xml 2011-03-17 03:11:01 UTC (rev 29851) @@ -49,7 +49,7 @@ </para> <note> <para> - It is possible for a ModeShape server instance to have numerious ModeShape repositories stored on it. Once you have registered a connection to the server you will have access to all ModeShape repositories on the server. You do not need to register a new connection for each repository on the same server. + It is possible for a ModeShape server instance to have numerous ModeShape repositories stored on it. Once you have registered a connection to the server you will have access to all ModeShape repositories on the server. You do not need to register a new connection for each repository on the same server. </para> </note>

13 years, 10 months

1
0
0 / 0

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

jbosstools-commits March 2011