From richfaces-svn-commits at lists.jboss.org Tue Mar 1 01:06:09 2011 Content-Type: multipart/mixed; boundary="===============7385213512641166893==" MIME-Version: 1.0 From: richfaces-svn-commits at lists.jboss.org To: richfaces-svn-commits at lists.jboss.org Subject: [richfaces-svn-commits] JBoss Rich Faces SVN: r21995 - modules/docs/trunk/Component_Reference/src/main/docbook/en-US. Date: Tue, 01 Mar 2011 01:06:09 -0500 Message-ID: <201103010606.p21669qI030758@svn01.web.mwc.hst.phx2.redhat.com> --===============7385213512641166893== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: SeanRogers Date: 2011-03-01 01:06:08 -0500 (Tue, 01 Mar 2011) New Revision: 21995 Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Compo= nent_Reference-Menus_and_toolbars.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Compo= nent_Reference-Output_and_messages.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Compo= nent_Reference-Panels_and_containers.xml modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Compo= nent_Reference-Tables_and_grids.xml Log: Completed API details RFPL-1085 Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/cha= p-Component_Reference-Menus_and_toolbars.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp= onent_Reference-Menus_and_toolbars.xml 2011-03-01 04:07:07 UTC (rev 21994) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp= onent_Reference-Menus_and_toolbars.xml 2011-03-01 06:06:08 UTC (rev 21995) @@ -252,6 +252,23 @@ + = +
+ JavaScript API + + The <rich:menuItem> component can be cont= rolled through the JavaScript API. The JavaScript API provides the followin= g functions: + + + + activate() + + + Activate the menu item as though it were selected. + + + + +
=
Reference data @@ -342,6 +359,31 @@
--> + = +
+ JavaScript API + + The <rich:menuGroup> component can be con= trolled through the JavaScript API. The JavaScript API provides the followi= ng functions: + + + + show() + + + Show the menu group. + + + + + hide() + + + Hide the menu group. + + + + +
=
Reference data @@ -625,6 +667,39 @@ The <rich:panelMenu> component fires the ItemChangeEvent event on the server side when the menu is ch= anged. The event only fires in the server and a= jax submission modes. The event provides the itemChangeL= istener attribute to reference the event listener.
+ = +
+ JavaScript API + + The <rich:panelMenu> component can be con= trolled through the JavaScript API. The JavaScript API provides the followi= ng functions: + + + + expandAll() + + + Expand all the panel menu groups in the component. + + + + + collapseAll() + + + Collapse all the panel menu groups in the component. + + + + + selectItem(id) + + + Select the menu item with the id i= dentifier. + + + + +
=
Reference data @@ -743,6 +818,39 @@ The <rich:panelMenuGroup> component fires th= e ActionEvent event on the server side when the menu gro= up receives a user action. The event only fires in the server and ajax submission modes. The event provides the = action attribute to specify the user action performed, a= nd the actionListener attribute to reference the event l= istener.
+ = +
+ JavaScript API + + The <rich:panelMenuGroup> component can be= controlled through the JavaScript API. The JavaScript API provides the fol= lowing functions: + + + + expand() + + + Expand this panel menu group. + + + + + collapse() + + + Collapse this panel menu group. + + + + + select(id) + + + Select the menu item with the id id= entifier. + + + + +
=
Reference data @@ -855,6 +963,23 @@ The <rich:panelMenuItem> component fires the= ActionEvent event on the server side when the menu item= receives a user action. The event only fires in the server and ajax submission modes. The event provides the action attribute to specify the user action performed, and= the actionListener attribute to reference the event lis= tener.
+ = +
+ JavaScript API + + The <rich:panelMenuItem> component can be = controlled through the JavaScript API. The JavaScript API provides the foll= owing functions: + + + + select() + + + Select this menu item. + + + + +
=
Reference data Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/cha= p-Component_Reference-Output_and_messages.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp= onent_Reference-Output_and_messages.xml 2011-03-01 04:07:07 UTC (rev 21994) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp= onent_Reference-Output_and_messages.xml 2011-03-01 06:06:08 UTC (rev 21995) @@ -418,6 +418,71 @@
= +
+ JavaScript API + + The <rich:progressBar> component can be c= ontrolled through the JavaScript API. The JavaScript API provides the follo= wing functions: + + + + getValue() + + + Return the current value displayed on the progress bar. + + + + + setValue() + + + Set the current value to display on the progress bar. + + + + + getMinValue() + + + Return the minimum value for the progress bar. + + + + + getMaxValue() + + + Return the maximum value for the progress bar. + + + + + disable() + + + Disables the progress bar. + + + + + enable() + + + Enables the progress bar. + + + + + isEnabled() + + + Returns a boolean value indicating whether the progress b= ar is enabled. + + + + +
+ =
Reference data @@ -636,6 +701,31 @@
= +
+ JavaScript API + + The <rich:toolTip> component can be contr= olled through the JavaScript API. The JavaScript API provides the following= functions: + + + + show(event) + + + Show the tool-tip. + + + + + hide(event) + + + Hide the tool-tip. + + + + +
+ =
Reference data Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/cha= p-Component_Reference-Panels_and_containers.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp= onent_Reference-Panels_and_containers.xml 2011-03-01 04:07:07 UTC (rev 2199= 4) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp= onent_Reference-Panels_and_containers.xml 2011-03-01 06:06:08 UTC (rev 2199= 5) @@ -623,6 +623,63 @@
= +
+ JavaScript API + + The <rich:popupPanel> component can be co= ntrolled through the JavaScript API. The JavaScript API provides the follow= ing functions: + + + + getTop() + + + Return the top co-ordinate for the position of the pop-up= panel. + + + + + getLeft() + + + Return the left co-ordinate for the position of the pop-u= p panel. + + + + + moveTo(top,left) + + + Move the pop-up panel to the co-ordinates specified with = the top and left parameters. + + + + + resize(width,height) + + + Resize the pop-up panel to the size specified with the width and height parameters. + + + + + show() + + + Show the pop-up panel. + + + + + hide() + + + Hide the pop-up panel. + + + + +
+ =
Reference data Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/cha= p-Component_Reference-Tables_and_grids.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp= onent_Reference-Tables_and_grids.xml 2011-03-01 04:07:07 UTC (rev 21994) +++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Comp= onent_Reference-Tables_and_grids.xml 2011-03-01 06:06:08 UTC (rev 21995) @@ -671,6 +671,71 @@
= +
+ JavaScript API + + The <rich:dataScroller> component can be = controlled through the JavaScript API. The JavaScript API provides the foll= owing functions: + + + + switchToPage(pageIndex) + + + Switch to the page specified with the pageInde= x parameter. + + + + + next() + + + Switch to the next page. + + + + + previous() + + + Switch to the previous page. + + + + + first() + + + Switch to the first page. + + + + + last() + + + Switch to the last page. + + + + + fastForward() + + + Step forward through the pages by the fastStep amount. + + + + + fastRewind() + + + Step backward through the pages by the fastStep<= /varname> amount. + + + + +
+ =
Reference data @@ -761,6 +826,55 @@
= +
+ JavaScript API + + The <rich:dataTable> component can be con= trolled through the JavaScript API. The JavaScript API provides the followi= ng functions: + + + + expandAllSubTables() + + + Expand any sub-tables contained in the data table. + + + + + collapseAllSubTables() + + + Collapse any sub-tables contained in the data table. + + + + + switchSubTables() + + + Switch the expanded or collapsed state of any sub-tables = contained in the data table. + + + + + filter(columnId, newFilterValue, [isClearPrevio= usFilters]) + + + Filter the table based on the column specified with the <= parameter>columnId parameter. Use the newFilterValue= parameter as the filter value. The optional isClear= PreviousFilters parameter is a boolean value which, if set to <= literal>true, will clear any previous filters applied to the tabl= e. + + + + + sort(columnId, [direction], [isClearPreviousSor= ting]) + + + Sort the table based on the column specified with the columnId parameter. The option direction parameter specifies whether to sort in ascending or descending ord= er. The optional isClearPreviousSorting parameter is= a boolean value which, if set to true, will clear any p= revious sorting applied to the table. + + + + +
+ =
Reference data @@ -796,7 +910,65 @@ Style classes and skin parameters
+ + + = = @@ -1009,6 +1181,79 @@ = = +
+ JavaScript API + + The <rich:extendedDataTable> component ca= n be controlled through the JavaScript API. The JavaScript API provides the= following functions: + + + + sort() + + + Sort the data table. + + + + + filter() + + + Filter the data table. + + + + + clearSorting() + + + Clear any sorting that is currently applied to the table. + + + + + clearFiltering() + + + Clear any filtering that is currently applied to the tabl= e. + + + + + selectRow(index) + + + Select the row specified by the index parameter. + + + + + selectRows([startIndex, stopIndex])<= /term> + + + Select all the rows in the table. Optionally, select only= those rows between the indexes specified with the startIndex and stopIndex parameters. + + + + + deselectRow + + + Deselect the row that is currently selected. + + + + + setActiveRow(index) + + + Set the active row to that specified by the in= dex parameter. + + + + +
+ =
Reference data --===============7385213512641166893==--