[jbosstools-commits] JBoss Tools SVN: r29858 - trunk/struts/docs/struts_tools_tutorial/en-US.

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 &gt; Configuration &gt; default - &gt; struts-config.xml &gt; 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>&quot;action&quot;</property> - </emphasis> attribute to the - <code>&lt;html:form&gt;</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>&lt;html:submit&gt;</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 &quot;Say Hello!&quot; 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>&lt;p&gt;</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 &quot;GetNameForm&quot; for the <emphasis - role="italic"> - <property>name</property> - </emphasis> attribute and add a <emphasis role="italic"> - <property>property</property> - </emphasis> attribute with &quot;name&quot; 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 &quot;forward=getName&quot; 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>&quot;action&quot;</property> </emphasis> attribute to the <code>&lt;html:form&gt;</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>&lt;html:submit&gt;</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 &quot;Say Hello!&quot; 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>&lt;p&gt;</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 &quot;GetNameForm&quot; for the <emphasis + role="italic"> <property>name</property> </emphasis> attribute and add a <emphasis role="italic"> <property>property</property> </emphasis> attribute with &quot;name&quot; 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 &quot;forward=getName&quot; 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 - &quot;StrutsHello&quot; 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 &quot;StrutsHello&quot; 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, - &quot;Hello &lt;name&gt;!&quot;</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/too... in the corresponding release directory.</para> - <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">htt... - - </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, &quot;Hello &lt;name&gt;!&quot; + </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/too... in the corresponding release directory. + </para> + + <para> + The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">htt...;. + </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 &gt; Open Perspective &gt; Other &gt; 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 &gt; New &gt; Struts Project</property> - </emphasis></para> - </listitem> - <listitem> - <para>Next enter &quot;StrutsHello&quot; 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 &quot;StrutsHello&quot; 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 &gt; WEB-ROOT (WebContent)</property> - </emphasis> folder in the <property moreinfo="none">Web Projects view</property> and select <emphasis> - <property moreinfo="none">New &gt; 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 &gt; File &gt; 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 &gt; File &gt; 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[&lt;%@ taglib uri=&quot;/WEB-INF/struts-html&quot; prefix=&quot;html&quot; %&gt; -&lt;html:html&gt; -&lt;head&gt; - &lt;title&gt;&lt;/title&gt; -&lt;/head&gt; -&lt;body&gt; - &lt;html:form action=&quot;&quot;&gt; - &lt;/html:form&gt; -&lt;/body&gt; -&lt;/html:html&gt;]]></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>&lt;leave blank&gt;</entry> - </row> - </tbody> - </tgroup> - </table> - <para>(&quot;GetNameForm&quot; 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&apos;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&apos;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&apos;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 - &quot;sayHello&quot; 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 &quot;StrutsHello&quot; 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 &quot;StrutsHello&quot; 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[&lt;%@ taglib uri=&quot;/WEB-INF/struts-html&quot; prefix=&quot;html&quot; %&gt; +&lt;html:html&gt; +&lt;head&gt; + &lt;title&gt;&lt;/title&gt; +&lt;/head&gt; +&lt;body&gt; + &lt;html:form action=&quot;&quot;&gt; + &lt;/html:form&gt; +&lt;/body&gt; +&lt;/html:html&gt;]]> + </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> + &lt;leave blank&gt; + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para> + (&quot;GetNameForm&quot; 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&apos;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&apos;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&apos;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 &quot;sayHello&quot; 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&apos;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 &quot;StrutsHello&quot; 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 &quot;plug-ins&quot; node under the <emphasis><property>StrutsHello &gt; Configuration &gt; default &gt; struts-config.xml</property></emphasis> node in the Web Projects view and select <emphasis><property>Create Special Plugin &gt; 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 &gt; ResourceBundles</property></emphasis> node and select <emphasis><property> New &gt; 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 &quot;applResources&quot; 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 &gt; 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 &gt; Save </property></emphasis>All from the menu bar</para></listitem> -<listitem><para>Select validation.xml under the <emphasis><property>StrutsHello &gt; 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 &quot;form-beans&quot; node under the <emphasis><property>StrutsHello &gt; Configuration &gt; default &gt; struts-config.xml node.</property></emphasis> Then, drag the form bean &quot;GetNameForm&quot; 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 &quot;tree&quot; 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 &quot;name.required&quot; in the Name field, and enter a person&apos;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 &gt; 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&apos;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&apos;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 &quot;formName&quot; from the prompting menu</para></listitem> -<listitem><para>Over in the Web Projects view, select GetNameForm under the <emphasis><property>StrutsHello &gt; Configuration &gt; default &gt; struts-config.xml &gt; form-beans</property></emphasis> node, drag it, and drop it between the quotes in the editor</para></listitem> -<listitem><para>Modify the <code>&lt;html:form&gt;</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 &gt; Run on Server</property></emphasis></para></listitem> -</itemizedlist> - -<itemizedlist><listitem><para>In the browser window, click on the &quot;Say Hello!&quot; 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&apos;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>&quot;onsubmit&quot;</property></emphasis> attribute in the <code>&lt;html:form&gt;</code> element that you put in for client-side validation</para></listitem> - -<listitem><para>Add an <code>&lt;html:errors/&gt;</code> tag after the - <code>&lt;html:form&gt;</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 &quot;Change Time Stamp&quot; 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 &quot;Say Hello!&quot; 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&apos;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 &quot;StrutsHello&quot; 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 &quot;plug-ins&quot; 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 &quot;applResources&quot; 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 &quot;form-beans&quot; 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 &quot;GetNameForm&quot; 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 &quot;tree&quot; 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 &quot;name.required&quot; in the Name field, and enter a person&apos;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&apos;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&apos;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 &quot;formName&quot; 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>&lt;html:form&gt;</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 &quot;Say Hello!&quot; 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&apos;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>&quot;onsubmit&quot;</property></emphasis> attribute in the <code>&lt;html:form&gt;</code> element that you put in for client-side validation + </para> + </listitem> + + <listitem> + <para> + Add an <code>&lt;html:errors/&gt;</code> tag after the <code>&lt;html:form&gt;</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 &quot;Change Time Stamp&quot; 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 &quot;Say Hello!&quot; 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>