January 2011 - jbosstools-commits

JBoss Tools SVN: r28643 - trunk/jsf/docs/jsf_tools_ref_guide/en-US.

by jbosstools-commits＠lists.jboss.org

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 =================================================================== --- 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 @@ <?xml version="1.0" encoding="UTF-8"?> <chapter id="jsf_config_file" role="updated"> - <?dbhtml filename="jsf_config_file.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Developer Studio</keyword> - <keyword>Eclipse</keyword> - <keyword>JSF Tools</keyword> - <keyword>Java</keyword> - <keyword>JBoss</keyword> - </keywordset> - </chapterinfo> + <?dbhtml filename="jsf_config_file.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 Configuration File Editor</title> + <title>JSF Configuration File Editor</title> - <para>First, we should mention that JSF configuration file (<emphasis> - <property>faces-config.xml</property> - </emphasis>) is intended for registering JSF application resources such as Converters, - Validators, Managed Beans and page-to-page navigation rules.</para> - <para>Now, let's look at how you can easily configure this file by means of a special - graphical editor for JSF configuration file. The editor has three main views:</para> + <para> + First, we should mention that JSF configuration file (<filename>faces-config.xml</filename>) is intended for registering JSF application resources such as Converters, Validators, Managed Beans and page-to-page navigation rules. + </para> + <para> + 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 has three main views: + </para> - <itemizedlist> - <listitem> - <para>Diagram</para> - </listitem> - <listitem> - <para>Tree</para> - </listitem> - <listitem> - <para>Source</para> - </listitem> - </itemizedlist> + <itemizedlist> + <listitem> + <para>Diagram</para> + </listitem> + <listitem> + <para>Tree</para> + </listitem> + <listitem> + <para>Source</para> + </listitem> + </itemizedlist> - <para>They can be selected via the tabs at the bottom of the editor.</para> + <para>They can be selected via the tabs at the bottom of the editor.</para> - <section id="Diagram9553"> + <section id="Diagram9553"> - <title>Diagram view</title> + <title>Diagram view</title> - <para>Here, we will show you how to work with JSF configuration file through the Diagram - view of the editor.</para> - <para>As you can see on the figure below, the Diagram view displays the navigation rules in - the faces-config.xml:</para> - <figure> - <title>Diagram View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_21.png"/> - </imageobject> - </mediaobject> - </figure> + <para>Here, we will show you how to work with JSF configuration file through the Diagram view of the editor.</para> + <para>As you can see on the figure below, the Diagram view displays the navigation rules container in the <filename>faces-config.xml</filename> file:</para> + <figure> + <title>Diagram View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_21.png"/> + </imageobject> + </mediaobject> + </figure> - <para>If your diagram is large, make use of the Outline view. Within it you can switch to a <emphasis> - <property>Diagram Navigator</property> - </emphasis> mode by selecting the middle icon at the top of the 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:</para> - <figure> - <title>Outline View for Diagram</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_32.png" scale="50"/> - </imageobject> - </mediaobject> - </figure> + <para> + If you have a large diagram, make use of the Outline view. Within it you can switch to a <guilabel>Diagram Navigator</guilabel> mode by selecting the middle icon at the top of the view window. This 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: + </para> + <figure> + <title>Outline View for Diagram</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_32.png" scale="50"/> + </imageobject> + </mediaobject> + </figure> - <para>To create a new page here, you should click the page icon (View Template) on the - toolbar from the left and then click anywhere on the diagram. A New Page Wizard will - appear.</para> + <para> + To create a new page here, you should click the page icon (View Template) on the toolbar from the left and then click anywhere on the diagram. A New Page Wizard will appear. + </para> - <para>To create a transition for connecting pages:</para> + <para>To create a transition for connecting pages:</para> - <itemizedlist> - <listitem> - <para>Select the transition icon from the toolbar (New Connection).</para> - </listitem> - <listitem> - <para>Click the source page.</para> - </listitem> - <listitem> - <para>Click the target page.</para> - </listitem> - </itemizedlist> + <itemizedlist> + <listitem> + <para>Select the transition icon from the toolbar (New Connection).</para> + </listitem> + <listitem> + <para>Click the source page.</para> + </listitem> + <listitem> + <para>Click the target page.</para> + </listitem> + </itemizedlist> - <para>A transition will appear between the two pages:</para> - <figure> - <title>Transition between JSP Pages</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_22.png"/> - </imageobject> - </mediaobject> - </figure> + <para>A transition will appear between the two pages:</para> + <figure> + <title>Transition between JSP Pages</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_22.png"/> + </imageobject> + </mediaobject> + </figure> - <para>It is also possible to create a new page with context menu by right-clicking anywhere - on the diagram and selecting <emphasis> - <property>Rule...</property></emphasis></para> - <figure> - <title>Creating a New View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_23.png"/> - </imageobject> - </mediaobject> - </figure> + <para> + It is also possible to create a new page with context menu by right-clicking anywhere on the diagram and selecting the <guimenuitem>Rule...</guimenuitem> option. + </para> + <figure> + <title>Creating a New View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_23.png"/> + </imageobject> + </mediaobject> + </figure> - <para>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:</para> - <figure> - <title>Editing Transition between Views</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_24.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - <section id="TreeView11123" role="updated"> + <para> + 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: + </para> + <figure> + <title>Editing Transition between Views</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_24.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="TreeView11123" role="updated"> - <title>Tree View</title> + <title>Tree View</title> - <para>You can find it more convenient to edit your JSF Configuration file in the Tree view of - the <property>VPE</property>.</para> + <para>You can find it more convenient to edit your JSF Configuration file in the Tree view of the <guilabel>VPE</guilabel>.</para> - <para>The view displays all JSF application artifacts referenced in the configuration file - in a tree format. By selecting any node on the left, you can see and edit its properties - which will appear in the right-hand area. Let's look at the structure of this - tree more closely.</para> + <para> + The view displays all JSF application artifacts referenced in the configuration 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's look at the structure of this tree more closely. + </para> - <itemizedlist> - <listitem> - <para>Under the <emphasis> - <property>Application</property> - </emphasis> node you can adjust JSF application specific settings such as - internationalization, possibility to set extensions, add property and variable - resolvers, etc.</para> - </listitem> - </itemizedlist> + <itemizedlist> + <listitem> + <para> + Under the <guilabel>Application</guilabel> node you can adjust JSF application specific settings such as internationalization, extensions, adding property and variable resolvers, etc. + </para> + </listitem> + </itemizedlist> - <figure> - <title>JSF Application Specific Settings</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_24a.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>JSF Application Specific Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_24a.png"/> + </imageobject> + </mediaobject> + </figure> - <itemizedlist> - <listitem> - <para>The <emphasis> - <property>Components</property> - </emphasis> node is for registering custom JSF components. Right-click and - choose <emphasis> - <property>New > Component</property> - </emphasis> or just press the <emphasis> - <property>Add</property> - </emphasis> button in the right-hand area to add a new component to the JSF - Configuration file.</para> - </listitem> - </itemizedlist> + <itemizedlist> + <listitem> + <para> + The <guilabel>Components</guilabel> node is for registering custom JSF components. Right-click and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Component</guimenuitem></menuchoice> or just click the <guibutton>Add</guibutton> button in the right-hand area to add a new component to the JSF Configuration file. + </para> + </listitem> + </itemizedlist> - <figure> - <title>Registering a New JSF Component</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_24b.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Registering a New JSF Component</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_24b.png"/> + </imageobject> + </mediaobject> + </figure> - <para>In the <property>Add Component wizard</property> you should set a component - type and point to a component class by using the <emphasis> - <property>Browse</property> - </emphasis> button or create a new class for this component by using the <emphasis> - <property>Component-Class</property> - </emphasis> link.</para> + <para> + In the <guilabel>Add Component</guilabel> wizard you should set a component type and point to a component class by using the <guibutton>Browse</guibutton> button or create a new class for this component by using the <guilabel>Component-Class</guilabel> link. + </para> - <figure> - <title>Adding a New JSF Component to the JSF Configuration File</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_24c.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Adding a New JSF Component to the JSF Configuration File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_24c.png"/> + </imageobject> + </mediaobject> + </figure> - <itemizedlist> - <listitem> - <para>Use the <emphasis> - <property>Render Kit</property> - </emphasis> node to create and register a set of related renderers for custom - JSF components.</para> - </listitem> - </itemizedlist> + <itemizedlist> + <listitem> + <para>Use the <guilabel>Render Kit</guilabel> node to create and register a set of related renderers for custom JSF components.</para> + </listitem> + </itemizedlist> - <figure> - <title>Adding a New JSF Renderer Kit to the JSF Configuration File</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_24d.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Adding a New JSF Renderer Kit to the JSF Configuration File</title> + <mediaobject> + <imageobject> + <imagedata fileref="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 see the <xref linkend="CreateAndRegisterACustomConverter94230"/> section.</para> - </listitem> - </itemizedlist> + <itemizedlist> + <listitem> + <para> + Under the <guilabel>Converters</guilabel> node you can create a converter class for your JSF application either with an id or for a proper class. For more information on this procedure see <xref linkend="CreateAndRegisterACustomConverter94230"/>. + </para> + </listitem> + </itemizedlist> - <figure> - <title>Creating a New Custom Converter</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_59.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Creating a New Custom Converter</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_59.png"/> + </imageobject> + </mediaobject> + </figure> - <itemizedlist> - <listitem> - <para>The <emphasis> - <property>Managed Bean</property> - </emphasis> node is meant for creating and registering Bean classes in your JSF - application. Read more on the topic in the <xref linkend="managed_beans"/> chapter.</para> - </listitem> - </itemizedlist> + <itemizedlist> + <listitem> + <para> + The <guilabel>Managed Bean</guilabel> node allows you to create and register Bean classes in your JSF application. Read more on the topic in <xref linkend="managed_beans"/>. + </para> + </listitem> + </itemizedlist> - <figure> - <title>Managed Beans</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_26.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Managed Beans</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_26.png"/> + </imageobject> + </mediaobject> + </figure> - <itemizedlist> - <listitem> - <para>Use the <emphasis> - <property>Navigation Rules</property> - </emphasis> node to configure a navigation between the pages in your - application: create a new navigation rule and adjust necessary properties for it - in the right-hand area.</para> - </listitem> - </itemizedlist> - <note> - <title>Tip:</title> - <para>The same you can do in the <xref linkend="Diagram9553"/> of the - JSF Configuration file editor.</para> - </note> + <itemizedlist> + <listitem> + <para> + Use the <guilabel>Navigation Rules</guilabel> node to configure a navigation between the pages in your application. Here you can create a new navigation rule and adjust necessary properties for it in the right-hand area. + </para> + </listitem> + </itemizedlist> + <note> + <title>Tip:</title> + <para>The same you can do in the Diagram view of the JSF Configuration file editor (see <xref linkend="Diagram9553"/>).</para> + </note> - <figure> - <title>Configuring Navigation Rules</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_26a.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Configuring Navigation Rules</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_26a.png"/> + </imageobject> + </mediaobject> + </figure> - <itemizedlist> - <listitem> - <para>Under the <emphasis> - <property>Referenced Beans</property> - </emphasis> node you can add a new Referenced Bean and configure various - properties for it. To learn more on this refer to the <xref - linkend="referenced_beans"/> - section.</para> - </listitem> - </itemizedlist> + <itemizedlist> + <listitem> + <para> + Under the <guilabel>Referenced Beans</guilabel> node you can add a new Referenced Bean and configure various properties for it. To learn more on this refer to <xref linkend="referenced_beans"/>. + </para> + </listitem> + </itemizedlist> - <figure> - <title>Referenced Beans</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_26b.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Referenced Beans</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_26b.png"/> + </imageobject> + </mediaobject> + </figure> - <itemizedlist> - <listitem> - <para>The <emphasis> - <property>Validators</property> - </emphasis> node is needed to create validator classes for organizing the - validation of your application data. You can read more on the topic in the <xref - linkend="CreateAndRegisterACustomValidator5632"/> section.</para> - </listitem> - </itemizedlist> + <itemizedlist> + <listitem> + <para> + The <guilabel>Validators</guilabel> node is needed to create validator classes for organizing the validation of your application data. You can read more on the topic in <xref linkend="CreateAndRegisterACustomValidator5632"/>. + </para> + </listitem> + </itemizedlist> - <figure> - <title>Validators</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_26c.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Validators</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_26c.png"/> + </imageobject> + </mediaobject> + </figure> - <itemizedlist> - <listitem> - <para>The <emphasis> - <property>Extensions</property> - </emphasis> node is for setting extensions for your <emphasis> - <property>faces-config.xml</property>.</emphasis></para> - </listitem> - </itemizedlist> + <itemizedlist> + <listitem> + <para>The <guilabel>Extensions</guilabel> node is for setting extensions in your <filename>faces-config.xml</filename> file. + </para> + </listitem> + </itemizedlist> - <figure> - <title>Adding Extensions</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_26d.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Adding Extensions</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_26d.png"/> + </imageobject> + </mediaobject> + </figure> - <para>In the <property>Tree view</property> you can also edit the properties of the selected - element with the help of the <property>Properties view</property> as shown below:</para> + <para> + In the <guilabel>Tree view</guilabel> you can also edit the properties of the selected element with the help of the <guilabel>Properties view</guilabel> as shown below: + </para> - <figure> - <title>Properties View </title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_33.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Properties View </title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_33.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> - </section> - <section id="SourceView4643"> + </section> + <section id="SourceView4643"> - <title>Source View</title> + <title>Source View</title> - <para>Here, we'll discuss how you can configure your faces-config.xml with the help - of Source View.</para> - <para>The Source view for the editor displays a text content 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:</para> - <figure> - <title>Source View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_27.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> + <para> + Here, we'll discuss how you can configure your <filename>faces-config.xml</filename> file with the help of the <guilabel>Source View</guilabel>. + </para> + <para> + The <guilabel>Source view</guilabel> for the editor displays the text content 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: + </para> + <figure> + <title>Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_27.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> - <para>You can also work in the Source view with the help of the <emphasis> - <property>Outline view</property>.</emphasis> The Outline view shows a tree - structure of the JSF configuration file. Simply select any element in the Outline view, - and it will jump to the same place in the Source editor, so you can navigate through the - source code with Outline view.</para> - <figure> - <title>Outline View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_31.png" scale="50"/> - </imageobject> - </mediaobject> - </figure> + <para> + You can also work in the <guilabel>Source view</guilabel> with the help of the <guilabel>Outline view</guilabel>. The <guilabel>Outline view</guilabel> shows a tree structure of the JSF configuration file. Simply select any element in the <guilabel>Outline view</guilabel>, and it will jump to the same place in the Source editor, so you can navigate through the source code with <guilabel>Outline view</guilabel>. + </para> + <figure> + <title>Outline View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_31.png" scale="50"/> + </imageobject> + </mediaobject> + </figure> - </section> + </section> - <section id="jsf_editor_features"> - <title>Editor Features</title> - <para>Here we'll discuss a very important features that JSF configuration file - editor provides for work with JSF resources.</para> + <section id="jsf_editor_features"> + <title>Editor Features</title> + <para>Here we'll discuss a very important features that JSF configuration file editor provides when working with JSF resources.</para> - <section id="jsf_openOn"> - <title>Open On</title> - <para>The JSF configuration file editor comes with a very useful OpenOn navigating - feature. More fully you can read about it in our Visual Web Tools - Guide.</para> - </section> + <section id="jsf_openOn"> + <title>Open On</title> + <para> + The JSF configuration file editor comes with the very useful OpenOn navigation feature. You can find more information on this feature in the Visual Web Tools Guide. + </para> + </section> - <section id="ContentAssist976"> + <section id="ContentAssist976"> - <title>Code Assist</title> - <para>Code Assist provides pop-up tip to help you complete your code statements. It - allows you to write your code faster and with more accuracy.</para> - <para>Code assist is always available in the Source mode:</para> - <figure> - <title>Code Assist in Source View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_28.png" scale="65"/> - </imageobject> - </mediaobject> - </figure> + <title>Code Assist</title> + <para> + Code Assist provides a pop-up tip to help you complete your code statements. It allows you to write your code faster and with more accuracy. + </para> + <para>Code assist is always available in the Source mode:</para> + <figure> + <title>Code Assist in Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_28.png" scale="65"/> + </imageobject> + </mediaobject> + </figure> - </section> + </section> - <section id="ErrorReporting3324"> + <section id="ErrorReporting3324"> - <title>Error Reporting</title> - <para>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.</para> - <para>Errors will be reported by <xref linkend="jsf_project_verification"/> facility:</para> - <figure> - <title>Error Reporting in Source View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_29.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> + <title>Error Reporting</title> + <para> + Constant error checking is provided while you are developing your project. This greatly reduces your development time as it allows you to catch many errors during the development process. + </para> + <para>Errors will be reported by <xref linkend="jsf_project_verification"/> facility:</para> + <figure> + <title>Error Reporting in Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_29.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> - <para>Other errors are also reported.</para> - <figure> - <title>Other Errors Reporting</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_30.png" scale="75"/> - </imageobject> - </mediaobject> - </figure> + <para>Other errors are also reported.</para> + <figure> + <title>Other Errors Reporting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_30.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> - </section> - </section> + </section> + </section> </chapter> \ No newline at end of file

13 years, 5 months

1
0
0 / 0

JBoss Tools SVN: r28642 - trunk/jsf/docs/jsf_tools_ref_guide/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-01-26 22:24:34 -0500 (Wed, 26 Jan 2011) New Revision: 28642 Modified: trunk/jsf/docs/jsf_tools_ref_guide/en-US/webxml_editor.xml Log: General Updates Modified: trunk/jsf/docs/jsf_tools_ref_guide/en-US/webxml_editor.xml =================================================================== --- trunk/jsf/docs/jsf_tools_ref_guide/en-US/webxml_editor.xml 2011-01-27 03:22:20 UTC (rev 28641) +++ trunk/jsf/docs/jsf_tools_ref_guide/en-US/webxml_editor.xml 2011-01-27 03:24:34 UTC (rev 28642) @@ -10,12 +10,11 @@ <title>Web.xml Editor</title> - <para>The <emphasis> - <property>web.xml</property></emphasis> file inside the <emphasis> - <property>WEB-INF</property></emphasis> folder is a deployment descriptor file for a Web Application. It - describes the servlets and other components and deployment properties that make up your application.</para> + <para> + The <filename>web.xml</filename> file inside the <filename>WEB-INF</filename> folder is a deployment descriptor file for a Web Application. It describes the servlets and other components and deployment properties that make up your application. + </para> - <para><property>JBoss Tools</property> add the <emphasis> - <property>web.xml</property></emphasis> file to created JSF project automatically and provides a special editor for its editing. - See the Visual Web Tools guide that gives a descriptive information on the <filename>web.xml editor</filename>.</para> + <para> + <property>JBoss Tools</property> add the <filename>web.xml</filename> file to created JSF project automatically and provides a special editor for its editing. See the Visual Web Tools guide for more information on the <filename>web.xml</filename> editor. + </para> </chapter> \ No newline at end of file

13 years, 5 months

1
0
0 / 0

JBoss Tools SVN: r28641 - trunk/jsf/docs/jsf_tools_ref_guide/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-01-26 22:22:20 -0500 (Wed, 26 Jan 2011) New Revision: 28641 Modified: trunk/jsf/docs/jsf_tools_ref_guide/en-US/projects.xml Log: General Updates Modified: trunk/jsf/docs/jsf_tools_ref_guide/en-US/projects.xml =================================================================== --- trunk/jsf/docs/jsf_tools_ref_guide/en-US/projects.xml 2011-01-27 02:54:57 UTC (rev 28640) +++ trunk/jsf/docs/jsf_tools_ref_guide/en-US/projects.xml 2011-01-27 03:22:20 UTC (rev 28641) @@ -1,75 +1,68 @@ <?xml version="1.0" encoding="UTF-8"?> <chapter id="projects"> - <?dbhtml filename="projects.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Developer Studio</keyword> - <keyword>Eclipse</keyword> - <keyword>JSF Tools</keyword> - <keyword>Java</keyword> - <keyword>JBoss</keyword> - </keywordset> - </chapterinfo> + <?dbhtml filename="projects.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>JSF Tools</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> - <title>Projects</title> - <para>To take an advantage of JSF firstly you should perform one of the next steps:</para> + <title>Projects</title> + <para>To take an advantage of JSF you will need to perform one of the next steps:</para> - <itemizedlist> - <listitem> - <para>Create new JSF projects</para> - </listitem> - <listitem> - <para>Import (open) existing JSF projects</para> - </listitem> - <listitem> - <para>Add JSF capability to any existing Eclipse project</para> - </listitem> - <listitem> - <para>Import and add JSF capability to any existing project created outside - Eclipse.</para> - </listitem> - </itemizedlist> - <para>In this section we're going to stop on each of them in detail.</para> + <itemizedlist> + <listitem> + <para>Create new JSF projects</para> + </listitem> + <listitem> + <para>Import (open) existing JSF projects</para> + </listitem> + <listitem> + <para>Add JSF capability to any existing Eclipse project</para> + </listitem> + <listitem> + <para>Import and add JSF capability to any existing project created outside Eclipse.</para> + </listitem> + </itemizedlist> + <para>This section will go into more detail for each step.</para> - <section id="new_jsf_project"> + <section id="new_jsf_project"> - <title>Creating a New JSF Project</title> + <title>Creating a New JSF Project</title> - <para>If you want your project to already contain all JSF libraries, tag libraries - and JSF configuration file, just organize a new brand JSF project. It is - possible to do this easily with the help of the special wizard. To get it, select<emphasis> - <property> File > New > Project > JBoos Tools - Web > JSF > JSF Project</property> - </emphasis> and click <emphasis> - <property>Next</property>.</emphasis></para> + <para> + It is easy to create a new project that contains all the JSF libraries, tag libraries and JSF configuration file with the aid of a special wizard. To get it, select <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>JBoos Tools Web</guimenuitem><guimenuitem>JSF</guimenuitem><guimenuitem>JSF Project</guimenuitem></menuchoice> and click the <guibutton>Next</guibutton> button. + </para> - <figure> - <title>Choosing a JSF Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_10.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Choosing a JSF Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_10.png"/> + </imageobject> + </mediaobject> + </figure> - <para>On the next form you'll be prompted to enter <property>Project - Name</property> and select a location for the project or just leave - a default path.</para> - <para>Here, JSF Version also allows you to select which JSF implementation to - use.</para> - <figure> - <title>Creating a New JSF Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_11.png"/> - </imageobject> - </mediaobject> - </figure> + <para> + On the next page you will be prompted to enter the <guilabel>Project Name</guilabel> and select a location for the project (or just leave a default path). + </para> + <para>The <guilabel>JSF Version</guilabel> option also allows you to specify the JSF implementation to use.</para> + <figure> + <title>Creating a New JSF Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_11.png"/> + </imageobject> + </mediaobject> + </figure> - <para>There is a number of predefined project templates that are flexible and easily - customizable. Thus you can pick a different template on which the projects - Importing Existing should be based on. Almost all templates come in two - variations: with jsf libraries and without ones.</para> + <para> + There are a number of predefined project templates that are both flexible and easily customizable. You can pick a different template on which the projects Importing Existing should be based on. Almost all templates come in two variations: with and without JSF libraries. + </para> <figure> <title>Choosing JSF Templates</title> <mediaobject> @@ -77,82 +70,77 @@ <imagedata fileref="images/jsf_support/jsf_support_12.png"/> </imageobject> </mediaobject> - </figure> + </figure> - <para>The table below provides description for each possible JSF template.</para> - <table> - <title>JSF Project Templates</title> - <tgroup cols="2"> - <colspec colnum="1" align="left" colwidth="1*"/> - <colspec colnum="2" colwidth="3*"/> + <para>The table below provides description for each possible JSF template.</para> + <table> + <title>JSF Project Templates</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> - <thead> - <row> - <entry align="center"> - <para>Template</para> - </entry> + <thead> + <row> + <entry align="center"> + <para>Template</para> + </entry> - <entry align="center"> - <para>Description</para> - </entry> - </row> - </thead> + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> - <tbody> + <tbody> - <row> - <entry> - <para> - <emphasis> - <property>JSFBlankWithLibs</property> - </emphasis> - </para> - </entry> + <row> + <entry> + <para> + <emphasis> + <property>JSFBlankWithLibs</property> + </emphasis> + </para> + </entry> - <entry> - <para>This template will create a standard Web - project structure with all JSF capabilities</para> - </entry> - </row> + <entry> + <para>This template will create a standard Web project structure with all the JSF capabilities</para> + </entry> + </row> - <row> - <entry> - <para> - <emphasis> - <property>JSFKickStartWithLibs</property> - </emphasis> - </para> - </entry> + <row> + <entry> + <para> + <emphasis> + <property>JSFKickStartWithLibs</property> + </emphasis> + </para> + </entry> - <entry> - <para>This template will create a standard Web - project structure but will also include a sample - application that is ready to run</para> - </entry> - </row> + <entry> + <para>This template will create a standard Web project structure, and also include a sample application that is ready to run</para> + </entry> + </row> - <row> - <entry> - <para> - <emphasis> - <property>JSFKickStartWithoutLibs</property> - </emphasis> - </para> - </entry> + <row> + <entry> + <para> + <emphasis> + <property>JSFKickStartWithoutLibs</property> + </emphasis> + </para> + </entry> - <entry> - <para>Some servers already provide jsf libs and - you take risk of getting conflicting libraries - while deploying your project. To avoid such - conflicts, use a template without libs if you have - a server with its own jsf libraries</para> - </entry> - </row> + <entry> + <para> + Some servers already provide JSF libs and you risk library conflicts while deploying your project. To avoid such conflicts, use a template without libs if you have a server with its own JSF libraries. + </para> + </entry> + </row> - </tbody> - </tgroup> - </table> + </tbody> + </tgroup> + </table>  - <para>On the next screen select what <emphasis> - <property>Servlet version</property> - </emphasis> to use and whether to register this application with JBoss AS - (or other server) for running and testing your application.</para> + <para> + On the next page you need to select which <guilabel>Servlet version</guilabel> to use, and specify whether or not to register this application with JBoss AS (or other server) in order to run and test your application. + </para> - <para>The <emphasis> - <property>Context Path</property> - </emphasis> is the name under which the application will be deployed.</para> + <para>The <guilabel>Context Path</guilabel> option defines the name under which the application will be deployed.</para> - <para>The <emphasis> - <property>Runtime</property> - </emphasis> value tells Eclipse where to find Web libraries in order to - build (compile) the project. It is not possible to finish project creation - without selecting Runtime. If you don't have any values, select <emphasis> - <property>New...</property> - </emphasis> to add new Runtime.</para> + <para> + The <guilabel>Runtime</guilabel> value tells Eclipse where to find the Web libraries necessary to build (compile) the project. It is not possible to finish the project creation without selecting a Runtime. If you do not have any values, click the <guibutton>New...</guibutton> button to add new Runtime. + </para> - <para>The <emphasis> - <property>Target Server</property> - </emphasis> allows you specifying whether to deploy the application. The - Target Server corresponds to the Runtime value selected above. If you - don't want to deploy the application, uncheck this value.</para> - <figure> - <title>Registering the Project on Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_14.png"/> - </imageobject> - </mediaobject> - </figure> + <para> + The <guilabel>Target Server</guilabel> option allows you specifying whether or not to deploy the application. The Target Server corresponds to the Runtime value selected above. If you do not want to deploy the application, uncheck this option. + </para> + <figure> + <title>Registering the Project on Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_14.png"/> + </imageobject> + </mediaobject> + </figure> - <para>When you are all done, you should have the project that has been appeared in - the Package Explorer view:</para> - <figure> - <title>A New Project in the Package Explorer</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_15.png"/> - </imageobject> - </mediaobject> - </figure> + <para>When you are all done, you should see that the project has been appeared in the Package Explorer view:</para> + <figure> + <title>A New Project in the Package Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_15.png"/> + </imageobject> + </mediaobject> + </figure> - <para>At this point you can open <emphasis> - <property>faces-config.xml</property> - </emphasis> and start working on your application. There are a lot of - features to develop JSF applications. We will describe the features - further.</para> - </section> + <para> + At this point you can open the <filename>faces-config.xml</filename> file and start working on your application. There are a lot of features available when developing JSF applications. These features will be discussed in more detail later in this document.</para> + </section> - <section id="ImportingExsJSFProjWithAnyStr74447"> + <section id="ImportingExsJSFProjWithAnyStr74447"> - <title>Importing Existing JSF Projects with Any Structure</title> + <title>Importing Existing JSF Projects with Any Structure</title> - <para>For detailed information on migration of JSF projects into a workspace see the Migration - Guide.</para> + <para>For detailed information on migration of JSF projects into a workspace see the Migration Guide.</para> - </section> - <section id="add_jsf_capability"> + </section> + <section id="add_jsf_capability"> - <title>Adding JSF Capability to Any Existing Eclipse Project</title> + <title>Adding JSF Capability to Any Existing Eclipse Project</title> - <para>It's also possible to add <property>JSF capability</property> (JSF - libraries, tag libraries) to any existing Eclipse project in your workspace. - After that you'll be able to make use of such editors as JSF - configuration editor, JBoss Tools JSP editor and any others.</para> - <para>Right click the project and select <emphasis> - <property>JBoss Tools > Add JSF Capabilities</property>. </emphasis> - This will start the process of adding all necessary libraries, files to make - this a Web JSF project.</para> - <figure> - <title>Adding JSF Capabilities</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_16.png"/> - </imageobject> - </mediaobject> - </figure> - <para>The wizard will first ask you to show the <emphasis> - <property>web.xml</property> - </emphasis> file location and the project name.</para> - <figure> - <title>Project Location</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_17.png"/> - </imageobject> - </mediaobject> - </figure> - <para>On the last form you can set the different folders for your project as well as - register this application with a servlet container.</para> + <para> + It is also possible to add <productname>JSF</productname> capabilities (JSF libraries, tag libraries) to any existing Eclipse project in your workspace. After that you will be able to make use of features such as the JSF configuration editor, JBoss Tools JSP editor and any others. + </para> + <para> + Right click the project and select <menuchoice><guimenuitem>JBoss Tools</guimenuitem><guimenuitem>Add JSF Capabilities</guimenuitem></menuchoice> from the context menu. This will start the process of adding the necessary libraries and files to convert the project into a Web JSF project. + </para> + <figure> + <title>Adding JSF Capabilities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_16.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The wizard will first ask you to define location of the <filename>web.xml</filename> file and the project name.</para> + <figure> + <title>Project Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_17.png"/> + </imageobject> + </mediaobject> + </figure> + <para>On the last page you can specify the different folders for your project as well as register this application with a servlet container.</para> - <para>Make sure to select <emphasis> - <property>Add Libraries</property> - </emphasis> to add all required JSF related libraries to this - project.</para> + <para>Make sure to select the <guilabel>Add Libraries</guilabel> option to add all required JSF related libraries into your project.</para> - <para>The <emphasis> - <property>Context Path</property> - </emphasis> is the name under which the application will be deployed.</para> + <para>The <guilabel>Context Path</guilabel> option defines the name under which the application will be deployed.</para> - <para>The <emphasis> - <property>Runtime</property> - </emphasis> value tells Eclipse where to find Web libraries in order to - build (compile) the project. It is not possible to finish project import - without selecting Runtime. If you don't have any values, select <emphasis> - <property>New...</property> - </emphasis> to add new Runtime.</para> + <para> + The <guilabel>Runtime</guilabel> value tells Eclipse where to find Web libraries necessary to build (compile) the project. It is not possible to finish project import without selecting the Runtime. If you don not have any values, click the <guibutton>New...</guibutton> button to add a new Runtime. + </para> - <para>The <emphasis> - <property>Target Server</property> - </emphasis> allows you to specify whether to deploy the application. The - Target Server corresponds to the Runtime value selected above. If you - don't want to deploy the application, uncheck this value.</para> - <figure> - <title>Project Folders</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_18.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Once your project is imported you can see that JSF related libraries have been - added to your project: <emphasis> - <property>jsf-api.jar</property> - </emphasis> and <emphasis> - <property>jsf-impl.jar</property> - </emphasis>.</para> - <note> - <title>Note:</title> - <para>Some application servers provide their own jsf implementation - libraries. Thus, to avoid conflicts you should not add jsf libraries - while adding jsf capabilities.</para> - </note> - <para>You are now ready to work with JSF by creating a new JSF configuration - file:</para> + <para> + The <guilabel>Target Server</guilabel> option allows you to specify whether or not to deploy the application. The Target Server corresponds to the Runtime value selected above. If you do not want to deploy the application, uncheck this value. + </para> + <figure> + <title>Project Folders</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_18.png"/> + </imageobject> + </mediaobject> + </figure> + <para> + Once your project is imported you can see that JSF related libraries <filename>jsf-api.jar</filename> and <filename>jsf-impl.jar</filename> have been added to your project. + </para> + <note> + <title>Note:</title> + <para> + Some application servers provide their own JSF implementation libraries. To avoid conflicts you should not add JSF libraries while adding JSF capabilities. + </para> + </note> + <para>You are now ready to work with JSF by creating a new JSF configuration file:</para> + <figure> + <title>Creating a New JSF Configuration File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_19.png"/> + </imageobject> + </mediaobject> + </figure> - <figure> - <title>Creating a New JSF Configuration File</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_19.png"/> - </imageobject> - </mediaobject> - </figure> + <para>Once the file has been created, it should be opened in a special editor (see <xref linkend="jsf_config_file"/>).</para> + </section> + <section id="AddingYourOwnProjectTemplates853"> - <para>Once the file has been created, it should be opened in a special <xref linkend="jsf_config_file"/>.</para> - </section> - <section id="AddingYourOwnProjectTemplates853"> + <title>Adding Your Own Project Templates</title> + <para> + A template is a set of files that is provided as a basis when creating a new project. Project templates provide content and structure for a project. + </para> + <para> + JSF Tools provides powerful template capabilities which allow you to create new templates and import existing Struts and JSF projects. This templating facility has a variety of aspects to consider. Let's start with the most straightforward case and consider the process of creating a template from your existing JSF project. + </para> - <title>Adding Your Own Project Templates</title> - <para>Template is a set of files that is served as a basis to facilitate the - creation of a new project. Project templates provide content and structure - for a project.</para> - <para>There is a powerful templating capability for creating new and importing - existing Struts and JSF projects. This templating facility has a variety of - aspects to consider. But, let's start with the most straightforward - case and consider the process of creating a template from your existing JSF - project.</para> + <para> + Let's say you have a project that you want to use as the basis for a new <property>template</property>. The following steps will show you how to achieve this: + </para> + <itemizedlist> + <listitem> + <para> + In the Web Projects view, right-click the project and select <menuchoice><guimenuitem>JBoss Tools JS</guimenuitem><guimenuitem>Save As Template</guimenuitem></menuchoice> + </para> + </listitem> + </itemizedlist> + <figure> + <title>Saving Your Project as Template</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_20.png"/> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para> + In the first dialog box, you can specify a name for the template (it will default to the project name) and confirm what run-time implementation of the project technology will be used. + </para> + </listitem> - <para>Let's say you have a project that you want to use as the basis for a - new <property>template</property>. Follow these steps to make a template out - of it:</para> - <itemizedlist> - <listitem> - <para>In the Web Projects view, right-click the project and select <emphasis> - <property>JBoss Tools JSF > Save As - Template</property> - </emphasis></para> - </listitem> - </itemizedlist> - <figure> - <title>Saving Your Project as Template</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_20.png"/> - </imageobject> - </mediaobject> - </figure> - <itemizedlist> - <listitem> - <para>In the first dialog box, you can choose a name for the - template (defaults to the project name) and confirm what - run-time implementation of the project technology will be - used</para> - </listitem> + </itemizedlist> + <figure> + <title>Define Template Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_20_1.png" /> + </imageobject> + </mediaobject> + </figure> - </itemizedlist> - <figure> - <title>Define Template Properties</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_20_1.png" - /> - </imageobject> - </mediaobject> - </figure> + <itemizedlist> + <listitem> + <para> + When you click the <guibutton>Next</guibutton> button a dialog box will be presented with your project structure displayed, along with a number of check boxes. Here you can select only those parts and files in your project directory that should be part of the template. + </para> + </listitem> + </itemizedlist> + <figure> + <title>Define Template Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_20_2.png" /> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para> + At this point, unless you want to designate some extra files as having Velocity template coding inside them, you should click the <guibutton>Finish</guibutton> button. + </para> + </listitem> + </itemizedlist> + <para> + That's it. This template can be used with any new or imported project that uses the same run-time implementation as the project you turned into a template. + </para> + <para>At this point you have a fully configured project. Now you can add some additional logic to it starting with the JSF configuration file.</para> + </section> + <section> + <title>Relevant Resources Links</title> - <itemizedlist> - <listitem> - <para>Select <emphasis> - <property>Next</property> - </emphasis> and you will be sent to a dialog box with your - project structure displayed with check boxes. Here you can - check only those parts and files in your project directory - that should be part of the template</para> - </listitem> - </itemizedlist> - <figure> - <title>Define Template Properties</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_20_2.png" - /> - </imageobject> - </mediaobject> - </figure> - <itemizedlist> - <listitem> - <para>At this point, unless you want to designate some extra files - as having Velocity template coding inside them, you should - click <emphasis> - <property>Finish</property> - </emphasis>.</para> - </listitem> - </itemizedlist> - <para>That's it. Now, you can use this template with any new or imported - project that uses the same run-time implementation as the project you turned - into a template.</para> - <para>At this point, you have a fully configured project and now you can bring some - new logic to it starting from JSF configuration file.</para> - </section> - <section> - <title>Relevant Resources Links</title> - - <para>You can find more in-depth explanation on how to work with special wizards, editors and views that can - be used in various scenarios while developing JSF applications in our Visual Web Tools Guide.</para> - </section> + <para> + You can find a more in-depth explanation on how to work with the special wizards, editors and views that can be used while developing JSF applications in our Visual Web Tools Guide. + </para> + </section> </chapter>

13 years, 5 months

1
0
0 / 0

JBoss Tools SVN: r28640 - trunk/jsf/docs/jsf_tools_ref_guide/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-01-26 21:54:57 -0500 (Wed, 26 Jan 2011) New Revision: 28640 Modified: trunk/jsf/docs/jsf_tools_ref_guide/en-US/jsf_support.xml Log: General Updates Modified: trunk/jsf/docs/jsf_tools_ref_guide/en-US/jsf_support.xml =================================================================== --- trunk/jsf/docs/jsf_tools_ref_guide/en-US/jsf_support.xml 2011-01-27 02:37:53 UTC (rev 28639) +++ trunk/jsf/docs/jsf_tools_ref_guide/en-US/jsf_support.xml 2011-01-27 02:54:57 UTC (rev 28640) @@ -1,169 +1,148 @@ <?xml version="1.0" encoding="UTF-8"?> <chapter id="jsf_support"> - <?dbhtml filename="jsf_support.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Developer Studio</keyword> - <keyword>Eclipse</keyword> - <keyword>JSF Tools</keyword> - <keyword>Java</keyword> - <keyword>JBoss</keyword> - </keywordset> - </chapterinfo> + <?dbhtml filename="jsf_support.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>JSF Tools</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> - <title>JavaServer Faces Support</title> + <title>JavaServer Faces Support</title> - <para>We don't lock you into any one <property>JavaServer - Faces</property> implementation. You can always select the one which is - necessary for you while <xref linkend="new_jsf_project"/>, <xref linkend="add_jsf_capability"/> to - any existing Eclipse project or <xref linkend="ImportingExsJSFProjWithAnyStr74447"/> as well.</para> - <para>At this point the special wizard will prompt you to specify a proper JSF environment. - It may be JSF 1.1.02 RI or JSF 1.2 which integrates a number of new features and - changes. The wizard also lets you select JSF implementation with a component - orientation such as JSF 1.2 with Facelets or MyFaces 1.1.4.</para> + <para> + We don't lock you into any one <productname>JavaServer Faces</productname> implementation. You can always specify the desired <productname>JavaServer Faces</productname> implementation while creating a new JSF project (see <xref linkend="new_jsf_project"/>), adding JSF capability to any existing Eclipse project (see <xref linkend="add_jsf_capability"/>) or importing existing JSF projects (see <xref linkend="ImportingExsJSFProjWithAnyStr74447"/>). + </para> + <para> + At this point the special wizard will prompt you to specify an appropriate JSF environment. It may be JSF 1.1.02 RI, or JSF 1.2 which integrates a number of new features and changes. The wizard also lets you select JSF implementation with a component orientation such as JSF 1.2 with Facelets or MyFaces 1.1.4. + </para> - <figure> - <title>Choosing JSF Environment</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_support/jsf_support_11.png"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Choosing JSF Environment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_11.png"/> + </imageobject> + </mediaobject> + </figure> - <para>After specifying a proper JSF environment all the required libraries for the selected - version will be added to your project.</para> + <para> + After specifying an appropriate JSF environment all the required libraries associated with the selected version will be added to your project. + </para> - <section id="FaceletsSupport865"> + <section id="FaceletsSupport865"> - <title>Facelets Support</title> - <para>In this section we will focus more on all concepts that are integrated for - working with Facelets.</para> + <title>Facelets Support</title> + <para>In this section we will focus all the concepts that relate to working with Facelets.</para> - <para>The Facelets extends JavaServer Faces by providing a lightweight framework - that radically simplifies the design of presentation pages for JSF. Facelets can be used in a variety of ways that we - will consider further in this section.</para> + <para> + Facelets extend JavaServer Faces by providing a lightweight framework that radically simplifies the design of presentation pages for JSF. Facelets can be used in a variety of ways that we will consider further in this section. + </para> - <section> - <title>Facelets templates</title> - <para>If you want to build an application using Facelets, just create a - project with Facelets based on version 1.2 of the JSF Reference - Implementation, i. e. select the <emphasis> - <property>JSF 1.2 with Facelets</property> - </emphasis> in the JSF Environment section of the New JSF Project - wizard.</para> + <section> + <title>Facelets templates</title> + <para> + If you want to build an application using Facelets, create a project with Facelets based on version 1.2 of the JSF Reference Implementation, i. e. select the <guilabel>JSF 1.2 with Facelets</guilabel> option in the <guilabel>JSF Environment</guilabel> section of the <guilabel>New JSF Project</guilabel> wizard. + </para> - <figure> - <title>Choosing Facelets Environment</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/jsf_support/jsf_support_2.png" - /> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Choosing Facelets Environment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_2.png"/> + </imageobject> + </mediaobject> + </figure> - <para>Once you've selected the environment, it's possible - to specify the one of three available templates:</para> - <figure> - <title>Choosing Facelets Template</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/jsf_support/jsf_support_3.png" - /> - </imageobject> - </mediaobject> - </figure> - <para>The following table lists possible templates with Facelets for any JSF - project and gives a proper description for each one.</para> - <table> - <title>Facelets Templates</title> - <tgroup cols="2"> - <colspec colnum="1" align="left" colwidth="2*"/> - <colspec colnum="2" colwidth="3*"/> + <para>Once you have selected the environment, it is possible to specify one of three available templates:</para> + <figure> + <title>Choosing Facelets Template</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_3.png" /> + </imageobject> + </mediaobject> + </figure> + <para>The following table lists the templates that can be used with Facelets for any JSF project, and gives a detailed description for each one.</para> + <table> + <title>Facelets Templates</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="2*"/> + <colspec colnum="2" colwidth="3*"/> - <thead> - <row> - <entry align="center"> - <para>Template</para> - </entry> + <thead> + <row> + <entry align="center"> + <para>Template</para> + </entry> - <entry align="center"> - <para>Description</para> - </entry> - </row> - </thead> + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> - <tbody> + <tbody> - <row> - <entry> - <para> - <emphasis> - <property>FaceletsBlankWithoutLibs</property> - </emphasis> - </para> - </entry> + <row> + <entry> + <para> + <emphasis> + <property>FaceletsBlankWithoutLibs</property> + </emphasis> + </para> + </entry> - <entry> - <para>Some servers already provide - jsf libs and you take risk - of getting conflicting - libraries while deploying - your project. To avoid such - conflicts, use a template - without libs if you have a - server with its own jsf - libraries</para> - </entry> - </row> + <entry> + <para> + Some servers already provide JSF libs and you risk library conflicts while deploying your project. To avoid such conflicts, use a template without libs if you have a server with its own JSF libraries. + </para> + </entry> + </row> - <row> - <entry> - <para> - <emphasis> - <property>FaceletsKickStartWithRILibs</property> - </emphasis> - </para> - </entry> + <row> + <entry> + <para> + <emphasis> + <property>FaceletsKickStartWithRILibs</property> + </emphasis> + </para> + </entry> - <entry> - <para>A sample application with - Facelets that is ready to - run</para> - </entry> - </row> + <entry> + <para> + A sample application with Facelets that is ready to run.</para> + </entry> + </row> - <row> - <entry> - <para> - <emphasis> - <property>FaceletsKickStartWithoutLibs</property> - </emphasis> - </para> - </entry> + <row> + <entry> + <para> + <emphasis> + <property>FaceletsKickStartWithoutLibs</property> + </emphasis> + </para> + </entry> - <entry> - <para>A sample application without - libraries</para> - </entry> - </row> + <entry> + <para>A sample application without libraries.</para> + </entry> + </row> - </tbody> - </tgroup> - </table> - </section> - <section> - <title>Facelets components</title> + </tbody> + </tgroup> + </table> + </section> + <section> + <title>Facelets components</title> - <para>The JBoss Tools - Palette comes with the Facelets components ready to - use. A useful tip appears when you hover the mouse cursor over the - tag, the tip includes a detailed description of the tag component, - the syntax and available attributes.</para> + <para> + The JBoss Tools Palette comes with the Facelets components ready to use. A useful tip appears when you hover the mouse cursor over the tag; this tip includes a detailed description of the tag component, the syntax and available attributes. + </para>  - <figure> - <title>Facelets Components</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/jsf_support/jsf_support_4.png" - scale="65"/> - </imageobject> - </mediaobject> - </figure> - </section> - <section> - <title>Code assist for Facelets</title> + <figure> + <title>Facelets Components</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_4.png" scale="65"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section> + <title>Code assist for Facelets</title> - <para>One more feature which comes with Facelets support is code assist - (Ctrl + Space). It is available for <property>Facelets - tags</property> while editing <emphasis> - <property>.xhtml</property> - </emphasis> files.</para> + <para> + JSF Tools provides Facelets code assistance, which can be assessed by pressing <keycombo><keycap>Ctrl</keycap><keycap>Space</keycap></keycombo>. It is available for <property>Facelets tags</property> while editing <filename>.xhtml</filename> files. + </para> - <figure> - <title>XHTML File Code Assist</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/jsf_support/jsf_support_5.png" - scale="60"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>XHTML File Code Assist</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_5.png" scale="60"/> + </imageobject> + </mediaobject> + </figure> - <para>What's more, code assist is also available for <emphasis - role="italic"> - <property>"jsfc"</property> - </emphasis> attribute in any HTML tag.</para> + <para> + Code assist is also available for <code>jsfc</code> attributes in any HTML tag. + </para> - <figure> - <title>Code Assist for JSFC Attribute</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/jsf_support/jsf_support_6.png" - scale="70"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Code Assist for JSFC Attribute</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_6.png" scale="70"/> + </imageobject> + </mediaobject> + </figure> - <para>After selecting <emphasis role="italic"> - <property>"jsfc"</property> - </emphasis> you get the code assist for JSF components available on - a page.</para> + <para>After selecting an <code>jsfc</code> attribute, the code assist feature will list the JSF components available on a page.</para> - <figure> - <title>Code Assist for JSF Components</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/jsf_support/jsf_support_7.png" - scale="80"/> - </imageobject> - </mediaobject> - </figure> + <figure> + <title>Code Assist for JSF Components</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_7.png" scale="80"/> + </imageobject> + </mediaobject> + </figure> - <para>When a component is chosen you will see all available attributes for - it.</para> + <para>When a component is selected you will see all available attributes for it.</para> - <figure> - <title>Available Attributes for the Component</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/jsf_support/jsf_support_8.png" - scale="80"/> - </imageobject> - </mediaobject> - </figure> - </section> - <section> - <title>Open On feature</title> - <para>Finally, Eclipse's <emphasis> - <property>OpenOn</property> - </emphasis> feature for editing Facelets files is supported. Using this feature, - you can easily navigate between the <property>Facelets - templates</property> and other parts of your projects. Just by - holding down the Control key while hovering the mouse cursor over a - reference to a template, the reference becomes a hyperlink to open - that template.</para> + <figure> + <title>Available Attributes for the Component</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_8.png" scale="80"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section> + <title>Open On feature</title> + <para> + Finally, JSF Tools supports Eclipse's <productname>OpenOn</productname> feature while editing Facelets files. Using this feature, you can easily navigate between the <property>Facelets templates</property> and other parts of your projects. By holding down the <keycap>Ctrl</keycap> key while hovering the mouse cursor over a reference to a template, the reference becomes a hyperlink to navigate to that template. + </para> + <figure> + <title>Template Hyperlink</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_9.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> - <figure> - <title>Template Hyperlink</title> - <mediaobject> - <imageobject> - <imagedata - fileref="images/jsf_support/jsf_support_9.png" - scale="75"/> - </imageobject> - </mediaobject> - </figure> -  - </section> + </section>  - </section> + </section>

13 years, 5 months

1
0
0 / 0

JBoss Tools SVN: r28639 - trunk/jsf/docs/jsf_tools_ref_guide/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-01-26 21:37:53 -0500 (Wed, 26 Jan 2011) New Revision: 28639 Modified: trunk/jsf/docs/jsf_tools_ref_guide/en-US/introduction.xml Log: General Updates Modified: trunk/jsf/docs/jsf_tools_ref_guide/en-US/introduction.xml =================================================================== --- trunk/jsf/docs/jsf_tools_ref_guide/en-US/introduction.xml 2011-01-27 02:25:46 UTC (rev 28638) +++ trunk/jsf/docs/jsf_tools_ref_guide/en-US/introduction.xml 2011-01-27 02:37:53 UTC (rev 28639) @@ -14,18 +14,18 @@ <title>Introduction</title> - <para>JSF Tools are especially designed for supporting JSF and JSF-related technologies. JSF - Tools provide extensible and exemplary tools for building JSF-based applications as well as - adding JSF capabilities to existing web projects, importing JSF projects and choosing any - JSF implementation while developing JSF application.</para> + <para> + JSF Tools are especially designed to support JSF and JSF-related technologies. JSF Tools provide extensible tools for building JSF-based applications as well as adding JSF capabilities to existing web projects, importing JSF projects and choosing any JSF implementation while developing JSF application. + </para> - <para>In this guide we provide you with the information on JSF tooling which allows you to - develop JSF applications much faster and with far fewer errors so sparing your time.</para> + <para> + This guide provides the information on JSF tooling you need to allow you to quickly develop JSF applications with far fewer errors. + </para> <section id="jsf_key_features"> <title>Key Features of JSF Tools</title> - <para>Here, we provide you with a key functionality which is integrated in JSF tooling.</para> + <para>The table below lists the functionality provided by the JSF Tools.</para> <table> <title>Key Functionality for JSF Tools</title> @@ -46,14 +46,15 @@ <row> <entry>JSF and Facelets support</entry> - <entry>Step-by-step wizards for creating new JSF and Facelets projects with a number of predefined templates, importing existing ones and adding JSF capabilities to non-jsf web projects.</entry> + <entry> + Step-by-step wizards for creating new JSF and Facelets projects with a number of predefined templates, importing existing ones and adding JSF capabilities to non-JSF web projects. + </entry> <entry><xref linkend="jsf_support"/></entry> </row> <row> <entry>Flexible and customizable project template management</entry> - <entry>Jump-start development with out-of-the-box templates or easily - customized templates for re-use.</entry> + <entry>Jump-start development with the supplied templates or easily create customized templates for re-use.</entry> <entry> <xref linkend="projects"/> </entry> @@ -61,18 +62,17 @@ <row> <entry>Support for JSF Configuration File</entry> - <entry>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.</entry> <entry> + Work on a file using three modes: diagram, tree and source. Automatic synchronization between the modes and full control over the code. Easily move around the diagram using the Diagram Navigator. + </entry> + <entry> <xref linkend="jsf_config_file"/> </entry> </row> <row> <entry>Support for Managed Beans</entry> - <entry>Adding new managed beans, generating code for attributes, properties - and getter/setter methods.</entry> + <entry>Adding new managed beans, generating code for attributes, properties and getter/setter methods.</entry> <entry> <xref linkend="managed_beans"/> </entry> @@ -80,8 +80,7 @@ <row> <entry>Support for Custom Converters and Validators</entry> - <entry>Fast creating of custom converters and validators with tree view of - faces-config.xml file.</entry> + <entry>Fast creation of custom converters and validators with a tree view of the <filename>faces-config.xml</filename> file.</entry> <entry> <xref linkend="creation_and_registration"/> </entry> @@ -89,11 +88,10 @@ <row> <entry>Verification and Validation</entry> - <entry>All occuring 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.</entry> <entry> + All errors will be immediately reported by verification feature, no matter in what view you are working. Constant validation and error checking allows you to catch many of the errors during development process that significantly reduces development time. + </entry> + <entry> <xref linkend="jsf_project_verification"/> </entry> @@ -104,7 +102,7 @@ </section> <section> <title>Other relevant resources on the topic</title> - <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at<ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para> + <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at <ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para> <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs</ulink>.</para> </section> </chapter>

13 years, 5 months

1
0
0 / 0

JBoss Tools SVN: r28638 - trunk/jmx/docs/reference/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-01-26 21:25:46 -0500 (Wed, 26 Jan 2011) New Revision: 28638 Modified: trunk/jmx/docs/reference/en-US/introduction.xml trunk/jmx/docs/reference/en-US/references.xml trunk/jmx/docs/reference/en-US/summary.xml trunk/jmx/docs/reference/en-US/tasks.xml Log: General Updates Modified: trunk/jmx/docs/reference/en-US/introduction.xml =================================================================== --- trunk/jmx/docs/reference/en-US/introduction.xml 2011-01-27 00:41:36 UTC (rev 28637) +++ trunk/jmx/docs/reference/en-US/introduction.xml 2011-01-27 02:25:46 UTC (rev 28638) @@ -1,135 +1,140 @@ <?xml version="1.0" encoding="ISO-8859-1"?> <chapter id="intruduction"> - <?dbhtml filename="introduction.html"?> + <?dbhtml filename="introduction.html"?> - <title>Introduction</title> - <para><property>JBoss Tools</property>' JMX project is a fork of <ulink - url="http://code.google.com/p/eclipse-jmx/">eclipse-jmx</ulink>, a project by Jeff Mesnil. + <title>Introduction</title> + <para> + <property>JBoss Tools</property>' JMX project is a fork of <ulink url="http://code.google.com/p/eclipse-jmx/">eclipse-jmx</ulink>, a project by Jeff Mesnil. It was forked with permission. </para> - - <section> - <title>What is JMX?</title> - <para> -The Java Management Extensions (JMX) technology is a standard part of the Java Platform, Standard Edition (Java SE platform). The JMX technology was added to the platform in the Java 2 Platform, Standard Edition (J2SE) 5.0 release. -</para> - <para> -The JMX technology provides a simple, standard way of managing resources such as applications, devices, and services. Because the JMX technology is dynamic, you can use it to monitor and manage resources as they are created, installed and implemented. You can also use the JMX technology to monitor and manage the Java Virtual Machine (Java VM). -</para> - <para> -The JMX specification defines the architecture, design patterns, APIs, and services in the Java programming language for management and monitoring of applications and networks. -</para> - <para> -Using the JMX technology, a given resource is instrumented by one or more Java objects known as Managed Beans, or MBeans. These MBeans are registered in a core-managed object server, known as an MBean server. The MBean server acts as a management agent and can run on most devices that have been enabled for the Java programming language. -</para> - - <para> -The specifications define JMX agents that you use to manage any resources that have been correctly configured for management. A JMX agent consists of an MBean server, in which MBeans are registered, and a set of services for handling the MBeans. In this way, JMX agents directly control resources and make them available to remote management applications. -</para> - <para> -The way in which resources are instrumented is completely independent from the management infrastructure. Resources can therefore be rendered manageable regardless of how their management applications are implemented. -</para> - <para> -The JMX technology defines standard connectors (known as JMX connectors) that enable you to access JMX agents from remote management applications. JMX connectors using different protocols provide the same management interface. Consequently, a management application can manage resources transparently, regardless of the communication protocol used. JMX agents can also be used by systems or applications that are not compliant with the JMX specification, as long as those systems or applications support JMX agents. -</para> -<para> -<ulink - url="http://java.sun.com/docs/books/tutorial/jmx/overview/index.html">Read more about JMX</ulink>. -</para> - </section> - - <section> - <title>What is JMX Tools?</title> - <para><property>JBoss JMX Tools</property> allow to setup multiple JMX connections and provide view - for exploring the JMX tree and execute operations directly from Eclipse.</para> - <para>This chapter covers the basics of working with <property>JMX plugin</property>, which is - used to manage Java applications (with Managed Beans) through JMX and its RMI Connector.</para> + <section> + <title>What is JMX?</title> + <para> + The Java Management Extensions (JMX) technology is a standard part of the Java Platform, Standard Edition (Java SE platform). The JMX technology was added to the platform in the Java 2 Platform, Standard Edition (J2SE) 5.0 release. + </para> + <para> + The JMX technology provides a simple, standard way of managing resources such as applications, devices, and services. Because the JMX technology is dynamic, you can use it to monitor and manage resources as they are created, installed and implemented. You can also use the JMX technology to monitor and manage the Java Virtual Machine (Java VM). + </para> + <para> + The JMX specification defines the architecture, design patterns, APIs, and services in the Java programming language for management and monitoring of applications and networks. + </para> + <para> + Using the JMX technology, a given resource is instrumented by one or more Java objects known as Managed Beans, or MBeans. These MBeans are registered in a core-managed object server, known as an MBean server. The MBean server acts as a management agent and can run on most devices that have been enabled for the Java programming language. + </para> - <figure> - <title>JMX Tools</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/eclipse-jmx_0.2.png"/> - </imageobject> - </mediaobject> - </figure> - </section> + <para> + The specifications define JMX agents that you use to manage any resources that have been correctly configured for management. A JMX agent consists of an MBean server, in which MBeans are registered, and a set of services for handling the MBeans. In this way, JMX agents directly control resources and make them available to remote management applications. + </para> + <para> + The way in which resources are instrumented is completely independent from the management infrastructure. Resources can therefore be rendered manageable regardless of how their management applications are implemented. + </para> + <para> + The JMX technology defines standard connectors (known as JMX connectors) that enable you to access JMX agents from remote management applications. JMX connectors using different protocols provide the same management interface. Consequently, a management application can manage resources transparently, regardless of the communication protocol used. JMX agents can also be used by systems or applications that are not compliant with the JMX specification, as long as those systems or applications support JMX agents. + </para> + <para> + <ulink url="http://java.sun.com/docs/books/tutorial/jmx/overview/index.html">Read more about JMX</ulink>. + </para> + </section> - <section><title>Key Features of JMX Tools</title> - <para>For a start, we propose you to look through the table of main features of JBoss JMX Tools:</para> - <table> - - <title>Key Functionality for JBoss JMX Tools</title> - <tgroup cols="3"> - - <colspec colnum="1" align="left" colwidth="2*"/> - <colspec colnum="2" colwidth="4*"/> - <colspec colnum="3" align="left" colwidth="2*"/> - - <thead> - <row> - <entry>Feature</entry> - <entry>Benefit</entry> - <entry>Chapter</entry> - </row> - </thead> - - <tbody> - - <row> - <entry><para>MBean Explorer</para></entry> - <entry><para>MBean Explorer is a useful view with a text filter that displays domains, mbeans, attributes, and operations inside a connection.</para></entry> - <entry> - <xref linkend="mbean_explorer"/> - </entry> - </row> - - <row> - <entry><para>MBean Editor</para></entry> - <entry><para>MBean Editor is a multi-page editor to manage MBeans.</para></entry> - <entry> - <xref linkend="mbean_editor"/> - </entry> - </row> - </tbody> - </tgroup> - </table> - </section> - - <section> - <title>Requirements and Installation</title> - <section> - <title> Requirements</title> - <para>Requirements to use <property>JBoss JMX Tools</property> are the following:</para> - - <itemizedlist> - <listitem> - <para><property>JBoss JMX Tools</property> is developed on Eclipse 3.4.x milestones</para> - </listitem> - <listitem> - <para><property>JBoss JMX Tools</property> requires that Eclipse is run on a JDK 1.5.0 or above - (due to dependencies on JMX packages which were introduced in Java 1.5.0)</para> - </listitem> - </itemizedlist> - </section> - <section> - <title>Installation</title> - <para>Here, we are going to explain how to install the <property>JMX plugin</property> into - Eclipse.</para> + <section> + <title>What is JMX Tools?</title> + <para> + <productname>JBoss JMX Tools</productname> allows you to setup multiple JMX connections, and provides a view for exploring the JMX tree and execute operations directly from within Eclipse. + </para> - <para><property>JBoss JMX Tools</property> is one module of the <property>JBoss Tools</property> - project. <property> JBoss JMX Tools</property> has no dependency on any other part of <property>JBoss - Tools</property>, and can be downloaded as a standalone Eclipse plugin. Even though the <property>JMX - Tools</property> have no dependencies on other plugins, such as <property>AS Tools</property>, - <property>JBoss JMX Tools</property> do depend on the JMX Tooling and even extend it. </para> + <para> + This chapter covers the basics of working with <productname>JMX plugin</productname>, which is used to manage Java applications (with Managed Beans) through JMX and its RMI Connector. + </para> - <para>You can find the <property>JBoss JBoss Tools</property> plugins over at the <ulink - url="http://labs.jboss.com/tools/download.html">download pages</ulink>. The only - package you'll need to get is the JBoss JMX Tooling, however the <property>AS - Tools</property> would give you a wider experience and more options when using JMX with JBoss Servers. - You can find further download and installation instructions on the JBoss Wiki in the <ulink - url="http://www.jboss.org/tools/download/installation">InstallingJBossTools</ulink> - section.</para> - </section> - </section> + <figure> + <title>JMX Tools</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/eclipse-jmx_0.2.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section> + <title>Key Features of JMX Tools</title> + <para>The table below lists the main features of JBoss JMX Tools:</para> + <table> + + <title>Key Functionality for JBoss JMX Tools</title> + <tgroup cols="3"> + + <colspec colnum="1" align="left" colwidth="2*"/> + <colspec colnum="2" colwidth="4*"/> + <colspec colnum="3" align="left" colwidth="2*"/> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + + <tbody> + + <row> + <entry> + <para>MBean Explorer</para> + </entry> + <entry> + <para>MBean Explorer is a useful view with a text filter that displays domains, mbeans, attributes, and operations inside a connection.</para> + </entry> + <entry> + <xref linkend="mbean_explorer"/> + </entry> + </row> + + <row> + <entry> + <para>MBean Editor</para> + </entry> + <entry> + <para>MBean Editor is a multi-page editor to manage MBeans.</para> + </entry> + <entry> + <xref linkend="mbean_editor"/> + </entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section> + <title>Requirements and Installation</title> + <section> + <title> Requirements</title> + <para>Requirements to use <productname>JBoss JMX Tools</productname> are the following:</para> + + <itemizedlist> + <listitem> + <para> + <productname>JBoss JMX Tools</productname> is developed on Eclipse 3.4.x milestones</para> + </listitem> + <listitem> + <para> + <productname>JBoss JMX Tools</productname> requires that Eclipse is run on a JDK 1.5.0 or above (due to dependencies on JMX packages which were introduced in Java 1.5.0) + </para> + </listitem> + </itemizedlist> + </section> + <section> + <title>Installation</title> + <para>Here, we are going to explain how to install the <productname>JMX plugin</productname> into Eclipse.</para> + + <para> + <productname>JBoss JMX Tools</productname> is one module of the <productname>JBoss Tools</productname> project. <productname> JBoss JMX Tools</productname> has no dependency on any other part of <productname>JBoss Tools</productname>, and can be downloaded as a standalone Eclipse plugin. Even though the <productname>JMX Tools</productname> have no dependencies on other plugins, such as <productname>AS Tools</productname>, <productname>JBoss JMX Tools</productname> do depend on the JMX Tooling and even extend it. + </para> + + <para> + You can find the <productname>JBoss Tools</productname> plugins over at the <ulink url="http://labs.jboss.com/tools/download.html">download pages</ulink>. The only package you will need to get is the JBoss JMX Tooling, however the <productname>AS Tools</productname> would give you a wider experience and more options when using JMX with JBoss Servers. You can find further download and installation instructions on the JBoss Wiki in the <ulink url="http://www.jboss.org/tools/download/installation">InstallingJBossTools</ulink> section. + </para> + </section> + </section> </chapter> \ No newline at end of file Modified: trunk/jmx/docs/reference/en-US/references.xml =================================================================== --- trunk/jmx/docs/reference/en-US/references.xml 2011-01-27 00:41:36 UTC (rev 28637) +++ trunk/jmx/docs/reference/en-US/references.xml 2011-01-27 02:25:46 UTC (rev 28638) @@ -8,7 +8,7 @@ <title>MBean Explorer</title> <para> - The <guilabel>MBean Explorer</guilabel> displays the MBean features (both attributes and operations) in its hierarchy. Double-clicking on a feature will open a <property>MBean Editor</property>, displaying the page corresponding to the feature type and select the feature. + The <guilabel>MBean Explorer</guilabel> displays the MBean features (both attributes and operations) in its hierarchy. Double-clicking on a feature will open an <property>MBean Editor</property>, displaying the page corresponding to the feature type and select the feature. </para> <figure> @@ -21,7 +21,7 @@ </figure> <para> - Since it is possible to have many MBean Editors opened at the same time, the <guilabel>MBean Explorer</guilabel> has the Link With Editor button <inlinemediaobject> <imageobject> <imagedata fileref="images/link-with-editor_0.2.0.png"/></imageobject></inlinemediaobject> to synchronize selections between the active <guilabel>MBean Editor</guilabel> and the <guilabel>MBean Explorer</guilabel> (and vice versa). + Since it is possible to have many MBean Editors opened at the same time, the <guilabel>MBean Explorer</guilabel> has the <guibutton>Link With Editor</guibutton> button <inlinemediaobject> <imageobject> <imagedata fileref="images/link-with-editor_0.2.0.png"/></imageobject></inlinemediaobject> to synchronize selections between the active <guilabel>MBean Editor</guilabel> and the <guilabel>MBean Explorer</guilabel> (and vice versa). </para> <para> @@ -29,7 +29,7 @@ </para> <para> - For example, if you are only interested by MBeans related to memory, typing "memo" will show any node (domain, mbean, attribute, or operation) that matches that text, as well as that node's parents and children. So if an MBean matches, all attributes and operations from that bean will show. If, however, an attribute or operation name (a leaf node) matches, only that node and its parents in the tree will show. + For example, if you are only interested by MBeans related to memory, typing "memo" will show any node (domain, mbean, attribute, or operation) that matches that text, as well as that node's parents and children. So if an MBean matches, all attributes and operations from that bean will be displayed. If, however, an attribute or operation name (a leaf node) matches, only that node and its parents in the tree will be displayed. </para> <figure> @@ -79,11 +79,11 @@ </itemizedlist> <para> - The <guilabel>Attributes</guilabel> and <guilabel>Operations</guilabel> pages display a list for either the MBean attributes or operations as well as details for the selection. + The <guilabel>Attributes</guilabel> and <guilabel>Operations</guilabel> pages display a list for either the MBean attributes or operations, as well as details about the selection. </para> <para> - It is possible to toggle the layout between the list and the details either vertically (by default) or horizontally with the help of the special icons <inlinemediaobject><imageobject><imagedata fileref="images/mbean-editor-layout-buttons_0.2.0.png"/></imageobject></inlinemediaobject>in the right top corner of the editor. + It is possible to toggle the layout between the list and the details either vertically (by default) or horizontally with the help of the special icons <inlinemediaobject><imageobject><imagedata fileref="images/mbean-editor-layout-buttons_0.2.0.png"/></imageobject></inlinemediaobject> in the right top corner of the editor. </para> <figure> @@ -108,7 +108,7 @@ <section> <title>Notifications Page</title> <para> - One more page in the <guilabel>MBean Editor</guilabel> is the <guilabel>Notifications</guilabel> page, which gives the possibility to subscribe or unsubscribe to an MBean to receive its notifications by checking or unchecking the <guibutton>Subscribe</guibutton> button in the right top corner. + The <guilabel>Notifications</guilabel> page provides the ability to subscribe or unsubscribe to an MBean to receive its notifications by checking or unchecking the <guibutton>Subscribe</guibutton> button in the right top corner. </para> <para>The list of notifications is refreshed every time a new notification is received:</para> @@ -123,7 +123,7 @@ <note> <title>Note</title> - <para>It is only possible to subscribe to MBean that emits notifications (i.e. they must be a NotificationBroadcaster).</para> + <para>It is only possible to subscribe to an MBean that emits notifications (i.e. they must be a NotificationBroadcaster).</para> </note> </section> Modified: trunk/jmx/docs/reference/en-US/summary.xml =================================================================== --- trunk/jmx/docs/reference/en-US/summary.xml 2011-01-27 00:41:36 UTC (rev 28637) +++ trunk/jmx/docs/reference/en-US/summary.xml 2011-01-27 02:25:46 UTC (rev 28638) @@ -3,29 +3,21 @@ <?dbhtml filename="summary.html"?> <title>Summary</title> <para> - In conclusion, with this document you could easily start with JXM Tools. The chapters above walked you through the steps on how to do Tomcat,Eclipse Equinox or JBoss Instances managing and how to create new JMX connections. The document also includes the reference of JMX Tools features. If you have questions or suggestions concerned both the documentation and tools behavior, you are welcome to JBoss Tools Users forum. Please, use Jira to report bugs and requests on documentation. + This document has provided an overview of the functionality included with JXM Tools, as well as walking you through the steps on managing Tomcat, Eclipse Equinox or JBoss Instances and how to create new JMX connections. If you have questions or suggestions concerned both the documentation and tools behavior, you are welcome to JBoss Tools Users forum. Please, use Jira to report bugs and requests on documentation. </para> <section> <title>Other relevant resources on the topic</title> <para> - All JBoss Developer Studio/JBoss Tools release documentation you can find at <ulink url="http://docs.jboss.org/tools">http://docs.jboss.org/tools</ulink> in the corresponding release directory. + You can find the JBoss Developer Studio/JBoss Tools release documentation at <ulink url="http://docs.jboss.org/tools">http://docs.jboss.org/tools</ulink> in the corresponding release directory. </para> <para> The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs">http://download.jboss.org/jbosstools/nightly-docs</ulink>. </para> - <para>You can find a set of benefits and other extra information on:</para> - <itemizedlist> - <listitem> - <para> - <ulink url="http://www.jboss.org/community/wiki/JBossMX">JBoss Wiki</ulink> - </para> - </listitem> - <listitem> - <para> - For more information about JMX technology please visit <ulink url="http://java.sun.com/javase/technologies/core/mntr-mgmt/javamanagement/">JMX Technology Home Page</ulink> - </para> - </listitem> - </itemizedlist> + <para>The JBoss JXM Wiki can be found at <ulink url="http://www.jboss.org/community/wiki/JBossMX">http://www.jboss.org/community/wiki/JBossMX</ulink></para> + <para> + For more information about JMX technology please visit <ulink url="http://java.sun.com/javase/technologies/core/mntr-mgmt/javamanagement/">JMX Technology Home Page</ulink> + </para> + </section> </chapter> \ No newline at end of file Modified: trunk/jmx/docs/reference/en-US/tasks.xml =================================================================== --- trunk/jmx/docs/reference/en-US/tasks.xml 2011-01-27 00:41:36 UTC (rev 28637) +++ trunk/jmx/docs/reference/en-US/tasks.xml 2011-01-27 02:25:46 UTC (rev 28638) @@ -7,33 +7,29 @@ <title>Quick Start</title> <para> - To start using the <property>JMX Tools</property> it's necessary to open <property>MBean Explorer</property>. Go to <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice>, select <guimenuitem>MBean Explorer</guimenuitem> and click the <guibutton>OK</guibutton> button. + To start using the <property>JMX Tools</property> it is necessary to open <guilabel>MBean Explorer</guilabel>. Select <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice>, select <guimenuitem>MBean Explorer</guimenuitem> and click the <guibutton>OK</guibutton> button. </para> <para> - The <property>MBean Explorer</property> lists all the domains, mbeans, attributes, and operations inside a connection. When you double-click an MBean in the <emphasis><property>MBean Explorer</property>,</emphasis> it opens a multi-page editor to manage the MBean. The <property>MBean Editor</property> is composed of these pages: + The <guilabel>MBean Explorer</guilabel> lists all the domains, MBeans, attributes, and operations inside a connection. When you double-click an MBean in the <guilabel>MBean Explorer</guilabel>, it opens a multi-page editor to manage the MBean. The <guilabel>MBean Editor</guilabel> is composed of these pages: </para> <itemizedlist> <listitem> <para> - <emphasis> - <property>Attributes page</property>,</emphasis> to get/set the attributes of the MBean</para> + <guilabel>Attributes page</guilabel>, to get/set the attributes of the MBean</para> </listitem> <listitem> <para> - <emphasis> - <property>Operations page</property>,</emphasis> to invoke operations on the MBean</para> + <guilabel>Operations page</guilabel>, to invoke operations on the MBean</para> </listitem> <listitem> <para> - <emphasis> - <property>Notifications page</property>,</emphasis> to receive notifications from the MBean</para> + <guilabel>Notifications page</guilabel>, to receive notifications from the MBean</para> </listitem> <listitem> <para> - <emphasis> - <property>Info page</property>,</emphasis> which displays general information about the MBean </para> + <guilabel>Info page</guilabel>, which displays general information about the MBean </para> </listitem> </itemizedlist> @@ -43,7 +39,7 @@ <title>Managing Application</title> <para> - As it's been said earlier in the guide that the JMX technology allows you to monitor and manage Java applications. In this section we will show you how to get connected to a sample Java application and run the <code>sayHello()</code> method remotely from inside of the <property>MBean Explorer</property>. + As it has been said earlier in the guide, the JMX technology allows you to monitor and manage Java applications. In this section we will show you how to get connected to a sample Java application and run the <code>sayHello()</code> method remotely from inside of the <guilabel>MBean Explorer</guilabel>. </para> <orderedlist> @@ -51,7 +47,7 @@ <listitem> <para> - Save the bundle of JMX API sample classes, <ulink url="http://java.sun.com/docs/books/tutorial/jmx/examples/jmx_examples.zip">jmx_examples.zip</ulink>, to your working directory + Save the bundle of JMX API sample classes, <ulink url="http://java.sun.com/docs/books/tutorial/jmx/examples/jmx_examples.zip">jmx_examples.zip</ulink>, to your working directory. </para> </listitem> <listitem> @@ -78,12 +74,12 @@ </listitem> <listitem> <para> - Now launch the Eclipse IDE, in Eclipse open the <guilabel>MBean Explorer</guilabel>. Go to <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice> and then select <guimenuitem>MBean Explorer</guimenuitem> and click the <guibutton>OK</guibutton> button) + Now launch the Eclipse IDE, in Eclipse open the <guilabel>MBean Explorer</guilabel>. Go to <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice>, select <guimenuitem>MBean Explorer</guimenuitem>, and then click the <guibutton>OK</guibutton> button) </para> </listitem> <listitem> <para> - Click the <guibutton>New Connection</guibutton> icon <inlinemediaobject><imageobject><imagedata fileref="images/new_connection_icon.png"/></imageobject></inlinemediaobject> in the <property>MBean Explorer</property> menu bar. + Click the <guibutton>New Connection</guibutton> icon <inlinemediaobject><imageobject><imagedata fileref="images/new_connection_icon.png"/></imageobject></inlinemediaobject> in the <guilabel>MBean Explorer</guilabel> menu bar. </para> </listitem> @@ -115,9 +111,9 @@ <listitem> <para> - Now expand the connection you have just created, then open the <guilabel>com.example</guilabel> package and click the <code>sayHello()</code> method. + Now expand the connection you have just created, open the <guilabel>com.example</guilabel> package, and click the <code>sayHello()</code> method. </para> - <para>Once the <code>sayHello()</code> method is clicked the <guilabel>MBean Editor</guilabel> is activated. </para> + <para>Once the <code>sayHello()</code> method is selected the <guilabel>MBean Editor</guilabel> is activated. </para> </listitem> @@ -139,7 +135,7 @@ <listitem> <para> - The final step is to make sure the application worked as it was expected. Open the terminal where you launched the application in step 3. Now you see the "hello, world" message on the screen. + The final step is to make sure the application worked as expected. Open the terminal where you launched the application in step 3. Now you see the "hello, world" message on the screen. </para> </listitem> </orderedlist> @@ -155,10 +151,10 @@ Using SSL for authentication is not supported: you need to make sure that the System property <guilabel>com.sun.management.jmxremote.ssl</guilabel> is set to false. </para> <para> - More information to manage Tomcat can be found in <ulink url="http://tomcat.apache.org/tomcat-6.0-doc/">Tomcat management documentation</ulink>. + More information to manage Tomcat can be found in the <ulink url="http://tomcat.apache.org/tomcat-6.0-doc/">Tomcat management documentation</ulink>. </para> <para> - Instructions to manage remotely Tomcat are available in <ulink url="http://tomcat.apache.org/tomcat-6.0-doc/monitoring.html">Tomcat's monitoring documentation</ulink>. + Instructions to remotely manage Tomcat are available in <ulink url="http://tomcat.apache.org/tomcat-6.0-doc/monitoring.html">Tomcat's monitoring documentation</ulink>. </para> @@ -169,9 +165,9 @@ <para>You can manage Equinox through the Equinox monitoring framework.</para> <para> - In this section we will show you how to connect to an Equinox server via JBoss JMX tools. First off, you need to create a simple servlet and run it on a server. This guide is not intended to teach you how to build application and run them on the server, <ulink url="http://www.eclipse.org/equinox-portal/tutorials/server-side/"> this tutorial </ulink> can be used to give you a better idea of how to build server-based applications with Eclipse Equinox. + In this section we will show you how to connect to an Equinox server via JBoss JMX tools. First you need to create a simple servlet and run it on a server. The process of building applications and running them on the server is beyond the scope of this documentation, however <ulink url="http://www.eclipse.org/equinox-portal/tutorials/server-side/"> this tutorial </ulink> can be used to give you a better idea of how to build server-based applications with Eclipse Equinox. </para> - <para>Once you have run an application on the server you can connect to it using JBoss JMX tools.</para> + <para>Once you have an application running on the server you can connect to it using JBoss JMX tools.</para> <orderedlist> <listitem> @@ -189,11 +185,13 @@ </listitem>--> <listitem> - <para>Switch to the <property>MBean Explorer</property> by selecting <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice> and selecting the <guimenuitem>MBean Explorer</guimenuitem>.</para> + <para> + Switch to the <guilabel>MBean Explorer</guilabel> by selecting <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice> and selecting the <guimenuitem>MBean Explorer</guimenuitem> option. + </para> </listitem> <listitem> - <para>Click the <guibutton>New Connection</guibutton> icon <inlinemediaobject><imageobject><imagedata fileref="images/new_connection_icon.png"/></imageobject></inlinemediaobject> in the <property>MBean Explorer</property> menu bar.</para> + <para>Click the <guibutton>New Connection</guibutton> icon <inlinemediaobject><imageobject><imagedata fileref="images/new_connection_icon.png"/></imageobject></inlinemediaobject> in the <property>MBean Explorer</property> menu bar.</para> </listitem> <listitem> @@ -221,15 +219,15 @@ <title>Managing JBoss AS</title> <para> - Managing JBoss instances is not supported with the <property>JMX Tools</property> alone. You must also download and install the <property>AS Tools</property> portion of the <property>JBoss Tools</property> distribution. Even after installing the proper tooling, you cannot create a JBoss JMX connection yourself or through the Connection Wizard. The first step is to create a JBoss Server. The full instructions for this can be found in the AS Tools section, however, the short summary is: + Managing JBoss instances is not supported with the <guilabel>JMX Tools</guilabel> alone. You must also download and install the <guilabel>AS Tools</guilabel> portion of the <guilabel>JBoss Tools</guilabel> distribution. Even after installing the proper tooling, you cannot create a JBoss JMX connection yourself or through the Connection Wizard. The first step is to create a JBoss Server. The full instructions for this can be found in the AS Tools section, however, the short summary is: </para> <orderedlist> <listitem> - <para>Open the <property>Servers</property> view.</para> + <para>Open the <guilabel>Servers</guilabel> view.</para> </listitem> <listitem> - <para>Right-click in the view and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Server</guimenuitem></menuchoice>.</para> + <para>Bring up the views context menu and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Server</guimenuitem></menuchoice>.</para> </listitem> <listitem> @@ -247,7 +245,7 @@ </listitem> <listitem> - <para>Start the server by right-clicking it and selecting <guimenuitem>Start</guimenuitem>.</para> + <para>Start the server by right-clicking it and selecting the <guimenuitem>Start</guimenuitem> option.</para> </listitem> <listitem> <para>Note that once the server is started, the JMX connection can be expanded.</para> @@ -261,15 +259,15 @@ <title>Managing JBoss AS Remotely</title> <para> - JBoss JMX Tool allow you to easily get access and manage a JBoss AS server remotely. In order to connect to the instance of JBoss AS remotely you need to run the server or make sure the server is launched. + The JBoss JMX Tools allow you to easily access and manage a JBoss AS server remotely. In order to connect to the instance of JBoss AS remotely you need to run the server or make sure the server is launched. </para> <orderedlist> <listitem> - <para>Go to <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Open Perspective</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice> and select the <guimenuitem>JMX perspective.</guimenuitem> + <para>Select <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Open Perspective</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice> and select the <guimenuitem>JMX perspective</guimenuitem> option. </para> </listitem> <listitem> - <para>Switch to the <guilabel>MBean Explorer</guilabel> by going to <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice> and selecting the <guimenuitem>MBean Explorer</guimenuitem>.</para> + <para>Switch to the <guilabel>MBean Explorer</guilabel> by selecting <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice> and selecting the <guimenuitem>MBean Explorer</guimenuitem> option.</para> </listitem> <listitem> @@ -279,10 +277,10 @@ </listitem> <listitem> - <para>Select the <guilabel>Advanced tab</guilabel> and set the JMX URL to:</para> + <para>Select the <guilabel>Advanced</guilabel> tab and set the JMX URL to:</para> <programlisting role="XML"><![CDATA[service:jmx:rmi://localhost/jndi/rmi://localhost:1090/jmxconnector]]></programlisting> - <para>Please, note that in this example we connected to the local host. </para> + <para>Please note that in this example we are connected to the local host. </para> </listitem> </orderedlist> </section> @@ -294,7 +292,7 @@ <title>Why we should do that?</title> <para> - You might be asking yourself why you would need to extend this framework if JMX is a standard. Perhaps you want a connection to be automatically created after some specific action, or perhaps you want your connection wizard to do more than simply set a host and port. JBoss, for example, requires setting some credentials on the client machine, but uses JBoss classes to do it. This requires that the connection have access to JBoss jars. + You might be asking yourself why you would need to extend this framework if JMX is a standard. Perhaps you want a connection to be automatically created after some specific action, or perhaps you want your connection wizard to do more than simply set a host and port. JBoss, for example, requires setting some credentials on the client machine, but uses JBoss classes to do it. This requires that the connection has access to the JBoss JARs. </para> </section> @@ -306,11 +304,11 @@ </para> <para> - An <code>IConnectionProvider</code> is responsible for creation and deletion of <code>IConnectionWrapper</code> objects. It must also keep a list of listeners that it is expected to inform when a connection is added or removed from its list. + An <code>IConnectionProvider</code> is responsible for creation and deletion of <code>IConnectionWrapper</code> objects. It must also keep a list of listeners that it is expected to notify when a connection is added or removed from its list. </para> <para> - Each <code>IConnectionWrapper</code> is expected to handle running arbitrary JMX runnables or getting a "Root" object representing all JMX nodes. There are some utility methods the <code>IConnectionWrapper</code> can make use of. + Each <code>IConnectionWrapper</code> is expected to be able to run arbitrary JMX runnables or getting a "Root" object representing all JMX nodes. There are some utility methods the <code>IConnectionWrapper</code> can make use of. </para> </section> @@ -327,7 +325,7 @@ <para> <code>org.jboss.tools.jmx.ui.attribute.controls</code> - allows you to map class types to some Control to present them in the MBean Editor </para> - <para>We hope, this guide helped you to get started with the JBoss JMX Tools. Besides, for additional information you are welcome on <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para> + <para>We hope this guide helped you to get started with the JBoss JMX Tools. For additional information you are welcome on the <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para> </listitem> </itemizedlist> </section> @@ -342,7 +340,7 @@ </para> <para> - Similarly, some connection types may be able to be created, and others may not. The default connection type, for example, can be created and deleted by you at will. The AS Tools connection type, which represents a JBoss server, does not allow you this level of control. A JBoss JMX connection is created when a JBoss server is created in the server's view, and deleted when said server is deleted. The JMX connection for this server is in the connected state only when the server is started. + Similarly, some connection types may be able to be created, and others may not. The default connection type, for example, can be created and deleted at will. The AS Tools connection type, which represents a JBoss server, does not allow you this level of control. A JBoss JMX connection is created when a JBoss server is created in the server's view, and deleted when said server is deleted. The JMX connection for this server is in the connected state only when the server is started. </para> @@ -352,14 +350,14 @@ <para> There are two ways to connect to an application with remote management enabled:</para> <para> - The first step is the same for both - to connect to a MBean Server, click the <guibutton>New Connection</guibutton> icon <inlinemediaobject><imageobject><imagedata fileref="images/new_connection_icon.png"/></imageobject></inlinemediaobject> in the <guilabel>MBean Explorer</guilabel> menu bar. + The first step is the same for both methods - to connect to a MBean Server, click the <guibutton>New Connection</guibutton> icon <inlinemediaobject><imageobject><imagedata fileref="images/new_connection_icon.png"/></imageobject></inlinemediaobject> in the <guilabel>MBean Explorer</guilabel> menu bar. </para> <para> - Then to follow the simple one you just need to specify host, port (and optionally user name and password) and click the <guibutton>OK</guibutton> button. + The simple method is to specify the host, port (and optionally user name and password) and click the <guibutton>OK</guibutton> button. </para> <para> - On the <guilabel>Advanced</guilabel> tab you can set the sever name (it will be displayed in <guilabel>MBean Explorer</guilabel>), a URL to the remote server. For example, to connect to JBoss AS you need to set the <guilabel>JMX URL</guilabel> to + On the <guilabel>Advanced</guilabel> tab you can set the sever name (it will be displayed in <guilabel>MBean Explorer</guilabel>), and a URL to the remote server. For example, to connect to JBoss AS you need to set the <guilabel>JMX URL</guilabel> to </para> <programlisting role="XML"><![CDATA[service:jmx:rmi://localhost/jndi/rmi://localhost:1090/jmxconnector]]></programlisting> <para>If it is required you can enter user name and password for the server connection. </para>

13 years, 5 months

1
0
0 / 0

JBoss Tools SVN: r28637 - trunk/documentation/guides/GettingStartedGuide/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-01-26 19:41:36 -0500 (Wed, 26 Jan 2011) New Revision: 28637 Modified: trunk/documentation/guides/GettingStartedGuide/en-US/Book_Info.xml Log: General Updates Modified: trunk/documentation/guides/GettingStartedGuide/en-US/Book_Info.xml =================================================================== --- trunk/documentation/guides/GettingStartedGuide/en-US/Book_Info.xml 2011-01-27 00:38:14 UTC (rev 28636) +++ trunk/documentation/guides/GettingStartedGuide/en-US/Book_Info.xml 2011-01-27 00:41:36 UTC (rev 28637) @@ -7,7 +7,7 @@ <productname>JBoss Developer Studio</productname> <productnumber>4.0</productnumber> <edition>4.0.0</edition> - <pubsnumber>7</pubsnumber> + <pubsnumber>8</pubsnumber> <abstract> <para>The Getting Started Guide explains the JBoss Developer Studio.</para> </abstract>

13 years, 5 months

1
0
0 / 0

JBoss Tools SVN: r28636 - trunk/hibernatetools/docs/reference/en-US.

by jbosstools-commits＠lists.jboss.org

Author: mcaspers Date: 2011-01-26 19:38:14 -0500 (Wed, 26 Jan 2011) New Revision: 28636 Modified: trunk/hibernatetools/docs/reference/en-US/Book_Info.xml Log: General Updates Modified: trunk/hibernatetools/docs/reference/en-US/Book_Info.xml =================================================================== --- trunk/hibernatetools/docs/reference/en-US/Book_Info.xml 2011-01-26 23:56:39 UTC (rev 28635) +++ trunk/hibernatetools/docs/reference/en-US/Book_Info.xml 2011-01-27 00:38:14 UTC (rev 28636) @@ -7,9 +7,11 @@ <productname>JBoss Developer Studio</productname> <productnumber>4.0</productnumber> <edition>4.0.0</edition> - <pubsnumber>4</pubsnumber> + <pubsnumber>5</pubsnumber> <abstract> - <para>The Hibernate Tools Reference Guide explains how to use the Hibernate Tools to perform reverse engineering, code generation, visualization and interaction with Hibernate.</para> + <para> + The Hibernate Tools Reference Guide explains how to use the Hibernate Tools to perform reverse engineering, code generation, visualization and interaction with Hibernate. + </para> </abstract> <corpauthor> <inlinemediaobject>

13 years, 5 months

1
0
0 / 0

JBoss Tools SVN: r28635 - trunk/deltacloud/plugins/org.jboss.tools.deltacloud.core/src/org/jboss/tools/deltacloud/core.

by jbosstools-commits＠lists.jboss.org

Author: adietish Date: 2011-01-26 18:56:39 -0500 (Wed, 26 Jan 2011) New Revision: 28635 Modified: trunk/deltacloud/plugins/org.jboss.tools.deltacloud.core/src/org/jboss/tools/deltacloud/core/DeltaCloud.java Log: renamed images to imagesRepo Modified: trunk/deltacloud/plugins/org.jboss.tools.deltacloud.core/src/org/jboss/tools/deltacloud/core/DeltaCloud.java =================================================================== --- trunk/deltacloud/plugins/org.jboss.tools.deltacloud.core/src/org/jboss/tools/deltacloud/core/DeltaCloud.java 2011-01-26 23:55:47 UTC (rev 28634) +++ trunk/deltacloud/plugins/org.jboss.tools.deltacloud.core/src/org/jboss/tools/deltacloud/core/DeltaCloud.java 2011-01-26 23:56:39 UTC (rev 28635) @@ -51,7 +51,7 @@ private InternalDeltaCloudClient client; - private DeltaCloudImagesRepository images; + private DeltaCloudImagesRepository imagesRepo; private DeltaCloudInstancesRepository instanceRepo; private IImageFilter imageFilter; @@ -355,15 +355,15 @@ } private void clearImages() { - if (images != null) { + if (imagesRepo != null) { // TODO: remove notification with all instanceRepo, replace by // notifying the changed instance - firePropertyChange(PROP_IMAGES, images.get(), images.clear()); + firePropertyChange(PROP_IMAGES, imagesRepo.get(), imagesRepo.clear()); } } public boolean imagesLoaded() { - return images == null ? false : true; + return imagesRepo == null ? false : true; } public boolean instancesLoaded() { @@ -397,17 +397,17 @@ } private DeltaCloudImagesRepository getImagesRepository() { - if (images == null) { - images = new DeltaCloudImagesRepository(); + if (imagesRepo == null) { + imagesRepo = new DeltaCloudImagesRepository(); } - return images; + return imagesRepo; } public DeltaCloudImage[] getImages() throws DeltaCloudException { - if (images == null) { + if (imagesRepo == null) { loadImages(); } - return images.get(); + return imagesRepo.get(); } /** @@ -425,7 +425,7 @@ try { Image image = client.listImages(id); deltaCloudImage = DeltaCloudImageFactory.create(image, this); - images.add(deltaCloudImage); + imagesRepo.add(deltaCloudImage); } catch (DeltaCloudClientException e) { throw new DeltaCloudException(MessageFormat.format("Cloud not find image with id \"{0}\"", id), e); }

13 years, 5 months

1
0
0 / 0

JBoss Tools SVN: r28634 - trunk/deltacloud/plugins/org.jboss.tools.deltacloud.core.

by jbosstools-commits＠lists.jboss.org

Author: adietish Date: 2011-01-26 18:55:47 -0500 (Wed, 26 Jan 2011) New Revision: 28634 Modified: trunk/deltacloud/plugins/org.jboss.tools.deltacloud.core/ChangeLog Log: [JBIDE-8250] authorization error is status code 401 (was: 403) Modified: trunk/deltacloud/plugins/org.jboss.tools.deltacloud.core/ChangeLog =================================================================== --- trunk/deltacloud/plugins/org.jboss.tools.deltacloud.core/ChangeLog 2011-01-26 23:54:04 UTC (rev 28633) +++ trunk/deltacloud/plugins/org.jboss.tools.deltacloud.core/ChangeLog 2011-01-26 23:55:47 UTC (rev 28634) @@ -1,3 +1,9 @@ +2011-01-27 André Dietisheim <André Dietisheim@adietisheim-thinkpad> + + * src/org/jboss/tools/deltacloud/core/client/HttpStatusCode.java (UNAUTHORIZED): + * src/org/jboss/tools/deltacloud/core/client/DeltaCloudClientImpl.java (throwOnHttpErrors): + [JBIDE-8250] authorization error is status code 401 (was: 403) + 2011-01-11 André Dietisheim <André Dietisheim@adietisheim-thinkpad> * src/org/jboss/tools/deltacloud/core/client/DeltaCloudClientImpl.java

13 years, 5 months

1
0
0 / 0

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

jbosstools-commits January 2011