Author: ochikvina Date: 2009-01-22 09:34:31 -0500 (Thu, 22 Jan 2009) New Revision: 13193 Modified: trunk/jsf/docs/jsf_tools_ref_guide/en/modules/jsf_project_verification.xml trunk/jsf/docs/jsf_tools_ref_guide/en/modules/managed_beans.xml Log: https://jira.jboss.org/jira/browse/JBDS-571 - deleting the old markers; Modified: trunk/jsf/docs/jsf_tools_ref_guide/en/modules/jsf_project_verification.xml =================================================================== --- trunk/jsf/docs/jsf_tools_ref_guide/en/modules/jsf_project_verification.xml 2009-01-22 14:32:07 UTC (rev 13192) +++ trunk/jsf/docs/jsf_tools_ref_guide/en/modules/jsf_project_verification.xml 2009-01-22 14:34:31 UTC (rev 13193) @@ -1,107 +1,107 @@ <?xml version="1.0" encoding="UTF-8"?> -<chapter id="jsf_project_verification" role="updated"> - <?dbhtml filename="struts_project_verification.html"?> - - <chapterinfo> - <keywordset> - <keyword>JBoss Developer Studio</keyword> - <keyword>Eclipse</keyword> - <keyword>JSF Tools</keyword> - <keyword>Java</keyword> - <keyword>JBoss</keyword> - </keywordset> - </chapterinfo> - - <title>JSF Project Verification</title> - - <para>In this chapter we&apos;ll discuss a possible verification that you can take advantage - of.</para> - <!-- JBoss Developer Studio checks for many different rules for a JSF project --> - <para>Many different rules are checked for a JSF project that can be configured by selecting <emphasis> - <property>Window > Preferences</property> - </emphasis> from the menu bar, selecting <emphasis> - <property>JBoss Tools > Web > Verification</property> - </emphasis> from the Preferences dialog box and then expanding the JSF Rules node.</para> - <figure> - <title>JSF Rules</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/verif_valid/verif_valid_1.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Suppose you are working in the Source viewer for a JSF configuration file as shown below:</para> - <figure> - <title>Faces-config.xml File</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/verif_valid/verif_valid_2.png"/> - </imageobject> - </mediaobject> - </figure> - <para>While typing a class name, you might make a minor typo (like <emphasis role="italic"> - <property>&quot;jsfHello.PersonBean9&quot;</property> - </emphasis> instead of <emphasis role="italic"> - <property>&quot;jsfHello.PersonBean&quot;</property> - </emphasis>). After saving the file, verification checks to make sure everything is correct - and finds the error below:</para> - <figure> - <title>Error in Source View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/verif_valid/verif_valid_3.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> - <para>Notice that the Package Explorer View shows a marked folder and a marked file where the - error is.</para> - <para>You can place the cursor over the line with an error message and get a detailed error - message:</para> - <figure> - <title>Error Message</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/verif_valid/verif_valid_4.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Verification also checks navigation rules:</para> - <figure> - <title>Checking Navigation Rules</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/verif_valid/verif_valid_5.png"/> - </imageobject> - </mediaobject> - </figure> - <para>If you provide a page name that does not exist, verification will let you know about that:</para> - <figure> - <title>Page Name Verification</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/verif_valid/verif_valid_6.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> - <para>You can always call up verification explicitly by right-clicking any element in the tree - and selecting Verify from the context menu. This works from both the Tree and Diagram - viewers for the JSF configuration file editor. You can also invoke verification from the Web - Projects view. Below we are checking all of the elements in the configuration file.</para> - <figure> - <title>Verify Command</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/verif_valid/verif_valid_7.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>In summary, this document highlights all the JSF-specific features of <property>JBoss Tools</property> - meant for enhancing the development of rich Web applications based on JSF technology. The - reference introduces you to wizards for creating and importing JSF projects, JSF - Configuration File editor features, functionality for enabling JSF capabilities and etc.</para> - - <para>If you have questions or good suggestions, please refer to <ulink - url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... - Tools Forum</ulink>.</para> -</chapter> +<chapter id="jsf_project_verification"> + <?dbhtml filename="struts_project_verification.html"?> + + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>JSF Tools</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>JSF Project Verification</title> + + <para>In this chapter we&apos;ll discuss a possible verification that you can take advantage + of.</para> + <!-- JBoss Developer Studio checks for many different rules for a JSF project --> + <para>Many different rules are checked for a JSF project that can be configured by selecting <emphasis> + <property>Window > Preferences</property> + </emphasis> from the menu bar, selecting <emphasis> + <property>JBoss Tools > Web > Verification</property> + </emphasis> from the Preferences dialog box and then expanding the JSF Rules node.</para> + <figure> + <title>JSF Rules</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_1.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Suppose you are working in the Source viewer for a JSF configuration file as shown below:</para> + <figure> + <title>Faces-config.xml File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_2.png"/> + </imageobject> + </mediaobject> + </figure> + <para>While typing a class name, you might make a minor typo (like <emphasis role="italic"> + <property>&quot;jsfHello.PersonBean9&quot;</property> + </emphasis> instead of <emphasis role="italic"> + <property>&quot;jsfHello.PersonBean&quot;</property> + </emphasis>). After saving the file, verification checks to make sure everything is correct + and finds the error below:</para> + <figure> + <title>Error in Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_3.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + <para>Notice that the Package Explorer View shows a marked folder and a marked file where the + error is.</para> + <para>You can place the cursor over the line with an error message and get a detailed error + message:</para> + <figure> + <title>Error Message</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_4.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Verification also checks navigation rules:</para> + <figure> + <title>Checking Navigation Rules</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_5.png"/> + </imageobject> + </mediaobject> + </figure> + <para>If you provide a page name that does not exist, verification will let you know about that:</para> + <figure> + <title>Page Name Verification</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_6.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + <para>You can always call up verification explicitly by right-clicking any element in the tree + and selecting Verify from the context menu. This works from both the Tree and Diagram + viewers for the JSF configuration file editor. You can also invoke verification from the Web + Projects view. Below we are checking all of the elements in the configuration file.</para> + <figure> + <title>Verify Command</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>In summary, this document highlights all the JSF-specific features of <property>JBoss Tools</property> + meant for enhancing the development of rich Web applications based on JSF technology. The + reference introduces you to wizards for creating and importing JSF projects, JSF + Configuration File editor features, functionality for enabling JSF capabilities and etc.</para> + + <para>If you have questions or good suggestions, please refer to <ulink + url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... + Tools Forum</ulink>.</para> +</chapter> Modified: trunk/jsf/docs/jsf_tools_ref_guide/en/modules/managed_beans.xml =================================================================== --- trunk/jsf/docs/jsf_tools_ref_guide/en/modules/managed_beans.xml 2009-01-22 14:32:07 UTC (rev 13192) +++ trunk/jsf/docs/jsf_tools_ref_guide/en/modules/managed_beans.xml 2009-01-22 14:34:31 UTC (rev 13193) @@ -1,208 +1,208 @@ <?xml version="1.0" encoding="UTF-8"?> -<chapter id="managed_beans" role="updated"> - <?dbhtml filename="managed_beans.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Developer Studio</keyword> - <keyword>Eclipse</keyword> - <keyword>JSF Tools</keyword> - <keyword>Java</keyword> - <keyword>JBoss</keyword> - </keywordset> - </chapterinfo> - - <title>Managed Beans</title> - - <para>There is lots of power to work with <property>managed beans</property>.</para> - <itemizedlist> - <listitem> - <para>Add and generate code for new managed beans</para> - <itemizedlist> - <listitem> - <para>Generate code for attributes and getter/setter methods</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>Add existing managed beans to JSF configuration file</para> - </listitem> - </itemizedlist> - - <para>Thus, in this section we will guides you through all this possibilities.</para> - - <section id="CodeGenerationForManagedBeans421" role="updated"> - - <title>Code Generation for Managed Beans</title> - - <para>To start, create a new managed bean in JSF configuration file editor, in the Tree - view.</para> - <figure> - <title>Creation of New Managed Bean</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_34.png"/> - </imageobject> - </mediaobject> - </figure> - <note> - <title>Note:</title> - <para>When you define a new managed bean, make sure that <emphasis> - <property>Generate Source Code</property> - </emphasis> is checked as shown in the figure below.</para> - </note> - <figure> - <title>New Managed Bean</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_35.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> - <para>After the <emphasis role="italic"> - <property>&quot;Java&quot;</property> - </emphasis> class has been generated you can open it for additional editing. There are - two ways to open the <emphasis role="italic"> - <property>&quot;Java&quot;</property> - </emphasis> class:</para> - - <itemizedlist> - <listitem> - <para>click on <emphasis> - <property>Managed-Bean-Class</property> - </emphasis> link in the editor</para> - </listitem> - </itemizedlist> - <para>or</para> - <itemizedlist> - <listitem> - <para>right click the <emphasis> - <property>managed bean</property> - </emphasis> and select <emphasis> - <property>Open Source</property> - </emphasis></para> - </listitem> - </itemizedlist> - - <figure> - <title>Opening of Created Managed Bean</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_36.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The generated Java source should look as follows:</para> - - <figure> - <title>Java Source Code</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_37.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>You can also generate source code for properties, also includes <emphasis - role="italic"> - <property>&quot;getter&quot;</property> - </emphasis> and <emphasis role="italic"> - <property>&quot;setter&quot;</property> - </emphasis> methods. Right click on the bean and select <emphasis> - <property>New &gt; Property</property> - </emphasis>. You will see <property>Add Property</property> dialog.</para> - <figure> - <title>Generation of Source Code for Properties</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_38.png"/> - </imageobject> - </mediaobject> - </figure> - <para>When the form is open make sure that all the check boxes are selected:</para> - <itemizedlist> - <listitem> - <para>Add Java property</para> - </listitem> - <listitem> - <para>Generate Getter</para> - </listitem> - <listitem> - <para>Generate Setter</para> - </listitem> - </itemizedlist> - <para/> - <figure> - <title>&quot;Add Property&quot; Form</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_39.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Once the generation is complete, you can open the file and see the added property with - <emphasis role="italic"> - <property>&quot;get&quot;</property> - </emphasis> and <emphasis role="italic"> - <property>&quot;set&quot;</property> - </emphasis> methods:</para> - <figure> - <title>Generated Java Source Code for Property</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_40.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> - <para>Thus, we&apos;ve discussed everything which comes to creating a new Managed Bean. - The next section will show you how to add an existing Bean into a JSF configuration - file.</para> - </section> - <section id="AddExistingJavaBeansToAJSFConfigurationFile74332" role="updated"> - - <title>Add Existing Java Beans to a JSF Configuration File</title> - <para>If you already have a Java bean you can easily add it to a <property>JSF configuration - file</property>.</para> - <para>You should start the same way you create a new managed bean. Use the <emphasis> - <property>Browse...</property> - </emphasis> button to add your existing Java class.</para> - <figure> - <title>New Managed Bean Form</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_42.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Once the class is set, its <emphasis> - <property>Name</property> - </emphasis> will be set as well. But you can easily substitute it for the other one. - Notice that <emphasis> - <property>Generate Source Code</property> - </emphasis> option is not available as the <emphasis role="italic"> - <property>&quot;Java&quot;</property> - </emphasis> class already exists. </para> - <para>After adding your class <emphasis> - <property>Next</property> - </emphasis> button will be activated. Pressing it you&apos;ll get <emphasis> - <property>Managed Properties</property> - </emphasis> dialog where all corresponding properties are displayed. Check the necessary - ones to add them into your <property>JSF Configuration File</property>.</para> - - <figure> - <title>Selection of Bean&apos;s Properties.</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_43.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>If you don&apos;t want to add any, just click <emphasis> - <property>Finish</property>. </emphasis></para> - <para>Above-listed steps have demonstrated how you can specify an existing Bean in the JSF - configuration file, i.e. <emphasis> - <property>faces-config.xml</property>. </emphasis> In the next chapter - you&apos;ll know how to organize and register another kind of artifacts.</para> - </section> -</chapter> +<chapter id="managed_beans"> + <?dbhtml filename="managed_beans.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>JSF Tools</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>Managed Beans</title> + + <para>There is lots of power to work with <property>managed beans</property>.</para> + <itemizedlist> + <listitem> + <para>Add and generate code for new managed beans</para> + <itemizedlist> + <listitem> + <para>Generate code for attributes and getter/setter methods</para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para>Add existing managed beans to JSF configuration file</para> + </listitem> + </itemizedlist> + + <para>Thus, in this section we will guides you through all this possibilities.</para> + + <section id="CodeGenerationForManagedBeans421"> + + <title>Code Generation for Managed Beans</title> + + <para>To start, create a new managed bean in JSF configuration file editor, in the Tree + view.</para> + <figure> + <title>Creation of New Managed Bean</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_34.png"/> + </imageobject> + </mediaobject> + </figure> + <note> + <title>Note:</title> + <para>When you define a new managed bean, make sure that <emphasis> + <property>Generate Source Code</property> + </emphasis> is checked as shown in the figure below.</para> + </note> + <figure> + <title>New Managed Bean</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_35.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + <para>After the <emphasis role="italic"> + <property>&quot;Java&quot;</property> + </emphasis> class has been generated you can open it for additional editing. There are + two ways to open the <emphasis role="italic"> + <property>&quot;Java&quot;</property> + </emphasis> class:</para> + + <itemizedlist> + <listitem> + <para>click on <emphasis> + <property>Managed-Bean-Class</property> + </emphasis> link in the editor</para> + </listitem> + </itemizedlist> + <para>or</para> + <itemizedlist> + <listitem> + <para>right click the <emphasis> + <property>managed bean</property> + </emphasis> and select <emphasis> + <property>Open Source</property> + </emphasis></para> + </listitem> + </itemizedlist> + + <figure> + <title>Opening of Created Managed Bean</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_36.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The generated Java source should look as follows:</para> + + <figure> + <title>Java Source Code</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_37.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>You can also generate source code for properties, also includes <emphasis + role="italic"> + <property>&quot;getter&quot;</property> + </emphasis> and <emphasis role="italic"> + <property>&quot;setter&quot;</property> + </emphasis> methods. Right click on the bean and select <emphasis> + <property>New &gt; Property</property> + </emphasis>. You will see <property>Add Property</property> dialog.</para> + <figure> + <title>Generation of Source Code for Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_38.png"/> + </imageobject> + </mediaobject> + </figure> + <para>When the form is open make sure that all the check boxes are selected:</para> + <itemizedlist> + <listitem> + <para>Add Java property</para> + </listitem> + <listitem> + <para>Generate Getter</para> + </listitem> + <listitem> + <para>Generate Setter</para> + </listitem> + </itemizedlist> + <para/> + <figure> + <title>&quot;Add Property&quot; Form</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_39.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Once the generation is complete, you can open the file and see the added property with + <emphasis role="italic"> + <property>&quot;get&quot;</property> + </emphasis> and <emphasis role="italic"> + <property>&quot;set&quot;</property> + </emphasis> methods:</para> + <figure> + <title>Generated Java Source Code for Property</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_40.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + <para>Thus, we&apos;ve discussed everything which comes to creating a new Managed Bean. + The next section will show you how to add an existing Bean into a JSF configuration + file.</para> + </section> + <section id="AddExistingJavaBeansToAJSFConfigurationFile74332"> + + <title>Add Existing Java Beans to a JSF Configuration File</title> + <para>If you already have a Java bean you can easily add it to a <property>JSF configuration + file</property>.</para> + <para>You should start the same way you create a new managed bean. Use the <emphasis> + <property>Browse...</property> + </emphasis> button to add your existing Java class.</para> + <figure> + <title>New Managed Bean Form</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_42.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Once the class is set, its <emphasis> + <property>Name</property> + </emphasis> will be set as well. But you can easily substitute it for the other one. + Notice that <emphasis> + <property>Generate Source Code</property> + </emphasis> option is not available as the <emphasis role="italic"> + <property>&quot;Java&quot;</property> + </emphasis> class already exists. </para> + <para>After adding your class <emphasis> + <property>Next</property> + </emphasis> button will be activated. Pressing it you&apos;ll get <emphasis> + <property>Managed Properties</property> + </emphasis> dialog where all corresponding properties are displayed. Check the necessary + ones to add them into your <property>JSF Configuration File</property>.</para> + + <figure> + <title>Selection of Bean&apos;s Properties.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_43.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>If you don&apos;t want to add any, just click <emphasis> + <property>Finish</property>. </emphasis></para> + <para>Above-listed steps have demonstrated how you can specify an existing Bean in the JSF + configuration file, i.e. <emphasis> + <property>faces-config.xml</property>. </emphasis> In the next chapter + you&apos;ll know how to organize and register another kind of artifacts.</para> + </section> +</chapter>