Author: ochikvina Date: 2009-02-24 10:31:11 -0500 (Tue, 24 Feb 2009) New Revision: 13768 Modified: trunk/seam/docs/reference/en/modules/seam_wizards.xml Log: https://jira.jboss.org/jira/browse/JBDS-582 - updating the "Seam Wizards" section; Modified: trunk/seam/docs/reference/en/modules/seam_wizards.xml =================================================================== --- trunk/seam/docs/reference/en/modules/seam_wizards.xml 2009-02-24 15:30:09 UTC (rev 13767) +++ trunk/seam/docs/reference/en/modules/seam_wizards.xml 2009-02-24 15:31:11 UTC (rev 13768) @@ -6,88 +6,125 @@ <keyword>JBoss Tools</keyword> <keyword>Seam</keyword> <keyword>JBDS</keyword> - </keywordset> + </keywordset> </chapterinfo> - + <title>Seam Wizards</title> - + <para>This chapter introduces you with Seam Components.</para> - <para>All the Seam component generations options known from Seam-gen are available as wizards (with sensible auto-defaulting) - for creating various common Seam components:</para> - + <para>All the Seam component generations options known from Seam-gen are available as wizards + (with sensible auto-defaulting) for creating various common Seam components:</para> + <itemizedlist> - <listitem><para><property>Seam Action</property></para></listitem> - <listitem><para><property>Seam Form</property></para></listitem> - <listitem><para><property>Seam Entity</property></para></listitem> - <listitem><para><property>Seam Conversation</property></para></listitem> + <listitem> + <para> + <property>Seam Action</property> + </para> + </listitem> + <listitem> + <para> + <property>Seam Form</property> + </para> + </listitem> + <listitem> + <para> + <property>Seam Entity</property> + </para> + </listitem> + <listitem> + <para> + <property>Seam Conversation</property> + </para> + </listitem> </itemizedlist> - - <para>Go to <emphasis><property>File > New</property></emphasis> and select the component wizard.</para> - + + <para>Go to <emphasis> + <property>File > New</property> + </emphasis> and select the component wizard.</para> + <figure> <title>Seam Component Wizards</title> - <mediaobject> + <mediaobject> <imageobject> <imagedata fileref="images/seam_wizards/seam_wizards_1.png"/> </imageobject> </mediaobject> </figure> - - <para>The wizards create multiple resources and place it in the appropriate folders depending on your project structure (WAR or EAR).</para> - <para>Let&apos;s create a WAR project using the New Seam Project wizard.</para> + <para>The wizards create multiple resources and place it in the appropriate folders depending on + your project structure (WAR or EAR).</para> + <para>Let&apos;s create a WAR project using the New Seam Project wizard.</para> + <figure> <title>Seam Project WAR Deployment</title> - <mediaobject> + <mediaobject> <imageobject> <imagedata fileref="images/seam_wizards/seam_wizards_2.png"/> </imageobject> </mediaobject> </figure> - + <para>After the project is created you need deploy it on server.</para> - - + + <section id="seam_action"> - + <title>New Seam Action</title> <para>In this and following sections you can see example creating Seam Components.</para> - <para>To create a New Seam Action you should select a necessary project, type a name for <property>Seam component</property>, <property>POJO class</property>, - <property>Method</property>, <property>Page</property> and select a <property>Package</property> using <emphasis><property>Browse</property></emphasis> button.</para> - + <para>To create a New Seam Action you should select a necessary project, type a name for + <property>Seam component</property>, <property>POJO class</property>, + <property>Method</property>, <property>Page</property> and select a + <property>Package</property> using the <emphasis> + <property>Browse</property> + </emphasis> button.</para> + <figure> <title>New Seam Action Wizard</title> - <mediaobject> + <mediaobject> <imageobject> <imagedata fileref="images/seam_wizards/seam_wizards_4.png"/> </imageobject> </mediaobject> </figure> - <para>You can see the action page in <property>WebContent</property> folder. Click on it to open in JBoss Tools HTML Editor.</para> + <para>If you specify a class which already exists, the wizard will warn you about it.</para> - <figure> - <title>Action Page in JBoss Tools HTML Editor.</title> - <mediaobject> + <figure> + <title>Wizard Warning against Existing File</title> + <mediaobject> <imageobject> + <imagedata fileref="images/seam_wizards/action_warning.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>You can see the action page in <property>WebContent</property> folder. Click on it to + open in JBoss Tools HTML Editor.</para> + + <figure> + <title>Action Page in JBoss Tools HTML Editor.</title> + <mediaobject> + <imageobject> <imagedata fileref="images/seam_wizards/seam_wizards_5.png" scale="70"/> </imageobject> </mediaobject> </figure> - - + + <note> <title>Note:</title> - <para>You don't need to restart the server to see how the action component works. Just use context menu - <emphasis><property>Run As > Run On Server</property>.</emphasis></para> + <para>You don't need to restart the server to see how the action component works. Just + use context menu <emphasis><property>Run As > Run On + Server</property>.</emphasis></para> </note> - - <para>Action component was hot-deployed. Forms and Conversations will work the same way.</para> - + + <para>Action component was hot-deployed. Forms and Conversations will work the same + way.</para> + <figure> <title>Action Component</title> - <mediaobject> + <mediaobject> <imageobject> <imagedata fileref="images/seam_wizards/seam_wizards_6.png"/> </imageobject> @@ -95,158 +132,210 @@ </figure> - + </section> <section id="seam_form"> <title>New Seam Form</title> - <para>Click on <property>actionMethod</property> in the internal browser and add a form in your project using the New Seam Form wizard - <emphasis><property>File > New > Seam Form</property>.</emphasis></para> - <para>Select a necessary project, type a name for <property>Seam component</property>, <property>POJO class</property>, - <property>Method</property>, <property>Page</property> and select a <property>Package</property> using <emphasis><property>Browse</property></emphasis> button.</para> - + <para>Click on <property>actionMethod</property> in the internal browser and add a form in + your project using the New Seam Form wizard <emphasis><property>File > New > Seam + Form</property>.</emphasis></para> + <para>Select a necessary project, type a name for <property>Seam component</property>, + <property>POJO class</property>, <property>Method</property>, + <property>Page</property> and select a <property>Package</property> using <emphasis> + <property>Browse</property> + </emphasis> button.</para> + <figure> <title>New Seam Form Wizard</title> - <mediaobject> + <mediaobject> <imageobject> <imagedata fileref="images/seam_wizards/seam_wizards_7.png"/> </imageobject> </mediaobject> </figure> - <para>The Form Page was created in <property>WebContent</property> folder.</para> + <para>If you specify a class which already exists, the wizard will warn you about it.</para> <figure> + <title>Wizard Warning against Existing File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/form_warning.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The Form Page was created in <property>WebContent</property> folder.</para> + + <figure> <title>Form Page in JBoss Tools HTML Editor.</title> - <mediaobject> + <mediaobject> <imageobject> <imagedata fileref="images/seam_wizards/seam_wizards_8.png" scale="70"/> </imageobject> </mediaobject> </figure> - - <para>Deploy the form on server. Right click on Form Page, select <emphasis><property>Run As > Run On Server</property>.</emphasis></para> - + + <para>Deploy the form on server. Right click on Form Page, select <emphasis><property>Run As + > Run On Server</property>.</emphasis></para> + <figure> <title>Form Component</title> - <mediaobject> + <mediaobject> <imageobject> <imagedata fileref="images/seam_wizards/seam_wizards_9.png"/> </imageobject> </mediaobject> </figure> - + <para>Form component was hot-deployed.</para> - + </section> - + <section id="seam_conversation"> <title>New Seam Conversation</title> - - <para>Enter some value in the text field (e.g. <property>value1</property>) and click on <property>formMethod</property>.</para> - <para>Add a conversation using the New Seam Conversation wizard - <emphasis><property>File > New > Seam Form</property>.</emphasis></para> - <para>You should select a necessary project, type a name for <property>Seam component</property>, <property>POJO class</property>, - <property>Method</property>, <property>Page</property> and select a <property>Package</property> using <emphasis><property>Browse</property></emphasis> button.</para> - - + + <para>Enter some value in the text field (e.g. <property>value1</property>) and click on + <property>formMethod</property>.</para> + <para>Add a conversation using the New Seam Conversation wizard <emphasis><property>File > + New > Seam Form</property>.</emphasis></para> + <para>You should select a necessary project, type a name for <property>Seam + component</property>, <property>POJO class</property>, <property>Method</property>, + <property>Page</property> and select a <property>Package</property> using <emphasis> + <property>Browse</property> + </emphasis> button.</para> + + <figure> <title>New Seam Conversation Wizard</title> - <mediaobject> + <mediaobject> <imageobject> <imagedata fileref="images/seam_wizards/seam_wizards_10.png"/> </imageobject> </mediaobject> </figure> + <para>If you specify a class which already exists, the wizard will warn you about it.</para> + + <figure> + <title>Wizard Warning against Existing File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/conversation_warning.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Conversation page was created in <property>WebContent</property> folder.</para> - + <figure> <title>Conversation Page in JBoss Tools HTML Editor.</title> - <mediaobject> + <mediaobject> <imageobject> <imagedata fileref="images/seam_wizards/seam_wizards_11.png" scale="70"/> </imageobject> </mediaobject> </figure> - - <para>Right click on Conversation page, select <emphasis><property>Run As > Run On Server</property>.</emphasis></para> - + + <para>Right click on Conversation page, select <emphasis><property>Run As > Run On + Server</property>.</emphasis></para> + <figure> <title>Conversation Component</title> - <mediaobject> + <mediaobject> <imageobject> <imagedata fileref="images/seam_wizards/seam_wizards_12.png"/> </imageobject> </mediaobject> </figure> - + <para>Conversation component was hot-deployed.</para> - <para>Click on <property>Begin</property> and <property>Increment</property> buttons to check the conversation functionality.</para> - + <para>Click on <property>Begin</property> and <property>Increment</property> buttons to + check the conversation functionality.</para> + </section> - - + + <section id="seam_entity"> <title>New Seam Entity</title> - - <para>Entities cannot be hot-deployed, so we need to stop the server.</para> - <para>Create an Entity using the New Entity wizard <emphasis><property>File > New > Seam Entity</property>.</emphasis> </para> - - <para>You should select a necessary project, type a name for <property>Entity class</property>, select a - <property>Package</property> using <emphasis><property>Browse</property></emphasis> button, type a name for <property>Master Page</property> and <property>Page</property>.</para> - + + <para>Entities cannot be hot-deployed, so we need to stop the server.</para> + <para>Create an Entity using the New Entity wizard <emphasis><property>File > New > Seam + Entity</property>.</emphasis> + </para> + + <para>You should select a necessary project, type a name for <property>Entity + class</property>, select a <property>Package</property> using <emphasis> + <property>Browse</property> + </emphasis> button, type a name for <property>Master Page</property> and + <property>Page</property>.</para> + <figure> <title>New Seam Entity Wizard</title> - <mediaobject> + <mediaobject> <imageobject> <imagedata fileref="images/seam_wizards/seam_wizards_13.png"/> </imageobject> </mediaobject> </figure> - - <para>The Master Page and the Entity were created in <property>WebContent</property> folder.</para> - + + <para>If you specify a class which already exists, the wizard will warn you about it.</para> + <figure> + <title>Wizard Warning against Existing File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_wizards/entity_warning.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The Master Page and the Entity were created in <property>WebContent</property> + folder.</para> + + <figure> <title>Master Page in JBoss Tools HTML Editor.</title> - <mediaobject> + <mediaobject> <imageobject> <imagedata fileref="images/seam_wizards/seam_wizards_14.png" scale="70"/> </imageobject> </mediaobject> </figure> - - <para>The Entity page is:</para> - + + <para>The Entity page is:</para> + <figure> <title>Entity Page in JBoss Tools HTML Editor.</title> - <mediaobject> + <mediaobject> <imageobject> <imagedata fileref="images/seam_wizards/seam_wizards_15.png" scale="70"/> </imageobject> </mediaobject> </figure> - + <para>Run the Entity page on server. This is what you get:</para> - + <figure> <title>Customer Page</title> - <mediaobject> + <mediaobject> <imageobject> <imagedata fileref="images/seam_wizards/seam_wizards_16.png"/> </imageobject> </mediaobject> </figure> - <para>Let's create two customers <property>c1</property> and <property>c2</property>. Enter the name in the text field and press the <property>Save</property> button. - Customer should be successfully created. Press <property>Done</property>. Do the same for <property>c2</property> customer. The result should be:</para> - + <para>Let's create two customers <property>c1</property> and <property>c2</property>. Enter + the name in the text field and press the <property>Save</property> button. Customer + should be successfully created. Press <property>Done</property>. Do the same for + <property>c2</property> customer. The result should be:</para> + <figure> <title>Two Customers Are Created</title> - <mediaobject> + <mediaobject> <imageobject> <imagedata fileref="images/seam_wizards/seam_wizards_17.png"/> </imageobject> </mediaobject> - </figure> - </section> - </chapter> + </figure> + </section> +</chapter>