richfaces-svn-commits
March 2011
richfaces-svn-commits@lists.jboss.org
- 1 participants
- 355 discussions
JBoss Rich Faces SVN: r21998 - modules/tests/metamer/trunk/ftest-source/src/main/java/org/richfaces/tests/metamer/ftest/richPanelMenu.
by richfaces-svn-commits＠lists.jboss.org
Author: lfryc(a)redhat.com
Date: 2011-03-01 04:18:10 -0500 (Tue, 01 Mar 2011)
New Revision: 21998
Modified:
modules/tests/metamer/trunk/ftest-source/src/main/java/org/richfaces/tests/metamer/ftest/richPanelMenu/TestPanelMenuDOMEvents.java
Log:
fixed group expanded/collapsed conditions - added isElementPresent condition
Modified: modules/tests/metamer/trunk/ftest-source/src/main/java/org/richfaces/tests/metamer/ftest/richPanelMenu/TestPanelMenuDOMEvents.java
===================================================================
--- modules/tests/metamer/trunk/ftest-source/src/main/java/org/richfaces/tests/metamer/ftest/richPanelMenu/TestPanelMenuDOMEvents.java 2011-03-01 09:03:46 UTC (rev 21997)
+++ modules/tests/metamer/trunk/ftest-source/src/main/java/org/richfaces/tests/metamer/ftest/richPanelMenu/TestPanelMenuDOMEvents.java 2011-03-01 09:18:10 UTC (rev 21998)
@@ -38,7 +38,6 @@
import org.jboss.test.selenium.waiting.selenium.SeleniumWaiting;
import org.richfaces.PanelMenuMode;
import org.richfaces.tests.metamer.ftest.annotations.Inject;
-import org.richfaces.tests.metamer.ftest.annotations.IssueTracking;
import org.richfaces.tests.metamer.ftest.annotations.Use;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;
@@ -61,13 +60,13 @@
SeleniumCondition isGroup2Expanded = new SeleniumCondition() {
public boolean isTrue() {
- return group2.isExpanded();
+ return selenium.isElementPresent(group2) && group2.isExpanded();
}
};
SeleniumCondition isGroup2Collapsed = new SeleniumCondition() {
public boolean isTrue() {
- return group2.isCollapsed();
+ return selenium.isElementPresent(group2) && group2.isCollapsed();
}
};
@@ -96,7 +95,6 @@
}
@Test
- @IssueTracking("https://issues.jboss.org/browse/RF-10481")
@Use(field = "mode", enumeration = true)
public void testCollapseEvent() {
attributes.setCollapseEvent(event.getEventName());
13 years, 10 months
- 1
- 0
JBoss Rich Faces SVN: r21997 - modules/tests/metamer/trunk/ftest-source/src/main/java/org/richfaces/tests/metamer/ftest.
by richfaces-svn-commits＠lists.jboss.org
Author: lfryc(a)redhat.com
Date: 2011-03-01 04:03:46 -0500 (Tue, 01 Mar 2011)
New Revision: 21997
Modified:
modules/tests/metamer/trunk/ftest-source/src/main/java/org/richfaces/tests/metamer/ftest/DelayTester.java
Log:
changed minimal maximum deviation for DelayTester
Modified: modules/tests/metamer/trunk/ftest-source/src/main/java/org/richfaces/tests/metamer/ftest/DelayTester.java
===================================================================
--- modules/tests/metamer/trunk/ftest-source/src/main/java/org/richfaces/tests/metamer/ftest/DelayTester.java 2011-03-01 08:58:44 UTC (rev 21996)
+++ modules/tests/metamer/trunk/ftest-source/src/main/java/org/richfaces/tests/metamer/ftest/DelayTester.java 2011-03-01 09:03:46 UTC (rev 21997)
@@ -82,7 +82,7 @@
}
protected long getMaximumDeviationMedian() {
- return getMinMax(200, expectedDelay / 4, 500);
+ return getMinMax(300, expectedDelay / 4, 500);
}
private void validateOnePass() {
13 years, 10 months
- 1
- 0
JBoss Rich Faces SVN: r21996 - in modules/tests/metamer/trunk/ftest-source/src/main/java/org/richfaces/tests/metamer/ftest: richTooltip and 1 other directory.
by richfaces-svn-commits＠lists.jboss.org
Author: lfryc(a)redhat.com
Date: 2011-03-01 03:58:44 -0500 (Tue, 01 Mar 2011)
New Revision: 21996
Modified:
modules/tests/metamer/trunk/ftest-source/src/main/java/org/richfaces/tests/metamer/ftest/richTabPanel/TestRichTabPanel.java
modules/tests/metamer/trunk/ftest-source/src/main/java/org/richfaces/tests/metamer/ftest/richTooltip/TestTooltipSimple.java
Log:
fixed rich:tabPanel testItemChangeListener + removed issue tracking for RF-10523, RF-10522
Modified: modules/tests/metamer/trunk/ftest-source/src/main/java/org/richfaces/tests/metamer/ftest/richTabPanel/TestRichTabPanel.java
===================================================================
--- modules/tests/metamer/trunk/ftest-source/src/main/java/org/richfaces/tests/metamer/ftest/richTabPanel/TestRichTabPanel.java 2011-03-01 06:06:08 UTC (rev 21995)
+++ modules/tests/metamer/trunk/ftest-source/src/main/java/org/richfaces/tests/metamer/ftest/richTabPanel/TestRichTabPanel.java 2011-03-01 08:58:44 UTC (rev 21996)
@@ -24,7 +24,6 @@
import static org.jboss.test.selenium.guard.request.RequestTypeGuardFactory.guardHttp;
import static org.jboss.test.selenium.guard.request.RequestTypeGuardFactory.guardNoRequest;
import static org.jboss.test.selenium.guard.request.RequestTypeGuardFactory.guardXhr;
-import static org.jboss.test.selenium.locator.LocatorFactory.jq;
import static org.jboss.test.selenium.utils.URLUtils.buildUrl;
import static org.testng.Assert.assertEquals;
import static org.testng.Assert.assertFalse;
@@ -181,13 +180,11 @@
}
@Test
- @IssueTracking("https://issues.jboss.org/browse/RF-10523")
+ @RegressionTest("https://issues.jboss.org/browse/RF-10523")
public void testItemChangeListener() {
selenium.click(inactiveHeaders[2]);
waitGui.failWith("Item 3 is not displayed.").until(isDisplayed.locator(itemContents[2]));
-
- String listenerOutput = selenium.getText(jq("div#phasesPanel li:eq(5)"));
- assertEquals(listenerOutput, "* item changed: tab1 -> tab3", "Item change listener's output");
+ phaseInfo.assertListener(PhaseId.UPDATE_MODEL_VALUES, "item changed: tab1 -> tab3");
}
@Test
Modified: modules/tests/metamer/trunk/ftest-source/src/main/java/org/richfaces/tests/metamer/ftest/richTooltip/TestTooltipSimple.java
===================================================================
--- modules/tests/metamer/trunk/ftest-source/src/main/java/org/richfaces/tests/metamer/ftest/richTooltip/TestTooltipSimple.java 2011-03-01 06:06:08 UTC (rev 21995)
+++ modules/tests/metamer/trunk/ftest-source/src/main/java/org/richfaces/tests/metamer/ftest/richTooltip/TestTooltipSimple.java 2011-03-01 08:58:44 UTC (rev 21996)
@@ -50,7 +50,7 @@
import org.richfaces.tests.metamer.ftest.AbstractMetamerTest;
import org.richfaces.tests.metamer.ftest.DelayTester;
import org.richfaces.tests.metamer.ftest.annotations.Inject;
-import org.richfaces.tests.metamer.ftest.annotations.IssueTracking;
+import org.richfaces.tests.metamer.ftest.annotations.RegressionTest;
import org.richfaces.tests.metamer.ftest.annotations.Use;
import org.richfaces.tests.metamer.ftest.annotations.Uses;
import org.testng.annotations.Test;
@@ -303,7 +303,7 @@
@Test
@Use(field = "presetDelay", ints = { 0, 1000, 5000 })
- @IssueTracking("https://issues.jboss.org/browse/RF-10522")
+ @RegressionTest("https://issues.jboss.org/browse/RF-10522")
public void testShowDelay() {
attributes.setMode(TooltipMode.client);
13 years, 10 months
- 1
- 0
JBoss Rich Faces SVN: r21995 - modules/docs/trunk/Component_Reference/src/main/docbook/en-US.
by richfaces-svn-commits＠lists.jboss.org
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>
13 years, 10 months
- 1
- 0
JBoss Rich Faces SVN: r21994 - in modules/docs/trunk/Component_Reference/src/main/docbook/en-US: extras and 1 other directory.
by richfaces-svn-commits＠lists.jboss.org
Author: SeanRogers
Date: 2011-02-28 23:07:07 -0500 (Mon, 28 Feb 2011)
New Revision: 21994
Modified:
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Trees.xml
modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richtree-nodeType_attribute.xml_sample
Log:
Updated tree documentation RFPL-984
Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Trees.xml
===================================================================
--- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Trees.xml 2011-02-28 19:20:20 UTC (rev 21993)
+++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Trees.xml 2011-03-01 04:07:07 UTC (rev 21994)
@@ -63,6 +63,7 @@
</imageobject>
</mediaobject>
</example>
+ <!--
<para>
Alternatively, use Expression Language (<acronym>EL</acronym>) with the <varname>nodeType</varname> attribute, as shown in <xref linkend="exam-Component_Reference-richtree-nodeType_attribute_with_Expression_Language" />.
</para>
@@ -70,6 +71,7 @@
<title><varname>nodeType</varname> attribute with Expression Language</title>
<programlisting language="XML" role="XML"><xi:include parse="text" href="extras/exam-Component_Reference-richtree-nodeType_attribute_with_Expression_Language.xml_sample" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
</example>
+ -->
<para>
If the <varname>nodeType</varname> attribute returns null, the node is rendered as a "<emphasis>typeless</emphasis>" (or default) node. The <emphasis>typeless</emphasis> node is the first child <sgmltag><rich:treeNode></sgmltag> component with a valid <varname>rendered</varname> attribute, but without a defined <varname>type</varname> attribute.
</para>
@@ -178,9 +180,16 @@
</variablelist>
</section>
- <section id="sect-Component_Reference-richtree-Identifying_nodes">
- <title>Identifying nodes</title>
+ <section id="sect-Component_Reference-richtree-Identifying_nodes_with_the_rowKeyConverter_attribute">
+ <title>Identifying nodes with the <varname>rowKeyConverter</varname> attribute</title>
<para>
+ If the <sgmltag><rich:tree></sgmltag> component uses a custom data model, the data model provides unique keys for tree nodes so they can be identified during a client request. The <sgmltag><rich:tree></sgmltag> component can use strings as key values. These strings may contain special characters that are not allowed by browsers, such as the left angle bracket (<) and ampersand (&). To allow these characters in the keys, a row key converter must be provided.
+ </para>
+ <para>
+ To apply a converter to the <sgmltag><rich:tree></sgmltag> component, define it with the <varname>rowKeyConverter</varname> attribute.
+ </para>
+ <!--
+ <para>
The <sgmltag><rich:tree></sgmltag> component uses a data model to represent the node structure on the page. To identify a particular node during a client request, the model provides unique keys for tree nodes. The <sgmltag><rich:tree></sgmltag> component can use strings as key values. These strings may contain special characters that are not allowed by browsers, such as the left angle bracket (<) and ampersand (&). To allow these characters in the keys, the following converter is provided:
</para>
<variablelist>
@@ -192,6 +201,7 @@
</para>
</listitem>
</varlistentry>
+ -->
<!-- TODO not in M5
<varlistentry>
<term><classname>org.richfaces.TreeAdaptorRowKeyConverter</classname></term>
@@ -209,7 +219,6 @@
</para>
</listitem>
</varlistentry>
- -->
</variablelist>
<para>
To apply a converter to the <sgmltag><rich:tree></sgmltag> component, define it with the <varname>rowKeyConverter</varname> attribute. <xref linkend="exam-Component_Reference-richtree-Identifying_nodes" /> demonstrates the use of a converter to identify tree nodes.
@@ -222,6 +231,7 @@
</para>
<programlisting language="Java" role="JAVA"><xi:include parse="text" href="extras/exam-Component_Reference-richtree-Identifying_nodes.js" xmlns:xi="http://www.w3.org/2001/XInclude" /></programlisting>
</example>
+ -->
</section>
<!-- TODO not in M6 -->
@@ -464,6 +474,16 @@
</para>
</section>
+ <section id="sect-Component_Reference-richtreeModelAdaptor-Identifying_nodes">
+ <title>Identifying nodes</title>
+ <para>
+ Adaptors that use <interfacename>Map</interfacename> interfaces or models with non-string keys require a row key converter in order to correctly identify nodes. Refer to <xref linkend="sect-Component_Reference-richtree-Identifying_nodes_with_the_rowKeyConverter_attribute" /> for details on the use of the <varname>rowKeyConverter</varname> attribute.
+ </para>
+ <para>
+ Adaptors that use <interfacename>Iterable</interfacename> interfaces have simple integer row keys. A default converter is provided and does not need to be referenced explicitly.
+ </para>
+ </section>
+
<section id="sect-Component_Reference-richtreeModelAdaptor-Reference_data">
<title>Reference data</title>
<itemizedlist>
@@ -538,6 +558,16 @@
</example>
</section>
+ <section id="sect-Component_Reference-richtreeModelRecursiveAdaptor-Identifying_nodes">
+ <title>Identifying nodes</title>
+ <para>
+ Adaptors that use <interfacename>Map</interfacename> interfaces or models with non-string keys require a row key converter in order to correctly identify nodes. Refer to <xref linkend="sect-Component_Reference-richtree-Identifying_nodes_with_the_rowKeyConverter_attribute" /> for details on the use of the <varname>rowKeyConverter</varname> attribute.
+ </para>
+ <para>
+ Adaptors that use <interfacename>Iterable</interfacename> interfaces have simple integer row keys. A default converter is provided and does not need to be referenced explicitly.
+ </para>
+ </section>
+
<section id="sect-Component_Reference-richtreeModelRecursiveAdaptor-Reference_data">
<title>Reference data</title>
<itemizedlist>
Modified: modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richtree-nodeType_attribute.xml_sample
===================================================================
--- modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richtree-nodeType_attribute.xml_sample 2011-02-28 19:20:20 UTC (rev 21993)
+++ modules/docs/trunk/Component_Reference/src/main/docbook/en-US/extras/exam-Component_Reference-richtree-nodeType_attribute.xml_sample 2011-03-01 04:07:07 UTC (rev 21994)
@@ -1,9 +1,9 @@
<rich:tree style="width:300px" value="#{library.data}" var="item" nodeType="#{item.type}">
- <rich:treeNode type="artist" iconLeaf="/images/tree/singer.png">
+ <rich:treeNode type="artist" iconExpanded="/images/tree/singer.png" iconCollapsed="/images/tree/singer.png">
<h:outputText value="#{item.name}" />
</rich:treeNode>
- <rich:treeNode type="album" iconLeaf="/images/tree/disc.png">
- <h:outputText value="#{item.title}" />
+ <rich:treeNode type="album" iconExpanded="/images/tree/disc.png" iconCollapsed="/images/tree/disc.png">
+ <h:outputText value="#{item.album}" />
</rich:treeNode>
<rich:treeNode type="song" iconLeaf="/images/tree/song.png">
<h:outputText value="#{item.title}" />
13 years, 10 months
- 1
- 0