Author: SeanRogers Date: 2010-12-21 01:30:57 -0500 (Tue, 21 Dec 2010) New Revision: 20714 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-Tables_and_grids.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning/skin-richdataTable.xml Log: Draft of dropDownMenu 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-21 04:05:17 UTC (rev 20713) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Menus_and_toolbars.xml 2010-12-21 06:30:57 UTC (rev 20714) @@ -26,41 +26,122 @@ --> <!--<rich:dropDownMenu>--> - <!-- <section id="sect-Component_Reference-Menus_and_toolbars-richdropDownMenu"> <title><sgmltag>&lt;rich:dropDownMenu&gt;</sgmltag></title> <para> - Incomplete + The <sgmltag>&lt;rich:dropDownMenu&gt;</sgmltag> component is used for creating a drop-down, hierarchical menu. It can be used with the <sgmltag>&lt;rich:toolbar&gt;</sgmltag> component to create menus in an application's toolbar. </para> + + <section id="sect-Component_Reference-richdropDownMenu-Basic_usage"> + <title>Basic usage</title> + <para> + The <sgmltag>&lt;rich:dropDownMenu&gt;</sgmltag> component only requires the <varname>value</varname> attribute for basic usage. Use the <varname>value</varname> attribute to define the text label that appears as the title of the menu. Clicking on the title drops the menu down. + </para> + <para> + Alternatively, use the <literal>label</literal> facet to define the menu title. If the <literal>label</literal> facet is used, the <varname>value</varname> attribute is not necessary. + </para> + </section> + + <section id="sect-Component_Reference-richdropDownMenu-Menu_content"> + <title>Menu content</title> + <para> + To set the content of the drop-down menu and any sub-menus, use the <sgmltag>&lt;rich:menuItem&gt;</sgmltag>, <sgmltag>&lt;rich:menuGroup&gt;</sgmltag>, and <sgmltag>&lt;rich:menuSeparator&gt;</sgmltag> components. These components are detailed in <xref linkend="sect-Component_Reference-Menus_and_toolbars-Menu_sub-components" />. + </para> + </section> + + <!-- TODO not in M5 --> + <!-- + <section id="sect-Component_Reference-richdropDownMenu-Appearance"> + <title>Appearance</title> + <para> + To determine the direction and location of the menu when it appears, use the <varname>direction</varname> and <varname>jointPoint</varname> attributes. + </para> + + </section> + --> + + <section id="sect-Component_Reference-richdropDownMenu-Expanding_and_collapsing_the_menu"> + <title>Expanding and collapsing the menu</title> + <para> + By default, the menu drops down when the title is clicked. To drop down with a different event, use the <varname>event</varname> attribute to define the event instead. + </para> + <para> + Use the <varname>submitMode</varname> attribute to determine how the menu requests are submitted: + </para> + <itemizedlist> + <listitem> + <para> + <literal>server</literal>, the default setting, submits the form normally and completely refreshes the page. + </para> + </listitem> + <listitem> + <para> + <literal>ajax</literal> performs an Ajax form submission, and re-renders elements specified with the <varname>render</varname> attribute. + </para> + </listitem> + <listitem> + <para> + <literal>none</literal> causes the <varname>action</varname> and <varname>actionListener</varname> items to be ignored, and the behavior is fully defined by the nested components instead of responses from submissions. + </para> + </listitem> + </itemizedlist> + </section> + + <section id="sect-Component_Reference-richdropDownMenu-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.DropDownMenu</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlDropDownMenu</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.DropDownMenu</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.DropDownMenuRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.DropDownMenuTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> - --> - <!-- <section id="sect-Component_Reference-Menus_and_toolbars-Menu_sub-components"> <title>Menu sub-components</title> - --> - + <para> + The <sgmltag>&lt;rich:menuGroup&gt;</sgmltag>, <sgmltag>&lt;rich:menuItem&gt;</sgmltag>, and <sgmltag>&lt;rich:menuSeparator&gt;</sgmltag> components are used to construct menus for the <sgmltag>&lt;rich:dropDownMenu&gt;</sgmltag> component. Refer to <xref linkend="sect-Component_Reference-Menus_and_toolbars-richdropDownMenu" /> for more details on the <sgmltag>&lt;rich:dropDownMenu&gt;</sgmltag> component. + </para> + <!--<rich:menuGroup>--> - <!-- <section id="sect-Component_Reference-Menus_and_toolbars-richmenuGroup"> <title><sgmltag>&lt;rich:menuGroup&gt;</sgmltag></title> <para> Incomplete </para> </section> - --> <!--<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> @@ -69,7 +150,6 @@ </section> </section> - --> <!-- TODO not in M5 --> <!--<rich:panelMenu>--> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml 2010-12-21 04:05:17 UTC (rev 20713) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml 2010-12-21 06:30:57 UTC (rev 20714) @@ -690,6 +690,8 @@ </listitem> </itemizedlist> </section> + + <xi:include href="skinning/skin-richdataTable.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> </section> <!--<rich:extendedDataTable>--> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning/skin-richdataTable.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning/skin-richdataTable.xml 2010-12-21 04:05:17 UTC (rev 20713) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/skinning/skin-richdataTable.xml 2010-12-21 06:30:57 UTC (rev 20714) @@ -9,22 +9,41 @@ <thead> <row> <entry>Class (selector) name</entry> - <entry>Description</entry> <entry>Skin Parameters</entry> <entry><acronym>CSS</acronym> properties mapped</entry> </row> </thead> <tbody> <row> - <entry><classname>.rich-table</classname></entry> - <entry>Defines the styles for a table</entry> + <entry> + <variablelist> + <varlistentry> + <term><classname>.rich-table</classname></term> + <listitem> + <para> + This class defines the styles for a table. + </para> + </listitem> + </varlistentry> + </variablelist> + </entry> <entry><literal>tableBackgroundColor</literal></entry> <entry><literal>background-color</literal></entry> </row> <row> - <entry morerows="2"><classname>.rich-table-cell</classname></entry> - <entry morerows="2">Defines the styles for a table cell</entry> + <entry morerows="2"> + <variablelist> + <varlistentry> + <term><classname>.rich-table-cell</classname></term> + <listitem> + <para> + This class defines the styles for a table cell. + </para> + </listitem> + </varlistentry> + </variablelist> + </entry> <entry><literal>generalSizeFont</literal></entry> <entry><literal>font-size</literal></entry> </row> @@ -38,22 +57,52 @@ </row> <row> - <entry><classname>.rich-table-header</classname></entry> - <entry>Defines the styles for a table header row</entry> + <entry> + <variablelist> + <varlistentry> + <term><classname>.rich-table-header</classname></term> + <listitem> + <para> + This class defines the styles for a table header row. + </para> + </listitem> + </varlistentry> + </variablelist> + </entry> <entry><literal>headerBackgroundColor</literal></entry> <entry><literal>background-color</literal></entry> </row> <row> - <entry><classname>.rich-table-header-continue</classname></entry> - <entry>Defines the styles for all header lines after the first</entry> + <entry> + <variablelist> + <varlistentry> + <term><classname>.rich-table-header-continue</classname></term> + <listitem> + <para> + This class defines the styles for all header lines after the first. + </para> + </listitem> + </varlistentry> + </variablelist> + </entry> <entry><literal>headerBackgroundColor</literal></entry> <entry><literal>background-color</literal></entry> </row> <row> - <entry morerows="4"><classname>.rich-table-headercell</classname></entry> - <entry morerows="4">Defines the styles for a header cell</entry> + <entry morerows="4"> + <variablelist> + <varlistentry> + <term><classname>.rich-table-headercell</classname></term> + <listitem> + <para> + This class defines the styles for a header cell. + </para> + </listitem> + </varlistentry> + </variablelist> + </entry> <entry><literal>tableBorderWidth</literal>, <literal>tableBorderColor</literal></entry> <entry><literal>border-right, border-bottom</literal></entry> </row> @@ -75,22 +124,52 @@ </row> <row> - <entry><classname>.rich-table-subheader</classname></entry> - <entry>Defines the styles for a column header</entry> + <entry> + <variablelist> + <varlistentry> + <term><classname>.rich-table-subheader</classname></term> + <listitem> + <para> + This class defines the styles for a column header. + </para> + </listitem> + </varlistentry> + </variablelist> + </entry> <entry><literal>additionalBackgroundColor</literal></entry> <entry><literal>background-color</literal></entry> </row> <row> - <entry><classname>.rich-table-thead</classname></entry> - <entry>Defines the styles for the separator between the header and the rest of the table</entry> + <entry> + <variablelist> + <varlistentry> + <term><classname>.rich-table-thead</classname></term> + <listitem> + <para> + This class defines the styles for the separator between the header and the rest of the table. + </para> + </listitem> + </varlistentry> + </variablelist> + </entry> <entry><literal>tableBorderWidth</literal>, <literal>tableBorderColor</literal></entry> <entry><literal>border-bottom</literal></entry> </row> <row> - <entry morerows="3"><classname>.rich-table-subheadercell</classname></entry> - <entry morerows="3">Defines the styles for a column header cell</entry> + <entry morerows="3"> + <variablelist> + <varlistentry> + <term><classname>.rich-table-subheadercell</classname></term> + <listitem> + <para> + This class defines the styles for a column header cell. + </para> + </listitem> + </varlistentry> + </variablelist> + </entry> <entry><literal>tableBorderWidth</literal>, <literal>tableBorderColor</literal></entry> <entry><literal>border-right</literal></entry> </row> @@ -108,22 +187,52 @@ </row> <row> - <entry><classname>.rich-table-footer</classname></entry> - <entry>Defines the styles for a footer row</entry> + <entry> + <variablelist> + <varlistentry> + <term><classname>.rich-table-footer</classname></term> + <listitem> + <para> + This class defines the styles for a footer row. + </para> + </listitem> + </varlistentry> + </variablelist> + </entry> <entry><literal>tableFooterBackgroundColor</literal></entry> <entry><literal>background-color</literal></entry> </row> <row> - <entry><classname>.rich-table-footer-continue</classname></entry> - <entry>Defines the styles for all footer lines after the first</entry> + <entry> + <variablelist> + <varlistentry> + <term><classname>.rich-table-footer-continue</classname></term> + <listitem> + <para> + This class defines the styles for all footer lines after the first. + </para> + </listitem> + </varlistentry> + </variablelist> + </entry> <entry><literal>tableFooterBackgroundColor</literal></entry> <entry><literal>background-color</literal></entry> </row> <row> - <entry morerows="4"><classname>.rich-table-footercell</classname></entry> - <entry morerows="4">Defines styles for a footer cell</entry> + <entry morerows="4"> + <variablelist> + <varlistentry> + <term><classname>.rich-table-footercell</classname></term> + <listitem> + <para> + This class defines styles for a footer cell. + </para> + </listitem> + </varlistentry> + </variablelist> + </entry> <entry><literal>tableBorderWidth, tableBorderColor</literal></entry> <entry><literal>border-right, border-bottom</literal></entry> </row> @@ -145,15 +254,35 @@ </row> <row> - <entry><classname>.rich-table-subfooter</classname></entry> - <entry>Defines the styles for a column footer</entry> + <entry> + <variablelist> + <varlistentry> + <term><classname>.rich-table-subfooter</classname></term> + <listitem> + <para> + This class defines the styles for a column footer. + </para> + </listitem> + </varlistentry> + </variablelist> + </entry> <entry><literal>tableSubfooterBackgroundColor</literal></entry> <entry><literal>background-color</literal></entry> </row> <row> - <entry morerows="3"><classname>.rich-table-subfootercell</classname></entry> - <entry morerows="3">Defines the styles for a column footer cell</entry> + <entry morerows="3"> + <variablelist> + <varlistentry> + <term><classname>.rich-table-subfootercell</classname></term> + <listitem> + <para> + This class defines the styles for a column footer cell. + </para> + </listitem> + </varlistentry> + </variablelist> + </entry> <entry><literal>tableBorderWidth</literal>, <literal>tableBorderColor</literal></entry> <entry><literal>border-right</literal>, <literal>border-bottom</literal></entry> </row> @@ -173,31 +302,31 @@ </tgroup> </table> - <table id="tabl-richdataTable-Style_classes_without_skin_parameters"> + <variablelist> <title>Style classes (selectors) without skin parameters</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Class name</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><classname>.rich-table-caption</classname></entry> - <entry>Defines styles for a "caption" facet element</entry> - </row> - - <row> - <entry><classname>.rich-table-row</classname></entry> - <entry>Defines styles for a table row</entry> - </row> - - <row> - <entry><classname>.rich-table-firstrow</classname></entry> - <entry>Defines styles for a table's first row</entry> - </row> - </tbody> - </tgroup> - </table> + <varlistentry> + <term><classname>.rich-table-caption</classname></term> + <listitem> + <para> + This class defines styles for a "caption" facet element. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><classname>.rich-table-row</classname></term> + <listitem> + <para> + This class defines styles for a table row. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><classname>.rich-table-firstrow</classname></term> + <listitem> + <para> + This class defines styles for a table's first row. + </para> + </listitem> + </varlistentry> + </variablelist> </section>