From jbosstools-commits at lists.jboss.org Wed Jan 26 22:41:34 2011 Content-Type: multipart/mixed; boundary="===============5602248238251347968==" MIME-Version: 1.0 From: jbosstools-commits at lists.jboss.org To: jbosstools-commits at lists.jboss.org Subject: [jbosstools-commits] JBoss Tools SVN: r28643 - trunk/jsf/docs/jsf_tools_ref_guide/en-US. Date: Wed, 26 Jan 2011 22:41:34 -0500 Message-ID: <201101270341.p0R3fYIw015066@svn01.web.mwc.hst.phx2.redhat.com> --===============5602248238251347968== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: mcaspers Date: 2011-01-26 22:41:34 -0500 (Wed, 26 Jan 2011) New Revision: 28643 Modified: trunk/jsf/docs/jsf_tools_ref_guide/en-US/jsf_config_file.xml Log: General Updates Modified: trunk/jsf/docs/jsf_tools_ref_guide/en-US/jsf_config_file.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/jsf/docs/jsf_tools_ref_guide/en-US/jsf_config_file.xml 2011-01-27= 03:24:34 UTC (rev 28642) +++ trunk/jsf/docs/jsf_tools_ref_guide/en-US/jsf_config_file.xml 2011-01-27= 03:41:34 UTC (rev 28643) @@ -1,431 +1,399 @@ - - - - JBoss Developer Studio - Eclipse - JSF Tools - Java - JBoss - - + + + + JBoss Developer Studio + Eclipse + JSF Tools + Java + JBoss + + = - JSF Configuration File Editor + JSF Configuration File Editor = - First, we should mention that JSF configuration file ( - faces-config.xml - ) is intended for registering JSF application resources= such as Converters, - Validators, Managed Beans and page-to-page navigation rules. - Now, let's look at how you can easily configure this file b= y means of a special - graphical editor for JSF configuration file. The editor has three = main views: + + First, we should mention that JSF configuration file (faces-co= nfig.xml) is intended for registering JSF application resources = such as Converters, Validators, Managed Beans and page-to-page navigation r= ules. + + + Now, let's look at how you can easily configure this file by means = of a special graphical editor for the JSF configuration file. The editor ha= s three main views: + = - - - Diagram - - - Tree - - - Source - - + + + Diagram + + + Tree + + + Source + + = - They can be selected via the tabs at the bottom of the editor. + They can be selected via the tabs at the bottom of the editor. = -
+
= - Diagram view + Diagram view = - Here, we will show you how to work with JSF configuration fi= le through the Diagram - view of the editor. - As you can see on the figure below, the Diagram view display= s the navigation rules in - the faces-config.xml: -
- Diagram View - - - - - -
+ Here, we will show you how to work with JSF configuration file thr= ough the Diagram view of the editor. + As you can see on the figure below, the Diagram view displays the = navigation rules container in the faces-config.xml fil= e: +
+ Diagram View + + + + + +
= - If your diagram is large, make use of the Outline view. With= in it you can switch to a - Diagram Navigator - mode by selecting the middle icon at the top of th= e view window. It allows - you to easily move around the diagram. Just move the blue area= in any direction, and the - diagram on the left will also move: -
- Outline View for Diagram - - - - - -
+ + If you have a large diagram, make use of the Outline view. Within it yo= u can switch to a Diagram Navigator mode by selecting = the middle icon at the top of the view window. This allows you to easily mo= ve around the diagram. Just move the blue area in any direction, and the di= agram on the left will also move: + +
+ Outline View for Diagram + + + + + +
= - To create a new page here, you should click the page icon (V= iew Template) on the - toolbar from the left and then click anywhere on the diagram. = A New Page Wizard will - appear. + + To create a new page here, you should click the page icon (View Templat= e) on the toolbar from the left and then click anywhere on the diagram. A N= ew Page Wizard will appear. + = - To create a transition for connecting pages: + To create a transition for connecting pages: = - - - Select the transition icon from the toolbar (New Con= nection). - - - Click the source page. - - - Click the target page. - - + + + Select the transition icon from the toolbar (New Connection). + + + Click the source page. + + + Click the target page. + + = - A transition will appear between the two pages: -
- Transition between JSP Pages - - - - - -
+ A transition will appear between the two pages: +
+ Transition between JSP Pages + + + + + +
= - It is also possible to create a new page with context menu b= y right-clicking anywhere - on the diagram and selecting - Rule... -
- Creating a New View - - - - - -
+ + It is also possible to create a new page with context menu by right-cli= cking anywhere on the diagram and selecting the Rule... option. + +
+ Creating a New View + + + + + +
= - To edit an existing transition, first select the transition = line. Then, place the - mouse cursor over the last black dot (on the target page). The= mouse cursor will change - to a big +. At this point, drag the line to a new target page:= -
- Editing Transition between Views - - - - - -
-
-
+ + To edit an existing transition, first select the transition line. Then,= place the mouse cursor over the last black dot (on the target page). The m= ouse cursor will change to a big +. At this point, drag the line to a new t= arget page: + +
+ Editing Transition between Views + + + + + +
+
+
= - Tree View + Tree View = - You can find it more convenient to edit your JSF Configurati= on file in the Tree view of - the VPE. + You can find it more convenient to edit your JSF Configuration fil= e in the Tree view of the VPE. = - The view displays all JSF application artifacts referenced i= n the configuration file - in a tree format. By selecting any node on the left, you can s= ee and edit its properties - which will appear in the right-hand area. Let's look at t= he structure of this - tree more closely. + + The view displays all JSF application artifacts referenced in the confi= guration file in a tree format. By selecting any node on the left, you can = view and edit its properties which will appear in the right-hand area. Let&= apos;s look at the structure of this tree more closely. + = - - - Under the - Application - node you can adjust JSF application specif= ic settings such as - internationalization, possibility to set extensions, a= dd property and variable - resolvers, etc. - - + + + + Under the Application node you can adjust JSF ap= plication specific settings such as internationalization, extensions, addin= g property and variable resolvers, etc. + + + = -
- JSF Application Specific Settings - - - - - -
+
+ JSF Application Specific Settings + + + + + +
= - - - The - Components - node is for registering custom JSF compone= nts. Right-click and - choose - New > Component - or just press the - Add - button in the right-hand area to add a new= component to the JSF - Configuration file. - - + + + + The Components node is for registering custom JS= F components. Right-click and select NewComponent or just click the Add button in the right-hand area to add a new componen= t to the JSF Configuration file. + + + = -
- Registering a New JSF Component - - - - - -
+
+ Registering a New JSF Component + + + + + +
= - In the Add Component wizard you= should set a component - type and point to a component class by using the - Browse - button or create a new class for this comp= onent by using the - Component-Class - link. + + In the Add Component wizard you should set a compo= nent type and point to a component class by using the Browse button or create a new class for this component by using the Component-Class link. + = -
- Adding a New JSF Component to the JSF Configuration Fil= e - - - - - -
+
+ Adding a New JSF Component to the JSF Configuration File + + + + + +
= - - - Use the - Render Kit - node to create and register a set of relat= ed renderers for custom - JSF components. - - + + + Use the Render Kit node to create and regis= ter a set of related renderers for custom JSF components. + + = -
- Adding a New JSF Renderer Kit to the JSF Configuration = File - - - - - -
+
+ Adding a New JSF Renderer Kit to the JSF Configuration File</tit= le> + <mediaobject> + <imageobject> + <imagedata fileref=3D"images/jsf_support/jsf_support_24d.png"/> + </imageobject> + </mediaobject> + </figure> = - <itemizedlist> - <listitem> - <para>Under the <emphasis> - <property>Converters</property> - </emphasis> node you can create a converter class for = your JSF application - either with id or for a proper class. How to do that s= ee the <xref linkend=3D"CreateAndRegisterACustomConverter94230"/> section.<= /para> - </listitem> - </itemizedlist> + <itemizedlist> + <listitem> + <para> + Under the <guilabel>Converters</guilabel> node you can create a conve= rter class for your JSF application either with an id or for a proper class= . For more information on this procedure see <xref linkend=3D"CreateAndRegi= sterACustomConverter94230"/>. + </para> + </listitem> + </itemizedlist> = - <figure> - <title>Creating a New Custom Converter - - - - - -
+
+ Creating a New Custom Converter + + + + + +
= - - - The - Managed Bean - node is meant for creating and registering= Bean classes in your JSF - application. Read more on the topic in the chapter. - - + + + + The Managed Bean node allows you to create and r= egister Bean classes in your JSF application. Read more on the topic in . + + + = -
- Managed Beans - - - - - -
+
+ Managed Beans + + + + + +
= - - - Use the - Navigation Rules - node to configure a navigation between the= pages in your - application: create a new navigation rule and adjust n= ecessary properties for it - in the right-hand area. - - - - Tip: - The same you can do in the of the - JSF Configuration file editor. - + + + + Use the Navigation Rules node to configure a nav= igation between the pages in your application. Here you can create a new na= vigation rule and adjust necessary properties for it in the right-hand area. + + + + + Tip: + The same you can do in the Diagram view of the JSF Configuration = file editor (see ). + = -
- Configuring Navigation Rules - - - - - -
+
+ Configuring Navigation Rules + + + + + +
= - - - Under the - Referenced Beans - node you can add a new Referenced Bean and= configure various - properties for it. To learn more on this refer to the = - section. - - + + + + Under the Referenced Beans node you can add a ne= w Referenced Bean and configure various properties for it. To learn more on= this refer to . + + + = -
- Referenced Beans - - - - - -
+
+ Referenced Beans + + + + + +
= - - - The - Validators - node is needed to create validator classes= for organizing the - validation of your application data. You can read more= on the topic in the section. - - + + + + The Validators node is needed to create validato= r classes for organizing the validation of your application data. You can r= ead more on the topic in . + + + = -
- Validators - - - - - -
+
+ Validators + + + + + +
= - - - The - Extensions - node is for setting extensions for your - faces-config.xml.<= /para> - - + + + The Extensions node is for setting extensio= ns in your faces-config.xml file. + + + = -
- Adding Extensions - - - - - -
+
+ Adding Extensions + + + + + +
= - In the Tree view you can also edit the = properties of the selected - element with the help of the Properties view as shown below: + + In the Tree view you can also edit the properties = of the selected element with the help of the Properties view as shown below: + = -
- Properties View - - - - - -
+
+ Properties View + + + + + +
= -
-
+
+
= - Source View + Source View = - Here, we'll discuss how you can configure your faces-co= nfig.xml with the help - of Source View. - The Source view for the editor displays a text content of th= e JSF configuration file. - It is always synchronized with other two views, so any changes= made in one of the views - will immediately appear in the other: -
- Source View - - - - - -
+ + Here, we'll discuss how you can configure your faces-con= fig.xml file with the help of the Source View. + + + The Source view for the editor displays the text c= ontent of the JSF configuration file. It is always synchronized with other = two views, so any changes made in one of the views will immediately appear = in the other: + +
+ Source View + + + + + +
= = - You can also work in the Source view with the help of the - Outline view. The Outline = view shows a tree - structure of the JSF configuration file. Simply select any ele= ment in the Outline view, - and it will jump to the same place in the Source editor, so yo= u can navigate through the - source code with Outline view. -
- Outline View - - - - - -
+ + You can also work in the Source view with the help= of the Outline view. The Outline view shows a tree structure of the JSF configuration file. Simply select a= ny element in the Outline view, and it will jump to th= e same place in the Source editor, so you can navigate through the source c= ode with Outline view. + +
+ Outline View + + + + + +
= -
+
= -
- Editor Features - Here we'll discuss a very important features that JSF c= onfiguration file - editor provides for work with JSF resources. +
+ Editor Features + Here we'll discuss a very important features that JSF configu= ration file editor provides when working with JSF resources. = -
- Open On - The JSF configuration file editor comes with a very usef= ul OpenOn navigating - feature. More fully you can read about it in our Visual We= b Tools - Guide. -
+
+ Open On + + The JSF configuration file editor comes with the very useful OpenOn na= vigation feature. You can find more information on this feature in the Visu= al Web Tools Guide. + +
= -
+
= - Code Assist - Code Assist provides pop-up tip to help you complete you= r code statements. It - allows you to write your code faster and with more accurac= y. - Code assist is always available in the Source mode: -
- Code Assist in Source View - - - - - -
+ Code Assist + + Code Assist provides a pop-up tip to help you complete your code state= ments. It allows you to write your code faster and with more accuracy. + + Code assist is always available in the Source mode: +
+ Code Assist in Source View + + + + + +
= -
+
= -
+
= - Error Reporting - When you are developing your project, error checking is = constantly provided. This - greatly reduces your development time as it allows you to = catch many of the errors - during development. - Errors will be reported by facility: -
- Error Reporting in Source View - - - - - -
+ Error Reporting + + Constant error checking is provided while you are developing your proj= ect. This greatly reduces your development time as it allows you to catch m= any errors during the development process. + + Errors will be reported by facility: +
+ Error Reporting in Source View + + + + + +
= - Other errors are also reported. -
- Other Errors Reporting - - - - - -
+ Other errors are also reported. +
+ Other Errors Reporting + + + + + +
= -
-
+
+
= \ No newline at end of file --===============5602248238251347968==--