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-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-Tables_and_grids.xml
Log:
Completed API details RFPL-1085
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 2011-03-01
04:07:07 UTC (rev 21994)
+++
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Menus_and_toolbars.xml 2011-03-01
06:06:08 UTC (rev 21995)
@@ -252,6 +252,23 @@
</listitem>
</itemizedlist>
</section>
+
+ <section id="sect-Component_Reference-richmenuItem-JavaScript_API">
+ <title>JavaScript API</title>
+ <para>
+ The <sgmltag><rich:menuItem></sgmltag> component can be
controlled through the JavaScript API. The JavaScript API provides the following
functions:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><function>activate()</function></term>
+ <listitem>
+ <para>
+ Activate the menu item as though it were selected.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
<section id="sect-Component_Reference-richmenuItem-Reference_data">
<title>Reference data</title>
@@ -342,6 +359,31 @@
</itemizedlist>
</section>
-->
+
+ <section id="sect-Component_Reference-richmenuGroup-JavaScript_API">
+ <title>JavaScript API</title>
+ <para>
+ The <sgmltag><rich:menuGroup></sgmltag> component can
be controlled through the JavaScript API. The JavaScript API provides the following
functions:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><function>show()</function></term>
+ <listitem>
+ <para>
+ Show the menu group.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>hide()</function></term>
+ <listitem>
+ <para>
+ Hide the menu group.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
<section id="sect-Component_Reference-richmenuGroup-Reference_data">
<title>Reference data</title>
@@ -625,6 +667,39 @@
The <sgmltag><rich:panelMenu></sgmltag> component fires the
<literal>ItemChangeEvent</literal> event on the server side when the menu is
changed. The event only fires in the <literal>server</literal> and
<literal>ajax</literal> submission modes. The event provides the
<varname>itemChangeListener</varname> attribute to reference the event
listener.
</para>
</section>
+
+ <section id="sect-Component_Reference-richpanelMenu-JavaScript_API">
+ <title>JavaScript API</title>
+ <para>
+ The <sgmltag><rich:panelMenu></sgmltag> component can
be controlled through the JavaScript API. The JavaScript API provides the following
functions:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><function>expandAll()</function></term>
+ <listitem>
+ <para>
+ Expand all the panel menu groups in the component.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>collapseAll()</function></term>
+ <listitem>
+ <para>
+ Collapse all the panel menu groups in the component.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>selectItem(id)</function></term>
+ <listitem>
+ <para>
+ Select the menu item with the <parameter>id</parameter>
identifier.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
<section id="sect-Component_Reference-richpanelMenu-Reference_data">
<title>Reference data</title>
@@ -743,6 +818,39 @@
The <sgmltag><rich:panelMenuGroup></sgmltag> component
fires the <literal>ActionEvent</literal> event on the server side when the
menu group receives a user action. The event only fires in the
<literal>server</literal> and <literal>ajax</literal> submission
modes. The event provides the <varname>action</varname> attribute to specify
the user action performed, and the <varname>actionListener</varname> attribute
to reference the event listener.
</para>
</section>
+
+ <section
id="sect-Component_Reference-richpanelMenuGroup-JavaScript_API">
+ <title>JavaScript API</title>
+ <para>
+ The <sgmltag><rich:panelMenuGroup></sgmltag> component
can be controlled through the JavaScript API. The JavaScript API provides the following
functions:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><function>expand()</function></term>
+ <listitem>
+ <para>
+ Expand this panel menu group.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>collapse()</function></term>
+ <listitem>
+ <para>
+ Collapse this panel menu group.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>select(id)</function></term>
+ <listitem>
+ <para>
+ Select the menu item with the <parameter>id</parameter>
identifier.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
<section
id="sect-Component_Reference-richpanelMenuGroup-Reference_data">
<title>Reference data</title>
@@ -855,6 +963,23 @@
The <sgmltag><rich:panelMenuItem></sgmltag> component
fires the <literal>ActionEvent</literal> event on the server side when the
menu item receives a user action. The event only fires in the
<literal>server</literal> and <literal>ajax</literal> submission
modes. The event provides the <varname>action</varname> attribute to specify
the user action performed, and the <varname>actionListener</varname> attribute
to reference the event listener.
</para>
</section>
+
+ <section
id="sect-Component_Reference-richpanelMenuItem-JavaScript_API">
+ <title>JavaScript API</title>
+ <para>
+ The <sgmltag><rich:panelMenuItem></sgmltag> component
can be controlled through the JavaScript API. The JavaScript API provides the following
functions:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><function>select()</function></term>
+ <listitem>
+ <para>
+ Select this menu item.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
<section
id="sect-Component_Reference-richpanelMenuItem-Reference_data">
<title>Reference data</title>
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 2011-03-01
04:07:07 UTC (rev 21994)
+++
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Output_and_messages.xml 2011-03-01
06:06:08 UTC (rev 21995)
@@ -418,6 +418,71 @@
</variablelist>
</section>
+ <section id="sect-Component_Reference-richprogressBar-JavaScript_API">
+ <title>JavaScript API</title>
+ <para>
+ The <sgmltag><rich:progressBar></sgmltag> component can
be controlled through the JavaScript API. The JavaScript API provides the following
functions:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><function>getValue()</function></term>
+ <listitem>
+ <para>
+ Return the current value displayed on the progress bar.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>setValue()</function></term>
+ <listitem>
+ <para>
+ Set the current value to display on the progress bar.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>getMinValue()</function></term>
+ <listitem>
+ <para>
+ Return the minimum value for the progress bar.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>getMaxValue()</function></term>
+ <listitem>
+ <para>
+ Return the maximum value for the progress bar.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>disable()</function></term>
+ <listitem>
+ <para>
+ Disables the progress bar.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>enable()</function></term>
+ <listitem>
+ <para>
+ Enables the progress bar.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>isEnabled()</function></term>
+ <listitem>
+ <para>
+ Returns a boolean value indicating whether the progress bar is enabled.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+
<section id="sect-Component_Reference-richprogressBar-Reference_data">
<title>Reference data</title>
<itemizedlist>
@@ -636,6 +701,31 @@
</variablelist>
</section>
+ <section id="sect-Component_Reference-richtoolTip-JavaScript_API">
+ <title>JavaScript API</title>
+ <para>
+ The <sgmltag><rich:toolTip></sgmltag> component can be
controlled through the JavaScript API. The JavaScript API provides the following
functions:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><function>show(event)</function></term>
+ <listitem>
+ <para>
+ Show the tool-tip.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>hide(event)</function></term>
+ <listitem>
+ <para>
+ Hide the tool-tip.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+
<section id="sect-Component_Reference-richtoolTip-Reference_data">
<title>Reference data</title>
<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 2011-03-01
04:07:07 UTC (rev 21994)
+++
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Panels_and_containers.xml 2011-03-01
06:06:08 UTC (rev 21995)
@@ -623,6 +623,63 @@
</example>
</section>
+ <section id="sect-Component_Reference-richpopupPanel-JavaScript_API">
+ <title>JavaScript API</title>
+ <para>
+ The <sgmltag><rich:popupPanel></sgmltag> component can
be controlled through the JavaScript API. The JavaScript API provides the following
functions:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><function>getTop()</function></term>
+ <listitem>
+ <para>
+ Return the top co-ordinate for the position of the pop-up panel.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>getLeft()</function></term>
+ <listitem>
+ <para>
+ Return the left co-ordinate for the position of the pop-up panel.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>moveTo(top,left)</function></term>
+ <listitem>
+ <para>
+ Move the pop-up panel to the co-ordinates specified with the
<parameter>top</parameter> and <parameter>left</parameter>
parameters.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+
<term><function>resize(width,height)</function></term>
+ <listitem>
+ <para>
+ Resize the pop-up panel to the size specified with the
<parameter>width</parameter> and <parameter>height</parameter>
parameters.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>show()</function></term>
+ <listitem>
+ <para>
+ Show the pop-up panel.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>hide()</function></term>
+ <listitem>
+ <para>
+ Hide the pop-up panel.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+
<section id="sect-Component_Reference-richpopupPanel-Reference_data">
<title>Reference data</title>
<itemizedlist>
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 2011-03-01
04:07:07 UTC (rev 21994)
+++
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Tables_and_grids.xml 2011-03-01
06:06:08 UTC (rev 21995)
@@ -671,6 +671,71 @@
</para>
</section>
+ <section
id="sect-Component_Reference-richdataScroller-JavaScript_API">
+ <title>JavaScript API</title>
+ <para>
+ The <sgmltag><rich:dataScroller></sgmltag> component
can be controlled through the JavaScript API. The JavaScript API provides the following
functions:
+ </para>
+ <variablelist>
+ <varlistentry>
+
<term><function>switchToPage(pageIndex)</function></term>
+ <listitem>
+ <para>
+ Switch to the page specified with the
<parameter>pageIndex</parameter> parameter.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>next()</function></term>
+ <listitem>
+ <para>
+ Switch to the next page.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>previous()</function></term>
+ <listitem>
+ <para>
+ Switch to the previous page.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>first()</function></term>
+ <listitem>
+ <para>
+ Switch to the first page.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>last()</function></term>
+ <listitem>
+ <para>
+ Switch to the last page.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>fastForward()</function></term>
+ <listitem>
+ <para>
+ Step forward through the pages by the
<varname>fastStep</varname> amount.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>fastRewind()</function></term>
+ <listitem>
+ <para>
+ Step backward through the pages by the
<varname>fastStep</varname> amount.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+
<section
id="sect-Component_Reference-richdataScroller-Reference_data">
<title>Reference data</title>
<itemizedlist>
@@ -761,6 +826,55 @@
</para>
</section>
+ <section id="sect-Component_Reference-richdataTable-JavaScript_API">
+ <title>JavaScript API</title>
+ <para>
+ The <sgmltag><rich:dataTable></sgmltag> component can
be controlled through the JavaScript API. The JavaScript API provides the following
functions:
+ </para>
+ <variablelist>
+ <varlistentry>
+
<term><function>expandAllSubTables()</function></term>
+ <listitem>
+ <para>
+ Expand any sub-tables contained in the data table.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+
<term><function>collapseAllSubTables()</function></term>
+ <listitem>
+ <para>
+ Collapse any sub-tables contained in the data table.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>switchSubTables()</function></term>
+ <listitem>
+ <para>
+ Switch the expanded or collapsed state of any sub-tables contained in
the data table.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>filter(columnId, newFilterValue,
[isClearPreviousFilters])</function></term>
+ <listitem>
+ <para>
+ Filter the table based on the column specified with the
<parameter>columnId</parameter> parameter. Use the
<parameter>newFilterValue</parameter> parameter as the filter value. The
optional <parameter>isClearPreviousFilters</parameter> parameter is a boolean
value which, if set to <literal>true</literal>, will clear any previous
filters applied to the table.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>sort(columnId, [direction],
[isClearPreviousSorting])</function></term>
+ <listitem>
+ <para>
+ Sort the table based on the column specified with the
<parameter>columnId</parameter> parameter. The option
<parameter>direction</parameter> parameter specifies whether to sort in
ascending or descending order. The optional
<parameter>isClearPreviousSorting</parameter> parameter is a boolean value
which, if set to <literal>true</literal>, will clear any previous sorting
applied to the table.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+
<section id="sect-Component_Reference-richdataTable-Reference_data">
<title>Reference data</title>
<itemizedlist>
@@ -796,7 +910,65 @@
<title>Style classes and skin parameters</title>
<xi:include href="skinning/tabl-richdataTable.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
+
+ <!--
+ <section
id="sect-Component_Reference-Tables_and_grids-richcollapsibleSubTable">
+ <title><sgmltag><rich:collapsibleSubTable></sgmltag></title>
+ <para>
+ <sgmltag><rich:collapsibleSubTable></sgmltag>
+ </para>
+ <section id="sect-Component_Reference-richdataTable-JavaScript_API">
+ <title>JavaScript API</title>
+ <para>
+ The <sgmltag><rich:dataTable></sgmltag> component can be
controlled through the JavaScript API. The JavaScript API provides the following
functions:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><function>expandAllSubTables()</function></term>
+ <listitem>
+ <para>
+ Expand any sub-tables contained in the data table.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+
<term><function>collapseAllSubTables()</function></term>
+ <listitem>
+ <para>
+ Collapse any sub-tables contained in the data table.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>switchSubTables()</function></term>
+ <listitem>
+ <para>
+ Switch the expanded or collapsed state of any sub-tables contained in the
data table.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>filter(columnId, newFilterValue,
[isClearPreviousFilters])</function></term>
+ <listitem>
+ <para>
+ Filter the table based on the column specified with the
<parameter>columnId</parameter> parameter. Use the
<parameter>newFilterValue</parameter> parameter as the filter value. The
optional <parameter>isClearPreviousFilters</parameter> parameter is a boolean
value which, if set to <literal>true</literal>, will clear any previous
filters applied to the table.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>sort(columnId, [direction],
[isClearPreviousSorting])</function></term>
+ <listitem>
+ <para>
+ Sort the table based on the column specified with the
<parameter>columnId</parameter> parameter. The option
<parameter>direction</parameter> parameter specifies whether to sort in
ascending or descending order. The optional
<parameter>isClearPreviousSorting</parameter> parameter is a boolean value
which, if set to <literal>true</literal>, will clear any previous sorting
applied to the table.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+ </section>
+ -->
+
</section>
<!--<rich:extendedDataTable>-->
@@ -1009,6 +1181,79 @@
</section>
+ <section
id="sect-Component_Reference-richextendedDataTable-JavaScript_API">
+ <title>JavaScript API</title>
+ <para>
+ The <sgmltag><rich:extendedDataTable></sgmltag>
component can be controlled through the JavaScript API. The JavaScript API provides the
following functions:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><function>sort()</function></term>
+ <listitem>
+ <para>
+ Sort the data table.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>filter()</function></term>
+ <listitem>
+ <para>
+ Filter the data table.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>clearSorting()</function></term>
+ <listitem>
+ <para>
+ Clear any sorting that is currently applied to the table.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>clearFiltering()</function></term>
+ <listitem>
+ <para>
+ Clear any filtering that is currently applied to the table.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>selectRow(index)</function></term>
+ <listitem>
+ <para>
+ Select the row specified by the <parameter>index</parameter>
parameter.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>selectRows([startIndex,
stopIndex])</function></term>
+ <listitem>
+ <para>
+ Select all the rows in the table. Optionally, select only those rows
between the indexes specified with the <parameter>startIndex</parameter> and
<parameter>stopIndex</parameter> parameters.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>deselectRow</function></term>
+ <listitem>
+ <para>
+ Deselect the row that is currently selected.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><function>setActiveRow(index)</function></term>
+ <listitem>
+ <para>
+ Set the active row to that specified by the
<parameter>index</parameter> parameter.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+
<section
id="sect-Component_Reference-richextendedDataTable-Reference_data">
<title>Reference data</title>
<itemizedlist>