Author: SeanRogers Date: 2010-08-17 00:56:25 -0400 (Tue, 17 Aug 2010) New Revision: 18694 Added: modules/docs/trunk/Component_Reference/Component_Reference_chapters.txt modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumn-Basic_column_example.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumn-Column_spanning_example.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumn-Row_spanning_example.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumnGroup-Complex_headers_using_column_groups.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumns-Basic_columns_example.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumns-Using_richcolumns_and_richcolumn_together.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richdataGrid-ajaxKeys_example.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richinplaceSelect-Defining_list_items_for_richinplaceSelect.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richjQuery-Avoiding_syntax_confusion_0.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richjQuery-Avoiding_syntax_confusion_1.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richjQuery-Calling_a_richjQuery_component_as_a_function.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richjQuery-Using_the_jQuery_JavaScript_framework.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richjQuery-richjQuery_example.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richpanel-Adding_a_header-0.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richpanel-Adding_a_header-1.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richtogglePanel-State_order_example.xml_sample modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richpanel-Adding_a_header.png modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richpanel-richpanel.png modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richpanelBar-richpanelBar.png Modified: 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-Actions.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Containers.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Layout_and_appearance.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-Output_and_messages.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Processing_management.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Resources.xml 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-Tables_and_grids.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Validation.xml Log: Merged working branch for M2 release Copied: modules/docs/trunk/Component_Reference/Component_Reference_chapters.txt (from rev 18693, branches/development/docs/Component_Reference/Component_Reference_chapters.txt) =================================================================== --- modules/docs/trunk/Component_Reference/Component_Reference_chapters.txt (rev 0) +++ modules/docs/trunk/Component_Reference/Component_Reference_chapters.txt 2010-08-17 04:56:25 UTC (rev 18694) @@ -0,0 +1,137 @@ +a4j tag library + +- chap-Component_Reference-Actions +-- a4j:actionParam +x- a4j:ajaxListener +-- a4j:commandButton +-- a4j:commandLink +-- rich:componentControl +xx a4j:hashParam +x- a4j:htmlCommandLink +-- a4j:jsFunction +-- a4j:poll +-- a4j:push +-- a4j:ajax + +- chap-Component_Reference-Resources +x- a4j:loadBundle +x- a4j:loadScript +x- a4j:loadStyle +-- a4j:keepAlive +x- a4j:mediaOutput + +- chap-Component_Reference-Containers +x- a4j:form +-- a4j:include +-- a4j:outputPanel +x- a4j:page +-- a4j:region + +- chap-Component_Reference-Validation +-- rich:ajaxValidator +-- rich:ajaxValidator +-- rich:beanValidator + +- chap-Component_Reference-Processing_management +-- a4j:queue +-- a4j:log +-- a4j:status + + +rich tag library + +- chap-Component_Reference-Rich_inputs +x- rich:calendar +x- rich:colorPicker +x- rich:comboBox +xx rich:editor +x- rich:fileUpload +-- rich:inplaceInput +-- rich:inplaceSelect +-- rich:inputNumberSlider +x- rich:inputNumberSpinner +x- rich:suggestionBox + +- chap-Component_Reference-Panels_and_containers +x- rich:modalPanel +xx rich:panel +xx rich:panelBar +xx rich:panelBarItem +x- rich:simpleTogglePanel +-- rich:tabPanel +x- rich:tab +-- rich:togglePanel +x- rich:toggleControl + +- chap-Component_Reference-Tables_and_grids +-- a4j:repeat +-- rich:column +-- rich:columnGroup +-- rich:columns +x- rich:dataDefinitionList +x- rich:dataFilterSlider +-- rich:dataGrid +x- rich:dataList +x- rich:dataOrderedList +xx rich:dataScroller +-- rich:dataTable +-- rich:extendedDataTable +xx rich:subTable +-x Table filtering +-x Table sorting + +x chap-Component_Reference-Trees +xx rich:changeExpandListener +xx rich:nodeSelectListener +xx rich:recursiveTreeNodesAdapter +xx rich:tree +xx rich:treeNode +xx rich:treeNodesAdapter + +x chap-Component_Reference-Menus_and_toolbars +xx rich:contextMenu +xx rich:dropDownMenu +xx rich:menuGroup +xx rich:menuItem +xx rich:menuSeparator +x- rich:panelMenu +x- rich:panelMenuGroup +x- rich:panelMenuItem +xx rich:toolBar +xx rich:toolBarGroup + +x chap-Component_Reference-Output_and_messages +x- rich:message +x- rich:messages +xx rich:paint2D +xx rich:progressBar +xx rich:toolTip + +x chap-Component_Reference-Drag_and_drop +xx rich:dragIndicator +xx rich:dragSupport +xx rich:dropSupport +xx rich:dragListener +xx rich:dropListener +xx rich:dndParam + +x chap-Component_Reference-Layout_and_appearance +xx rich:effect +xx rich:jQuery +xx rich:separator +xx rich:spacer +xx rich:page +xx rich:layout +xx rich:layoutPanel + +- chap-Component_Reference-Functions +-- rich:clientId +-- rich:component +-- rich:element +-- rich:findComponent +-- rich:isUserInRole + +x chap-Component_Reference-Functionality_extension +xx rich:gmap +xx rich:hotkey +xx rich:virtualEarth 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-08-17 01:41:02 UTC (rev 18693) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/Component_Reference.xml 2010-08-17 04:56:25 UTC (rev 18694) @@ -5,7 +5,8 @@ <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <!-- <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> - --><xi:include href="chap-Component_Reference-Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + --> + <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"> @@ -18,17 +19,17 @@ </part> <part id="part-Component_Reference-rich_tag_library"> <title>rich tag library</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-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-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" /> - --><xi:include href="chap-Component_Reference-Functions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="chap-Component_Reference-Functions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <!-- <xi:include href="chap-Component_Reference-Functionality_extension.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Actions.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Actions.xml 2010-08-17 01:41:02 UTC (rev 18693) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Actions.xml 2010-08-17 04:56:25 UTC (rev 18694) @@ -11,12 +11,12 @@ <itemizedlist> <listitem> <para> - component-type: <classname>org.ajax4jsf.ActionParameter</classname> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.ActionParameter</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.ajax4jsf.component.html.HTMLActionParameter</classname> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HTMLActionParameter</classname> </para> </listitem> </itemizedlist> @@ -81,17 +81,17 @@ <itemizedlist> <listitem> <para> - listener-class: <classname>org.ajax4jsf.event.AjaxListener</classname> + <parameter>listener-class</parameter>: <classname>org.ajax4jsf.event.AjaxListener</classname> </para> </listitem> <listitem> <para> - event-class: <classname>org.ajax4jsf.event.AjaxEvent</classname> + <parameter>event-class</parameter>: <classname>org.ajax4jsf.event.AjaxEvent</classname> </para> </listitem> <listitem> <para> - tag-class: <classname>org.ajax4jsf.taglib.html.jsp.AjaxListenerTag</classname> + <parameter>tag-class</parameter>: <classname>org.ajax4jsf.taglib.html.jsp.AjaxListenerTag</classname> </para> </listitem> </itemizedlist> @@ -112,22 +112,22 @@ <itemizedlist> <listitem> <para> - component-type: <classname>org.ajax4jsf.CommandButton</classname> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.CommandButton</classname> </para> </listitem> <listitem> <para> - component-family: <classname>javax.faces.Command</classname> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlAjaxCommandButton</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.ajax4jsf.component.html.HtmlAjaxCommandButton</classname> + <parameter>component-family</parameter>: <classname>javax.faces.Command</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.ajax4jsf.components.AjaxCommandButtonRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxCommandButtonRenderer</classname> </para> </listitem> </itemizedlist> @@ -163,22 +163,22 @@ <itemizedlist> <listitem> <para> - component-type: <classname>org.ajax4jsf.CommandLink</classname> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.CommandLink</classname> </para> </listitem> <listitem> <para> - component-family: <classname>javax.faces.Command</classname> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlAjaxCommandLink</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.ajax4jsf.component.html.HtmlAjaxCommandLink</classname> + <parameter>component-family</parameter>: <classname>javax.faces.Command</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.ajax4jsf.components.AjaxCommandLinkRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxCommandLinkRenderer</classname> </para> </listitem> </itemizedlist> @@ -209,27 +209,27 @@ <itemizedlist> <listitem> <para> - component-type: <classname>org.richfaces.ComponentControl</classname> + <parameter>component-type</parameter>: <classname>org.richfaces.ComponentControl</classname> </para> </listitem> <listitem> <para> - component-family: <classname>org.richfaces.ComponentControl</classname> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlComponentControl</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.richfaces.component.html.HtmlComponentControl</classname> + <parameter>component-family</parameter>: <classname>org.richfaces.ComponentControl</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.richfaces.ComponentControlRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.richfaces.ComponentControlRenderer</classname> </para> </listitem> <listitem> <para> - tag-class: <classname>org.richfaces.taglib.ComponentControlTag</classname> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.ComponentControlTag</classname> </para> </listitem> </itemizedlist> @@ -340,22 +340,22 @@ <itemizedlist> <listitem> <para> - component-type: <classname>org.ajax4jsf.HtmlCommandLink</classname> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.HtmlCommandLink</classname> </para> </listitem> <listitem> <para> - component-family: <classname>javax.faces.Command</classname> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlCommandLink</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.ajax4jsf.component.html.HtmlCommandLink</classname> + <parameter>component-family</parameter>: <classname>javax.faces.Command</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.ajax4jsf.HtmlCommandLinkRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.HtmlCommandLinkRenderer</classname> </para> </listitem> </itemizedlist> @@ -373,22 +373,22 @@ <itemizedlist> <listitem> <para> - component-type: <classname>org.ajax4jsf.Function</classname> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.Function</classname> </para> </listitem> <listitem> <para> - component-family: <classname>org.ajax4jsf.components.ajaxFunction</classname> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlajaxFunction</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.ajax4jsf.component.html.HtmlajaxFunction</classname> + <parameter>component-family</parameter>: <classname>org.ajax4jsf.components.ajaxFunction</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.ajax4jsf.components.ajaxFunctionRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.ajaxFunctionRenderer</classname> </para> </listitem> </itemizedlist> @@ -418,22 +418,22 @@ <itemizedlist> <listitem> <para> - component-type: <classname>org.ajax4jsf.Poll</classname> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.Poll</classname> </para> </listitem> <listitem> <para> - component-family: <classname>org.ajax4jsf.components.AjaxPoll</classname> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.AjaxPoll</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.ajax4jsf.component.html.AjaxPoll</classname> + <parameter>component-family</parameter>: <classname>org.ajax4jsf.components.AjaxPoll</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.ajax4jsf.components.AjaxPollRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxPollRenderer</classname> </para> </listitem> </itemizedlist> @@ -456,22 +456,22 @@ <itemizedlist> <listitem> <para> - component-type: <classname>org.ajax4jsf.Push</classname> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.Push</classname> </para> </listitem> <listitem> <para> - component-family: <classname>org.ajax4jsf.components.AjaxPush</classname> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.AjaxPush</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.ajax4jsf.component.html.AjaxPush</classname> + <parameter>component-family</parameter>: <classname>org.ajax4jsf.components.AjaxPush</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.ajax4jsf.components.AjaxPushRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxPushRenderer</classname> </para> </listitem> </itemizedlist> @@ -491,22 +491,22 @@ <itemizedlist> <listitem> <para> - component-type: <classname>org.ajax4jsf.Ajax</classname> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.Ajax</classname> </para> </listitem> <listitem> <para> - component-family: <classname>org.ajax4jsf.Ajax</classname> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlAjaxSupport</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.ajax4jsf.component.html.HtmlAjaxSupport</classname> + <parameter>component-family</parameter>: <classname>org.ajax4jsf.Ajax</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.ajax4jsf.components.AjaxSupportRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxSupportRenderer</classname> </para> </listitem> </itemizedlist> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Containers.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Containers.xml 2010-08-17 01:41:02 UTC (rev 18693) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Containers.xml 2010-08-17 04:56:25 UTC (rev 18694) @@ -6,29 +6,30 @@ <para> This chapter details those components in the <classname>a4j</classname> tag library which define an area used as a container or wrapper for other components. </para> - <!-- FIXME NOT IN M2 --> + + <!-- TODO not in M2 --> <!-- <section id="sect-Component_Reference-Containers-a4jform"> <title><sgmltag>&lt;a4j:form&gt;</sgmltag></title> <itemizedlist> <listitem> <para> - component-type: <classname>org.ajax4jsf.Form</classname> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.Form</classname> </para> </listitem> <listitem> <para> - component-family: <classname>javax.faces.Form</classname> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.AjaxForm</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.ajax4jsf.component.html.AjaxForm</classname> + <parameter>component-family</parameter>: <classname>javax.faces.Form</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.ajax4jsf.FormRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.FormRenderer</classname> </para> </listitem> </itemizedlist> @@ -61,22 +62,22 @@ <itemizedlist> <listitem> <para> - component-type: <classname>org.ajax4jsf.Include</classname> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.Include</classname> </para> </listitem> <listitem> <para> - component-family: <classname>javax.faces.Output</classname> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.Include</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.ajax4jsf.component.html.Include</classname> + <parameter>component-family</parameter>: <classname>javax.faces.Output</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.ajax4jsf.components.AjaxIncludeRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxIncludeRenderer</classname> </para> </listitem> </itemizedlist> @@ -117,22 +118,22 @@ <itemizedlist> <listitem> <para> - component-type: <classname>org.ajax4jsf.OutputPanel</classname> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.OutputPanel</classname> </para> </listitem> <listitem> <para> - component-family: <classname>javax.faces.Panel</classname> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlAjaxOutputPanel</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.ajax4jsf.component.html.HtmlAjaxOutputPanel</classname> + <parameter>component-family</parameter>: <classname>javax.faces.Panel</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.ajax4jsf.components.AjaxOutputPanelRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxOutputPanelRenderer</classname> </para> </listitem> </itemizedlist> @@ -164,29 +165,29 @@ </para> </section> - <!-- FIXME not in M2 --> + <!-- TODO not in M2 --> <!-- <section id="sect-Component_Reference-Containers-a4jpage"> <title><sgmltag>&lt;a4j:page&gt;</sgmltag></title> <itemizedlist> <listitem> <para> - component-type: <classname>org.ajax4jsf.components.Page</classname> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.components.Page</classname> </para> </listitem> <listitem> <para> - component-family: <classname>org.ajax4jsf.components.AjaxRegion</classname> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlPage</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.ajax4jsf.component.html.HtmlPage</classname> + <parameter>component-family</parameter>: <classname>org.ajax4jsf.components.AjaxRegion</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.ajax4jsf.components.AjaxPageRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxPageRenderer</classname> </para> </listitem> </itemizedlist> @@ -227,22 +228,22 @@ <itemizedlist> <listitem> <para> - component-type: <classname>org.ajax4jsf.AjaxRegion</classname> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.AjaxRegion</classname> </para> </listitem> <listitem> <para> - component-family: <classname>org.ajax4jsf.AjaxRegion</classname> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlAjaxRegion</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.ajax4jsf.component.html.HtmlAjaxRegion</classname> + <parameter>component-family</parameter>: <classname>org.ajax4jsf.AjaxRegion</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.ajax4jsf.components.AjaxRegionRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxRegionRenderer</classname> </para> </listitem> </itemizedlist> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Layout_and_appearance.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Layout_and_appearance.xml 2010-08-17 01:41:02 UTC (rev 18693) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Layout_and_appearance.xml 2010-08-17 04:56:25 UTC (rev 18694) @@ -3,23 +3,287 @@ ]> <chapter id="chap-Component_Reference-Layout_and_appearance"> <title>Layout and appearance</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 to alter the layout and appearance of web applications using special components. </para> + + <!-- TODO not in M2 --> + <!-- <section id="sect-Component_Reference-Layout_and_appearance-richeffect"> <title><sgmltag>&lt;rich:effect&gt;</sgmltag></title> <para> Incomplete </para> </section> + --> <section id="sect-Component_Reference-Layout_and_appearance-richjQuery"> <title><sgmltag>&lt;rich:jQuery&gt;</sgmltag></title> <para> - Milestone2 + The <sgmltag>&lt;rich:jQuery&gt;</sgmltag> component applies styles and custom behavior to both <acronym>JSF</acronym> (JavaServer Faces) objects and regular <acronym>DOM</acronym> (Document Object Model) objects. It uses the <phrase>jQuery</phrase> JavaScript framework to add functionality without conflicting with the <filename>prototype.js</filename> library. </para> + <section id="sect-Component_Reference-richjQuery-Basic_usage"> + <title>Basic usage</title> + <para> + The query triggered by the <sgmltag>&lt;rich:jQuery&gt;</sgmltag> component is specified using the <varname>query</varname> attribute. + </para> + <para> + The query can be triggered in three different ways. Use the <varname>timing</varname> attribute to specify the point at which the query is triggered: + </para> + <variablelist> + <varlistentry> + <term><literal>immediate</literal></term> + <listitem> + <para> + The query is triggered immediately. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>onload</literal></term> + <listitem> + <para> + The query is triggered when the document is loaded. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>onJScall</literal></term> + <listitem> + <para> + The query is triggered when a JavaScript function is invoked. The JavaScript function is specified using the <varname>name</varname> attribute. + </para> + <para> + If the <varname>name</varname> attribute is included when the <varname>timing</varname> attribute is set to either <literal>immediate</literal> or <literal>onload</literal>, the query can be triggered using the JavaScript function <emphasis>in addition</emphasis> to the specified trigger timing. + </para> + </listitem> + </varlistentry> + </variablelist> + <example id="exam-Component_Reference-richjQuery-richjQuery_example"> + <title><sgmltag>&lt;rich:jQuery&gt;</sgmltag> example</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richjQuery-richjQuery_example.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <para> + In the example, the selector picks out the odd <sgmltag>&lt;tr&gt;</sgmltag> elements that are children of the element with an <code><varname>id</varname>="customlist"</code> attribute. The query <code>addClass(odd)</code> is then performed on the selection during page loading (<literal>onload</literal>) such that the <literal>odd</literal> CSS class is added to the selected elements. + </para> + </example> + <para> + Any objects or lists of objects used in the query are specified using the <varname>selector</varname> attribute. The <varname>selector</varname> attribute references objects using the following method: + </para> + <itemizedlist> + <listitem> + <para> + The <varname>selector</varname> attribute can refer to the <varname>id</varname> attribute of any JSF component or client. + </para> + </listitem> + <listitem> + <para> + If the <varname>selector</varname> attribute does not match the <varname>id</varname> identifier attribute of any JSF components or clients on the page, it instead uses syntax defined by the <orgname>World Wide Web Consortium (<acronym>W3C</acronym>)</orgname> for the <acronym>CSS</acronym> rule selector. <xref linkend="exam-Component_Reference-richjQuery-Example_selector_values" /> shows a list of examples of the selector syntax. Refer to the syntax specification at <ulink url="http://www.w3.org/TR/CSS2/selector.html">http://www.w3.... for full details. + </para> + <example id="exam-Component_Reference-richjQuery-Example_selector_values"> + <title>Example selector values</title> + <variablelist> + <varlistentry> + <term><code>p:has(a)</code></term> + <listitem> + <para> + All <sgmltag>&lt;p&gt;</sgmltag> elements which contain an <sgmltag>&lt;a&gt;</sgmltag> element are selected. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><code>p.foo:has(a)</code></term> + <listitem> + <para> + All <sgmltag>&lt;p&gt;</sgmltag> elements of class <literal>foo</literal> which contain an <sgmltag>&lt;a&gt;</sgmltag> element are selected. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><code>p#secret</code></term> + <listitem> + <para> + All <sgmltag>&lt;p&gt;</sgmltag> elements with an <literal>id</literal> identifier of <literal>secret</literal> are selected. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><code>ul &gt; li</code></term> + <listitem> + <para> + All <sgmltag>&lt;li&gt;</sgmltag> elements that are children of <sgmltag>&lt;ul&gt;</sgmltag> elements are selected. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><code>input[name=bar]</code></term> + <listitem> + <para> + All <sgmltag>&lt;input&gt;</sgmltag> elements with a <varname>name</varname> attribute whose value is <literal>bar</literal> are selected. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><code>input[type=radio][@checked]</code></term> + <listitem> + <para> + All <sgmltag>&lt;input&gt;</sgmltag> elements with both a <code><varname>type</varname>="radio"</code> attribute and a <varname>checked</varname> attribute are selected. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><code>p,span,td</code></term> + <listitem> + <para> + All <sgmltag>&lt;p&gt;</sgmltag> elements, <sgmltag>&lt;span&gt;</sgmltag> elements, and <sgmltag>&lt;td&gt;</sgmltag> elements are selected. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><code>p span</code></term> + <listitem> + <para> + All <sgmltag>&lt;span&gt;</sgmltag> elements that are direct or indirect children of <sgmltag>&lt;p&gt;</sgmltag> elements are selected. Use <code>p &gt; span</code> for direct children only. + </para> + </listitem> + </varlistentry> + <!-- + <varlistentry> + <term><code>p//span</code></term> + <listitem> + <para> + All <sgmltag>&lt;span&gt;</sgmltag> elements that are direct or indirect children of <sgmltag>&lt;p&gt;</sgmltag> elements are selected. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><code>p/../span</code></term> + <listitem> + <para> + All <sgmltag>&lt;span&gt;</sgmltag> elements that are grandchildren of <sgmltag>&lt;p&gt;</sgmltag> elements are selected. + </para> + </listitem> + </varlistentry> + --> + <varlistentry> + <term><code>p[foo^=bar]</code></term> + <listitem> + <para> + All <sgmltag>&lt;p&gt;</sgmltag> elements that contain a <varname>foo</varname> attribute with a textual value <emphasis>beginning</emphasis> with <literal>bar</literal> are selected. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><code>p[foo$=bar]</code></term> + <listitem> + <para> + All <sgmltag>&lt;p&gt;</sgmltag> elements that contain a <varname>foo</varname> attribute with a textual value <emphasis>ending</emphasis> with <literal>bar</literal> are selected. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><code>p[foo*=bar]</code></term> + <listitem> + <para> + All <sgmltag>&lt;p&gt;</sgmltag> elements that contain a <varname>foo</varname> attribute with a textual value that contains the sub-string <literal>bar</literal> in any position are selected. + </para> + </listitem> + </varlistentry> + </variablelist> + </example> + </listitem> + </itemizedlist> + <para> + Because the <varname>selector</varname> attribute can be either an <varname>id</varname> identifier attribute or CSS selector syntax, conflicting values could arise. <xref linkend="exam-Component_Reference-richjQuery-Avoiding_syntax_confusion" /> demonstrates how to use double backslashes to escape colon characters in <varname>id</varname> identifier values. + </para> + <example id="exam-Component_Reference-richjQuery-Avoiding_syntax_confusion"> + <title>Avoiding syntax confusion</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richjQuery-Avoiding_syntax_confusion_0.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <para> + The <varname>id</varname> identifier for the <sgmltag>&lt;h:panelGrid&gt;</sgmltag> element is <literal>form:menu</literal>, which can conflict with CSS selector syntax. Double backslashes can be used to escape the colon character such that the identifier is read correctly instead of being interpreted as CSS selector syntax. + </para> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richjQuery-Avoiding_syntax_confusion_1.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </example> + </section> + + <section id="sect-Component_Reference-richjQuery-Calling_a_richjQuery_as_a_JavaScript_function"> + <title>Calling a <sgmltag>&lt;richjQuery&gt;</sgmltag> as a JavaScript function</title> + <para> + If the <varname>name</varname> attribute is specified, the <sgmltag>&lt;rich:jQuery&gt;</sgmltag> component generates a JavaScript function that can be called by any other JavaScript on the page. + </para> + <para> + Calls to the function must pass a direct reference (<literal>this</literal>) to the calling object as a parameter. If the function requires extra parameters itself, these are provided in JavaScript Object Notation (JSON) syntax as a second parameter in the JavaScript call. The <literal>param</literal> namespace is then used in the <sgmltag>&lt;rich:jQuery&gt;</sgmltag> query to access the passed function parameters. <xref linkend="exam-Component_Reference-richjQuery-Calling_a_richjQuery_component_as_a_function" /> demonstrates the use of the <varname>name</varname> attribute and how to pass function parameters through the JavaScript calls. + </para> + <example id="exam-Component_Reference-richjQuery-Calling_a_richjQuery_component_as_a_function"> + <title>Calling a <sgmltag>&lt;rich:jQuery&gt;</sgmltag> component as a function</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richjQuery-Calling_a_richjQuery_component_as_a_function.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <para> + The example enlarges the images when the mouse moves over them. The <literal>enlargePic</literal> and <literal>releasePic</literal> components are called like ordinary JavaScript functions from the image elements. + </para> + </example> + </section> + + <section id="sect-Component_Reference-richjQuery-Dynamic_rendering"> + <title>Dynamic rendering</title> + <para> + The <sgmltag>&lt;rich:jQuery&gt;</sgmltag> component applies style and behavioral changes to DOM objects dynamically. As such, changes applied during an Ajax response are overwritten, and will need to be re-applied once the Ajax response is complete. + </para> + <para> + Any queries with the <varname>timing</varname> attribute set to <literal>onload</literal> may not update during an Ajax response, as the DOM document is not completely reloaded. To ensure the query is re-applied after an Ajax response, include the <varname>name</varname> attribute in the <sgmltag>&lt;rich:jQuery&gt;</sgmltag> component and invoke it using JavaScript from the <varname>oncomplete</varname> event attribute of the component that triggered the Ajax interaction. + </para> + </section> + + <section id="sect-Component_Reference-richjQuery-Using_the_jQuery_JavaScript_framework"> + <title>Using the jQuery JavaScript framework</title> + <para> + RichFaces includes the jQuery JavaScript framework. The features of the framework can be accessed directly without using a <sgmltag>&lt;rich:jQuery&gt;</sgmltag> component by including the library on the page using the <sgmltag>&lt;a4j:loadScript&gt;</sgmltag> component: + </para> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richjQuery-Using_the_jQuery_JavaScript_framework.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <para> + Refer to the <citetitle>jQuery documentation</citetitle> at <ulink url="http://docs.jquery.com">http://docs.jquery.com</ulink> for full details on jQuery syntax and usage. + </para> + </section> + + <section id="sect-Component_Reference-richjQuery-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.JQuery</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlJQuery</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.JQuery</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.JQueryRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.JQueryTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> + <!-- TODO not in M2 --> + <!-- <section id="sect-Component_Reference-Layout_and_appearance-richseparator"> <title><sgmltag>&lt;rich:separator&gt;</sgmltag></title> <para> @@ -54,6 +318,7 @@ Incomplete </para> </section> + --> </chapter> 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-08-17 01:41:02 UTC (rev 18693) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Menus_and_toolbars.xml 2010-08-17 04:56:25 UTC (rev 18694) @@ -43,6 +43,33 @@ <section id="sect-Component_Reference-Menus_and_toolbars-richpanelMenu"> <title><sgmltag>&lt;rich:panelMenu&gt;</sgmltag></title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.PanelMenu</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlPanelMenu</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.PanelMenu</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.PanelMenuRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.PanelMenuTag</classname> + </para> + </listitem> + </itemizedlist> <para> The <classname>&lt;rich:panelMenu&gt;</classname> component can be used in conjunction with <classname>&lt;rich:panelMenuItem&gt;</classname> and <classname>&lt;rich:panelMenuGroup&gt;</classname> to create an expanding, hierarchical menu. The <classname>&lt;rich:panelMenu&gt;</classname> component's appearance can be highly customized, and the hierarchy can stretch to any number of sub-levels. </para> @@ -111,6 +138,33 @@ <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> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Output_and_messages.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Output_and_messages.xml 2010-08-17 01:41:02 UTC (rev 18693) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Output_and_messages.xml 2010-08-17 04:56:25 UTC (rev 18694) @@ -11,27 +11,27 @@ <itemizedlist> <listitem> <para> - component-type: <classname>org.richfaces.RichMessage</classname> + <parameter>component-type</parameter>: <classname>org.richfaces.RichMessage</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.richfaces.component.html.HtmlRichMessage</classname> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlRichMessage</classname> </para> </listitem> <listitem> <para> - component-family: <classname>org.richfaces.component.RichMessage</classname> + <parameter>component-family</parameter>: <classname>org.richfaces.component.RichMessage</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.richfaces.RichMessageRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.richfaces.RichMessageRenderer</classname> </para> </listitem> <listitem> <para> - tag-class: <classname>org.richfaces.taglib.RichMessageTag</classname> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.RichMessageTag</classname> </para> </listitem> </itemizedlist> @@ -115,27 +115,27 @@ <itemizedlist> <listitem> <para> - component-type: <classname>org.richfaces.component.RichMessages</classname> + <parameter>component-type</parameter>: <classname>org.richfaces.component.RichMessages</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.richfaces.component.html.HtmlRichMessages</classname> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlRichMessages</classname> </para> </listitem> <listitem> <para> - component-family: <classname>org.richfaces.component.RichMessages</classname> + <parameter>component-family</parameter>: <classname>org.richfaces.component.RichMessages</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.richfaces.RichMessagesRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.richfaces.RichMessagesRenderer</classname> </para> </listitem> <listitem> <para> - tag-class: <classname>org.richfaces.taglib.RichMessagesTag</classname> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.RichMessagesTag</classname> </para> </listitem> </itemizedlist> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml 2010-08-17 01:41:02 UTC (rev 18693) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml 2010-08-17 04:56:25 UTC (rev 18694) @@ -3,9 +3,19 @@ ]> <chapter id="chap-Component_Reference-Panels_and_containers"> <title>Panels and containers</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> This chapter details those components which act as panels and containers to hold groups of other components. </para> + + <!-- TODO not in M2 --> + <!-- <section id="sect-Component_Reference-Panels_and_containers-richmodalPanel"> <title><sgmltag>&lt;rich:modalPanel&gt;</sgmltag></title> <para> @@ -36,24 +46,161 @@ </programlisting> </example> </section> + --> <section id="sect-Component_Reference-Panels_and_containers-richpanel"> <title><sgmltag>&lt;rich:panel&gt;</sgmltag></title> <para> The <sgmltag>&lt;rich:panel&gt;</sgmltag> component is a bordered panel with an optional header. </para> - <para> - No attributes need to be listed for basic usage. To add a header to the panel, use the <code>header</code> attribute to specify the text to appear in the header. Alternatively the header can be constructed using a header facet. - </para> + <figure id="figu-Component_Reference-richpanel-richpanel"> + <title><sgmltag>&lt;rich:panel&gt;</sgmltag></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richpanel-richpanel.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A <sgmltag>&lt;rich:Panel&gt;</sgmltag> component displaying details on a camera model. + </para> + </textobject> + </mediaobject> + </figure> + <section id="sect-Component_Reference-richpanel-Basic_usage"> + <title>Basic usage</title> + <para> + No attributes need to be listed for basic usage. a <sgmltag>&lt;rich:panel&gt;</sgmltag> without any attributes defined renders a bordered region with no header. + </para> + </section> + <section id="sect-Component_Reference-richpanel-Adding_a_header"> + <title>Adding a header</title> + <para> + To add a header to the panel, use the <varname>header</varname> attribute to specify the text to appear in the header. Alternatively the header can be constructed using a header facet. <xref linkend="exam-Component_Reference-richpanel-Adding_a_header" /> demonstrates the two different approaches. + </para> + <example id="exam-Component_Reference-richpanel-Adding_a_header"> + <title>Adding a header</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richpanel-Adding_a_header-0.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richpanel-Adding_a_header-1.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </example> + <para> + Both the examples render an identical panel. + </para> + <blockquote> + <figure id="figu-Component_Reference-richpanel-Adding_a_header"> + <title>Adding a header</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richpanel-Adding_a_header.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A panel with a header that reads <phrase>"This is the panel header"</phrase> and content that reads <phrase>"This is the panel content"</phrase>. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> + </section> + + <section id="sect-Component_Reference-richpanel-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.panel</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlPanel</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.panel</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.panelRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.panelTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> <section id="sect-Component_Reference-Panels_and_containers-richpanelBar"> <title><sgmltag>&lt;rich:panelBar&gt;</sgmltag></title> <para> - The <sgmltag>&lt;rich:panelBar&gt;</sgmltag> is a series of panels stacked on top of each other, each collapsed such that only the header of the panel is showing. When the header of a panel is clicked, it is expanded to show the content of the panel. Clicking on a different header will collapse the previous panel and epand the selected one. Another name for the component is "accordion". Each panel in contained in a <sgmltag>&lt;rich:panelBar&gt;</sgmltag> component is a <sgmltag>&lt;rich:panelBarItem&gt;</sgmltag> component. + The <sgmltag>&lt;rich:panelBar&gt;</sgmltag> is a series of panels stacked on top of each other, each collapsed such that only the header of the panel is showing. When the header of a panel is clicked, it is expanded to show the content of the panel. Clicking on a different header will collapse the previous panel and epand the selected one. Similar controls are sometimes known as "accordion" controls. Each panel contained in a <sgmltag>&lt;rich:panelBar&gt;</sgmltag> component is a <sgmltag>&lt;rich:panelBarItem&gt;</sgmltag> component. </para> + <figure id="figu-Component_Reference-richpanelBar-richpanelBar"> + <title><sgmltag>&lt;rich:panelBar&gt;</sgmltag></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richpanelBar-richpanelBar.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A <sgmltag>&lt;rich:panelBar&gt;</sgmltag> component displaying details on different cameras. Only the first panel is expanded. + </para> + </textobject> + </mediaobject> + </figure> + + <section id="sect-Component_Reference-richpanelBar-Basic_usage"> + <title>Basic usage</title> + <para> + The <sgmltag>&lt;rich:panelBar&gt;</sgmltag> component requires no attributes for basic usage. The component can contain any number of <sgmltag>&lt;rich:panelBarItem&gt;</sgmltag> components as children. The headers of the <sgmltag>&lt;rich:panelBarItem&gt;</sgmltag> components control the expanding and collapsing when clicked. Only a single <sgmltag>&lt;rich:panelBarItem&gt;</sgmltag> can be displayed at a time. + </para> + </section> + + <section id="sect-Component_Reference-richpanelBar-Controlling_panel_size"> + <title>Controlling panel size</title> + <para> + Unlike the <sgmltag>&lt;rich:panel&gt;</sgmltag> component, the size of the <sgmltag>&lt;rich:panelBar&gt;</sgmltag> can be specified using <varname>width</varname> and <varname>height</varname> attributes. If unspecified, these values default to 100%. + </para> + </section> + + <section id="sect-Component_Reference-richpanelBar-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.panelBar</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlPanelBar</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.panelBar</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.panelBarRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.panelBarTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> + <!-- TODO not in M2 --> + <!-- <section id="sect-Component_Reference-Panels_and_containers-richpanelBarItem"> <title><sgmltag>&lt;rich:panelBarItem&gt;</sgmltag></title> <para> @@ -96,46 +243,10 @@ The <code>openMarker</code> and <code>closeMarker</code> attributes can be used to define custom icons for the expanding header. </para> </section> + --> - <section id="sect-Component_Reference-Panels_and_containers-richtabPanel"> - <title><sgmltag>&lt;rich:tabPanel&gt;</sgmltag></title> - <para> - The <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component provides a set of tabbed panels for displaying one panel of content at a time. The tabs can be highly customized and themed. - </para> - <note> - <title>Form elements required</title> - <para> - All <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> components should be wrapped in a form element so that content is correctly submitted. - </para> - </note> - <para> - The switching mode for performing submissions is determined by the <code>switchType</code> attribute, which can have one of the following three values: - </para> - <itemizedlist> - <listitem> - <para> - <literal>server</literal>, the default setting, which causes the <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component to perform a common submission, completely re-rendering the page. Only one panel at a time is uploaded to the client side. - </para> - </listitem> - <listitem> - <para> - <literal>ajax</literal>, which causes the <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component to perform an Ajax form submission, and the content of the panel is rendered. Only one panel at a time is uploaded to the client side. - </para> - </listitem> - <listitem> - <para> - <literal>client</literal>, which causes <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> components to update on the client side, re-rendering themselves and any additional components listed with the <code>render</code> attribute. - </para> - </listitem> - </itemizedlist> - <para> - The <code>selectedTab</code> attribute holds the active tab name. - </para> - <para> - The tabs themselves can be aligned using the <code>headerAlignment</code> attribute. The attribute can be set to <code>left</code>, <code>center</code>, or <code>right</code>, aligning the header tabs to the left, center, or right of the top edge of the panel respectively. If no alignment is specified, left-alignment is the default behavior. - </para> - </section> - + <!-- TODO not in M2 --> + <!-- <section id="sect-Component_Reference-Panels_and_containers-richtab"> <title><sgmltag>&lt;rich:tab&gt;</sgmltag></title> <para> @@ -154,38 +265,139 @@ There are two event handlers that are unique to the <sgmltag>&lt;rich:tab&gt;</sgmltag> component. The <code>ontabenter</code> attribute points to the function to perform when the mouse enters the tab, while the <code>ontableave</code> attribute points to the function to perform when the mouse leaves the tab. </para> </section> + --> + <section id="sect-Component_Reference-Panels_and_containers-richtabPanel"> + <title><sgmltag>&lt;rich:tabPanel&gt;</sgmltag></title> + <para> + The <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component provides a set of tabbed panels for displaying one panel of content at a time. The tabs can be highly customized and themed. + </para> + <note> + <title>Form elements required</title> + <para> + All <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> components should be wrapped in a form element so that content is correctly submitted. + </para> + </note> + <section id="sect-Component_Reference-richtabPanel-Basic_usage"> + <title>Basic usage</title> + <para> + The switching mode for performing submissions is determined by the <code>switchType</code> attribute, which can have one of the following three values: + </para> + <itemizedlist> + <listitem> + <para> + <literal>server</literal>, the default setting, which causes the <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component to perform a common submission, completely re-rendering the page. Only one panel at a time is uploaded to the client side. + </para> + </listitem> + <listitem> + <para> + <literal>ajax</literal>, which causes the <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> component to perform an Ajax form submission, and the content of the panel is rendered. Only one panel at a time is uploaded to the client side. + </para> + </listitem> + <listitem> + <para> + <literal>client</literal>, which causes <sgmltag>&lt;rich:tabPanel&gt;</sgmltag> components to update on the client side, re-rendering themselves and any additional components listed with the <code>render</code> attribute. + </para> + </listitem> + </itemizedlist> + <para> + The <code>selectedTab</code> attribute holds the active tab name. + </para> + </section> + + <section id="sect-Component_Reference-richtabPanel-Tab_alignment"> + <title>Tab alignment</title> + <para> + The tabs themselves can be aligned using the <code>headerAlignment</code> attribute. The attribute can be set to <code>left</code>, <code>center</code>, or <code>right</code>, aligning the header tabs to the left, center, or right of the top edge of the panel respectively. If no alignment is specified, left-alignment is the default behavior. + </para> + </section> + + <section id="sect-Component_Reference-richtabPanel-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.tabPanel</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmltabPanel</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.tabPanel</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.tabPanelRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.tabPanelTag</classname> + </para> + </listitem> + </itemizedlist> + </section> + </section> + <section id="sect-Component_Reference-Panels_and_containers-richtogglePanel"> <title><sgmltag>&lt;rich:togglePanel&gt;</sgmltag></title> <para> The <sgmltag>&lt;rich:togglePanel&gt;</sgmltag> component is a wrapper component with named facets. Each facet is displayed after activating a corresponding <sgmltag>&lt;rich:toggleControl&gt;</sgmltag> component. </para> - <para> - The initial state of the component can be configured using the <code>initialState</code> attribute, which points to a facet name to display. Alternatively, setting <code>initialState="empty"</code>, the initial state will be blank until the user selects an option. - </para> - <para> - The order in which the facets are shown can be defined using the <code>statusOrder</code> attribute, listing the facet names separated by commas, as shown in <xref linkend="exam-Component_Reference-richtogglePanel-State_order_example" />. - </para> - <example id="exam-Component_Reference-richtogglePanel-State_order_example"> - <title>State order example</title> - -<programlisting language="XML" role="XML"> -&lt;rich:togglePanel id="panel" initialState="panelB" switchType="client" stateOrder="panelA,panelB,panelC"&gt; - &lt;f:facet name="panelA"&gt; - ... - &lt;/f:facet&gt; - &lt;f:facet name="panelB"&gt; - ... - &lt;/f:facet&gt; - &lt;f:facet name="panelC"&gt; - ... - &lt;/f:facet&gt; -&lt;/rich:togglePanel&gt; -&lt;rich:toggleControl for="panel" value="Switch"/&gt; -</programlisting> - </example> + + <section id="sect-Component_Reference-richtogglePanel-Basic_usage"> + <title>Basic usage</title> + <para> + The initial state of the component can be configured using the <code>initialState</code> attribute, which points to a facet name to display. Alternatively, setting <code>initialState="empty"</code>, the initial state will be blank until the user selects an option. + </para> + <para> + The order in which the facets are shown can be defined using the <code>statusOrder</code> attribute, listing the facet names separated by commas, as shown in <xref linkend="exam-Component_Reference-richtogglePanel-State_order_example" />. + </para> + <example id="exam-Component_Reference-richtogglePanel-State_order_example"> + <title>State order example</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richtogglePanel-State_order_example.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </example> + </section> + + <section id="sect-Component_Reference-richtogglePanel-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.TogglePanel</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlTogglePanel</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.TogglePanel</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.TogglePanelRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.TogglePanelTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> + <!-- TODO not in M2 --> + <!-- <section id="sect-Component_Reference-Panels_and_containers-richtoggleControl"> <title><sgmltag>&lt;rich:toggleControl&gt;</sgmltag></title> <para> @@ -206,14 +418,14 @@ &lt;h:panelGroup&gt; &lt;rich:toggleControl for="helloForm:panel" value="Empty" switchToState="empty"/&gt; &lt;rich:toggleControl for="helloForm:panel" value=" Second" switchToState="second"/&gt; - &lt;!--Some content--&gt; + &lt;!-Some content-&gt; &lt;/h:panelGroup&gt; &lt;/f:facet&gt; &lt;f:facet name="second"&gt; &lt;h:panelGroup&gt; &lt;rich:toggleControl for="helloForm:panel" value="Empty" switchToState="empty"/&gt; &lt;rich:toggleControl for="helloForm:panel" value=" first" switchToState="first"/&gt; - &lt;!--Some content--&gt; + &lt;!-Some content-&gt; &lt;/h:panelGroup&gt; &lt;/f:facet&gt; &lt;f:facet name="empty"&gt; @@ -226,6 +438,7 @@ </programlisting> </example> </section> + --> </chapter> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Processing_management.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Processing_management.xml 2010-08-17 01:41:02 UTC (rev 18693) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Processing_management.xml 2010-08-17 04:56:25 UTC (rev 18694) @@ -11,22 +11,22 @@ <itemizedlist> <listitem> <para> - component-family: <classname>org.ajax4jsf.Queue</classname> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.QueueRenderer</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.ajax4jsf.component.html.HtmlQueue</classname> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlQueue</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.ajax4jsf.QueueRenderer</classname> + <parameter>component-family</parameter>: <classname>org.ajax4jsf.Queue</classname> </para> </listitem> <listitem> <para> - tag-class: <classname>org.ajax4jsf.taglib.html.jsp.QueueTag</classname> + <parameter>tag-class</parameter>: <classname>org.ajax4jsf.taglib.html.jsp.QueueTag</classname> </para> </listitem> </itemizedlist> @@ -100,22 +100,22 @@ <itemizedlist> <listitem> <para> - component-type: <classname>org.ajax4jsf.Log</classname> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.Log</classname> </para> </listitem> <listitem> <para> - component-family: <classname>org.ajax4jsf.Log</classname> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.AjaxLog</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.ajax4jsf.component.html.AjaxLog</classname> + <parameter>component-family</parameter>: <classname>org.ajax4jsf.Log</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.ajax4jsf.LogRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.LogRenderer</classname> </para> </listitem> </itemizedlist> @@ -175,22 +175,22 @@ <itemizedlist> <listitem> <para> - component-type: <classname>org.ajax4jsf.Status</classname> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.Status</classname> </para> </listitem> <listitem> <para> - component-family: <classname>javax.faces.Panel</classname> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlAjaxStatus</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.ajax4jsf.component.html.HtmlAjaxStatus</classname> + <parameter>component-family</parameter>: <classname>javax.faces.Panel</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.ajax4jsf.components.AjaxStatusRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxStatusRenderer</classname> </para> </listitem> </itemizedlist> Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Resources.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Resources.xml 2010-08-17 01:41:02 UTC (rev 18693) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Resources.xml 2010-08-17 04:56:25 UTC (rev 18694) @@ -7,24 +7,24 @@ This chapter covers those components used to handle and manage resources and beans. </para> - <!-- FIXME not in M2 --> + <!-- TODO not in M2 --> <!-- <section id="sect-Component_Reference-Resources-a4jloadBundle"> <title><sgmltag>&lt;a4j:loadBundle&gt;</sgmltag></title> <itemizedlist> <listitem> <para> - component-type: <classname>org.ajax4jsf.Bundle</classname> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.Bundle</classname> </para> </listitem> <listitem> <para> - component-family: <classname>org.ajax4jsf.Bundle</classname> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.AjaxLoadBundle</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.ajax4jsf.component.html.AjaxLoadBundle</classname> + <parameter>component-family</parameter>: <classname>org.ajax4jsf.Bundle</classname> </para> </listitem> </itemizedlist> @@ -106,28 +106,31 @@ </para> </example> </section> + --> + <!-- TODO not in M2 --> + <!-- <section id="sect-Component_Reference-Resources-a4jloadScript"> <title><sgmltag>&lt;a4j:loadScript&gt;</sgmltag></title> <itemizedlist> <listitem> <para> - component-type: <classname>org.ajax4jsf.LoadScript</classname> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.LoadScript</classname> </para> </listitem> <listitem> <para> - component-family: <classname>org.ajax4jsf.LoadScript</classname> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlLoadScript</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.ajax4jsf.component.html.HtmlLoadScript</classname> + <parameter>component-family</parameter>: <classname>org.ajax4jsf.LoadScript</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.ajax4jsf.LoadScriptRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.LoadScriptRenderer</classname> </para> </listitem> </itemizedlist> @@ -145,28 +148,31 @@ </programlisting> </example> </section> + --> + <!-- TODO not in M2 --> + <!-- <section id="sect-Component_Reference-Resources-a4jloadStyle"> <title><sgmltag>&lt;a4j:loadStyle&gt;</sgmltag></title> <itemizedlist> <listitem> <para> - component-type: <classname>org.ajax4jsf.LoadStyle</classname> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.LoadStyle</classname> </para> </listitem> <listitem> <para> - component-family: <classname>org.ajax4jsf.LoadStyle</classname> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlLoadStyle</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.ajax4jsf.component.html.HtmlLoadStyle</classname> + <parameter>component-family</parameter>: <classname>org.ajax4jsf.LoadStyle</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.ajax4jsf.LoadStyleRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.LoadStyleRenderer</classname> </para> </listitem> </itemizedlist> @@ -191,17 +197,17 @@ <itemizedlist> <listitem> <para> - component-type: <classname>org.ajax4jsf.components.KeepAlive</classname> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.components.KeepAlive</classname> </para> </listitem> <listitem> <para> - component-family: <classname>org.ajax4jsf.components.AjaxKeepAlive</classname> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.components.AjaxKeepAlive</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.ajax4jsf.components.AjaxKeepAlive</classname> + <parameter>component-family</parameter>: <classname>org.ajax4jsf.components.AjaxKeepAlive</classname> </para> </listitem> </itemizedlist> @@ -223,27 +229,29 @@ </example> </section> + <!-- TODO not in M2 --> + <!-- <section id="sect-Component_Reference-Resources-a4jmediaOutput"> <title><sgmltag>&lt;a4j:mediaOutput&gt;</sgmltag></title> <itemizedlist> <listitem> <para> - component-type: <classname>org.ajax4jsf.Push</classname> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.Push</classname> </para> </listitem> <listitem> <para> - component-family: <classname>org.ajax4jsf.components.AjaxPush</classname> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.AjaxPush</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.ajax4jsf.component.html.AjaxPush</classname> + <parameter>component-family</parameter>: <classname>org.ajax4jsf.components.AjaxPush</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.ajax4jsf.components.AjaxPushRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.AjaxPushRenderer</classname> </para> </listitem> </itemizedlist> @@ -337,6 +345,7 @@ </para> </note> </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-08-17 01:41:02 UTC (rev 18693) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml 2010-08-17 04:56:25 UTC (rev 18694) @@ -3,11 +3,24 @@ ]> <chapter id="chap-Component_Reference-Rich_inputs"> <title>Rich inputs</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> + This chapter details those components which act as panels and containers to hold groups of other components. + </para> + + <!-- TODO not in M2 --> + <!-- + <para> This chapter details rich components for user input and interaction. </para> - <section id="sect-Component_Reference-Rich_inputs-richCalendar"> - <title><sgmltag>&lt;rich:Calendar&gt;</sgmltag></title> + <section id="sect-Component_Reference-Rich_inputs-richcalendar"> + <title><sgmltag>&lt;rich:calendar&gt;</sgmltag></title> <para> The <sgmltag>&lt;rich:calendar&gt;</sgmltag> component allows the user to enter a date and time through an in-line or pop-up calendar. The pop-up calendar can navigate through months and years, and its look and feel can be highly customized. </para> @@ -82,7 +95,10 @@ The entire calendar can be set as read-only with <code>readonly="true"</code>. This allows months and years to be browsed through with the arrow controls, but dates and times cannot be selected. </para> </section> + --> + <!-- TODO not in M2 --> + <!-- <section id="sect-Component_Reference-Rich_inputs-richcolorPicker"> <title><sgmltag>&lt;rich:colorPicker&gt;</sgmltag></title> <para> @@ -158,7 +174,10 @@ </listitem> </itemizedlist> </section> + --> + <!-- TODO not in M2 --> + <!-- <section id="sect-Component_Reference-Rich_inputs-richeditor"> <title><sgmltag>&lt;rich:editor&gt;</sgmltag></title> <para> @@ -247,106 +266,185 @@ </listitem> </itemizedlist> </section> + --> <section id="sect-Component_Reference-Rich_inputs-richinplaceInput"> <title><sgmltag>&lt;rich:inplaceInput&gt;</sgmltag></title> <para> The <sgmltag>&lt;rich:inplaceInput&gt;</sgmltag> component allows information to be entered in-line in blocks of text, improving readability of the text. Changes can be rendered either in-line or for the whole block, and inputs can be focused with keyboard navigation. The component has three functional states: the "view" state, where the component displays its initial setting, such as "click to edit"; the "edit" state, where the user can input text; and the "changed" state, where the new value for the component has been confirmed but can be edited again if required. </para> - <para> - When in the initial "view" state, the starting label can be set using the <varname>defaultLabel</varname> attribute, such as <code>defaultLabel="click to edit"</code>. - </para> - <para> - Basic usage requires the <varname>value</varname> attribute to point to the expression for the current value of the component. - </para> - <para> - By default, the event to switch the component to the "edit" state is a single mouse click. This can be changed using the <varname>editEvent</varname> attribute to specify a different event. When switching to "edit" mode, the existing text can be automatically highlighted to make editing easier by setting <code>selectOnEdit="true"</code>. - </para> - <para> - The user can confirm and save their input by pressing the <keycap>Enter</keycap> key or cancel by pressing the <keycap>Esc</keycap> key. Alternatively, buttons for confirming or canceling can be added to the component by setting <code>showControls="true"</code>. These buttons can be positioned using the <varname>controlsHorizontalPosition</varname> attribute with settings of <literal>left</literal>, <literal>right</literal>, or <literal>center</literal>, and the <varname>controlsVerticalPosition</varname> attribute with settings <literal>bottom</literal>, <literal>center</literal>, or <literal>top</literal>. The confirmation control icons can be altered using the <varname>saveControlIcon</varname> and <varname>cancelControlIcon</varname>. Further customization is possible through the use of facets. - </para> - <para> - There are several event handlers that are specific to the <sgmltag>&lt;rich:inplaceInput&gt;</sgmltag> component: - </para> - <itemizedlist> - <listitem> - <para> - <varname>oneditactivation</varname> is triggered before the "edit" state is activated. - </para> - </listitem> - <listitem> - <para> - <varname>oneditactivated</varname> is triggered after the "edit" state is activated. - </para> - </listitem> - <listitem> - <para> - <varname>onviewactivation</varname> is triggered before the "view" or "changed" state is activated. - </para> - </listitem> - <listitem> - <para> - <varname>onviewactivated</varname> is triggered after the "view" or "changed" state is activated. - </para> - </listitem> - </itemizedlist> + + <section id="sect-Component_Reference-richinplaceInput-Basic_usage"> + <title>Basic usage</title> + <para> + Basic usage requires the <varname>value</varname> attribute to point to the expression for the current value of the component. + </para> + </section> + + <section id="sect-Component_Reference-richinplaceInput-Interactivity_options"> + <title>Interactivity options</title> + <para> + When in the initial "view" state, the starting label can be set using the <varname>defaultLabel</varname> attribute, such as <code><varname>defaultLabel</varname>="click to edit"</code>. + </para> + + <para> + By default, the event to switch the component to the "edit" state is a single mouse click. This can be changed using the <varname>editEvent</varname> attribute to specify a different event. When switching to "edit" mode, the existing text can be automatically highlighted to make editing easier by setting <code><varname>selectOnEdit</varname>="true"</code>. + </para> + <para> + The user can confirm and save their input by pressing the <keycap>Enter</keycap> key or cancel by pressing the <keycap>Esc</keycap> key. Alternatively, buttons for confirming or canceling can be added to the component by setting <code>showControls="true"</code>. These buttons can be positioned using the <varname>controlsHorizontalPosition</varname> attribute with settings of <literal>left</literal>, <literal>right</literal>, or <literal>center</literal>, and the <varname>controlsVerticalPosition</varname> attribute with settings <literal>bottom</literal>, <literal>center</literal>, or <literal>top</literal>. The confirmation control icons can be altered using the <varname>saveControlIcon</varname> and <varname>cancelControlIcon</varname>. Further customization is possible through the use of facets. + </para> + </section> + + <section id="sect-Component_Reference-richinplaceInput-richinplaceInput_events"> + <title><sgmltag>&lt;rich:inplaceInput&gt;</sgmltag> events</title> + <para> + There are several event handlers that are specific to the <sgmltag>&lt;rich:inplaceInput&gt;</sgmltag> component: + </para> + <itemizedlist> + <listitem> + <para> + <varname>oneditactivation</varname> is triggered before the "edit" state is activated. + </para> + </listitem> + <listitem> + <para> + <varname>oneditactivated</varname> is triggered after the "edit" state is activated. + </para> + </listitem> + <listitem> + <para> + <varname>onviewactivation</varname> is triggered before the "view" or "changed" state is activated. + </para> + </listitem> + <listitem> + <para> + <varname>onviewactivated</varname> is triggered after the "view" or "changed" state is activated. + </para> + </listitem> + </itemizedlist> + </section> + + <section id="sect-Component_Reference-richinplaceInput-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.inplaceInput</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlInplaceInput</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.inplaceInput</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.renderkit.inplaceInputRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.inplaceInputTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> <section id="sect-Component_Reference-Rich_inputs-richinplaceSelect"> <title><sgmltag>&lt;rich:inplaceSelect&gt;</sgmltag></title> <para> - The <sgmltag>&lt;rich:inplaceSelect&gt;</sgmltag> component is similar to the <sgmltag>&lt;rich:inplaceInput&gt;</sgmltag> component, but the uses a drop-down selection box to enter text instead of a regular text field. Changes can be rendered either in-line or for the whole block, and inputs can be focused with keyboard navigation. The component has three functional states: the "view" state, where the component displays its initial setting, such as "click to edit"; the "edit" state, where the user can select a value from a drop-down list; and the "changed" state, where the new value for the component has been confirmed but can be edited again if required. + The <sgmltag>&lt;rich:inplaceSelect&gt;</sgmltag> component is similar to the <sgmltag>&lt;rich:inplaceInput&gt;</sgmltag> component, except that the <sgmltag>&lt;rich:inplaceSelect&gt;</sgmltag> component uses a drop-down selection box to enter text instead of a regular text field. Changes can be rendered either in-line or for the whole block, and inputs can be focused with keyboard navigation. The component has three functional states: the "view" state, where the component displays its initial setting, such as "click to edit"; the "edit" state, where the user can select a value from a drop-down list; and the "changed" state, where the new value for the component has been confirmed but can be edited again if required. </para> - <para> - When in the initial "view" state, the starting label can be set using the <varname>defaultLabel</varname> attribute, such as <code>defaultLabel="click to edit"</code>. - </para> - <para> - Basic usage requires the <varname>value</varname> attribute to point to the expression for the current value of the component and a list of items. The list of items can be defined using the JSF components <sgmltag>&lt;f:selectItem/&gt;</sgmltag> and <sgmltag>&lt;f:selectItems/&gt;</sgmltag>. - </para> - <example id="exam-Component_Reference-richinplaceSelect-Defining_list_items_for_richinplaceSelect"> - <title>Defining list items for <sgmltag>&lt;rich:inplaceSelect&gt;</sgmltag></title> - -<programlisting language="XML" role="XML"> -&lt;rich:inplaceSelect value="#{bean.inputValue}" defaultLabel="click to edit" &gt; - &lt;f:selectItems value="#{bean.selectItems}" /&gt; - &lt;f.selectItem itemValue="1" itemLabel="Item 1" /&gt; - &lt;f.selectItem itemValue="2" itemLabel="Item 2" /&gt; - &lt;f.selectItem itemValue="3" itemLabel="Item 3" /&gt; - &lt;f.selectItem itemValue="4" itemLabel="Item 4" /&gt; -&lt;/rich:comboBox&gt; -</programlisting> - </example> - <para> - By default, the event to switch the component to the "edit" state is a single mouse click. This can be changed using the <varname>editEvent</varname> attribute to specify a different event. When switching to "edit" mode, the drop-down list of possible values will automatically be displayed; this can be deactivated by setting <code>openOnEdit="false"</code>. - </para> - <para> - Once the user selects an option from the drop-down list, the item becomes the new value for the component and the state is switched to the "changed" state. Alternatively, buttons for confirming or canceling can be added to the component by setting <code>showControls="true"</code>. These buttons can be positioned using the <varname>controlsHorizontalPosition</varname> attribute with settings of <literal>left</literal>, <literal>right</literal>, or <literal>center</literal>, and the <varname>controlsVerticalPosition</varname> attribute with settings <literal>bottom</literal>, <literal>center</literal>, or <literal>top</literal>. The confirmation control icons can be altered using the <varname>saveControlIcon</varname> and <varname>cancelControlIcon</varname>. Further customization is possible through the use of facets. - </para> - <para> - There are several event handlers that are specific to the <sgmltag>&lt;rich:inplaceSelect&gt;</sgmltag> component: - </para> - <itemizedlist> - <listitem> - <para> - <varname>oneditactivation</varname> is triggered before the "edit" state is activated. - </para> - </listitem> - <listitem> - <para> - <varname>oneditactivated</varname> is triggered after the "edit" state is activated. - </para> - </listitem> - <listitem> - <para> - <varname>onviewactivation</varname> is triggered before the "view" or "changed" state is activated. - </para> - </listitem> - <listitem> - <para> - <varname>onviewactivated</varname> is triggered after the "view" or "changed" state is activated. - </para> - </listitem> - </itemizedlist> + + <section id="sect-Component_Reference-richinplaceSelect-Basic_usage"> + <title>Basic usage</title> + <para> + Basic usage requires the <varname>value</varname> attribute to point to the expression for the current value of the component and a list of items. The list of items can be defined using the JSF components <sgmltag>&lt;f:selectItem/&gt;</sgmltag> and <sgmltag>&lt;f:selectItems/&gt;</sgmltag>. + </para> + <example id="exam-Component_Reference-richinplaceSelect-Defining_list_items_for_richinplaceSelect"> + <title>Defining list items for <sgmltag>&lt;rich:inplaceSelect&gt;</sgmltag></title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richinplaceSelect-Defining_list_items_for_richinplaceSelect.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </example> + </section> + + <section id="sect-Component_Reference-richinplaceSelect-Interactivity_options"> + <title>Interactivity options</title> + <para> + When in the initial "view" state, the starting label can be set using the <varname>defaultLabel</varname> attribute, such as <code>defaultLabel="click to edit"</code>. + </para> + <para> + By default, the event to switch the component to the "edit" state is a single mouse click. This can be changed using the <varname>editEvent</varname> attribute to specify a different event. When switching to "edit" mode, the drop-down list of possible values will automatically be displayed; this can be deactivated by setting <code><varname>openOnEdit</varname>="false"</code>. + </para> + <para> + Once the user selects an option from the drop-down list, the item becomes the new value for the component and the state is switched to the "changed" state. Alternatively, buttons for confirming or canceling can be added to the component by setting <code>showControls="true"</code>. These buttons can be positioned using the <varname>controlsHorizontalPosition</varname> attribute with settings of <literal>left</literal>, <literal>right</literal>, or <literal>center</literal>, and the <varname>controlsVerticalPosition</varname> attribute with settings <literal>bottom</literal>, <literal>center</literal>, or <literal>top</literal>. The confirmation control icons can be altered using the <varname>saveControlIcon</varname> and <varname>cancelControlIcon</varname>. Further customization is possible through the use of facets. + </para> + </section> + + <section id="sect-Component_Reference-richinplaceInput-richinplaceSelect_events"> + <title><sgmltag>&lt;rich:inplaceSelect&gt;</sgmltag> events</title> + <para> + There are several event handlers that are specific to the <sgmltag>&lt;rich:inplaceSelect&gt;</sgmltag> component: + </para> + <itemizedlist> + <listitem> + <para> + <varname>oneditactivation</varname> is triggered before the "edit" state is activated. + </para> + </listitem> + <listitem> + <para> + <varname>oneditactivated</varname> is triggered after the "edit" state is activated. + </para> + </listitem> + <listitem> + <para> + <varname>onviewactivation</varname> is triggered before the "view" or "changed" state is activated. + </para> + </listitem> + <listitem> + <para> + <varname>onviewactivated</varname> is triggered after the "view" or "changed" state is activated. + </para> + </listitem> + </itemizedlist> + </section> + + <section id="sect-Component_Reference-richinplaceSelect-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.inplaceSelect</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlInplaceSelect</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.inplaceSelect</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.renderkit.inplaceSelectRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.inplaceSelectTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> <section id="sect-Component_Reference-Rich_inputs-richinputNumberSlider"> @@ -354,14 +452,63 @@ <para> The <sgmltag>&lt;rich:inputNumberSlider&gt;</sgmltag> component provides a slider for changing numerical values. Optional features include a tool-tip to display the value while sliding, and a text field for typing the numerical value which can then be validated against the slider's range. </para> - <para> - Basic use of the component with no attributes specified will render a slider with a minimum value of 0, a maximum of 100, and a gradient step of 1, together with a text field for typing the desired numerical value. The text field can be removed by setting <code>showInput="false"</code>, and the properties of the slider can be set with the attributes <varname>minValue</varname>, <varname>maxValue</varname>, and <varname>step</varname>. The slider is labeled with the minimum and maximum boundary values, and a tool-tip showing the current value is shown while sliding the slider; these items can be turned off by setting <code>showBoundaryValues="false"</code> and <code>showToolTip="false"</code> respectively. - </para> - <para> - Arrow controls can be added to either side of the slider to adjust the value incrementally by setting <code>showArrows="true"</code>. Clicking the arrows move the slider indicator in that direction by the gradient step, and clicking and holding the arrows moves the indicator continuously. The time delay for each step when updating continuously can be defined using the <varname>delay</varname> attribute. - </para> + <section id="sect-Component_Reference-richinputNumberSlider-Basic_usage"> + <title>Basic usage</title> + <para> + Basic use of the component with no attributes specified will render a slider with a minimum value of 0, a maximum of 100, and a gradient step of 1, together with a text field for typing the desired numerical value. The slider is labeled with the minimum and maximum boundary values, and a tool-tip showing the current value is shown while sliding the slider. + </para> + </section> + + <section id="sect-Component_Reference-richinputNumberSlider-Interactivity_options"> + <title>Interactivity options</title> + <para> + The text field can be removed by setting <code>showInput="false"</code>. + </para> + <para> + The properties of the slider can be set with the attributes <varname>minValue</varname>, <varname>maxValue</varname>, and <varname>step</varname>. + </para> + <para> + The minimum and maximum labels on the slider can be hidden by setting <code><varname>showBoundaryValues</varname>="false"</code>. The tool-tip showing the current value can be hidden by setting <code><varname>showToolTip</varname>="false"</code>. + </para> + <para> + Arrow controls can be added to either side of the slider to adjust the value incrementally by setting <code>showArrows="true"</code>. Clicking the arrows move the slider indicator in that direction by the gradient step, and clicking and holding the arrows moves the indicator continuously. The time delay for each step when updating continuously can be defined using the <varname>delay</varname> attribute. + </para> + </section> + + <section id="sect-Component_Reference-richinputNumberSlider-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.inputNumberSlider</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlInputNumberSlider</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.inputNumberSlider</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.renderkit.inputNumberSliderRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.inputNumberSliderTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> + <!-- TODO not in M2 --> + <!-- <section id="sect-Component_Reference-Rich_inputs-richinputNumberSpinner"> <title><sgmltag>&lt;rich:inputNumberSpinner&gt;</sgmltag></title> <para> @@ -399,6 +546,7 @@ Instead of returning just one value from an object, the entire object can be returned to the client and handled appropriately. This is done by specifying <code>usingSuggestObjects="true"</code> and setting the <varname>onobjectchange</varname> attribute to a JavaScript method to handle the object, passing the <literal>suggestion</literal> object as a parameter. </para> </section> + --> </chapter> 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-08-17 01:41:02 UTC (rev 18693) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml 2010-08-17 04:56:25 UTC (rev 18694) @@ -15,428 +15,367 @@ This chapter covers all components related to the display of tables and grids. </para> + <!--<a4j:repeat>--> <section id="sect-Component_Reference-Actions-a4jrepeat"> <title><sgmltag>&lt;a4j:repeat&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - component-type: <classname>org.ajax4jsf.Repeat</classname> - </para> - </listitem> - <listitem> - <para> - component-family: <classname>javax.faces.Data</classname> - </para> - </listitem> - <listitem> - <para> - component-class: <classname>org.ajax4jsf.component.html.HtmlAjaxRepeat</classname> - </para> - </listitem> - <listitem> - <para> - renderer-type: <classname>org.ajax4jsf.components.RepeatRenderer</classname> - </para> - </listitem> - </itemizedlist> <para> The <sgmltag>&lt;a4j:repeat&gt;</sgmltag> component is used to iterate changes through a repeated collection of components. It allows specific rows of items to be updated without sending Ajax requests for the entire collection. The <sgmltag>&lt;a4j:repeat&gt;</sgmltag> component forms the basis for many of the tabular components detailed in <xref linkend="chap-Component_Reference-Tables_and_grids" />. </para> - <para> - The contents of the collection are determined using Expression Language (<acronym>EL</acronym>). The data model for the contents is specified with the <varname>value</varname> attribute. The <varname>var</varname> attribute names the object to use when iterating through the collection. This object is then referenced in the relevant child components. After an Ajax request, only the rows specified with the <varname>ajaxKeys</varname> attribute are updated rather than the entire collection. <xref linkend="exam-Component_Reference-a4jrepeat-a4jrepeat_example" /> shows how to use <sgmltag>&lt;a4j:repeat&gt;</sgmltag> to maintain a simple table. - </para> - <example id="exam-Component_Reference-a4jrepeat-a4jrepeat_example"> - <title><sgmltag>&lt;a4j:repeat&gt;</sgmltag> example</title> - -<programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-Tables_and_grids-a4jrepeat_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> -</programlisting> + + <section id="sect-Component_Reference-a4jrepeat-Basic_usage"> + <title>Basic usage</title> <para> - Each row of a table contains two cells: one showing the item code, and the other showing the item price. The table is generated by iterating through items in the <code>repeatBeans.items</code> data model. + The contents of the collection are determined using Expression Language (<acronym>EL</acronym>). The data model for the contents is specified with the <varname>value</varname> attribute. The <varname>var</varname> attribute names the object to use when iterating through the collection. This object is then referenced in the relevant child components. After an Ajax request, only the rows specified with the <varname>ajaxKeys</varname> attribute are updated rather than the entire collection. <xref linkend="exam-Component_Reference-a4jrepeat-a4jrepeat_example" /> shows how to use <sgmltag>&lt;a4j:repeat&gt;</sgmltag> to maintain a simple table. </para> - </example> - <para> - The <sgmltag>&lt;a4j:repeat&gt;</sgmltag> component uses other attributes common to iteration components, such as the <varname>first</varname> attribute for specifying the first item for iteration, and the <varname>rows</varname> attribute for specifying the number of rows of items to display. - </para> + <example id="exam-Component_Reference-a4jrepeat-a4jrepeat_example"> + <title><sgmltag>&lt;a4j:repeat&gt;</sgmltag> example</title> + <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-Tables_and_grids-a4jrepeat_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <para> + Each row of a table contains two cells: one showing the item code, and the other showing the item price. The table is generated by iterating through items in the <code>repeatBeans.items</code> data model. + </para> + </example> + <para> + The <sgmltag>&lt;a4j:repeat&gt;</sgmltag> component uses other attributes common to iteration components, such as the <varname>first</varname> attribute for specifying the first item for iteration, and the <varname>rows</varname> attribute for specifying the number of rows of items to display. + </para> + </section> + + <section id="sect-Component_Reference-a4jrepeat-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.ajax4jsf.Repeat</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.ajax4jsf.component.html.HtmlAjaxRepeat</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>javax.faces.Data</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.ajax4jsf.components.RepeatRenderer</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> + <!--<rich:column>--> <section id="sect-Component_Reference-Tables_and_grids-richcolumn"> <title><sgmltag>&lt;rich:column&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - component-type: <classname>org.richfaces.Column</classname> - </para> - </listitem> - <listitem> - <para> - component-class: <classname>org.richfaces.component.html.HtmlColumn</classname> - </para> - </listitem> - <listitem> - <para> - component-family: <classname>org.richfaces.Column</classname> - </para> - </listitem> - <listitem> - <para> - renderer-type: <classname>org.richfaces.renderkit.CellRenderer</classname> - </para> - </listitem> - <listitem> - <para> - tag-class: <classname>org.richfaces.taglib.ColumnTag</classname> - </para> - </listitem> - </itemizedlist> <para> The <sgmltag>&lt;rich:column&gt;</sgmltag> component facilitates columns in a table or other <classname>UIData</classname> component. It supports merging columns and rows, sorting, filtering, and customized skinning. </para> - <para> - In general usage, the <sgmltag>&lt;rich:column&gt;</sgmltag> component is used in the same was as the JavaServer Faces (<acronym>JSF</acronym>) <sgmltag>&lt;h:column&gt;</sgmltag> component. It requires no extra attributes for basic usage, as shown in <xref linkend="exam-Component_Reference-richcolumn-Basic_column_example" />. - </para> - <example id="exam-Component_Reference-richcolumn-Basic_column_example"> - <title>Basic column example</title> - -<programlisting language="XML" role="XML">&lt;rich:dataTable value="#{capitalsBean.capitals}" var="cap" rows="5"&gt; - &lt;rich:column&gt; - &lt;f:facet name="header"&gt;State Flag&lt;/f:facet&gt; - &lt;h:graphicImage value="#{cap.stateFlag}"/&gt; - &lt;/rich:column&gt; - &lt;rich:column&gt; - &lt;f:facet name="header"&gt;State Name&lt;/f:facet&gt; - &lt;h:outputText value="#{cap.state}"/&gt; - &lt;/rich:column&gt; - &lt;rich:column &gt; - &lt;f:facet name="header"&gt;State Capital&lt;/f:facet&gt; - &lt;h:outputText value="#{cap.name}"/&gt; - &lt;/rich:column&gt; - &lt;rich:column&gt; - &lt;f:facet name="header"&gt;Time Zone&lt;/f:facet&gt; - &lt;h:outputText value="#{cap.timeZone}"/&gt; - &lt;/rich:column&gt; -&lt;/rich:dataTable&gt; -</programlisting> - <blockquote> - <figure id="figu-Component_Reference-Basic_column_example-Basic_column_example"> - <title>Basic column example</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-richcolumn-Basic_column_example.png" format="PNG" /> - </imageobject> - <textobject> - <para> - The result of the basic column example, displaying a table with a header row and four columns. - </para> - </textobject> - </mediaobject> - </figure> - </blockquote> - </example> - <para> - Columns can be merged by using the <varname>colspan</varname> attribute to specify how many normal columns to span. The <varname>colspan</varname> attribute is used in conjunction with the <varname>breakBefore</varname> attribute on the next column to determine how the merged columns are laid out. <xref linkend="exam-Component_Reference-richcolumn-Column_spanning_example" />. - </para> - <example id="exam-Component_Reference-richcolumn-Column_spanning_example"> - <title>Column spanning example</title> - -<programlisting language="XML" role="XML">&lt;rich:dataTable value="#{capitalsBean.capitals}" var="cap" rows="5"&gt; - &lt;rich:column colspan="3"&gt; - &lt;h:graphicImage value="#{cap.stateFlag}"/&gt; - &lt;/rich:column&gt; - &lt;rich:column breakBefore="true"&gt; - &lt;h:outputText value="#{cap.state}"/&gt; - &lt;/rich:column&gt; - &lt;rich:column &gt; - &lt;h:outputText value="#{cap.name}"/&gt; - &lt;/rich:column&gt; - &lt;rich:column&gt; - &lt;h:outputText value="#{cap.timeZone}"/&gt; - &lt;/rich:column&gt; -&lt;/rich:dataTable&gt; -</programlisting> - <blockquote> - <figure id="figu-Component_Reference-Column_spanning_example-Column_spanning_example"> - <title>Column spanning example</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-richcolumn-Column_spanning_example.png" format="PNG" /> - </imageobject> - <textobject> - <para> - The result of the column spanning example, showing the first column (the state flag column) spanning a width of three columns, with the others broken onto the following line. - </para> - </textobject> - </mediaobject> - </figure> - </blockquote> - </example> - <para> - Similarly, the <varname>rowspan</varname> attribute can be used to merge and span rows. Again the <varname>breakBefore</varname> attribute needs to be used on related <sgmltag>&lt;rich:column&gt;</sgmltag> components to define the layout. <xref linkend="exam-Component_Reference-richcolumn-Row_spanning_example" /> and the resulting <xref linkend="figu-Component_Reference-Complex_headers_using_column_groups-Complex_headers_using_column_groups" /> show the first column of the table spanning three rows. - </para> - <example id="exam-Component_Reference-richcolumn-Row_spanning_example"> - <title>Row spanning example</title> - -<programlisting language="XML" role="XML">&lt;rich:dataTable value="#{capitalsBean.capitals}" var="cap" rows="5"&gt; - &lt;rich:column rowspan="3"&gt; - &lt;f:facet name="header"&gt;State Flag&lt;/f:facet&gt; - &lt;h:graphicImage value="#{cap.stateFlag}"/&gt; - &lt;/rich:column&gt; - &lt;rich:column&gt; - &lt;f:facet name="header"&gt;State Info&lt;/f:facet&gt; - &lt;h:outputText value="#{cap.state}"/&gt; - &lt;/rich:column&gt; - &lt;rich:column breakBefore="true"&gt; - &lt;h:outputText value="#{cap.name}"/&gt; - &lt;/rich:column&gt; - &lt;rich:column breakBefore="true"&gt; - &lt;h:outputText value="#{cap.timeZone}"/&gt; - &lt;/rich:column&gt; -&lt;/rich:dataTable&gt; -</programlisting> - <blockquote> - <figure id="figu-Component_Reference-Row_spanning_example-Row_spanning_example"> - <title>Row spanning example</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-richcolumn-Row_spanning_example.png" format="PNG" /> - </imageobject> - <textobject> - <para> - The result of the row spanning example, showing the first column of the table spanning three rows. - </para> - </textobject> - </mediaobject> - </figure> - </blockquote> - </example> - <para> - For details on filtering and sorting columns, refer to <xref linkend="sect-Component_Reference-Tables_and_grids-Table_filtering" /> and <xref linkend="sect-Component_Reference-Tables_and_grids-Table_sorting" />. - </para> + + <section id="sect-Component_Reference-richcolumn-Basic_usage"> + <title>Basic usage</title> + <para> + In general usage, the <sgmltag>&lt;rich:column&gt;</sgmltag> component is used in the same was as the JavaServer Faces (<acronym>JSF</acronym>) <sgmltag>&lt;h:column&gt;</sgmltag> component. It requires no extra attributes for basic usage, as shown in <xref linkend="exam-Component_Reference-richcolumn-Basic_column_example" />. + </para> + <example id="exam-Component_Reference-richcolumn-Basic_column_example"> + <title>Basic column example</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richcolumn-Basic_column_example.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <blockquote> + <figure id="figu-Component_Reference-Basic_column_example-Basic_column_example"> + <title>Basic column example</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richcolumn-Basic_column_example.png" format="PNG" /> + </imageobject> + <textobject> + <para> + The result of the basic column example, displaying a table with a header row and four columns. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> + </example> + </section> + + <section id="sect-Component_Reference-richcolumn-Spanning_columns"> + <title>Spanning columns</title> + <para> + Columns can be merged by using the <varname>colspan</varname> attribute to specify how many normal columns to span. The <varname>colspan</varname> attribute is used in conjunction with the <varname>breakBefore</varname> attribute on the next column to determine how the merged columns are laid out. <xref linkend="exam-Component_Reference-richcolumn-Column_spanning_example" />. + </para> + <example id="exam-Component_Reference-richcolumn-Column_spanning_example"> + <title>Column spanning example</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richcolumn-Column_spanning_example.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <blockquote> + <figure id="figu-Component_Reference-Column_spanning_example-Column_spanning_example"> + <title>Column spanning example</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richcolumn-Column_spanning_example.png" format="PNG" /> + </imageobject> + <textobject> + <para> + The result of the column spanning example, showing the first column (the state flag column) spanning a width of three columns, with the others broken onto the following line. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> + </example> + </section> + + <section id="sect-Component_Reference-richcolumn-Spanning_rows"> + <title>Spanning rows</title> + <para> + Similarly, the <varname>rowspan</varname> attribute can be used to merge and span rows. Again the <varname>breakBefore</varname> attribute needs to be used on related <sgmltag>&lt;rich:column&gt;</sgmltag> components to define the layout. <xref linkend="exam-Component_Reference-richcolumn-Row_spanning_example" /> and the resulting <xref linkend="figu-Component_Reference-Complex_headers_using_column_groups-Complex_headers_using_column_groups" /> show the first column of the table spanning three rows. + </para> + <example id="exam-Component_Reference-richcolumn-Row_spanning_example"> + <title>Row spanning example</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richcolumn-Row_spanning_example.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <blockquote> + <figure id="figu-Component_Reference-Row_spanning_example-Row_spanning_example"> + <title>Row spanning example</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richcolumn-Row_spanning_example.png" format="PNG" /> + </imageobject> + <textobject> + <para> + The result of the row spanning example, showing the first column of the table spanning three rows. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> + </example> + <para> + For details on filtering and sorting columns, refer to <xref linkend="sect-Component_Reference-Tables_and_grids-Table_filtering" /> and <xref linkend="sect-Component_Reference-Tables_and_grids-Table_sorting" />. + </para> + </section> + + <section id="sect-Component_Reference-richcolumn-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.Column</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlColumn</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.Column</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.renderkit.CellRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.ColumnTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> + <!--<rich:columnGroup>--> <section id="sect-Component_Reference-Tables_and_grids-richcolumnGroup"> <title><sgmltag>&lt;rich:columnGroup&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - component-type: <classname>org.richfaces.ColumnGroup</classname> - </para> - </listitem> - <listitem> - <para> - component-class: <classname>org.richfaces.component.html.HtmlColumnGroup</classname> - </para> - </listitem> - <listitem> - <para> - component-family: <classname>org.richfaces.ColumnGroup</classname> - </para> - </listitem> - <listitem> - <para> - renderer-type: <classname>org.richfaces.ColumnGroupRenderer</classname> - </para> - </listitem> - <listitem> - <para> - tag-class: <classname>org.richfaces.taglib.ColumnGroupTag</classname> - </para> - </listitem> - </itemizedlist> <para> The <sgmltag>&lt;rich:columnGroup&gt;</sgmltag> component combines multiple columns in a single row to organize complex parts of a table. The resulting effect is similar to using the <varname>breakBefore</varname> attribute of the <sgmltag>&lt;rich:column&gt;</sgmltag> component, but is clearer and easier to follow in the source code. </para> - <para> - The <sgmltag>&lt;rich:columnGroup&gt;</sgmltag> can also be used to create complex headers in a table. <xref linkend="exam-Component_Reference-richcolumnGroup-Complex_headers_using_column_groups" /> and the resulting <xref linkend="figu-Component_Reference-Complex_headers_using_column_groups-Complex_headers_using_column_groups" /> demonstrate how complex headers can be achieved. - </para> - <example id="exam-Component_Reference-richcolumnGroup-Complex_headers_using_column_groups"> - <title>Complex headers using column groups</title> - -<programlisting language="XML" role="XML">&lt;rich:dataTable value="#{capitalsBean.capitals}" var="cap" rows="5" id="sublist"&gt; - &lt;f:facet name="header"&gt; - &lt;rich:columnGroup&gt; - &lt;rich:column rowspan="2"&gt; - &lt;h:outputText value="State Flag"/&gt; - &lt;/rich:column&gt; - &lt;rich:column colspan="3"&gt; - &lt;h:outputText value="State Info"/&gt; - &lt;/rich:column&gt; - &lt;rich:column breakBefore="true"&gt; - &lt;h:outputText value="State Name"/&gt; - &lt;/rich:column&gt; - &lt;rich:column&gt; - &lt;h:outputText value="State Capital"/&gt; - &lt;/rich:column&gt; - &lt;rich:column&gt; - &lt;h:outputText value="Time Zone"/&gt; - &lt;/rich:column&gt; - &lt;/rich:columnGroup&gt; - &lt;/f:facet&gt; - &lt;rich:column&gt; - &lt;h:graphicImage value="#{cap.stateFlag}"/&gt; - &lt;/rich:column&gt; - &lt;rich:column&gt; - &lt;h:outputText value="#{cap.state}"/&gt; - &lt;/rich:column&gt; - &lt;rich:column&gt; - &lt;h:outputText value="#{cap.name}"/&gt; - &lt;/rich:column&gt; - &lt;rich:column&gt; - &lt;h:outputText value="#{cap.timeZone}"/&gt; - &lt;/rich:column&gt; -&lt;/rich:dataTable&gt; -</programlisting> - <blockquote> - <figure id="figu-Component_Reference-Complex_headers_using_column_groups-Complex_headers_using_column_groups"> - <title>Complex headers using column groups</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-richcolumnGroup-Complex_headers_using_column_groups.png" format="PNG" /> - </imageobject> - <textobject> - <para> - A table with a complex header, where three of the columns are grouped together under a common title. - </para> - </textobject> - </mediaobject> - </figure> - </blockquote> - </example> + <section id="sect-Component_Reference-richcolumnGroup-Complex_headers"> + <title>Complex headers</title> + <para> + The <sgmltag>&lt;rich:columnGroup&gt;</sgmltag> can also be used to create complex headers in a table. <xref linkend="exam-Component_Reference-richcolumnGroup-Complex_headers_using_column_groups" /> and the resulting <xref linkend="figu-Component_Reference-Complex_headers_using_column_groups-Complex_headers_using_column_groups" /> demonstrate how complex headers can be achieved. + </para> + <example id="exam-Component_Reference-richcolumnGroup-Complex_headers_using_column_groups"> + <title>Complex headers using column groups</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richcolumnGroup-Complex_headers_using_column_groups.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <blockquote> + <figure id="figu-Component_Reference-Complex_headers_using_column_groups-Complex_headers_using_column_groups"> + <title>Complex headers using column groups</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richcolumnGroup-Complex_headers_using_column_groups.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A table with a complex header, where three of the columns are grouped together under a common title. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> + </example> + </section> + + <section id="sect-Component_Reference-richcolumnGroup-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.ColumnGroup</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlColumnGroup</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.ColumnGroup</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.ColumnGroupRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.ColumnGroupTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> + <!--<rich:columns>--> <section id="sect-Component_Reference-Tables_and_grids-richcolumns"> <title><sgmltag>&lt;rich:columns&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - component-type: <classname>org.richfaces.Column</classname> - </para> - </listitem> - <listitem> - <para> - tag-class: <classname>org.richfaces.taglib.ColumnsTagHandler</classname> - </para> - </listitem> - </itemizedlist> <para> The <sgmltag>&lt;rich:columns&gt;</sgmltag> component allows for dynamic sets of columns for tables. Columns and rows can be merged, and the look and feel can be highly customized. The component gets a list from a data model and creates a corresponding set of columns in a <sgmltag>&lt;rich:dataTable&gt;</sgmltag> component. The <sgmltag>&lt;rich:columns&gt;</sgmltag> component also supports <literal>header</literal> and <literal>footer</literal> facets. </para> - <para> - Basic usage of the <sgmltag>&lt;rich:columns&gt;</sgmltag> component requires the <varname>value</varname> attribute, which points to the data model; the <varname>var</varname> attribute, which holds the current variable for the collection of data; and the <varname>index</varname> attribute, which holds the current counter. The <varname>id</varname> attribute is used for when the individuals rows require identifiers for Ajax events. - </para> - <example id="exam-Component_Reference-richcolumns-Basic_columns_example"> - <title>Basic columns example</title> - -<programlisting language="XML" role="XML">&lt;rich:dataTable value="#{dataTableScrollerBean.model}" var="model" width="750"&gt; - &lt;rich:columns value="#{dataTableScrollerBean.columns}" var="columns" index="ind" id="column#{ind}"&gt; - &lt;f:facet name="header"&gt; - &lt;h:outputText value="#{columns.header}" /&gt; - &lt;/f:facet&gt; - &lt;h:outputText value="#{model[ind].model} " /&gt; - &lt;h:outputText value="#{model[ind].mileage} miles " /&gt; - &lt;h:outputText value="#{model[ind].price}$" /&gt; - &lt;/rich:columns&gt; -&lt;/rich:dataTable&gt; -</programlisting> - </example> - <para> - The output can be customized to display specific columns and rows. The <varname>columns</varname> attribute specifies the number of columns. The <varname>rowspan</varname> attribute specifies the number of rows to display; if the attribute is set to <literal>0</literal>, all remaining rows in the table are displayed. The <varname>begin</varname> and <varname>end</varname> attributes are used to specify the first and last zero-based iteration items to display in the table. Columns can be adjusted using the <varname>colspan</varname>, <varname>rowspan</varname>, and <varname>breakBefore</varname> attributes the same as with the <sgmltag>&lt;rich:column&gt;</sgmltag> component. - </para> - <para> - The <sgmltag>&lt;rich:columns&gt;</sgmltag> component can be used alongside <sgmltag>&lt;rich:column&gt;</sgmltag> components. - </para> - <example id="exam-Component_Reference-richcolumns-Using_richcolumns_and_richcolumn_together"> + <section id="sect-Component_Reference-richcolumns-Basic_usage"> + <title>Basic usage</title> + <para> + Basic usage of the <sgmltag>&lt;rich:columns&gt;</sgmltag> component requires the <varname>value</varname> attribute, which points to the data model; the <varname>var</varname> attribute, which holds the current variable for the collection of data; and the <varname>index</varname> attribute, which holds the current counter. The <varname>id</varname> attribute is used for when the individuals rows require identifiers for Ajax events. + </para> + <example id="exam-Component_Reference-richcolumns-Basic_columns_example"> + <title>Basic columns example</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richcolumns-Basic_columns_example.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </example> + </section> + + <section id="sect-Component_Reference-richcolumns-Customizing_the_view"> + <title>Customizing the view</title> + <para> + The output can be customized to display specific columns and rows. The <varname>columns</varname> attribute specifies the number of columns. The <varname>rowspan</varname> attribute specifies the number of rows to display; if the attribute is set to <literal>0</literal>, all remaining rows in the table are displayed. The <varname>begin</varname> and <varname>end</varname> attributes are used to specify the first and last zero-based iteration items to display in the table. Columns can be adjusted using the <varname>colspan</varname>, <varname>rowspan</varname>, and <varname>breakBefore</varname> attributes the same as with the <sgmltag>&lt;rich:column&gt;</sgmltag> component. + </para> + </section> + + <section id="sect-Component_Reference-richcolumns-Using_richcolumns_and_richcolumn_together"> <title>Using <sgmltag>&lt;rich:columns&gt;</sgmltag> and <sgmltag>&lt;rich:column&gt;</sgmltag> together</title> - -<programlisting language="XML" role="XML">&lt;rich:dataTable value="#{dataTableScrollerBean.model}" var="model" width="500px" rows="5"&gt; - &lt;f:facet name="header"&gt; - &lt;h:outputText value="Cars Available"&gt;&lt;/h:outputText&gt; - &lt;/f:facet&gt; - &lt;rich:columns value="#{dataTableScrollerBean.columns}" var="columns" index="ind"&gt; - &lt;f:facet name="header"&gt; - &lt;h:outputText value="#{columns.header}" /&gt; - &lt;/f:facet&gt; - &lt;h:outputText value="#{model[ind].model} " /&gt; - &lt;/rich:columns&gt; - &lt;rich:column&gt; - &lt;f:facet name="header"&gt; - &lt;h:outputText value="Price" /&gt; - &lt;/f:facet&gt; - &lt;h:outputText value="Price" /&gt; - &lt;/rich:column&gt; - &lt;rich:columns value="#{dataTableScrollerBean.columns}" var="columns" index="ind"&gt; - &lt;f:facet name="header"&gt; - &lt;h:outputText value="#{columns.header}" /&gt; - &lt;/f:facet&gt; - &lt;h:outputText value="#{model[ind].mileage}$" /&gt; - &lt;/rich:columns&gt; -&lt;/rich:dataTable&gt; -</programlisting> - </example> - <para> - For details on filtering and sorting columns, refer to <xref linkend="sect-Component_Reference-Tables_and_grids-Table_filtering" /> and <xref linkend="sect-Component_Reference-Tables_and_grids-Table_sorting" />. - </para> + <para> + The <sgmltag>&lt;rich:columns&gt;</sgmltag> component can be used alongside one or more <sgmltag>&lt;rich:column&gt;</sgmltag> components. + </para> + <example id="exam-Component_Reference-richcolumns-Using_richcolumns_and_richcolumn_together"> + <title>Using <sgmltag>&lt;rich:columns&gt;</sgmltag> and <sgmltag>&lt;rich:column&gt;</sgmltag> together</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richcolumns-Using_richcolumns_and_richcolumn_together.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </example> + <para> + For details on filtering and sorting columns, refer to <xref linkend="sect-Component_Reference-Tables_and_grids-Table_filtering" /> and <xref linkend="sect-Component_Reference-Tables_and_grids-Table_sorting" />. + </para> + </section> + + <section id="sect-Component_Reference-richcolumns-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.Column</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.ColumnsTagHandler</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> - <!-- TODO not in M2 --> - <!-- + <!--<rich:dataDefinitionList>--> <section id="sect-Component_Reference-Tables_and_grids-richdataDefinitionList"> <title><sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - component-type: <classname>org.richfaces.DataDefinitionList</classname> - </para> - </listitem> - <listitem> - <para> - component-class: <classname>org.richfaces.component.html.HtmlDataDefinitionList</classname> - </para> - </listitem> - <listitem> - <para> - component-family: <classname>org.richfaces.DataDefinitionList</classname> - </para> - </listitem> - <listitem> - <para> - renderer-type: <classname>org.richfaces.DataDefinitionListRenderer</classname> - </para> - </listitem> - <listitem> - <para> - tag-class: <classname>org.richfaces.taglib.DataDefinitionListTag</classname> - </para> - </listitem> - </itemizedlist> <para> The <sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag> component renders a list of items with definitions. The component uses a data model for managing the list items, which can be updated dynamically. </para> - <para> - The <varname>var</varname> attribute names a variable for iterating through the items in the data model. The items to iterate through are determined with the <varname>value</varname> attribute by using EL (Expression Lanugage). The <varname>first</varname> attribute specifies which item in the data model to start from, and the <varname>rows</varname> attribute specifies the number of items to list. The <varname>title</varname> attribute is used for a floating tool-tip. <xref linkend="exam-Component_Reference-richdataDefinitionList-richdataDefinitionList_example" /> shows a simple example using the <sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag> component. - </para> - <example id="exam-Component_Reference-richdataDefinitionList-richdataDefinitionList_example"> - <title><sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag> example</title> - -<programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-Tables_and_grids-richdataDefinitionList_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> -</programlisting> - <blockquote> - <figure id="figu-Component_Reference-richdataDefinitionList_example-richdataDefinitionList_example"> - <title><sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag> example</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-Tables_and_grids-richdataDefinitionList_example.png" format="PNG" /> - </imageobject> - <textobject> - <para> - A list of cars with their price and mileage displayed as a data definition. - </para> - </textobject> - </mediaobject> - </figure> - </blockquote> - </example> + + <section id="sect-Component_Reference-richdataDefinitionList-Basic_usage"> + <title>Basic usage</title> + <para> + The <varname>var</varname> attribute names a variable for iterating through the items in the data model. The items to iterate through are determined with the <varname>value</varname> attribute by using EL (Expression Lanugage). + </para> + </section> + + <section id="sect-Component_Reference-richdataDefinitionList-Customizing_the_list"> + <title>Customizing the list</title> + <para> + The <varname>first</varname> attribute specifies which item in the data model to start from, and the <varname>rows</varname> attribute specifies the number of items to list. The <varname>title</varname> attribute is used for a floating tool-tip. <xref linkend="exam-Component_Reference-richdataDefinitionList-richdataDefinitionList_example" /> shows a simple example using the <sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag> component. + </para> + <example id="exam-Component_Reference-richdataDefinitionList-richdataDefinitionList_example"> + <title><sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag> example</title> + <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-Tables_and_grids-richdataDefinitionList_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <blockquote> + <figure id="figu-Component_Reference-richdataDefinitionList_example-richdataDefinitionList_example"> + <title><sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag> example</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-Tables_and_grids-richdataDefinitionList_example.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A list of cars with their price and mileage displayed as a data definition. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> + </example> + </section> + + <section id="sect-Component_Reference-richdataDefinitionList-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.DataDefinitionList</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlDataDefinitionList</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.DataDefinitionList</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.DataDefinitionListRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.DataDefinitionListTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> - --> <!-- TODO not in M2 --> <!-- @@ -445,27 +384,27 @@ <itemizedlist> <listitem> <para> - component-type: <classname>org.richfaces.DataFilterSlider</classname> + <parameter>component-type</parameter>: <classname>org.richfaces.DataFilterSlider</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.richfaces.component.html.HtmlDataFilterSlider</classname> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlDataFilterSlider</classname> </para> </listitem> <listitem> <para> - component-family: <classname>org.richfaces.DataFilterSlider</classname> + <parameter>component-family</parameter>: <classname>org.richfaces.DataFilterSlider</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.richfaces.DataFilterSliderRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.richfaces.DataFilterSliderRenderer</classname> </para> </listitem> <listitem> <para> - tag-class: <classname>org.richfaces.taglib.dataFilterSliderTag</classname> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.dataFilterSliderTag</classname> </para> </listitem> </itemizedlist> @@ -505,35 +444,9 @@ </section> --> + <!--<rich:dataGrid>--> <section id="sect-Component_Reference-Tables_and_grids-richdataGrid"> <title><sgmltag>&lt;rich:dataGrid&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - component-type: <classname>org.richfaces.DataGrid</classname> - </para> - </listitem> - <listitem> - <para> - component-class: <classname>org.richfaces.component.html.HtmlDataGrid</classname> - </para> - </listitem> - <listitem> - <para> - component-family: <classname>org.richfaces.DataGrid</classname> - </para> - </listitem> - <listitem> - <para> - renderer-type: <classname>org.richfaces.DataGridRenderer</classname> - </para> - </listitem> - <listitem> - <para> - tag-class: <classname>org.richfaces.taglib.DataGridTag</classname> - </para> - </listitem> - </itemizedlist> <para> The <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> component is used to arrange data objects in a grid. Values in the grid can be updated dynamically from the data model, and Ajax updates can be limited to specific rows. The component supports <literal>header</literal>, <literal>footer</literal>, and <literal>caption</literal> facets. </para> @@ -550,244 +463,317 @@ </textobject> </mediaobject> </figure> - <para> - The <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> component requires the <varname>value</varname> attribute, which points to the data model, and the <varname>var</varname> attribute, which holds the current variable for the collection of data. The number of columns for the grid is specifed with the <varname>columns</varname> attribute, and the number of elements to layout among the columns is determined with the <varname>elements</varname> attribute. The <varname>first</varname> attribute references the zero-based element in the data model from which the grid starts. - </para> - <example id="exam-Component_Reference-richdataGrid-richdataGrid_example"> - <title><sgmltag>&lt;rich:dataGrid&gt;</sgmltag> example</title> - -<programlisting language="XML" role="XML"> -<xi:include href="extras/exam-Component_Reference-richdataGrid-richdataGrid_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> -</programlisting> - <blockquote> - <figure id="figu-Component_Reference-richdataGrid_example-richdataGrid_example"> - <title><sgmltag>&lt;rich:dataGrid&gt;</sgmltag> example</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-richdataGrid-richdataGrid_example.png" format="PNG" /> - </imageobject> - <textobject> - <para> - The result of the <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> example, with the <literal>header</literal> facet, <literal>footer</literal> facet, and first element annotated. - </para> - </textobject> - </mediaobject> - </figure> - </blockquote> - </example> + + <section id="sect-Component_Reference-richdataGrid-Basic_usage"> + <title>Basic usage</title> + <para> + The <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> component requires the <varname>value</varname> attribute, which points to the data model, and the <varname>var</varname> attribute, which holds the current variable for the collection of data. + </para> + </section> + + <section id="sect-Component_Reference-richdataGrid-Customizing_the_grid"> + <title>Customizing the grid</title> + <para> + The number of columns for the grid is specifed with the <varname>columns</varname> attribute, and the number of elements to layout among the columns is determined with the <varname>elements</varname> attribute. The <varname>first</varname> attribute references the zero-based element in the data model from which the grid starts. + </para> + <example id="exam-Component_Reference-richdataGrid-richdataGrid_example"> + <title><sgmltag>&lt;rich:dataGrid&gt;</sgmltag> example</title> + <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-richdataGrid-richdataGrid_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <blockquote> + <figure id="figu-Component_Reference-richdataGrid_example-richdataGrid_example"> + <title><sgmltag>&lt;rich:dataGrid&gt;</sgmltag> example</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richdataGrid-richdataGrid_example.png" format="PNG" /> + </imageobject> + <textobject> + <para> + The result of the <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> example, with the <literal>header</literal> facet, <literal>footer</literal> facet, and first element annotated. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> + </example> + </section> + <!-- TODO - <para> - The <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> component can be used with the <sgmltag>&lt;rich:dataScroller&gt;</sgmltag> component to display multiple pages of grids. Refer to <xref linkend="sect-Component_Reference-Tables_and_grids-richdataScroller" /> for details on the <sgmltag>&lt;rich:dataScroller&gt;</sgmltag> component. - </para> - --> - <para> - As the component is based on the <sgmltag>&lt;a4j:repeat&gt;</sgmltag> component, it can be partially updated with Ajax. The <varname>ajaxKeys</varname> attribute allows row keys to be defined, which are updated after an Ajax request. - </para> - <example id="exam-Component_Reference-richdataGrid-ajaxKeys_example"> - <title><varname>ajaxKeys</varname> example</title> - -<programlisting language="XML" role="XML"> -&lt;rich:dataGrid value="#{dataTableScrollerBean.allCars}" var="car" ajaxKeys="#{listBean.list}" binding="#{listBean.dataGrid}" id="grid" elements="4" columns="2"&gt; - ... -&lt;/rich:dataGrid&gt; -... -&lt;a4j:commandButton action="#{listBean.action}" reRender="grid" value="Submit"/&gt; -</programlisting> - </example> + <section id="sect-Component_Reference-richdataGrid-Multiple-page_grids"> + <title>Multiple-page grids</title> + <para> + The <sgmltag>&lt;rich:dataGrid&gt;</sgmltag> component can be used with the <sgmltag>&lt;rich:dataScroller&gt;</sgmltag> component to display multiple pages of grids. Refer to <xref linkend="sect-Component_Reference-Tables_and_grids-richdataScroller" /> for details on the <sgmltag>&lt;rich:dataScroller&gt;</sgmltag> component. + </para> + </section> + --> + + <section id="sect-Component_Reference-richdataGrid-Patial_updates"> + <title>Patial updates</title> + <para> + As the component is based on the <sgmltag>&lt;a4j:repeat&gt;</sgmltag> component, it can be partially updated with Ajax. The <varname>ajaxKeys</varname> attribute allows row keys to be defined, which are updated after an Ajax request. + </para> + <example id="exam-Component_Reference-richdataGrid-ajaxKeys_example"> + <title><varname>ajaxKeys</varname> example</title> + <programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richdataGrid-ajaxKeys_example.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + </example> + </section> + + <section id="sect-Component_Reference-richdataGrid-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.DataGrid</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlDataGrid</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.DataGrid</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.DataGridRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.DataGridTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> - <!-- TODO not in M2 --> - <!-- + <!--<rich:dataOrderedList>--> <section id="sect-Component_Reference-Tables_and_grids-richdataList"> <title><sgmltag>&lt;rich:dataList&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - component-type: <classname>org.richfaces.DataList</classname> - </para> - </listitem> - <listitem> - <para> - component-class: <classname>org.richfaces.component.html.HtmlDataList</classname> - </para> - </listitem> - <listitem> - <para> - component-family: <classname>org.richfaces.DataList</classname> - </para> - </listitem> - <listitem> - <para> - renderer-type: <classname>org.richfaces.DataListRenderer</classname> - </para> - </listitem> - <listitem> - <para> - tag-class: <classname>org.richfaces.taglib.DataListTag</classname> - </para> - </listitem> - </itemizedlist> <para> The <sgmltag>&lt;rich:dataList&gt;</sgmltag> component renders an unordered list of items. The component uses a data model for managing the list items, which can be updated dynamically. </para> - <para> - The <varname>type</varname> attribute refers to the appearance of the bullet points. The values of the attribute correspond to the <varname>type</varname> parameter for the <sgmltag>&lt;ul&gt;</sgmltag> HTML element: - </para> - <variablelist> - <varlistentry> - <term><literal>circle</literal></term> + + <section id="sect-Component_Reference-richdataList-Basic_usage"> + <title>Basic usage</title> + <para> + The <varname>var</varname> attribute names a variable for iterating through the items in the data model. The items to iterate through are determined with the <varname>value</varname> attribute by using EL (Expression Lanugage). + </para> + </section> + + <section id="sect-Component_Reference-richdataList-Bullet_point_type"> + <title>Bullet point type</title> + <para> + The <varname>type</varname> attribute refers to the appearance of the bullet points. The values of the attribute correspond to the <varname>type</varname> parameter for the <sgmltag>&lt;ul&gt;</sgmltag> HTML element: + </para> + <variablelist> + <varlistentry> + <term><literal>circle</literal></term> + <listitem> + <para> + Displays an unfilled circle as a bullet point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>disc</literal></term> + <listitem> + <para> + Displays a filled disc as a bullet point. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>square</literal></term> + <listitem> + <para> + Displays a square as a bullet point. + </para> + </listitem> + </varlistentry> + </variablelist> + </section> + + <section id="sect-Component_Reference-richdataList-Customizing_the_list"> + <title>Customizing the list</title> + <para> + The <varname>first</varname> attribute specifies which item in the data model to start from, and the <varname>rows</varname> attribute specifies the number of items to list. The <varname>title</varname> attribute is used for a floating tool-tip. <xref linkend="exam-Component_Reference-richdataDefinitionList-richdataDefinitionList_example" /> shows a simple example using the <sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag> component. + </para> + <example id="exam-Component_Reference-richdataList-richdataList_example"> + <title><sgmltag>&lt;rich:dataList&gt;</sgmltag> example</title> + <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-richdataList-richdataList_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <blockquote> + <figure id="figu-Component_Reference-richdataList_example-richdataList_example"> + <title><sgmltag>&lt;rich:dataList&gt;</sgmltag> example</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richdataList-richdataList_example.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A list of cars displayed in a list with bullet points. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> + </example> + </section> + + <section id="sect-Component_Reference-richdataList-Reference_data"> + <title>Reference data</title> + <itemizedlist> <listitem> <para> - Displays an unfilled circle as a bullet point. + <parameter>component-type</parameter>: <classname>org.richfaces.DataList</classname> </para> </listitem> - </varlistentry> - <varlistentry> - <term><literal>disc</literal></term> <listitem> <para> - Displays a filled disc as a bullet point. + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlDataList</classname> </para> </listitem> - </varlistentry> - <varlistentry> - <term><literal>square</literal></term> <listitem> <para> - Displays a square as a bullet point. + <parameter>component-family</parameter>: <classname>org.richfaces.DataList</classname> </para> </listitem> - </varlistentry> - </variablelist> - <para> - The <varname>var</varname> attribute names a variable for iterating through the items in the data model. The items to iterate through are determined with the <varname>value</varname> attribute by using EL (Expression Lanugage). The <varname>first</varname> attribute specifies which item in the data model to start from, and the <varname>rows</varname> attribute specifies the number of items to list. The <varname>title</varname> attribute is used for a floating tool-tip. <xref linkend="exam-Component_Reference-richdataDefinitionList-richdataDefinitionList_example" /> shows a simple example using the <sgmltag>&lt;rich:dataDefinitionList&gt;</sgmltag> component. - </para> - <example id="exam-Component_Reference-richdataList-richdataList_example"> - <title><sgmltag>&lt;rich:dataList&gt;</sgmltag> example</title> - -<programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-richdataList-richdataList_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> -</programlisting> - <blockquote> - <figure id="figu-Component_Reference-richdataList_example-richdataList_example"> - <title><sgmltag>&lt;rich:dataList&gt;</sgmltag> example</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-richdataList-richdataList_example.png" format="PNG" /> - </imageobject> - <textobject> - <para> - A list of cars displayed in a list with bullet points. - </para> - </textobject> - </mediaobject> - </figure> - </blockquote> - </example> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.DataListRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.DataListTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> + <!--<rich:dataOrderedList>--> <section id="sect-Component_Reference-Tables_and_grids-richdataOrderedList"> <title><sgmltag>&lt;rich:dataOrderedList&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - component-type: <classname>org.richfaces.DataOrderedList</classname> - </para> - </listitem> - <listitem> - <para> - component-class: <classname>org.richfaces.component.html.HtmlDataOrderedList</classname> - </para> - </listitem> - <listitem> - <para> - component-family: <classname>org.richfaces.DataOrderedList</classname> - </para> - </listitem> - <listitem> - <para> - renderer-type: <classname>org.richfaces.DataOrderedListRenderer</classname> - </para> - </listitem> - <listitem> - <para> - tag-class: <classname>org.richfaces.taglib.DataOrderedListTag</classname> - </para> - </listitem> - </itemizedlist> <para> The <sgmltag>&lt;rich:dataOrderedList&gt;</sgmltag> component renders an ordered list of items from a data model. Specific rows can be updated dynamically without updating the entire list. </para> - <para> - The <varname>type</varname> attribute defines the appearance of the numerating list markers for the list. The possible values for the <varname>type</varname> attribute are as follows: - </para> - <variablelist> - <varlistentry> - <term><literal>A</literal></term> + + <section id="sect-Component_Reference-richdataOrderedList-Basic_usage"> + <title>Basic usage</title> + <para> + The <varname>var</varname> attribute names a variable for iterating through the items in the data model. The items to iterate through are determined with the <varname>value</varname> attribute by using EL (Expression Lanugage). + </para> + </section> + + <section id="sect-Component_Reference-richdataOrderedList-Numeration_type"> + <title>Numeration type</title> + <para> + The <varname>type</varname> attribute defines the appearance of the numerating list markers for the list. The possible values for the <varname>type</varname> attribute are as follows: + </para> + <variablelist> + <varlistentry> + <term><literal>A</literal></term> + <listitem> + <para> + Numerates the list items as <wordasword>A</wordasword>, <wordasword>B</wordasword>, <wordasword>C</wordasword>, etc. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>a</literal></term> + <listitem> + <para> + Numerates the list items as <wordasword>a</wordasword>, <wordasword>b</wordasword>, <wordasword>c</wordasword>, etc. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>I</literal></term> + <listitem> + <para> + Numerates the list items as <wordasword>I</wordasword>, <wordasword>II</wordasword>, <wordasword>III</wordasword>, etc. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>i</literal></term> + <listitem> + <para> + Numerates the list items as <wordasword>i</wordasword>, <wordasword>ii</wordasword>, <wordasword>iii</wordasword>, etc. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><literal>1</literal></term> + <listitem> + <para> + Numerates the list items as <wordasword>1</wordasword>, <wordasword>2</wordasword>, <wordasword>3</wordasword>, etc. + </para> + </listitem> + </varlistentry> + </variablelist> + </section> + + <section id="sect-Component_Reference-richdataOrderedList-Customizing_the_list"> + <title>Customizing the list</title> + <para> + The <varname>first</varname> attribute specifies which item in the data model to start from, and the <varname>rows</varname> attribute specifies the number of items to list. The <varname>title</varname> attribute defines a pop-up title. To only update a sub-set of the rows in the list, use the <varname>ajaxKeys</varname> attribute, which points to an object that contains the specified rows. + </para> + <example id="exam-Component_Reference-richdataOrderedList-richdataOrderedList_example"> + <title><sgmltag>&lt;rich:dataOrderedList&gt;</sgmltag> example</title> + <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-Tables_and_grids-richdataOrderedList_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <blockquote> + <figure id="figu-Component_Reference-richdataOrderedList_example-richdataOrderedList_example"> + <title><sgmltag>&lt;rich:dataOrderedList&gt;</sgmltag> example</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-Tables_and_grids-richdataOrderedList_example.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A list of cars displayed in a numbered list. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> + </example> + </section> + + <section id="sect-Component_Reference-richdataOrderedList-Reference_data"> + <title>Reference data</title> + <itemizedlist> <listitem> <para> - Numerates the list items as <wordasword>A</wordasword>, <wordasword>B</wordasword>, <wordasword>C</wordasword>, etc. + <parameter>component-type</parameter>: <classname>org.richfaces.DataOrderedList</classname> </para> </listitem> - </varlistentry> - <varlistentry> - <term><literal>a</literal></term> <listitem> <para> - Numerates the list items as <wordasword>a</wordasword>, <wordasword>b</wordasword>, <wordasword>c</wordasword>, etc. + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlDataOrderedList</classname> </para> </listitem> - </varlistentry> - <varlistentry> - <term><literal>I</literal></term> <listitem> <para> - Numerates the list items as <wordasword>I</wordasword>, <wordasword>II</wordasword>, <wordasword>III</wordasword>, etc. + <parameter>component-family</parameter>: <classname>org.richfaces.DataOrderedList</classname> </para> </listitem> - </varlistentry> - <varlistentry> - <term><literal>i</literal></term> <listitem> <para> - Numerates the list items as <wordasword>i</wordasword>, <wordasword>ii</wordasword>, <wordasword>iii</wordasword>, etc. + <parameter>renderer-type</parameter>: <classname>org.richfaces.DataOrderedListRenderer</classname> </para> </listitem> - </varlistentry> - <varlistentry> - <term><literal>1</literal></term> <listitem> <para> - Numerates the list items as <wordasword>1</wordasword>, <wordasword>2</wordasword>, <wordasword>3</wordasword>, etc. + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.DataOrderedListTag</classname> </para> </listitem> - </varlistentry> - </variablelist> - <para> - The <varname>first</varname> attribute specifies which item in the data model to start from, and the <varname>rows</varname> attribute specifies the number of items to list. The <varname>title</varname> attribute defines a pop-up title. To only update a sub-set of the rows in the list, use the <varname>ajaxKeys</varname> attribute, which points to an object that contains the specified rows. - </para> - <example id="exam-Component_Reference-richdataOrderedList-richdataOrderedList_example"> - <title><sgmltag>&lt;rich:dataOrderedList&gt;</sgmltag> example</title> - -<programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-Tables_and_grids-richdataOrderedList_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> -</programlisting> - <blockquote> - <figure id="figu-Component_Reference-richdataOrderedList_example-richdataOrderedList_example"> - <title><sgmltag>&lt;rich:dataOrderedList&gt;</sgmltag> example</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-Tables_and_grids-richdataOrderedList_example.png" format="PNG" /> - </imageobject> - <textobject> - <para> - A list of cars displayed in a numbered list. - </para> - </textobject> - </mediaobject> - </figure> - </blockquote> - </example> + </itemizedlist> + </section> </section> - --> <!-- TODO not in M2 --> <!-- @@ -796,27 +782,27 @@ <itemizedlist> <listitem> <para> - component-type: <classname>org.richfaces.DataTable</classname> + <parameter>component-type</parameter>: <classname>org.richfaces.DataTable</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.richfaces.component.html.HtmlDataTable</classname> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlDataTable</classname> </para> </listitem> <listitem> <para> - component-family: <classname>org.richfaces.DataTable</classname> + <parameter>component-family</parameter>: <classname>org.richfaces.DataTable</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.richfaces.DataTableRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.richfaces.DataTableRenderer</classname> </para> </listitem> <listitem> <para> - tag-class: <classname>org.richfaces.taglib.DataTableTag</classname> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.DataTableTag</classname> </para> </listitem> </itemizedlist> @@ -826,35 +812,9 @@ </section> --> + <!--<rich:dataTable>--> <section id="sect-Component_Reference-Tables_and_grids-richdataTable"> <title><sgmltag>&lt;rich:dataTable&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - component-type: <classname>org.richfaces.DataTable</classname> - </para> - </listitem> - <listitem> - <para> - component-class: <classname>org.richfaces.component.html.HtmlDataTable</classname> - </para> - </listitem> - <listitem> - <para> - component-family: <classname>org.richfaces.DataTable</classname> - </para> - </listitem> - <listitem> - <para> - renderer-type: <classname>org.richfaces.DataTableRenderer</classname> - </para> - </listitem> - <listitem> - <para> - tag-class: <classname>org.richfaces.taglib.DataTableTag</classname> - </para> - </listitem> - </itemizedlist> <para> The <sgmltag>&lt;rich:dataTable&gt;</sgmltag> component is used to render a table, including the table's header and footer. It works in conjunction with the <sgmltag>&lt;rich:column&gt;</sgmltag>, <sgmltag>&lt;rich:columnGroup&gt;</sgmltag>, and <sgmltag>&lt;rich:columns&gt;</sgmltag> components to list the contents of a data model. </para> @@ -864,67 +824,87 @@ The <sgmltag>&lt;rich:dataTable&gt;</sgmltag> component does not include extended table features, such as data scrolling, row selection, and column reordering. These features are available as part of the <sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> component; refer to <xref linkend="sect-Component_Reference-Tables_and_grids-richextendedDataTable" /> for further details. </para> </note> - <para> - The <varname>value</varname> attribute points to the data model, and the <varname>var</varname> attribute specifies a variable to use when iterating through the data model. The <varname>first</varname> attribute specifies which item in the data model to start from, and the <varname>rows</varname> attribute specifies the number of items to list. The <literal>header</literal>, <literal>footer</literal>, and <literal>caption</literal> facets can be used to display text, and to customize the appearance of the table through skinning. demonstrates a simple table implementation. - </para> - <example id="exam-Component_Reference-richdataTable-richdataTable_example"> - <title><sgmltag>&lt;rich:dataTable&gt;</sgmltag> example</title> + + <section id="sect-Component_Reference-richdataTable-Basic_usage"> + <title>Basic usage</title> + <para> + The <varname>value</varname> attribute points to the data model, and the <varname>var</varname> attribute specifies a variable to use when iterating through the data model. + </para> + </section> + + <section id="sect-Component_Reference-richdataTable-Customizing_the_table"> + <title>Customizing the table</title> + <para> + The <varname>first</varname> attribute specifies which item in the data model to start from, and the <varname>rows</varname> attribute specifies the number of items to list. The <literal>header</literal>, <literal>footer</literal>, and <literal>caption</literal> facets can be used to display text, and to customize the appearance of the table through skinning. demonstrates a simple table implementation. + </para> + <example id="exam-Component_Reference-richdataTable-richdataTable_example"> + <title><sgmltag>&lt;rich:dataTable&gt;</sgmltag> example</title> -<programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-Tables_and_grids-richdataTable_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> -</programlisting> - <blockquote> - <figure id="figu-Component_Reference-richdataTable_example-richdataTable_example"> - <title><sgmltag>&lt;rich:dataTable&gt;</sgmltag> example</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-richdataTable_example.png" format="PNG" /> - </imageobject> - <textobject> - <para> - A data table made using the <sgmltag>&lt;rich:dataTable&gt;</sgmltag> component. - </para> - </textobject> - </mediaobject> - </figure> - </blockquote> - </example> - <para> - The <sgmltag>&lt;rich:dataTable&gt;</sgmltag> component is based on the <sgmltag>&lt;a4j:repeat&gt;</sgmltag> component, and as such it can be partially updated using Ajax. The <varname>ajaxKeys</varname> attribute defines the rows to be updated during an Ajax request. - </para> - <para> - For details on filtering and sorting data tables, refer to <xref linkend="sect-Component_Reference-Tables_and_grids-Table_filtering" /> and <xref linkend="sect-Component_Reference-Tables_and_grids-Table_sorting" />. - </para> + <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-Tables_and_grids-richdataTable_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> + </programlisting> + <blockquote> + <figure id="figu-Component_Reference-richdataTable_example-richdataTable_example"> + <title><sgmltag>&lt;rich:dataTable&gt;</sgmltag> example</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richdataTable_example.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A data table made using the <sgmltag>&lt;rich:dataTable&gt;</sgmltag> component. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> + </example> + <para> + For details on filtering and sorting data tables, refer to <xref linkend="sect-Component_Reference-Tables_and_grids-Table_filtering" /> and <xref linkend="sect-Component_Reference-Tables_and_grids-Table_sorting" />. + </para> + </section> + + <section id="sect-Component_Reference-richdataTable-Partial_updates"> + <title>Partial updates</title> + <para> + The <sgmltag>&lt;rich:dataTable&gt;</sgmltag> component is based on the <sgmltag>&lt;a4j:repeat&gt;</sgmltag> component, and as such it can be partially updated using Ajax. The <varname>ajaxKeys</varname> attribute defines the rows to be updated during an Ajax request. + </para> + </section> + + <section id="sect-Component_Reference-richdataTable-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.DataTable</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlDataTable</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.DataTable</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.DataTableRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.DataTableTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> + <!--<rich:extendedDataTable>--> <section id="sect-Component_Reference-Tables_and_grids-richextendedDataTable"> <title><sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag></title> - <itemizedlist> - <listitem> - <para> - component-type: <classname>org.richfaces.ExtendedDataTable</classname> - </para> - </listitem> - <listitem> - <para> - component-class: <classname>org.richfaces.component.html.HtmlExtendedDataTable</classname> - </para> - </listitem> - <listitem> - <para> - component-family: <classname>org.richfaces.ExtendedDataTable</classname> - </para> - </listitem> - <listitem> - <para> - renderer-type: <classname>org.richfaces.ExtendedDataTableRenderer</classname> - </para> - </listitem> - <listitem> - <para> - tag-class: <classname>org.richfaces.taglib.ExtendedDataTableTag</classname> - </para> - </listitem> - </itemizedlist> <para> The <sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> component builds on the functionality of the <sgmltag>&lt;rich:dataTable&gt;</sgmltag> component, adding features such as data scrolling, row and column selection, and rearranging of columns. </para> @@ -964,125 +944,194 @@ </para> </listitem> </itemizedlist> - <para> - Basic use of the <sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> component requires the <varname>value</varname> and <varname>var</varname> attributes, the same as with the <sgmltag>&lt;rich:dataTable&gt;</sgmltag> component. Refer to <xref linkend="sect-Component_Reference-Tables_and_grids-richdataTable" /> for details. - </para> - <para> - The <varname>height</varname> attribute is mandatory, and defines the height of the table on the page. This is set to <literal>500px</literal> by default. The width of the table can be set by using the <varname>width</varname> attribute. As with the <sgmltag>&lt;rich:dataTable&gt;</sgmltag> component, the look of the <sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> component can be customized and skinned using the <literal>header</literal>, <literal>footer</literal>, and <literal>caption</literal> facets. - </para> - <example id="exam-Component_Reference-richextendedDataTable-richextendedDataTable_example"> - <title><sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> example</title> + <section id="sect-Component_Reference-richextendedDataTable-Basic_usage"> + <title>Basic usage</title> + <para> + Basic use of the <sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> component requires the <varname>value</varname> and <varname>var</varname> attributes, the same as with the <sgmltag>&lt;rich:dataTable&gt;</sgmltag> component. Refer to <xref linkend="sect-Component_Reference-Tables_and_grids-richdataTable" /> for details. + </para> + </section> + + <section id="sect-Component_Reference-richextendedDataTable-Table_appearance"> + <title>Table appearance</title> + <para> + The <varname>height</varname> attribute defines the height of the table on the page. This is set to <literal>500px</literal> by default. The width of the table can be set by using the <varname>width</varname> attribute. As with the <sgmltag>&lt;rich:dataTable&gt;</sgmltag> component, the look of the <sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> component can be customized and skinned using the <literal>header</literal>, <literal>footer</literal>, and <literal>caption</literal> facets. + </para> + </section> + + <section id="sect-Component_Reference-richextendedDataTable-Extended_features"> + <title>Extended features</title> + <example id="exam-Component_Reference-richextendedDataTable-richextendedDataTable_example"> + <title><sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> example</title> + <programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-Tables_and_grids-richextendedDataTable_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting> + <blockquote> + <figure id="figu-Component_Reference-richextendedDataTable_example-richextendedDataTable_example"> + <title><sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> example</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-Tables_and_grids-richextendedDataTable_example.png" format="PNG" width="444" /> + </imageobject> + <textobject> + <para> + A data table made using the <sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> component. It features scrolling data, column sorting, and a column filter. + </para> + </textobject> + </mediaobject> + </figure> + </blockquote> + </example> + <para> + <xref linkend="exam-Component_Reference-richextendedDataTable-richextendedDataTable_example" /> shows an example extended data table. The implementation features a scrolling data table, selection of one or more rows, sorting by columns, grouping by column, and a filter on the <guilabel>Name</guilabel> column. + </para> -<programlisting language="XML" role="XML"><xi:include href="extras/exam-Component_Reference-Tables_and_grids-richextendedDataTable_example.xml_sample" parse="text" xmlns:xi="http://www.w3.org/2001/XInclude" /> -</programlisting> - <blockquote> - <figure id="figu-Component_Reference-richextendedDataTable_example-richextendedDataTable_example"> - <title><sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> example</title> + <section id="sect-Component_Reference-richextendedDataTable-Row_selection"> + <title>Row selection</title> + <para> + Row selection is determined by the <varname>selectionMode</varname> attribute. Setting the attribute to <literal>none</literal> allows for no row selection capability. Setting the <varname>selectionMode</varname> attribute to <literal>single</literal> allows the user to select a single row at a time using the mouse. With the <varname>selectionMode</varname> attribute set to <literal>multi</literal>, the user can select multiple rows by holding down the <keycap function="shift">Shift</keycap> or <keycap function="control">Ctrl</keycap> keys while clicking. The <varname>selection</varname> attribute points to the object that tracks which rows are selected. <xref linkend="figu-Component_Reference-richextendedDataTable-Selecting_multiple_rows" /> shows the table from the example with multiple rows selected. + </para> + <figure id="figu-Component_Reference-richextendedDataTable-Selecting_multiple_rows"> + <title>Selecting multiple rows</title> <mediaobject> <imageobject> - <imagedata fileref="images/figu-Component_Reference-Tables_and_grids-richextendedDataTable_example.png" format="PNG" width="444" /> + <imagedata fileref="images/figu-Component_Reference-Tables_and_grids-Selecting_multiple_rows.png" format="PNG" width="444" /> </imageobject> <textobject> <para> - A data table made using the <sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> component. It features scrolling data, column sorting, and a column filter. + The example table with rows numbered 1, 2, 3, and 5 selected. </para> </textobject> </mediaobject> </figure> - </blockquote> - </example> - <para> - <xref linkend="exam-Component_Reference-richextendedDataTable-richextendedDataTable_example" /> shows an example extended data table. The implementation features a scrolling data table, selection of one or more rows, sorting by columns, grouping by column, and a filter on the <guilabel>Name</guilabel> column. - </para> - <para> - Row selection is determined by the <varname>selectionMode</varname> attribute. Setting the attribute to <literal>none</literal> allows for no row selection capability. Setting the <varname>selectionMode</varname> attribute to <literal>single</literal> allows the user to select a single row at a time using the mouse. With the <varname>selectionMode</varname> attribute set to <literal>multi</literal>, the user can select multiple rows by holding down the <keycap function="shift">Shift</keycap> or <keycap function="control">Ctrl</keycap> keys while clicking. The <varname>selection</varname> attribute points to the object that tracks which rows are selected. <xref linkend="figu-Component_Reference-richextendedDataTable-Selecting_multiple_rows" /> shows the table from the example with multiple rows selected. - </para> - <figure id="figu-Component_Reference-richextendedDataTable-Selecting_multiple_rows"> - <title>Selecting multiple rows</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-Tables_and_grids-Selecting_multiple_rows.png" format="PNG" width="444" /> - </imageobject> - <textobject> + </section> + + <section id="sect-Component_Reference-richextendedDataTable-Filtering"> + <title>Filtering</title> + <para> + The example uses the <literal>filter</literal> facet of the <sgmltag>&lt;rich:column&gt;</sgmltag> component to display the text field. A user can type their criteria into the text field to customize the filter of the column below. For full details on filtering tables, refer to <xref linkend="sect-Component_Reference-Tables_and_grids-Table_filtering" />. + </para> + </section> + + <section id="sect-Component_Reference-richextendedDataTable-Sorting"> + <title>Sorting</title> + <para> + When hovering the mouse over a column header, a menu button appears to the right-hand side, as shown in <xref linkend="figu-Component_Reference-richextendedDataTable-Column_menu" />. This menu allows the user to sort the contents of the column, group the table by the column, or hide and show columns. + </para> + <figure id="figu-Component_Reference-richextendedDataTable-Column_menu"> + <title>Column menu</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-Tables_and_grids-Column_menu.png" format="PNG" width="444" /> + </imageobject> + <textobject> + <para> + The menu for sorting, grouping, and hiding or showing columns. + </para> + </textobject> + </mediaobject> + </figure> + <para> + Each column can allow sorting by setting the <sgmltag>&lt;rich:column&gt;</sgmltag> component's <varname>sortable</varname> attribute to <literal>true</literal>. The value of the data model to sort by is specified with the <varname>sortBy</varname> attribute. In addition to using the menu for sorting, columns can be quickly sorted either ascending or descending by clicking on the directional icon next to the column title. The directional icons are defined in each <sgmltag>&lt;rich:column&gt;</sgmltag> component with the <varname>sortIconAscending</varname> and <varname>sortIconDescending</varname> attributes, for ascending and descending icons respectively. For full details on sorting tables, refer to <xref linkend="sect-Component_Reference-Tables_and_grids-Table_sorting" />. + </para> + </section> + + <section id="sect-Component_Reference-richextendedDataTable-Grouping"> + <title>Grouping</title> + <para> + Grouping the table's entries by a column will organize the table into collapsible sections, as shown in <xref linkend="figu-Component_Reference-richextendedDataTable-Grouping_table_entries_by_column" />. + </para> + <figure id="figu-Component_Reference-richextendedDataTable-Grouping_table_entries_by_column"> + <title>Grouping table entries by column</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-Tables_and_grids-Grouping_table_entries_by_column.png" format="PNG" width="444" /> + </imageobject> + <textobject> + <para> + A table with entries grouped by the <guilabel>Group</guilabel> column. + </para> + </textobject> + </mediaobject> + </figure> + </section> + + <section id="sect-Component_Reference-richextendedDataTable-Hiding_columns"> + <title>Hiding columns</title> + <para> + The checkboxes in the column menu under the <guisubmenu>Columns</guisubmenu> sub-menu will hide or show the respective columns, as shown in <xref linkend="figu-Component_Reference-richextendedDataTable-Hiding_columns" />. + </para> + <figure id="figu-Component_Reference-richextendedDataTable-Hiding_columns"> + <title>Hiding columns</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-Tables_and_grids-Hiding_columns.png" format="PNG" width="444" /> + </imageobject> + <textobject> + <para> + The <guilabel>Date</guilabel> and <guilabel>Group</guilabel> columns are hidden from the table. + </para> + </textobject> + </mediaobject> + </figure> + </section> + + <section id="sect-Component_Reference-richextendedDataTable-Rearranging_columns"> + <title>Rearranging columns</title> + <para> + Columns in a <sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> component can be rearranged by the user by dragging each column to a different position. The <varname>label</varname> attribute for the <sgmltag>&lt;rich:column&gt;</sgmltag> component is displayed during dragging, as shown in + </para> + <figure id="figu-Component_Reference-richextendedDataTable-Dragging_columns"> + <title>Dragging columns</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-Tables_and_grids-Dragging_columns.png" format="PNG" width="444" /> + </imageobject> + <textobject> + <para> + Dragging the <guilabel>Name</guilabel> column rearranges the order of the columns. + </para> + </textobject> + </mediaobject> + </figure> + </section> + + <section id="sect-Component_Reference-richextendedDataTable-Saving_the_state"> + <title>Saving the state</title> + <para> + Once the contents of the table have been rearranged and customized by the user, the <varname>tableState</varname> attribute can be used to preserve the customization so it can be restored later. The <varname>tableState</varname> attribute points to a backing-bean property which can in turn be saved to a database separate from standard JSF state-saving mechanisms. + </para> + </section> + + </section> + + <section id="sect-Component_Reference-richextendedDataTable-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> <para> - The example table with rows numbered 1, 2, 3, and 5 selected. + <parameter>component-type</parameter>: <classname>org.richfaces.ExtendedDataTable</classname> </para> - </textobject> - </mediaobject> - </figure> - <para> - The example uses the <literal>filter</literal> facet of the <sgmltag>&lt;rich:column&gt;</sgmltag> component to display the text field. A user can type their criteria into the text field to customize the filter of the column below. For full details on filtering tables, refer to <xref linkend="sect-Component_Reference-Tables_and_grids-Table_filtering" />. - </para> - <para> - When hovering the mouse over a column header, a menu button appears to the right-hand side, as shown in <xref linkend="figu-Component_Reference-richextendedDataTable-Column_menu" />. This menu allows the user to sort the contents of the column, group the table by the column, or hide and show columns. - </para> - <figure id="figu-Component_Reference-richextendedDataTable-Column_menu"> - <title>Column menu</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-Tables_and_grids-Column_menu.png" format="PNG" width="444" /> - </imageobject> - <textobject> + </listitem> + <listitem> <para> - The menu for sorting, grouping, and hiding or showing columns. + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlExtendedDataTable</classname> </para> - </textobject> - </mediaobject> - </figure> - <para> - Each column can allow sorting by setting the <sgmltag>&lt;rich:column&gt;</sgmltag> component's <varname>sortable</varname> attribute to <literal>true</literal>. The value of the data model to sort by is specified with the <varname>sortBy</varname> attribute. In addition to using the menu for sorting, columns can be quickly sorted either ascending or descending by clicking on the directional icon next to the column title. The directional icons are defined in each <sgmltag>&lt;rich:column&gt;</sgmltag> component with the <varname>sortIconAscending</varname> and <varname>sortIconDescending</varname> attributes, for ascending and descending icons respectively. For full details on sorting tables, refer to <xref linkend="sect-Component_Reference-Tables_and_grids-Table_sorting" />. - </para> - <para> - Grouping the table's entries by a column will organize the table into collapsible sections, as shown in <xref linkend="figu-Component_Reference-richextendedDataTable-Grouping_table_entries_by_column" />. - </para> - <figure id="figu-Component_Reference-richextendedDataTable-Grouping_table_entries_by_column"> - <title>Grouping table entries by column</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-Tables_and_grids-Grouping_table_entries_by_column.png" format="PNG" width="444" /> - </imageobject> - <textobject> + </listitem> + <listitem> <para> - A table with entries grouped by the <guilabel>Group</guilabel> column. + <parameter>component-family</parameter>: <classname>org.richfaces.ExtendedDataTable</classname> </para> - </textobject> - </mediaobject> - </figure> - <para> - The checkboxes in the column menu under the <guisubmenu>Columns</guisubmenu> sub-menu will hide or show the respective columns, as shown in <xref linkend="figu-Component_Reference-richextendedDataTable-Hiding_columns" />. - </para> - <figure id="figu-Component_Reference-richextendedDataTable-Hiding_columns"> - <title>Hiding columns</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-Tables_and_grids-Hiding_columns.png" format="PNG" width="444" /> - </imageobject> - <textobject> + </listitem> + <listitem> <para> - The <guilabel>Date</guilabel> and <guilabel>Group</guilabel> columns are hidden from the table. + <parameter>renderer-type</parameter>: <classname>org.richfaces.ExtendedDataTableRenderer</classname> </para> - </textobject> - </mediaobject> - </figure> - <para> - Columns in a <sgmltag>&lt;rich:extendedDataTable&gt;</sgmltag> component can be rearranged by the user by dragging each column to a different position. The <varname>label</varname> attribute for the <sgmltag>&lt;rich:column&gt;</sgmltag> component is displayed during dragging, as shown in - </para> - <figure id="figu-Component_Reference-richextendedDataTable-Dragging_columns"> - <title>Dragging columns</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/figu-Component_Reference-Tables_and_grids-Dragging_columns.png" format="PNG" width="444" /> - </imageobject> - <textobject> + </listitem> + <listitem> <para> - Dragging the <guilabel>Name</guilabel> column rearranges the order of the columns. + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.ExtendedDataTableTag</classname> </para> - </textobject> - </mediaobject> - </figure> - <para> - Once the contents of the table have been rearranged and customized by the user, the <varname>tableState</varname> attribute can be used to preserve the customization so it can be restored later. The <varname>tableState</varname> attribute points to a backing-bean property which can in turn be saved to a database separate from standard JSF state-saving mechanisms. - </para> + </listitem> + </itemizedlist> + </section> </section> <!-- TODO Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Validation.xml =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Validation.xml 2010-08-17 01:41:02 UTC (rev 18693) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Validation.xml 2010-08-17 04:56:25 UTC (rev 18694) @@ -11,27 +11,27 @@ <itemizedlist> <listitem> <para> - component-type: <classname>org.richfaces.ajaxValidator</classname> + <parameter>component-type</parameter>: <classname>org.richfaces.ajaxValidator</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.richfaces.component.html.HtmlajaxValidator</classname> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlajaxValidator</classname> </para> </listitem> <listitem> <para> - component-family: <classname>org.richfaces.ajaxValidator</classname> + <parameter>component-family</parameter>: <classname>org.richfaces.ajaxValidator</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.richfaces.ajaxValidatorRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.richfaces.ajaxValidatorRenderer</classname> </para> </listitem> <listitem> <para> - tag-class: <classname>org.richfaces.taglib.ajaxValidatorTag</classname> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.ajaxValidatorTag</classname> </para> </listitem> </itemizedlist> @@ -90,27 +90,27 @@ <itemizedlist> <listitem> <para> - component-type: <classname>org.richfaces.beanValidator</classname> + <parameter>component-type</parameter>: <classname>org.richfaces.beanValidator</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.richfaces.component.html.HtmlbeanValidator</classname> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlbeanValidator</classname> </para> </listitem> <listitem> <para> - component-family: <classname>org.richfaces.beanValidator</classname> + <parameter>component-family</parameter>: <classname>org.richfaces.beanValidator</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.richfaces.beanValidatorRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.richfaces.beanValidatorRenderer</classname> </para> </listitem> <listitem> <para> - tag-class: <classname>org.richfaces.taglib.beanValidatorTag</classname> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.beanValidatorTag</classname> </para> </listitem> </itemizedlist> @@ -159,27 +159,27 @@ <itemizedlist> <listitem> <para> - component-type: <classname>org.richfaces.graphValidator</classname> + <parameter>component-type</parameter>: <classname>org.richfaces.graphValidator</classname> </para> </listitem> <listitem> <para> - component-class: <classname>org.richfaces.component.html.HtmlgraphValidator</classname> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlgraphValidator</classname> </para> </listitem> <listitem> <para> - component-family: <classname>org.richfaces.graphValidator</classname> + <parameter>component-family</parameter>: <classname>org.richfaces.graphValidator</classname> </para> </listitem> <listitem> <para> - renderer-type: <classname>org.richfaces.graphValidatorRenderer</classname> + <parameter>renderer-type</parameter>: <classname>org.richfaces.graphValidatorRenderer</classname> </para> </listitem> <listitem> <para> - tag-class: <classname>org.richfaces.taglib.graphValidatorTag</classname> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.graphValidatorTag</classname> </para> </listitem> </itemizedlist> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumn-Basic_column_example.xml_sample (from rev 18693, branches/development/docs/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumn-Basic_column_example.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumn-Basic_column_example.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumn-Basic_column_example.xml_sample 2010-08-17 04:56:25 UTC (rev 18694) @@ -0,0 +1,18 @@ +<rich:dataTable value="#{capitalsBean.capitals}" var="cap" rows="5"> + <rich:column> + <f:facet name="header">State Flag</f:facet> + <h:graphicImage value="#{cap.stateFlag}"/> + </rich:column> + <rich:column> + <f:facet name="header">State Name</f:facet> + <h:outputText value="#{cap.state}"/> + </rich:column> + <rich:column > + <f:facet name="header">State Capital</f:facet> + <h:outputText value="#{cap.name}"/> + </rich:column> + <rich:column> + <f:facet name="header">Time Zone</f:facet> + <h:outputText value="#{cap.timeZone}"/> + </rich:column> +</rich:dataTable> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumn-Column_spanning_example.xml_sample (from rev 18693, branches/development/docs/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumn-Column_spanning_example.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumn-Column_spanning_example.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumn-Column_spanning_example.xml_sample 2010-08-17 04:56:25 UTC (rev 18694) @@ -0,0 +1,14 @@ +<rich:dataTable value="#{capitalsBean.capitals}" var="cap" rows="5"> + <rich:column colspan="3"> + <h:graphicImage value="#{cap.stateFlag}"/> + </rich:column> + <rich:column breakBefore="true"> + <h:outputText value="#{cap.state}"/> + </rich:column> + <rich:column > + <h:outputText value="#{cap.name}"/> + </rich:column> + <rich:column> + <h:outputText value="#{cap.timeZone}"/> + </rich:column> +</rich:dataTable> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumn-Row_spanning_example.xml_sample (from rev 18693, branches/development/docs/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumn-Row_spanning_example.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumn-Row_spanning_example.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumn-Row_spanning_example.xml_sample 2010-08-17 04:56:25 UTC (rev 18694) @@ -0,0 +1,16 @@ +<rich:dataTable value="#{capitalsBean.capitals}" var="cap" rows="5"> + <rich:column rowspan="3"> + <f:facet name="header">State Flag</f:facet> + <h:graphicImage value="#{cap.stateFlag}"/> + </rich:column> + <rich:column> + <f:facet name="header">State Info</f:facet> + <h:outputText value="#{cap.state}"/> + </rich:column> + <rich:column breakBefore="true"> + <h:outputText value="#{cap.name}"/> + </rich:column> + <rich:column breakBefore="true"> + <h:outputText value="#{cap.timeZone}"/> + </rich:column> +</rich:dataTable> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumnGroup-Complex_headers_using_column_groups.xml_sample (from rev 18693, branches/development/docs/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumnGroup-Complex_headers_using_column_groups.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumnGroup-Complex_headers_using_column_groups.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumnGroup-Complex_headers_using_column_groups.xml_sample 2010-08-17 04:56:25 UTC (rev 18694) @@ -0,0 +1,33 @@ +<rich:dataTable value="#{capitalsBean.capitals}" var="cap" rows="5" id="sublist"> + <f:facet name="header"> + <rich:columnGroup> + <rich:column rowspan="2"> + <h:outputText value="State Flag"/> + </rich:column> + <rich:column colspan="3"> + <h:outputText value="State Info"/> + </rich:column> + <rich:column breakBefore="true"> + <h:outputText value="State Name"/> + </rich:column> + <rich:column> + <h:outputText value="State Capital"/> + </rich:column> + <rich:column> + <h:outputText value="Time Zone"/> + </rich:column> + </rich:columnGroup> + </f:facet> + <rich:column> + <h:graphicImage value="#{cap.stateFlag}"/> + </rich:column> + <rich:column> + <h:outputText value="#{cap.state}"/> + </rich:column> + <rich:column> + <h:outputText value="#{cap.name}"/> + </rich:column> + <rich:column> + <h:outputText value="#{cap.timeZone}"/> + </rich:column> +</rich:dataTable> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumns-Basic_columns_example.xml_sample (from rev 18693, branches/development/docs/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumns-Basic_columns_example.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumns-Basic_columns_example.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumns-Basic_columns_example.xml_sample 2010-08-17 04:56:25 UTC (rev 18694) @@ -0,0 +1,10 @@ +<rich:dataTable value="#{dataTableScrollerBean.model}" var="model" width="750"> + <rich:columns value="#{dataTableScrollerBean.columns}" var="columns" index="ind" id="column#{ind}"> + <f:facet name="header"> + <h:outputText value="#{columns.header}" /> + </f:facet> + <h:outputText value="#{model[ind].model} " /> + <h:outputText value="#{model[ind].mileage} miles " /> + <h:outputText value="#{model[ind].price}$" /> + </rich:columns> +</rich:dataTable> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumns-Using_richcolumns_and_richcolumn_together.xml_sample (from rev 18693, branches/development/docs/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumns-Using_richcolumns_and_richcolumn_together.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumns-Using_richcolumns_and_richcolumn_together.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richcolumns-Using_richcolumns_and_richcolumn_together.xml_sample 2010-08-17 04:56:25 UTC (rev 18694) @@ -0,0 +1,23 @@ +<rich:dataTable value="#{dataTableScrollerBean.model}" var="model" width="500px" rows="5"> + <f:facet name="header"> + <h:outputText value="Cars Available"></h:outputText> + </f:facet> + <rich:columns value="#{dataTableScrollerBean.columns}" var="columns" index="ind"> + <f:facet name="header"> + <h:outputText value="#{columns.header}" /> + </f:facet> + <h:outputText value="#{model[ind].model} " /> + </rich:columns> + <rich:column> + <f:facet name="header"> + <h:outputText value="Price" /> + </f:facet> + <h:outputText value="Price" /> + </rich:column> + <rich:columns value="#{dataTableScrollerBean.columns}" var="columns" index="ind"> + <f:facet name="header"> + <h:outputText value="#{columns.header}" /> + </f:facet> + <h:outputText value="#{model[ind].mileage}$" /> + </rich:columns> +</rich:dataTable> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richdataGrid-ajaxKeys_example.xml_sample (from rev 18693, branches/development/docs/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richdataGrid-ajaxKeys_example.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richdataGrid-ajaxKeys_example.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richdataGrid-ajaxKeys_example.xml_sample 2010-08-17 04:56:25 UTC (rev 18694) @@ -0,0 +1,5 @@ +<rich:dataGrid value="#{dataTableScrollerBean.allCars}" var="car" ajaxKeys="#{listBean.list}" binding="#{listBean.dataGrid}" id="grid" elements="4" columns="2"> + ... +</rich:dataGrid> +... +<a4j:commandButton action="#{listBean.action}" reRender="grid" value="Submit"/> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richinplaceSelect-Defining_list_items_for_richinplaceSelect.xml_sample (from rev 18693, branches/development/docs/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richinplaceSelect-Defining_list_items_for_richinplaceSelect.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richinplaceSelect-Defining_list_items_for_richinplaceSelect.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richinplaceSelect-Defining_list_items_for_richinplaceSelect.xml_sample 2010-08-17 04:56:25 UTC (rev 18694) @@ -0,0 +1,7 @@ +<rich:inplaceSelect value="#{bean.inputValue}" defaultLabel="click to edit" > + <f:selectItems value="#{bean.selectItems}" /> + <f.selectItem itemValue="1" itemLabel="Item 1" /> + <f.selectItem itemValue="2" itemLabel="Item 2" /> + <f.selectItem itemValue="3" itemLabel="Item 3" /> + <f.selectItem itemValue="4" itemLabel="Item 4" /> +</rich:comboBox> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richjQuery-Avoiding_syntax_confusion_0.xml_sample (from rev 18693, branches/development/docs/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richjQuery-Avoiding_syntax_confusion_0.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richjQuery-Avoiding_syntax_confusion_0.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richjQuery-Avoiding_syntax_confusion_0.xml_sample 2010-08-17 04:56:25 UTC (rev 18694) @@ -0,0 +1,6 @@ +<h:form id="form"> + <h:panelGrid id="menu"> + <h:graphicImage value="pic1.jpg" /> + <h:graphicImage value="pic2.jpg" /> + </h:panelGrid> +</h:form> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richjQuery-Avoiding_syntax_confusion_1.xml_sample (from rev 18693, branches/development/docs/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richjQuery-Avoiding_syntax_confusion_1.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richjQuery-Avoiding_syntax_confusion_1.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richjQuery-Avoiding_syntax_confusion_1.xml_sample 2010-08-17 04:56:25 UTC (rev 18694) @@ -0,0 +1 @@ +<rich:jQuery selector="#form\\:menu img" query="..." /> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richjQuery-Calling_a_richjQuery_component_as_a_function.xml_sample (from rev 18693, branches/development/docs/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richjQuery-Calling_a_richjQuery_component_as_a_function.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richjQuery-Calling_a_richjQuery_component_as_a_function.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richjQuery-Calling_a_richjQuery_component_as_a_function.xml_sample 2010-08-17 04:56:25 UTC (rev 18694) @@ -0,0 +1,5 @@ +<h:graphicImage width="50" value="/images/price.png" onmouseover="enlargePic(this, {pwidth:'60px'})" onmouseout="releasePic(this)" /> +<h:graphicImage width="50" value="/images/discount.png" onmouseover="enlargePic(this, {pwidth:'100px'})" onmouseout="releasePic(this)" /> +... +<rich:jQuery name="enlargePic" timing="onJScall" query="animate({width:param.pwidth})" /> +<rich:jQuery name="releasePic" timing="onJScall" query="animate({width:'50px'})"/> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richjQuery-Using_the_jQuery_JavaScript_framework.xml_sample (from rev 18693, branches/development/docs/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richjQuery-Using_the_jQuery_JavaScript_framework.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richjQuery-Using_the_jQuery_JavaScript_framework.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richjQuery-Using_the_jQuery_JavaScript_framework.xml_sample 2010-08-17 04:56:25 UTC (rev 18694) @@ -0,0 +1 @@ +<a4j:loadScript src="resource://jquery.js"/> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richjQuery-richjQuery_example.xml_sample (from rev 18693, branches/development/docs/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richjQuery-richjQuery_example.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richjQuery-richjQuery_example.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richjQuery-richjQuery_example.xml_sample 2010-08-17 04:56:25 UTC (rev 18694) @@ -0,0 +1,5 @@ +<rich:dataTable id="customList" ... > + ... +</rich:dataTable> + +<rich:jQuery selector="#customList tr:odd" timing="onload" query="addClass(odd)" /> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richpanel-Adding_a_header-0.xml_sample (from rev 18693, branches/development/docs/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richpanel-Adding_a_header-0.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richpanel-Adding_a_header-0.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richpanel-Adding_a_header-0.xml_sample 2010-08-17 04:56:25 UTC (rev 18694) @@ -0,0 +1,3 @@ +<rich:panel header="This is the panel header"> + <h:outputText value="This is the panel content" /> +</rich:panel> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richpanel-Adding_a_header-1.xml_sample (from rev 18693, branches/development/docs/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richpanel-Adding_a_header-1.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richpanel-Adding_a_header-1.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richpanel-Adding_a_header-1.xml_sample 2010-08-17 04:56:25 UTC (rev 18694) @@ -0,0 +1,6 @@ +<rich:panel> + <f:facet name="header"> + <h:outputText value="This is the panel header"> + </f:facet> + <h:outputText value="This is the panel content" /> +</rich:panel> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richtogglePanel-State_order_example.xml_sample (from rev 18693, branches/development/docs/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richtogglePanel-State_order_example.xml_sample) =================================================================== --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richtogglePanel-State_order_example.xml_sample (rev 0) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richtogglePanel-State_order_example.xml_sample 2010-08-17 04:56:25 UTC (rev 18694) @@ -0,0 +1,12 @@ +<rich:togglePanel id="panel" initialState="panelB" switchType="client" stateOrder="panelA,panelB,panelC"> + <f:facet name="panelA"> + ... + </f:facet> + <f:facet name="panelB"> + ... + </f:facet> + <f:facet name="panelC"> + ... + </f:facet> +</rich:togglePanel> +<rich:toggleControl for="panel" value="Switch"/> Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richpanel-Adding_a_header.png (from rev 18693, branches/development/docs/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richpanel-Adding_a_header.png) =================================================================== (Binary files differ) Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richpanel-richpanel.png (from rev 18693, branches/development/docs/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richpanel-richpanel.png) =================================================================== (Binary files differ) Copied: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richpanelBar-richpanelBar.png (from rev 18693, branches/development/docs/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richpanelBar-richpanelBar.png) =================================================================== (Binary files differ)