[richfaces-svn-commits] JBoss Rich Faces SVN: r20284 - in modules/docs/trunk/Component_Reference: src/main/docbook/en-US and 2 other directories.

Author: SeanRogers Date: 2010-12-02 01:43:02 -0500 (Thu, 02 Dec 2010) New Revision: 20284 Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richtoolbar-Basic_usage.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richtoolbar-disc.png modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richtoolbar-grid.png modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richtoolbar-line.png modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richtoolbar-richtoolbar.png modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richtoolbar-square.png Modified: modules/docs/trunk/Component_Reference/Component_Reference_chapters.txt modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_Reference.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Menus_and_toolbars.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml Log: rich:toolbar draft Modified: modules/docs/trunk/Component_Reference/Component_Reference_chapters.txt =================================================================== --- modules/docs/trunk/Component_Reference/Component_Reference_chapters.txt 2010-12-02 00:50:34 UTC (rev 20283) +++ modules/docs/trunk/Component_Reference/Component_Reference_chapters.txt 2010-12-02 06:43:02 UTC (rev 20284) @@ -77,8 +77,8 @@ -- rich:dataTable -- rich:extendedDataTable -- rich:list --x Table filtering --x Table sorting +-- Table filtering +-- Table sorting x chap-Component_Reference-Trees xx rich:changeExpandListener Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_Reference.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_Reference.xml 2010-12-02 00:50:34 UTC (rev 20283) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_Reference.xml 2010-12-02 06:43:02 UTC (rev 20284) @@ -9,25 +9,25 @@ <xi:include href="chap-Component_Reference-Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Common_Ajax_attributes.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Common_features.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <part id="part-Component_Reference-a4j_tag_library"> - <title>a4j tag library</title> + <part id="part-Component_Reference-Ajax_control_components"> + <title>Ajax control components</title> <xi:include href="chap-Component_Reference-Actions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Resources.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Containers.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Validation.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Processing_management.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </part> - <part id="part-Component_Reference-rich_tag_library"> - <title>rich tag library</title> + <part id="part-Component_Reference-User_interface_components"> + <title>User interface components</title> <xi:include href="chap-Component_Reference-Rich_inputs.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Panels_and_containers.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="chap-Component_Reference-Tables_and_grids.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <!-- <xi:include href="chap-Component_Reference-Trees.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + --> <xi:include href="chap-Component_Reference-Menus_and_toolbars.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - --> - <xi:include href="chap-Component_Reference-Output_and_messages.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <!-- + <xi:include href="chap-Component_Reference-Output_and_messages.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <!-- <xi:include href="chap-Component_Reference-Drag_and_drop.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --> <xi:include href="chap-Component_Reference-Layout_and_appearance.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Menus_and_toolbars.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Menus_and_toolbars.xml 2010-12-02 00:50:34 UTC (rev 20283) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Menus_and_toolbars.xml 2010-12-02 06:43:02 UTC (rev 20284) @@ -3,44 +3,77 @@ ]> <chapter id="chap-Component_Reference-Menus_and_toolbars"> <title>Menus and toolbars</title> + <!-- In development notification --> + <important> + <title>Documentation in development</title> + <para> + Some concepts covered in this chapter may refer to the previous version of <productname>Richfaces</productname>, version 3.3.3. This chapter is scheduled for review to ensure all information is up to date. + </para> + </important> <para> - Incomplete + Read this chapter for details on menu and toolbar components. </para> + + <!-- TODO not in M5 --> + <!--<rich:contextMenu>--> + <!-- <section id="sect-Component_Reference-Menus_and_toolbars-richcontextMenu"> <title><sgmltag>&lt;rich:contextMenu&gt;</sgmltag></title> <para> Incomplete </para> </section> + --> + <!--<rich:dropDownMenu>--> + <!-- <section id="sect-Component_Reference-Menus_and_toolbars-richdropDownMenu"> <title><sgmltag>&lt;rich:dropDownMenu&gt;</sgmltag></title> <para> Incomplete </para> </section> + --> + + <!-- + <section id="sect-Component_Reference-Menus_and_toolbars-Menu_sub-components"> + <title>Menu sub-components</title> + --> - <section id="sect-Component_Reference-Menus_and_toolbars-richmenuGroup"> - <title><sgmltag>&lt;rich:menuGroup&gt;</sgmltag></title> - <para> - Incomplete - </para> - </section> + <!--<rich:menuGroup>--> + <!-- + <section id="sect-Component_Reference-Menus_and_toolbars-richmenuGroup"> + <title><sgmltag>&lt;rich:menuGroup&gt;</sgmltag></title> + <para> + Incomplete + </para> + </section> + --> - <section id="sect-Component_Reference-Menus_and_toolbars-richmenuItem"> - <title><sgmltag>&lt;rich:menuItem&gt;</sgmltag></title> - <para> - Incomplete - </para> + <!--<rich:menuItem>--> + <!-- + <section id="sect-Component_Reference-Menus_and_toolbars-richmenuItem"> + <title><sgmltag>&lt;rich:menuItem&gt;</sgmltag></title> + <para> + Incomplete + </para> + </section> + --> + <!--<rich:menuSeparator>--> + <!-- + <section id="sect-Component_Reference-Menus_and_toolbars-richmenuSeparator"> + <title><sgmltag>&lt;rich:menuSeparator&gt;</sgmltag></title> + <para> + Incomplete + </para> + </section> + </section> - - <section id="sect-Component_Reference-Menus_and_toolbars-richmenuSeparator"> - <title><sgmltag>&lt;rich:menuSeparator&gt;</sgmltag></title> - <para> - Incomplete - </para> - </section> - + --> + + <!-- TODO not in M5 --> + <!--<rich:panelMenu>--> + <!-- <section id="sect-Component_Reference-Menus_and_toolbars-richpanelMenu"> <title><sgmltag>&lt;rich:panelMenu&gt;</sgmltag></title> <itemizedlist> @@ -99,118 +132,294 @@ </para> </listitem> </itemizedlist> - </section> + --> - <section id="sect-Component_Reference-Menus_and_toolbars-richpanelMenuGroup"> - <title><sgmltag>&lt;rich:panelMenuGroup&gt;</sgmltag></title> - <para> - The <classname>&lt;rich:panelMenuGroup&gt;</classname> component defines a group of <classname>&lt;rich:panelMenuItem&gt;</classname> components inside a <classname>&lt;rich:panelMenu&gt;</classname>. - </para> - <para> - If the <code>expandMode</code> is unspecified, the submission behavior for the group is inherited from the parent <classname>&lt;rich:panelMenu&gt;</classname>. Otherwise, the <code>expandMode</code> setting is used instead of the parent's behavior. - </para> - <para> - Icons for the menu group can be chosen from a set of standard icons. There are three attributes that relate to the different menu states that the icon represents: <code>iconExpanded</code>, <code>iconCollapsed</code>, and <code>iconDisabled</code>. The standard icons are shown in <xref linkend="figu-Component_Reference-richpanelMenuGroup-Standard_icons" />. - </para> - <figure id="figu-Component_Reference-richpanelMenuGroup-Standard_icons"> - <title><sgmltag>&lt;Standard icons&gt;</sgmltag></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-richpanelMenuGroup-Standard_icons.png" format="PNG" /> - </imageobject> - </mediaobject> - </figure> - <para> - Alternatively, a path can be defined that points to an image file to use as an icon. - </para> - <example id="exam-Component_Reference-richpanelMenuGroup-Using_custom_icons"> - <title>Using custom icons</title> + <!--<rich:panelMenuGroup>--> + <!-- + <section id="sect-Component_Reference-Menus_and_toolbars-richpanelMenuGroup"> + <title><sgmltag>&lt;rich:panelMenuGroup&gt;</sgmltag></title> + <para> + The <classname>&lt;rich:panelMenuGroup&gt;</classname> component defines a group of <classname>&lt;rich:panelMenuItem&gt;</classname> components inside a <classname>&lt;rich:panelMenu&gt;</classname>. + </para> + <para> + If the <code>expandMode</code> is unspecified, the submission behavior for the group is inherited from the parent <classname>&lt;rich:panelMenu&gt;</classname>. Otherwise, the <code>expandMode</code> setting is used instead of the parent's behavior. + </para> + <para> + Icons for the menu group can be chosen from a set of standard icons. There are three attributes that relate to the different menu states that the icon represents: <code>iconExpanded</code>, <code>iconCollapsed</code>, and <code>iconDisabled</code>. The standard icons are shown in <xref linkend="figu-Component_Reference-richpanelMenuGroup-Standard_icons" />. + </para> + <figure id="figu-Component_Reference-richpanelMenuGroup-Standard_icons"> + <title><sgmltag>&lt;Standard icons&gt;</sgmltag></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richpanelMenuGroup-Standard_icons.png" format="PNG" /> + </imageobject> + </mediaobject> + </figure> + <para> + Alternatively, a path can be defined that points to an image file to use as an icon. + </para> + <example id="exam-Component_Reference-richpanelMenuGroup-Using_custom_icons"> + <title>Using custom icons</title> <programlisting language="XML" role="XML"> &lt;rich:panelMenu&gt; &lt;rich:PanelMenuGroup label="Group 1" iconExpanded="\images\img1.png" iconCollapsed="\images\img2.png"&gt;&gt; - &lt;!--Nested menu components--&gt; + &lt;!- -Nested menu components- -&gt; &lt;/rich:panelMenuGroup&gt; &lt;/rich:panelMenu&gt; </programlisting> - </example> - </section> - - <section id="sect-Component_Reference-Menus_and_toolbars-richpanelMenuItem"> - <title><sgmltag>&lt;rich:panelMenuItem&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - <parameter>component-type</parameter>: <classname>org.richfaces.PanelMenuItem</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlPanelMenuItem</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <classname>org.richfaces.PanelMenuItem</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>renderer-type</parameter>: <classname>org.richfaces.PanelMenuItemRenderer</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.PanelMenuItemTag</classname> - </para> - </listitem> - </itemizedlist> - <para> - The <classname>&lt;rich:panelMenuItem&gt;</classname> component represents a single item inside a <classname>&lt;rich:panelMenuGroup&gt;</classname> component, which is in turn part of a <classname>&lt;rich:panelMenu&gt;</classname> component. - </para> - <para> - If the <code>mode</code> is unspecified, the submission behavior for the item is inherited from the parent <classname>&lt;rich:panelMenu&gt;</classname>. Otherwise, the <code>mode</code> setting is used instead of the parent's behavior. - </para> - <para> - Icons for menu items can be chosen from a set of standard icons. There are two attributes that relate to the different menu states that the icon represents: <code>icon</code> and <code>iconDisabled</code>. The standard icons are shown in <xref linkend="figu-Component_Reference-Basic_column_example-Basic_column_example" />. - </para> - <figure id="figu-Component_Reference-richpanelMenuItem-Standard_icons"> - <title>Standard icons</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-richpanelMenuItem-Standard_icons.png" format="PNG" /> - </imageobject> - </mediaobject> - </figure> - <para> - Alternatively, a path can be defined that points to an image file to use as an icon. - </para> - <example id="exam-Component_Reference-richpanelMenuItem-Using_custom_icons"> - <title>Using custom icons</title> + </example> + </section> + --> + + <!--<rich:panelMenuItem>--> + <!-- + <section id="sect-Component_Reference-Menus_and_toolbars-richpanelMenuItem"> + <title><sgmltag>&lt;rich:panelMenuItem&gt;</sgmltag></title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.PanelMenuItem</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlPanelMenuItem</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.PanelMenuItem</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.PanelMenuItemRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.PanelMenuItemTag</classname> + </para> + </listitem> + </itemizedlist> + <para> + The <classname>&lt;rich:panelMenuItem&gt;</classname> component represents a single item inside a <classname>&lt;rich:panelMenuGroup&gt;</classname> component, which is in turn part of a <classname>&lt;rich:panelMenu&gt;</classname> component. + </para> + <para> + If the <code>mode</code> is unspecified, the submission behavior for the item is inherited from the parent <classname>&lt;rich:panelMenu&gt;</classname>. Otherwise, the <code>mode</code> setting is used instead of the parent's behavior. + </para> + <para> + Icons for menu items can be chosen from a set of standard icons. There are two attributes that relate to the different menu states that the icon represents: <code>icon</code> and <code>iconDisabled</code>. The standard icons are shown in <xref linkend="figu-Component_Reference-Basic_column_example-Basic_column_example" />. + </para> + <figure id="figu-Component_Reference-richpanelMenuItem-Standard_icons"> + <title>Standard icons</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richpanelMenuItem-Standard_icons.png" format="PNG" /> + </imageobject> + </mediaobject> + </figure> + <para> + Alternatively, a path can be defined that points to an image file to use as an icon. + </para> + <example id="exam-Component_Reference-richpanelMenuItem-Using_custom_icons"> + <title>Using custom icons</title> <programlisting language="XML" role="XML"> &lt;rich:panelMenu&gt; ... - &lt;rich:panelMenuItem value="Item 1.1" icon="\images\img1.png" iconDisabled="\images\img2.png" /&gt; + &lt;rich:panelMenuItem value="Item 1.1" icon="\images\img1.png" iconDisabled="\images\img2.png" /&gt; ... &lt;/rich:panelMenu&gt; </programlisting> - </example> + </example> + </section> + </section> + --> - <section id="sect-Component_Reference-Menus_and_toolbars-richtoolBar"> - <title><sgmltag>&lt;rich:toolBar&gt;</sgmltag></title> + <!--<rich:toolBar>--> + <section id="sect-Component_Reference-Menus_and_toolbars-richtoolbar"> + <title><sgmltag>&lt;rich:toolbar&gt;</sgmltag></title> <para> - Incomplete + The <sgmltag>&lt;rich:toolbar&gt;</sgmltag> component is a horizontal toolbar. Any JavaServer Faces (<acronym>JSF</acronym>) component can be added to the toolbar. </para> + <figure id="figu-Component_Reference-richtoolbar-richtoolbar"> + <title><sgmltag>&lt;rich:toolbar&gt;</sgmltag></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richtoolbar-richtoolbar.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A <sgmltag>&lt;rich:toolbar&gt;</sgmltag> component with a label, hyperlinks, item separators, and a text box. + </para> + </textobject> + </mediaobject> + </figure> + + <section id="sect-Component_Reference-richtoolbar-Basic_usage"> + <title>Basic usage</title> + <para> + The <sgmltag>&lt;rich:toolbar&gt;</sgmltag> component does not require any attributes to be defined for basic usage. Add child components to the <sgmltag>&lt;rich:toolbar&gt;</sgmltag> component to have them appear on the toolbar when rendered. + </para> + <example id="exam-Component_Reference-richtoolbar-Basic_usage"> + <title>Basic usage</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richtoolbar-Basic_usage.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </example> + </section> + + <section id="sect-Component_Reference-richtoolbar-Appearance"> + <title>Appearance</title> + <para> + Set the width and height of the toolbar using the common <varname>width</varname> and <varname>height</varname> attributes. + </para> + <para> + Items on the toolbar can be separated by a graphical item separator. Use the <varname>itemSeparator</varname> attribute to specify one of the standard separator styles: + </para> + <itemizedlist> + <listitem> + <para> + <literal>none</literal>, the default appearance, does not show any item separators. + </para> + </listitem> + <listitem> + <para> + <literal>disc</literal> shows a small circular disc to separate items: + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richtoolbar-disc.png" format="PNG" /> + </imageobject> + <textobject> + A small circular disc to separate items. + </textobject> + </inlinemediaobject> + </para> + </listitem> + <listitem> + <para> + <literal>grid</literal> shows a grid pattern to separate items: + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richtoolbar-grid.png" format="PNG" /> + </imageobject> + <textobject> + A grid pattern to separate items. + </textobject> + </inlinemediaobject> + </para> + </listitem> + <listitem> + <para> + <literal>line</literal> shows a vertical line to separate items: + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richtoolbar-line.png" format="PNG" /> + </imageobject> + <textobject> + A vertical line to separate items. + </textobject> + </inlinemediaobject> + </para> + </listitem> + <listitem> + <para> + <literal>square</literal> shows a small square to separate items: + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richtoolbar-square.png" format="PNG" /> + </imageobject> + <textobject> + A small square to separate items. + </textobject> + </inlinemediaobject> + </para> + </listitem> + </itemizedlist> + <para> + Alternatively, use the <varname>itemSeparator</varname> attribute to specify a URL to an image. The image is then used as an item separator. The appearance of the item separator can be additionally customized by using the <literal>itemSeparator</literal> facet. + </para> + </section> + + <section id="sect-Component_Reference-richtoolbar-Grouping_items"> + <title>Grouping items</title> + <para> + Group together multiple items on the toolbar by using the <sgmltag>&lt;rich:toolbarGroup&gt;</sgmltag> child component. Refer to <xref linkend="sect-Component_Reference-Menus_and_toolbars-richtoolbarGroup" /> for full details on the <sgmltag>&lt;rich:toolbarGroup&gt;</sgmltag> component. + </para> + </section> + + <section id="sect-Component_Reference-richtoolbar-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.Toolbar</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlToolbar</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.Toolbar</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.ToolbarRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.ToolbarTag</classname> + </para> + </listitem> + </itemizedlist> + </section> + + <!--<rich:toolbarGroup>--> + <section id="sect-Component_Reference-Menus_and_toolbars-richtoolbarGroup"> + <title><sgmltag>&lt;rich:toolbarGroup&gt;</sgmltag></title> + <para> + The <sgmltag>&lt;rich:toolbarGroup&gt;</sgmltag> component is a child component of the <sgmltag>&lt;rich:toolbar&gt;</sgmltag> component. The <sgmltag>&lt;rich:toolbarGroup&gt;</sgmltag> component is used to group a number of items together on a toolbar. + </para> + + <section id="sect-Component_Reference-richtoolbarGroup-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.ToolbarGroup</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlToolbarGroup</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.ToolbarGroup</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.ToolbarGroupRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.ToolbarGroupTag</classname> + </para> + </listitem> + </itemizedlist> + </section> + </section> + </section> - - <section id="sect-Component_Reference-Menus_and_toolbars-richtoolBarGroup"> - <title><sgmltag>&lt;rich:toolBarGroup&gt;</sgmltag></title> - <para> - Incomplete - </para> - </section> </chapter> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml 2010-12-02 00:50:34 UTC (rev 20283) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml 2010-12-02 06:43:02 UTC (rev 20284) @@ -141,58 +141,59 @@ </listitem> </itemizedlist> </section> - </section> - - <!-- TODO not in M4 --> - <!--<rich:autocompleteBehavior>--> - <!-- - <section id="sect-Component_Reference-Rich_inputs-richautocompleteBehavior"> - <title><sgmltag>&lt;rich:autocompleteBehavior&gt;</sgmltag></title> - <para> - The <sgmltag>&lt;rich:autocompleteBehavior&gt;</sgmltag> behavior is an auto-completing list of input suggestions that can be attached to other components. - </para> - <para> - Use the <sgmltag>&lt;rich:autocomplete&gt;</sgmltag> component for a standard auto-completing combo-box control. Refer to <xref linkend="sect-Component_Reference-Rich_inputs-richautocomplete" /> for full details on the <sgmltag>&lt;rich:autocomplete&gt;</sgmltag> component. - </para> - <section id="sect-Component_Reference-richautocompleteBehavior-Basic_usage"> - <title>Basic usage</title> + <!-- TODO not in M4 --> + <!--<rich:autocompleteBehavior>--> + <!-- + <section id="sect-Component_Reference-Rich_inputs-richautocompleteBehavior"> + <title><sgmltag>&lt;rich:autocompleteBehavior&gt;</sgmltag></title> <para> - Attach the <sgmltag>&lt;rich:autocompleteBehavior&gt;</sgmltag> behavior as a sub-element to another component to provide auto-complete suggestions for that component. Suggestions shown in the auto-complete list can be specified using the <varname>autocompleteMethod</varname> attribute, which points to a collection of suggestions. <xref linkend="exam-Component_Reference-richautocompleteBehavior-Defining_suggestion_values" /> demonstrates a <sgmltag>&lt;rich:autocompleteBehavior&gt;</sgmltag> behavior attached to a standard JSF <sgmltag>&lt;h:inputText&gt;</sgmltag> component. + The <sgmltag>&lt;rich:autocompleteBehavior&gt;</sgmltag> behavior is an auto-completing list of input suggestions that can be attached to other components. </para> - <example id="exam-Component_Reference-richautocompleteBehavior-Defining_suggestion_values"> - <title>Defining suggestion values</title> - <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richautocompleteBehavior-Defining_suggestion_values.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> - </example> - </section> + <para> + Use the <sgmltag>&lt;rich:autocomplete&gt;</sgmltag> component for a standard auto-completing combo-box control. Refer to <xref linkend="sect-Component_Reference-Rich_inputs-richautocomplete" /> for full details on the <sgmltag>&lt;rich:autocomplete&gt;</sgmltag> component. + </para> - <section id="sect-Component_Reference-richautocompleteBehavior-Reference_data"> - <title>Reference data</title> - <itemizedlist> - <listitem> - <para> - <parameter>component-type</parameter>: <classname>org.richfaces.autocompleteBehavior</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlAutocompleteBehavior</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>component-family</parameter>: <classname>org.richfaces.autocompleteBehavior</classname> - </para> - </listitem> - <listitem> - <para> - <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.autocompleteBehaviorTag</classname> - </para> - </listitem> - </itemizedlist> + <section id="sect-Component_Reference-richautocompleteBehavior-Basic_usage"> + <title>Basic usage</title> + <para> + Attach the <sgmltag>&lt;rich:autocompleteBehavior&gt;</sgmltag> behavior as a sub-element to another component to provide auto-complete suggestions for that component. Suggestions shown in the auto-complete list can be specified using the <varname>autocompleteMethod</varname> attribute, which points to a collection of suggestions. <xref linkend="exam-Component_Reference-richautocompleteBehavior-Defining_suggestion_values" /> demonstrates a <sgmltag>&lt;rich:autocompleteBehavior&gt;</sgmltag> behavior attached to a standard JSF <sgmltag>&lt;h:inputText&gt;</sgmltag> component. + </para> + <example id="exam-Component_Reference-richautocompleteBehavior-Defining_suggestion_values"> + <title>Defining suggestion values</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richautocompleteBehavior-Defining_suggestion_values.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </example> + </section> + + <section id="sect-Component_Reference-richautocompleteBehavior-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.autocompleteBehavior</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlAutocompleteBehavior</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.autocompleteBehavior</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.autocompleteBehaviorTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> + --> + </section> - --> <!-- <rich:calendar> --> <section id="sect-Component_Reference-Rich_inputs-richcalendar"> Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richtoolbar-Basic_usage.xml_sample =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richtoolbar-Basic_usage.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richtoolbar-Basic_usage.xml_sample 2010-12-02 06:43:02 UTC (rev 20284) @@ -0,0 +1,5 @@ +<rich:toolbar> + <h:commandLink value="News" /> + <h:commandLink value="Reviews" /> + <h:commandLink value="Galleries" /> +</rich:toolbar> Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richtoolbar-disc.png =================================================================== (Binary files differ) Property changes on: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richtoolbar-disc.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richtoolbar-grid.png =================================================================== (Binary files differ) Property changes on: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richtoolbar-grid.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richtoolbar-line.png =================================================================== (Binary files differ) Property changes on: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richtoolbar-line.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richtoolbar-richtoolbar.png =================================================================== (Binary files differ) Property changes on: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richtoolbar-richtoolbar.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richtoolbar-square.png =================================================================== (Binary files differ) Property changes on: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richtoolbar-square.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream