[richfaces-svn-commits] JBoss Rich Faces SVN: r4950 - in trunk: cdk/maven-cdk-plugin/src/main/resources and 10 other directories.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Fri Dec 21 10:43:18 EST 2007
Author: vkorluzhenko
Date: 2007-12-21 10:43:17 -0500 (Fri, 21 Dec 2007)
New Revision: 4950
Added:
trunk/docs/userguide/en/src/main/docbook/included/componentControl.desc.xml
trunk/docs/userguide/en/src/main/docbook/included/componentControl.xml
trunk/docs/userguide/en/src/main/resources/images/calendar4.png
trunk/docs/userguide/en/src/main/resources/images/contextMenu_attached.png
trunk/docs/userguide/en/src/main/resources/images/contextMenu_classes.png
trunk/docs/userguide/en/src/main/resources/images/listShuttle1.png
trunk/docs/userguide/en/src/main/resources/images/listShuttle_classes_s.png
trunk/docs/userguide/en/src/main/resources/images/listShuttle_classes_t.png
trunk/docs/userguide/en/src/main/resources/images/orderingList_classes.png
Removed:
trunk/docs/userguide/build.xml
Modified:
trunk/cdk/generator/src/main/java/org/ajax4jsf/builder/component/ComponentPropertyProcessor.java
trunk/cdk/maven-cdk-plugin/src/main/resources/VM_global_library.vm
trunk/docs/userguide/en/src/main/docbook/included/calendar.xml
trunk/docs/userguide/en/src/main/docbook/included/contextMenu.desc.xml
trunk/docs/userguide/en/src/main/docbook/included/contextMenu.xml
trunk/docs/userguide/en/src/main/docbook/included/dropDownMenu.xml
trunk/docs/userguide/en/src/main/docbook/included/effect.xml
trunk/docs/userguide/en/src/main/docbook/included/insert.xml
trunk/docs/userguide/en/src/main/docbook/included/listShuttle.desc.xml
trunk/docs/userguide/en/src/main/docbook/included/listShuttle.xml
trunk/docs/userguide/en/src/main/docbook/included/menuItem.xml
trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml
trunk/docs/userguide/en/src/main/docbook/included/orderingList.desc.xml
trunk/docs/userguide/en/src/main/docbook/included/orderingList.xml
trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml
trunk/docs/userguide/en/src/main/docbook/included/panelMenu.xml
trunk/docs/userguide/en/src/main/docbook/included/panelMenuGroup.xml
trunk/docs/userguide/en/src/main/docbook/included/panelMenuItem.xml
trunk/docs/userguide/en/src/main/docbook/included/portlet.xml
trunk/docs/userguide/en/src/main/docbook/included/scrollableDataTable.xml
trunk/docs/userguide/en/src/main/docbook/included/toolTip.xml
trunk/docs/userguide/en/src/main/docbook/included/tree.xml
trunk/docs/userguide/en/src/main/docbook/master.xml
trunk/docs/userguide/en/src/main/docbook/modules/AUGWADParams.xml
trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml
trunk/docs/userguide/en/src/main/resources/css/html.css
trunk/docs/userguide/en/src/main/resources/images/contextMenu1.png
trunk/docs/userguide/en/src/main/resources/images/orderinList1.png
trunk/docs/userguide/pom.xml
trunk/ui/core/src/main/config/component/commandButton.xml
trunk/ui/core/src/main/config/component/commandLink.xml
trunk/ui/core/src/main/config/component/function.xml
trunk/ui/core/src/main/config/component/mediaOutput.xml
trunk/ui/core/src/main/config/component/poll.xml
trunk/ui/core/src/main/config/component/push.xml
trunk/ui/core/src/main/config/component/support.xml
trunk/ui/listShuttle/src/main/config/component/listShuttle.xml
trunk/ui/orderingList/src/main/config/component/orderinglist.xml
trunk/ui/togglePanel/src/main/config/component/togglePanel.xml
Log:
http://jira.jboss.com/jira/browse/RF-971 - Branch and trunk merge
Modified: trunk/cdk/generator/src/main/java/org/ajax4jsf/builder/component/ComponentPropertyProcessor.java
===================================================================
--- trunk/cdk/generator/src/main/java/org/ajax4jsf/builder/component/ComponentPropertyProcessor.java 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/cdk/generator/src/main/java/org/ajax4jsf/builder/component/ComponentPropertyProcessor.java 2007-12-21 15:43:17 UTC (rev 4950)
@@ -60,7 +60,7 @@
String defaultvalue = propertyBean.getDefaultvalue();
Class<?> propertyClass = getType(propertyBean, configuration.getClassLoader());
JavaField field = new JavaField(propertyClass, "_" + name, defaultvalue);
- field.getComments().add(new JavaComment(propertyBean.getDescription()));
+ field.getComments().add(new JavaComment(propertyBean.getXmlEncodedDescription()));
field.getModifiers().add(JavaModifier.PRIVATE);
handleDeprecation(field.getType(), field);
return field;
Modified: trunk/cdk/maven-cdk-plugin/src/main/resources/VM_global_library.vm
===================================================================
--- trunk/cdk/maven-cdk-plugin/src/main/resources/VM_global_library.vm 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/cdk/maven-cdk-plugin/src/main/resources/VM_global_library.vm 2007-12-21 15:43:17 UTC (rev 4950)
@@ -19,7 +19,7 @@
*/
private $type _${prop.name};
/**
- * $prop.description
+ * ${prop.xmlEncodedDescription}
* Setter for $prop.name
* @param $prop.name - new value
*/
Deleted: trunk/docs/userguide/build.xml
===================================================================
--- trunk/docs/userguide/build.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/build.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -1,20 +0,0 @@
-<project name="Documentation" default="all.doc" basedir=".">
-
- <!-- Set the following property to generate the doco in the output folder -->
- <property name="build.dir" value="${basedir}/../target/"/>
-
- <property name="pdf.name" value="richfaces-usersguide.pdf" />
- <import file="../resources/support.xml" />
-
- <target name="all.doc" depends="clean">
- <antcall target="lang.all"><param name="lang" value="en"/></antcall>
- </target>
-
- <!-- Use this alternate target to enable uptodate checking, i.e.
- don't generate docs if nothing has changed
- <target name="all.doc">
- <antcall target="lang.all.run"><param name="lang" value="en"/></antcall>
- </target>
- -->
-
-</project>
Modified: trunk/docs/userguide/en/src/main/docbook/included/calendar.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/calendar.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/en/src/main/docbook/included/calendar.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -292,7 +292,7 @@
<para>This is a result:</para>
<figure>
- <title>Using facets </title>
+ <title>Facets usage</title>
<mediaobject>
<imageobject>
@@ -311,8 +311,26 @@
</emphasis> facet, {nextYearControl}, {previousYearControl} are absent. Numbers of weeks are
red colored.</para>
- <para>It's possible to program events for calendar from JavaScript code. A simplest example of
- usage JavaScript API is placed below:</para>
+ <para>The <emphasis role="bold">
+ <property><rich:calendar></property>
+ </emphasis> component allows to show and manage time. It's necessary to define time
+ in a pattern (for example, it could be defined as "d/M/yy HH:mm"). Then after
+ you choose some data in the calendar, it becomes possible to manage time for this date. For time editing
+ it's necessary to click on its field (see a picture below). To clean the field click
+ on the "Clean".</para>
+
+ <figure>
+ <title>Timing</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/calendar4.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>It's possible to program events for calendar from JavaScript code. A simplest
+ example of usage JavaScript API is placed below:</para>
<para>
<emphasis role="bold">Example:</emphasis>
</para>
@@ -320,11 +338,11 @@
<a4j:form id="form">
<rich:calendar popup="true" rendered="#{!bean.check}" value="#{bean.date}" id="c"/>
<!--The link which is used to call a calendar popup externally-->
- <a onclick="$('form:c').component.doExpand()" href="#">Show</a>
+ <a onclick="$('form:c').component.Expand()" href="#">Show</a>
</a4j:form>
...
]]></programlisting>
-
+
<para>Also the discussion about this problem can be found on the <ulink
url="http://www.jboss.com/index.html?module=bb&op=viewtopic&p=4078301#4078301"
>RichFaces Users Forum</ulink>.</para>
@@ -382,8 +400,8 @@
<row>
<entry>selectDate(date)</entry>
- <entry>Selects the date specified. If the date isn't in current month - performs
- request to select</entry>
+ <entry>Selects the date specified. If the date isn't in current month -
+ performs request to select</entry>
</row>
<row>
@@ -483,13 +501,13 @@
</row>
<row>
- <entry>doCollapse()</entry>
+ <entry>Collapse()</entry>
<entry>Collapses calendar element</entry>
</row>
<row>
- <entry>doExpand()</entry>
+ <entry>Expand()</entry>
<entry>Expands calendar element</entry>
</row>
Added: trunk/docs/userguide/en/src/main/docbook/included/componentControl.desc.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/componentControl.desc.xml (rev 0)
+++ trunk/docs/userguide/en/src/main/docbook/included/componentControl.desc.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section>
+ <sectioninfo>
+ <keywordset>
+ <keyword>componentControl</keyword>
+ </keywordset>
+ </sectioninfo>
+ <section>
+ <title>Description</title>
+ <para>The <emphasis role="bold">
+ <property><rich:componentControl></property>
+ </emphasis> allows to call JS API functions on components after defined events.</para>
+
+ </section>
+ <!--section>
+ <title>Key Features</title>
+ <itemizedlist>
+ <listitem>Highly customizable look and feel</listitem>
+ <listitem>Popup representation</listitem>
+ <listitem>Disablement support</listitem>
+ <listitem>Smart and user-defined positioning</listitem>
+ <listitem>Cells customization</listitem>
+ <listitem>Macro substitution based on tool bars customization</listitem>
+ </itemizedlist>
+ </section-->
+</section>
Added: trunk/docs/userguide/en/src/main/docbook/included/componentControl.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/componentControl.xml (rev 0)
+++ trunk/docs/userguide/en/src/main/docbook/included/componentControl.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -0,0 +1,218 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<section>
+ <sectioninfo>
+ <keywordset>
+ <keyword>componentControl</keyword>
+ </keywordset>
+ </sectioninfo>
+
+ <table>
+ <title>Component identification parameters</title>
+
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Name</entry>
+
+ <entry>Value</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry>component-type</entry>
+
+ <entry>org.richfaces.ComponentControl</entry>
+ </row>
+
+ <row>
+ <entry>component-class</entry>
+
+ <entry>org.richfaces.component.html.HtmlComponentControl</entry>
+ </row>
+
+ <row>
+ <entry>component-family</entry>
+
+ <entry>org.richfaces.ComponentControl</entry>
+ </row>
+
+ <row>
+ <entry>renderer-type</entry>
+
+ <entry>org.richfaces.ComponentControlRenderer</entry>
+ </row>
+
+ <row>
+ <entry>tag-class</entry>
+
+ <entry>org.richfaces.taglib.ComponentControlTag</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <section>
+ <title>Creating the Component with a Page Tag</title>
+
+ <para>To create the simplest variant on a page use the following syntax:</para>
+
+
+ <para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
+ <programlisting role="XML"><![CDATA[...
+ <rich:componentControl attachTo="doExpandCalendarID" for="ccCalendarID" event="onclick" operation="Expand" />
+...]]></programlisting>
+ </section>
+
+ <section>
+ <title>Creating the Component Dynamically Using Java</title>
+
+ <para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
+ <programlisting role="JAVA"><![CDATA[import org.richfaces.component.html.HtmlComponentControl;
+...
+HtmlComponentControl myCalendar = new HtmlComponentControl();
+...
+]]></programlisting>
+ </section>
+
+ <section>
+ <title>Details of Usage</title>
+ <para>There are three ways to use the <emphasis role="bold">
+ <property><rich:componentControl></property>
+ </emphasis> to another component.</para>
+ <itemizedlist>
+ <listitem>Defining a name of a function that is generated (definition is similar to a
+ definition of <emphasis role="bold">
+ <property><a4j:jsFunction></property>
+ </emphasis>). An "event" argument is passed to this function.</listitem>
+ </itemizedlist>
+ <para>An example is placed below:</para>
+ <programlisting role="XML"><![CDATA[...
+ <rich:componentControl name="ffunction" for="comp_ID" operation="show"/>
+...
+]]></programlisting>
+ <para>According to this code a function with name <property>"call"</property>
+ is generated. It is used in JavaScript code to trigger an operation on the target component
+ with defined id=<property>"comp_ID"</property>.</para>
+ <para>The generated function is shown below:</para>
+ <programlisting role="JAVA"><![CDATA[function ffunction (event) {
+}
+]]></programlisting>
+ <itemizedlist>
+ <listitem>Attaching to a parent component (usage is similar to <emphasis role="bold">
+ <property><a4j:support></property>
+ </emphasis> component).</listitem>
+ </itemizedlist>
+ <para>An example is placed below:</para>
+
+ <programlisting role="XML"><![CDATA[...
+ <rich:modalPanel id="ccModalPanelID" onshow="alert(event.parameters.show)" onhide="alert(event.parameters.hide)">
+ ...
+ </rich:modalPanel>
+ <h:commandButton value="Show Modal Panel">
+ <rich:componentControl for="ccModalPanelID" event="onclick" disableDefault="true" operation="show">
+ <f:param name="show" value="componentControl work(show)"/>
+ <rich:componentControl/>
+ </h:commandButton>
+...
+]]></programlisting>
+ <para>In the example the <emphasis>
+ <property>"for"</property>
+ </emphasis> attribute contains value of an Id of <emphasis role="bold">
+ <property><rich:modalpanel></property>
+ </emphasis> component. The <emphasis>
+ <property>"operation"</property>
+ </emphasis> attribute contains a name of JavaScript API function. An <emphasis>
+ <property>"event"</property>
+ </emphasis> attribute is used to trigger an operation defined with the <emphasis>
+ <property>"operation"</property>
+ </emphasis> attribute. A set of parameters is defined with <emphasis role="bold">
+ <property><f:param></property>
+ </emphasis>. As an alternative, the <emphasis>
+ <property>"params"</property>
+ </emphasis> attribute can be used. Thus, one of main features is that <emphasis role="bold">
+ <property><rich:componentControl></property>
+ </emphasis> allows to transfer parameters. The <emphasis>
+ <property>"disableDefault"</property>
+ </emphasis> attribute with <property>"true"</property> value is used instead
+ of <property>onclick="return false;"</property> attribute for <emphasis role="bold">
+ <property><h:commandButton></property>
+ </emphasis> to avoid a problem with form submit and <property>modalPanel</property> showing.</para>
+ <itemizedlist>
+ <listitem>Attaching with <emphasis>
+ <property>"attachTo"</property>
+ </emphasis> attribute.</listitem>
+ </itemizedlist>
+ <para>An example is placed below:</para>
+
+ <programlisting role="XML"><![CDATA[...
+ <rich:calendar popup="#{componentControl.calendarPopup}" id="ccCalendarID" />
+ ...
+ <f:verbatim>
+ <a href="#" id="doExpandCalendarID">Calendar (nextYear)</a>
+ </f:verbatim>
+ <rich:componentControl attachTo="doExpandCalendarID" for="ccCalendarID" event="onclick" disableDefault="true" operation="nextYear" />
+...
+]]></programlisting>
+ <para>In the example the <emphasis>
+ <property>"attachTo"</property>
+ </emphasis> attribute contais a value of an Id of <property><a></property> tag.
+ The <emphasis>
+ <property>"for"</property>
+ </emphasis> attribute contains value of an Id of <emphasis role="bold">
+ <property><rich:calendar></property>
+ </emphasis> component. The <emphasis>
+ <property>"operation"</property>
+ </emphasis> attribute contains a name of JavaScript API function. Thus, clicking on the link
+ represents the next year on the calendar.</para>
+ <!--para>One more example of <emphasis role="bold">
+ <property><rich:componentControl></property>
+ </emphasis> usage is placed below:</para>
+ <programlisting role="XML"><![CDATA[...
+ <rich:panelMenu id="ccContextMenuPanelMenuID">
+ <h:outputText value="click text" />
+ </rich:panelMenu>
+ <rich:contextMenu id="ccContextMenuID" submitMode="ajax">
+ <rich:menuItem icon="/pics/header.png" value="tab1" reRender="cmInfoID">
+ <f:param name="cmdParam" value="menu" />
+ </rich:menuItem>
+ <rich:menuSeparator />
+ <rich:menuItem icon="/pics/info.gif" value="a" reRender="cmInfoID">
+ <f:param name="cmdParam" value="a" />
+ </rich:menuItem>
+ <rich:menuItem icon="/pics/info.gif" value=" b" reRender="cmInfoID">
+ <f:param name="cmdParam" value="b" />
+ </rich:menuItem>
+ <rich:menuItem icon="/pics/info.gif" value="c" reRender="cmInfoID">
+ <f:param name="cmdParam" value="c" />
+ </rich:menuItem>
+ </rich:contextMenu>
+ <rich:componentControl event="oncontextmenu" attachTo="ccContextMenuPanelMenuID" for="ccContextMenuID" disableDefault="true" operation="Show" />
+...
+]]></programlisting-->
+
+ </section>
+
+ <section>
+ <title>Look-and-Feel Customization</title>
+
+ <para><emphasis role="bold">
+ <property><rich:componentControl></property>
+ </emphasis> has no skin parameters and custom <property>style classes</property>, as the
+ component isn't visual.</para>
+ </section>
+
+ <section>
+ <title>Relevant Resources Links</title>
+ <para><ulink
+ url="http://livedemo.exadel.com/richfaces-demo/richfaces/componentControl.jsf?c=componentControl"
+ >Here</ulink> you can see an example of <emphasis role="bold">
+ <property><rich:componentControl></property>
+ </emphasis> usage and sources for the given example. </para>
+ </section>
+
+</section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/contextMenu.desc.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/contextMenu.desc.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/en/src/main/docbook/included/contextMenu.desc.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -21,10 +21,11 @@
<section>
<title>Key Features</title>
<itemizedlist>
- <listitem>Skinnable <property>context menu</property> and child items</listitem>
- <listitem>Highly customizable look and feel</listitem>
+ <listitem>Highly customizable look and feel</listitem>
+ <listitem>"oncontextmenu" event support</listitem>
<listitem>Disablement support</listitem>
<listitem>Pop-up appearance event customization</listitem>
+ <listitem>Usage of shared instance of a menu on a page</listitem>
</itemizedlist>
</section>
</section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/contextMenu.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/contextMenu.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/en/src/main/docbook/included/contextMenu.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -46,9 +46,7 @@
<emphasis role="bold">Example:</emphasis>
</para>
<programlisting role="XML"><![CDATA[...
-<rich:contextMenu value="Menu1">
- <!--Nested menu components-->
-</rich:contextMenu>
+<rich:contextMenu event="oncontextmenu" attached="true">
...]]></programlisting>
</section>
<section>
@@ -63,18 +61,244 @@
</section>
<section>
<title>Details of Usage</title>
- <para>All attributes except <emphasis>
- <property>"value"</property>
- </emphasis> are optional. The <emphasis>
- <property>"value"</property>
- </emphasis> attribute defines text to be represented. For the same purpose you can also
- use the <emphasis>
- <property>"label"</property>
- </emphasis> facet.</para>
+ <para>
+ <emphasis role="bold">
+ <property><rich:contextMenu></property>
+ </emphasis> is a support-like component. Context menu itself is an invisible panel that
+ appears after a particular client side event (onmouseover, onclick, etc) occured on a
+ parent component. The event is defined with an <emphasis>
+ <property>"event"</property>
+ </emphasis> attribute. The component uses <emphasis>
+ <property>"oncontextmenu"</property>
+ </emphasis> event by default to call a context menu by clicking on the right mouse
+ button.</para>
- <para> It's possible to define the direction for list appear in the <emphasis>
+ <para><property>
+ <link linkend="menuGroup"><rich:menuGroup></link>
+ </property>, <property>
+ <link linkend="menuItem"><rich:menuItem></link>
+ </property> and <property>
+ <link linkend="menuSeparator"><rich:menuSeparator></link>
+ </property> components are used as nested elements for <emphasis role="bold">
+ <property><rich:contextMenu></property>
+ </emphasis>in the same way as for <emphasis role="bold">
+ <property><rich:dropDownMenu></property>
+ </emphasis>. </para>
+
+ <para>If a value of the <emphasis>
+ <property>"attached"</property>
+ </emphasis> attribute is defined as <property>"true"</property>,
+ the component is attached to the parent component. An example is placed below.</para>
+ <para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
+ <programlisting role="XML"><![CDATA[...
+ <h:panelGrid columns="1" columnClasses="cent">
+ <h:panelGroup id="picture">
+ <h:graphicImage value="/richfaces/jQuery/images/pic1.jpg" id="pic"/>
+ <rich:contextMenu event="oncontextmenu" attached="true" submitMode="none">
+ <rich:menuItem value="Zoom In" onclick="enlarge();" id="zin"></rich:menuItem>
+ <rich:menuItem value="Zoom Out" onclick="decrease();" id="zout"></rich:menuItem>
+ </rich:contextMenu>
+ </h:panelGroup>
+ </h:panelGrid>
+...]]></programlisting>
+ <para>The <property>"enlarge()"</property> and
+ <property>"decrease()"</property> functions definition is placed
+ below.</para>
+ <programlisting role="JAVA"><![CDATA[...
+ <script type="text/javascript">
+ function enlarge(){
+ document.getElementById('pic').width=document.getElementById('pic').width*1.1;
+ document.getElementById('pic').height=document.getElementById('pic').height*1.1;
+ }
+ function decrease(){
+ document.getElementById('pic').width=document.getElementById('pic').width*0.9;
+ document.getElementById('pic').height=document.getElementById('pic').height*0.9;
+ }
+ </script>
+...]]></programlisting>
+
+ <para>In the example a picture zooming possibility with <emphasis role="bold">
+ <property><rich:contextMenu></property>
+ </emphasis> component usage was shown. The picture is placed on the <emphasis
+ role="bold">
+ <property><h:panelGroup></property>
+ </emphasis> component. The <emphasis role="bold">
+ <property><rich:contextMenu></property>
+ </emphasis> component is defined as nested to <emphasis role="bold">
+ <property><h:panelGroup></property>
+ </emphasis> one and has a value of the<emphasis>
+ <property>"attached"</property>
+ </emphasis> attribute defined as <property>"true"</property>. Thus,
+ the context menu is attached to the parent component. The context menu has two items to
+ zoom in (zoom out) a picture by <property>"onclick"</property> event.
+ For earch item corresponding JavaScript function is defined to provide necessary action
+ as a result of the clicking on it. For the menu is defined an <emphasis>
+ <property>"oncontextmenu"</property>
+ </emphasis> event to call the context menu on a right click mouse event.</para>
+
+ <para>In the example the context menu is defined for the parent <emphasis role="bold">
+ <property><h:panelGroup></property>
+ </emphasis> component with a value of <emphasis>
+ <property>"id"</property>
+ </emphasis> attribute equal to <property>"picture"</property>. You
+ should be careful with such definition, because a client context menu is looked for a
+ DOM element with a client Id of a parent component on a server. If a parent component
+ doesn't encode an Id on a client, it can't be found by the <emphasis
+ role="bold">
+ <property><rich:contextMenu></property>
+ </emphasis> and it's attached to its closest parent in a DOM tree.</para>
+
+ <para> If the <emphasis>
+ <property>"attached"</property>
+ </emphasis> attribute has <property>"false"</property> value,
+ component activates via JavaScript API with assistance of <emphasis role="bold">
+ <property><rich:componentControl></property>
+ </emphasis>. An example is placed below.</para>
+ <para id="ex">
+ <emphasis role="bold">Example:</emphasis>
+ </para>
+ <programlisting role="XML"><![CDATA[...
+ <h:form id="form">
+ <rich:contextMenu attached="false" id="menu" submitMode="ajax">
+ <rich:menuItem ajaxSingle="true">
+ <b>{car} {model}</b> details
+ <a4j:actionparam name="det" assignTo="#{ddmenu.current}" value="{car} {model} details"/>
+ </rich:menuItem>
+ <rich:menuGroup value="Actions">
+ <rich:menuItem ajaxSingle="true">
+ Put <b>{car} {model}</b> To Basket
+ <a4j:actionparam name="bask" assignTo="#{ddmenu.current}" value="Put {car} {model} To Basket"/>
+ </rich:menuItem>
+ <rich:menuItem value="Read Comments" ajaxSingle="true">
+ <a4j:actionparam name="bask" assignTo="#{ddmenu.current}" value="Read Comments"/>
+ </rich:menuItem>
+ <rich:menuItem ajaxSingle="true">
+ Go to <b>{car}</b> site
+ <a4j:actionparam name="bask" assignTo="#{ddmenu.current}" value="Go to {car} site"/>
+ </rich:menuItem>
+ </rich:menuGroup>
+ </rich:contextMenu>
+
+ <h:panelGrid columns="2">
+ <rich:dataTable value="#{dataTableScrollerBean.tenRandomCars}" var="car" id="table"
+ onRowMouseOver="this.style.backgroundColor='#F8F8F8'"
+ onRowMouseOut="this.style.backgroundColor='#{a4jSkin.tableBackgroundColor}'" rowClasses="cur">
+ <rich:column>
+ <f:facet name="header">Make</f:facet>
+ <h:outputText value="#{car.make}"/>
+ </rich:column>
+ <rich:column>
+ <f:facet name="header">Model</f:facet>
+ <h:outputText value="#{car.model}"/>
+ </rich:column>
+ <rich:column>
+ <f:facet name="header">Price</f:facet>
+ <h:outputText value="#{car.price}" />
+ </rich:column>
+
+ <rich:componentControl event="onRowClick" for="menu" operation="show">
+ <f:param value="#{car.model}" name="model"/>
+ <f:param value="#{car.make}" name="car"/>
+ </rich:componentControl>
+ </rich:dataTable>
+
+ <a4j:outputPanel ajaxRendered="true">
+ <rich:panel>
+ <f:facet name="header">Last Menu Action</f:facet>
+ <h:outputText value="#{ddmenu.current}"></h:outputText>
+ </rich:panel>
+ </a4j:outputPanel>
+ </h:panelGrid>
+ </h:form>
+ ...]]></programlisting>
+ <para>This is a result:</para>
+ <figure>
+ <title>The <emphasis>
+ <property>"attached"</property>
+ </emphasis> attribute usage</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/contextMenu_attached.png" scalefit="1"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>In the example the context menu is activated (by clicking on the left mouse button) on
+ the table via JavaScript API with assistance of <emphasis role="bold">
+ <property><rich:componentControl></property>
+ </emphasis>. The attribute <emphasis>
+ <property>"for"</property>
+ </emphasis> contains a value of the <emphasis role="bold">
+ <property><rich:contextMenu></property>
+ </emphasis> Id. For menu appearance Java Script API function
+ <property>"Show"</property> is used. It is defined with <emphasis>
+ <property>"operation"</property>
+ </emphasis> attribute for the <emphasis role="bold">
+ <property><rich:componentControl></property>
+ </emphasis> component. Context menu is recreated after the every call on a client and
+ new {car} and {model} values are inserted in it. In the example for a menu customization
+ macrosubstitutions were used.</para>
+
+ <para>The <emphasis role="bold">
+ <property><rich:contextMenu></property>
+ </emphasis> component can be defined once on a page and can be used as shared for
+ different components (this is the main difference from the <emphasis role="bold">
+ <property><rich:dropDownMenu></property>
+ </emphasis> component). It's necessary to define it once on a page (as it was
+ shown in the example <link linkend="ex">above</link>) and activate it on required
+ components via JavaScript API with assistance of <emphasis role="bold">
+ <property><rich:componentControl></property>
+ </emphasis>.</para>
+
+ <para>The <emphasis role="bold">
+ <property><rich:contextMenu></property>
+ </emphasis>
+ <emphasis>
+ <property>"submitMode"</property>
+ </emphasis> attribute can be set to three possible parameters:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Server (default)</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Regular form submition request is used</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Ajax</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Ajax submission is used for switching</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>None</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The <emphasis>
+ <property>"action"</property>
+ </emphasis> and <emphasis>
+ <property>"actionListener"</property>
+ </emphasis> item's attributes are ignored. Menu items don't fire any submits
+ themselves. The behavior is fully defined by the components nested inside items.</para>
+
+ <note><title>Note:</title> As the <emphasis role="bold">
+ <property><rich:contextMenu></property>
+ </emphasis> component doesn't provide its own form, use it between
+ <h:form> and </h:form> tags.</note>
+
+
+
+ <!-- Will be done for latest version -->
+ <!--para> It's possible to define the direction for list appear in the <emphasis>
<property>"direction"</property>
- </emphasis>attribute. If the accordance of the popup corner to corner of the label isn't
+ </emphasis>attribute. If the accordance of the popup corner to corner of the label isn’t
set <emphasis>
<property>"direction"</property>
</emphasis> attribute must set next accordances: </para>
@@ -128,15 +352,14 @@
</listitem>
</itemizedlist>
- <!--ADD EXAMPLE and SCREENSHOT -->
-
<para>In order to set the offset for the menu popup relatively to label, you can use <emphasis>
<property>"horizontalOffset"</property>
</emphasis> and <emphasis>
<property>"verticalOffset"</property>
- </emphasis> attributes. Values can be negative.</para>
+ </emphasis> attributes. Values can be negative.</para-->
- <para><property>menuItem</property> provides <emphasis>
+ <!-- For menuItem, not for contexMenu -->
+ <!--para><property>menuItem</property> provides <emphasis>
<property>"submitMode"</property>
</emphasis> attribute to define the way of submission. Possible values : <itemizedlist>
<listitem>
@@ -163,16 +386,15 @@
<property>"actionListener"</property>
</emphasis> item's attributes are ignored. Menu items don't fire any submits
themselves. The behavior is fully defined by the components nested inside items.</para>
- <!-- template
+ <template
<para>emphasis role="bold">
<property><contextMenu></property>
</emphasis> could not be generated for every component where it's defined. Templating could
be used instead. So only representation data could be loaded from server. And markup
could be evaluated on client side. So it's should accept macrosubstitutions like
{value} </para>
-
- -->
- </para>
+
+ </para-->
</section>
<section>
<title>JavaScript API</title>
@@ -189,207 +411,156 @@
<tbody>
<!--Sorting API -->
<row>
- <entry>doHide()</entry>
+ <entry>Hide()</entry>
<entry>Hide component or group</entry>
<entry>Component, group</entry>
</row>
<row>
- <entry>doShow()</entry>
+ <entry>Show()</entry>
<entry>Show component or group</entry>
<entry>Component, group</entry>
</row>
- <row>
- <entry>doEnable()</entry>
+ <!--row>
+ <entry>Enable()</entry>
<entry>Enable component, item, group</entry>
<entry>Component, Item, Group</entry>
</row>
<row>
- <entry>doDisable()</entry>
+ <entry>Disable()</entry>
<entry>Disable component, item or group</entry>
<entry>Component, Item, Group</entry>
- </row>
+ </row-->
</tbody>
</tgroup>
</table>
</section>
<section>
<title>Look-and-Feel Customization</title>
-
<para>For skinnability implementation, the components use a <emphasis>
<property>style class redefinition method.</property>
</emphasis> Default style classes are mapped on <emphasis>
<property>skin parameters.</property>
</emphasis></para>
-
<para>There are two ways to redefine the appearance of all <emphasis role="bold">
<property><rich:contextMenu></property>
- </emphasis> components at once:</para>
-
- <itemizedlist>
- <listitem>
- <para>Redefine the corresponding skin parameters</para>
- </listitem>
-
- <listitem>
- <para>Add to your style sheets <emphasis>
- <property>style classes</property>
- </emphasis> used by a <emphasis role="bold">
+ </emphasis> components at once: <itemizedlist>
+ <listitem>Redefine the corresponding skin parameters</listitem>
+ <listitem> Add to your style sheets style classes used by a <emphasis role="bold">
<property><rich:contextMenu></property>
- </emphasis> component</para>
- </listitem>
- </itemizedlist>
+ </emphasis> component</listitem>
+ </itemizedlist>
+ </para>
</section>
<section>
<title>Skin Parameters Redefinition</title>
- </section>
- <section>
- <title>Definition of Custom Style Classes</title>
-
- <para>On the screenshot there are classes names that define styles for component elements.</para>
-
- <!-- ADD SCREENSHOT -->
-
<table>
- <title>Classes names that define a menu item</title>
+ <title>Skin parameters redefinition for a border</title>
<tgroup cols="2">
<thead>
<row>
- <entry>Class name</entry>
- <entry>Description</entry>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
</row>
</thead>
<tbody>
<row>
- <entry>rich-menu-item</entry>
- <entry>Defines styles for menu item</entry>
+ <entry>panelBorderColor</entry>
+ <entry>border-color</entry>
</row>
<row>
- <entry>rich-menu-item-disabled</entry>
- <entry>Defines styles for menu item in disabed state</entry>
+ <entry>additionalBackgroundColor</entry>
+ <entry>background-color</entry>
</row>
- <row>
- <entry>rich-menu-item-enabled</entry>
- <entry>Defines styles for menu item in enabled state</entry>
- </row>
- <row>
- <entry>rich-menu-item-hover</entry>
- <entry>Defines styles for menu item on hover event</entry>
- </row>
- <row>
- <entry>rich-menu-item-icon</entry>
- <entry>Defines styles for icon in menu item</entry>
- </row>
</tbody>
</tgroup>
</table>
- <table>
- <title>Classes names that define a menu item label</title>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Class name</entry>
-
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>rich-menu-item-label</entry>
- <entry>Defines styles for menu item label</entry>
- </row>
- <row>
- <entry>rich-menu-item-label-disabled</entry>
- <entry>Defines styles for menu item label in disabled state</entry>
- </row>
- <row>
- <entry>rich-menu-item-label-selected</entry>
- <entry>Defines styles for menu item label already selected</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
<table>
- <title>Classes names that define a menu item icon</title>
+ <title>Skin parameters redefinition for a background</title>
<tgroup cols="2">
<thead>
<row>
- <entry>Class name</entry>
-
- <entry>Description</entry>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
</row>
</thead>
<tbody>
- <row>
- <entry>rich-menu-item-icon-disabled</entry>
- <entry>Defines styles for icon of menu item in disabled state</entry>
- </row>
<row>
- <entry>rich-menu-item-icon-selected</entry>
- <entry>Defines styles for icon of menu item in selected state</entry>
+ <entry>additionalBackgroundColor</entry>
+ <entry>border-top-color</entry>
</row>
- </tbody>
- </tgroup>
- </table>
- <table>
- <title>Classes names that define a group element</title>
- <tgroup cols="2">
- <thead>
<row>
- <entry>Class name</entry>
- <entry>Description</entry>
+ <entry>additionalBackgroundColor</entry>
+ <entry>border-left-color</entry>
</row>
- </thead>
- <tbody>
<row>
- <entry>rich-menu-group</entry>
- <entry>Defines styles for menu group</entry>
+ <entry>additionalBackgroundColor</entry>
+ <entry>border-right-color</entry>
</row>
- <row>
- <entry>rich-menu-group-disabled</entry>
- <entry>Defines styles for menu group in disabled state</entry>
- </row>
- <row>
- <entry>rich-menu-group-selected</entry>
- <entry>Defines styles for menu group in selected state</entry>
- </row>
</tbody>
</tgroup>
</table>
+ </section>
+ <section>
+ <title>Definition of Custom Style Classes</title>
+
+ <para>On the screenshot there are classes names that define styles for component elements.</para>
+
+
+ <figure>
+ <title>Style classes</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/contextMenu_classes.png" scalefit="1"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
<table>
- <title>Classes names that define a separator</title>
+ <title>Classes names that define the contextMenu element</title>
<tgroup cols="2">
<thead>
<row>
<entry>Class name</entry>
-
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
- <entry>rich-menu-separator</entry>
- <entry>Defines styles for menu separator</entry>
+ <entry>rich-menu-list-border</entry>
+ <entry>Defines styles for borders</entry>
</row>
- </tbody>
- </tgroup>
- </table>
- <table>
- <title>Classes names that define a popup element</title>
- <tgroup cols="2">
- <thead>
<row>
- <entry>Class name</entry>
-
- <entry>Description</entry>
+ <entry>rich-menu-list-bg</entry>
+ <entry>Defines styles for a general background list</entry>
</row>
- </thead>
- <tbody>
<row>
- <entry>rich-menu-popup</entry>
- <entry>Defines styles for popup element</entry>
+ <entry>rich-menu-list-strut</entry>
+ <entry>Defines styles for a wrapper <div> element for a strut
+ of a popup list</entry>
</row>
</tbody>
</tgroup>
</table>
+ <para>In order to redefine styles for all <emphasis role="bold">
+ <property><rich:contextMenu></property>
+ </emphasis> components on a page using CSS, it's enough to create classes with the same
+ names and define necessary properties in them. </para>
+ <para>To change styles of particular <emphasis role="bold">
+ <property><rich:contextMenu></property>
+ </emphasis> components, define your own style classes in the corresponding <emphasis
+ role="bold">
+ <property><rich:contextMenu></property>
+ </emphasis> component attributes.</para>
</section>
+
+ <section>
+ <title>Relevant Resources Links</title>
+ <para><ulink
+ url="http://livedemo.exadel.com/richfaces-demo/richfaces/contextMenu.jsf?c=contextMenu"
+ >Here</ulink> you can see an example of <emphasis role="bold">
+ <property><rich:contextMenu></property>
+ </emphasis> usage and sources for the given example. </para>
+ </section>
+
</section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/dropDownMenu.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/dropDownMenu.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/en/src/main/docbook/included/dropDownMenu.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -140,7 +140,7 @@
</listitem>
</itemizedlist>
- <para>The standard form submission is performed and the page is completely refreshed.</para>
+ <para>Regular form submission request is used.</para>
<itemizedlist>
<listitem>
@@ -148,9 +148,7 @@
</listitem>
</itemizedlist>
- <para>An Ajax form submission is performed, and specified elements in the <emphasis>
- <property>"reRender"</property>
- </emphasis> attribute are rerendered.</para>
+ <para>Ajax submission is used for switching.</para>
<itemizedlist>
<listitem>
@@ -162,8 +160,8 @@
<property>"action"</property>
</emphasis> and <emphasis>
<property>"actionListener"</property>
- </emphasis> item's attributes are ignored. Menu items don't fire any submits themselves. The
- behavior is fully defined by the components nested inside items.</para>
+ </emphasis> item's attributes are ignored. Menu items don't fire any submits themselves. The
+ behavior is fully defined by the components nested into items.</para>
<note><title>Note:</title> As the <emphasis role="bold">
<property><rich:dropDownMenu></property>
Modified: trunk/docs/userguide/en/src/main/docbook/included/effect.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/effect.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/en/src/main/docbook/included/effect.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -189,7 +189,7 @@
]]></programlisting>
<para> If you do use the <emphasis role="bold">
<property><rich:effect></property>
- </emphasis>component, there is no need to include this library because it's already here. </para>
+ </emphasis>component, there is no need to include this library because it's already here. </para>
<para>For more information look at <ulink
url="http://jboss.com/index.html?module=bb&op=viewtopic&t=119044">RichFaces
Modified: trunk/docs/userguide/en/src/main/docbook/included/insert.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/insert.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/en/src/main/docbook/included/insert.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -116,7 +116,17 @@
style classes for source code of particular language could be changed to your names, wich are
used by the <ulink url="https://jhighlight.dev.java.net/">JHighlight</ulink> library.</para>
</section>
+
<section>
+ <title>Look-and-Feel Customization</title>
+
+ <para><emphasis role="bold">
+ <property><rich:insert></property>
+ </emphasis> has no skin parameters and custom <property>style classes</property>, as the
+ component doesn't have own visual representation.</para>
+ </section>
+
+ <section>
<title>Relevant Resources Links</title>
<para><ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/insert.jsf?c=insert"
>Here</ulink> you can see the example of <emphasis role="bold"
Modified: trunk/docs/userguide/en/src/main/docbook/included/listShuttle.desc.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/listShuttle.desc.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/en/src/main/docbook/included/listShuttle.desc.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -13,17 +13,18 @@
from one list into another with their optional reordering there.</para>
<mediaobject>
<imageobject>
- <imagedata fileref=""/>
+ <imagedata fileref="images/listShuttle1.png"/>
</imageobject>
</mediaobject>
</section>
<section>
<title>Key Features</title>
<itemizedlist>
- <listitem>Skinnable <property>listShuttle</property> and child items</listitem>
- <listitem>Customizable component layout (captions, headers, list items and control sets)</listitem>
- <listitem>Disabled/enabled ordering controls</listitem>
- <listitem> Built-In Drag-and-Drop support</listitem>
+ <listitem>Highly customizable look and feel</listitem>
+ <listitem>Reordering possibility for lists items</listitem>
+ <listitem>Multiple selection of lists items</listitem>
+ <listitem>Keyboard support</listitem>
+ <!--listitem> Built-In Drag-and-Drop support</listitem-->
</itemizedlist>
</section>
</section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/listShuttle.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/listShuttle.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/en/src/main/docbook/included/listShuttle.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -13,14 +13,14 @@
<emphasis role="bold">Example:</emphasis>
</para>
<programlisting role="XML"><![CDATA[...
-<rich:listShuttle value="#{bean.list}" var="list" selection="#{value.resultList}">
- <f:facet name=header>
- <h:outputText value="Header1"/>
- </f:facet>
- <rich:column>
- <h:outputText value="#{list.text}">
- </rich:column>
-<rich:listShuttle>
+<rich:listShuttle var="item" sourceValue="#{bean.source}" targetValue="#{bean.target}" converter="listShuttleconverter">
+ <h:column>
+ <f:facet name="header">
+ <h:outputText value="Cars" />
+ </f:facet>
+ <h:outputText value="#{item.name}" />
+ </h:column>
+</rich:listShuttle>
...]]></programlisting>
</section>
<section>
@@ -38,46 +38,38 @@
<para>The <emphasis role="bold">
<property><rich:listShuttle></property>
</emphasis> component consists of the following parts: <itemizedlist>
- <listitem>two <property>item lists</property> (source and target). List consists of items; each item has
- three different representations: common, selected, active</listitem>
- <listitem>optional <property>caption</property>, <property>header</property> (sorted and non-sorted), <property>footer</property> elements</listitem>
- <listitem><property>copy/moving controls set</property>, a set of controls, which performs moving/copying
- items between lists</listitem>
- <listitem><property>optional ordering controls set</property>, a set of controls that performs
- reordering</listitem>
+ <listitem>two <property>item lists</property> (source and target). List consists of
+ items. Each item has three different representations: common, selected, active</listitem>
+ <listitem>optional <property>caption</property> element</listitem>
+ <listitem><property>optional ordering controls set</property> is a set of controls
+ that performs reordering</listitem>
+ <listitem><property>move controls set</property> is a set of controls, which
+ performs moving items between lists</listitem>
</itemizedlist>
</para>
- <para>The <emphasis role="bold">
- <property><rich:listShuttle></property>
- </emphasis> component provides to use <emphasis>
- <property>"source"</property>
- </emphasis> and <emphasis>
- <property>"target"</property>
- </emphasis> facets. It is possible to use the facets only together defined. In case the
- facets definition skipped both lists contain the columns defined nested to listShuttle
- component.</para>
- <para>Here is a simple example as it could be used on a page.</para>
+ <para> The <emphasis>
+ <property>"sourceValue" </property>
+ </emphasis> attribute defines the collection to be shown in the source list.</para>
+ <para>The <emphasis>
+ <property>"targetValue" </property>
+ </emphasis> attribute defines the collection to be shown in the target list.</para>
+ <para> The <emphasis>
+ <property>"var" </property>
+ </emphasis> could be shared between both collections to defined lists on the page.</para>
<para>
- <emphasis role="bold">Example:</emphasis>
+ The <emphasis>
+ <property>"converter" </property>
+ </emphasis> attribute is used to convert component data to a particular component's value.
+ For example, when you select items in a list, a converter is used to format a set of objects to a strings to be displayed.
</para>
- <programlisting role="XML"><![CDATA[...
-<rich:listShuttle sourceValue="#{bean.list}" var="list" value="#{value.resultList}">
- <f:facet name="source">
- <rich:column>
- <h:outputText value="#{list.text}"/>
- </rich:column>
- </f:facet>
- <f:facet name="target">
- <rich:column>
- <h:outputText value="#{list.text}"/>
- </rich:column>
- <rich:column>
- <h:outputText value="#{list.description}"/>
- </rich:column>
- </f:facet>
-<rich:listShuttle>
-...]]></programlisting>
- <!-- ADD SCREESHOT-->
+ <para>
+ The <emphasis>
+ <property>"sourceSelection" </property>
+ </emphasis> attribute stores the collection of items selected by user in the source list.
+ The <emphasis>
+ <property>"targetSelection" </property>
+ </emphasis> attribute stores the collection of items selected by user in the target list.
+ </para>
<para>Captions could be added to a list only after it was defined as a <emphasis>
<property>"sourceCaption"</property>
</emphasis> and <emphasis>
@@ -86,104 +78,145 @@
<property>"sourceCaptionLabel"</property>
</emphasis> and <emphasis>
<property>"targetCaptionLabel"</property>
- </emphasis> attribute.</para>
+ </emphasis> attribute.
+ </para>
+ <programlisting role="XML"><![CDATA[...
+<rich:listShuttle var="item" sourceValue="#{bean.source}" targetValue="#{bean.target}" sourceSelection="#{bean.sourceSelection}"
+ targetSelection="#{bean.targetSelection}" converter="listShuttleconverter">
+ <f:facet name="sourceCaption">
+ <h:outputText value="Cars Store #1" />
+ </f:facet>
+ <f:facet name="targetCaption">
+ <h:outputText value="Cars Store #2" />
+ </f:facet>
+ <rich:column>
+ <h:outputText value="#{items.name}" />
+ </rich:column>
+</rich:listShuttle>
+...]]></programlisting>
<!-- ordering control set-->
<para>The <emphasis role="bold">
<property><rich:listShuttle></property>
</emphasis> component provides the possibility to use <property>ordering controls
set</property>, which performs reordering in the target item list. Every control has
possibility to be disabled. </para>
- <para>
+ <para>An <property>ordering controls set</property> could be defined with
+ <emphasis><property>"topControlLabel"</property></emphasis>, <emphasis><property>"bottomControlLabel"</property></emphasis>,
+ <emphasis><property>"upControlLabel"</property></emphasis>, <emphasis><property>"downControlLabel"</property></emphasis>attributes.
+ </para>
+ <para>It is also possible to use
<emphasis>
- <property>"topControl" </property>
+ <property> "topControl" </property>
</emphasis>, <emphasis>
- <property>"topControlDisabled" </property>
+ <property>"topControlDisabled"</property>
+ </emphasis> , <emphasis>
+ <property> "bottomControl"</property>
+ </emphasis> , <emphasis>
+ <property> "bottomControlDisabled" </property>
</emphasis>, <emphasis>
- <property>"bottomControl" </property>
+ <property> "upControl" </property>
</emphasis>, <emphasis>
- <property>"bottomControlDisabled" </property>
+ <property> "upControlDisabled" </property>
</emphasis>, <emphasis>
- <property>"upControl" </property>
- </emphasis>, <emphasis>
- <property>"upControlDisabled" </property>
- </emphasis>, <emphasis>
- <property>"downControl" </property>
- </emphasis>, <emphasis>
- <property>"downControlDisabled" </property>
- </emphasis> facets are used to replaces the default control with facets content. </para>
+ <property> "downControl"</property>
+ </emphasis> , <emphasis>
+ <property> "downControlDisabled" </property>
+ </emphasis> facets in order to replace the default controls with facets content.
+ </para>
<para>
<emphasis role="bold">Example:</emphasis>
</para>
<programlisting role="XML"><![CDATA[...
-<rich:orderingList value="#{demoBean.items}" var="item" controlType="button">
+<rich:listShuttle var="item" sourceValue="#{bean.source}" targetValue="#{bean.target}" converter="listShuttleconverter">
+...
<f:facet name="topControl">
- <h:outputText value="Move to top">
+ <h:outputText value="Move to top" />
</f:facet>
- <f:facet name="upControl">
- <h:outputText value="Move up">
+ <f:facet name="upControl">
+ <h:outputText value="Move up" />
</f:facet>
- <f:facet name="downControl">
- <h:outputText value="Move down">
+ <f:facet name="downControl">
+ <h:outputText value="Move down" />
</f:facet>
- <f:facet name="bottomControl">
- <h:outputText value="Move to bottom">
+ <f:facet name="bottomControl">
+ <h:outputText value="Move to bottom" />
</f:facet>
<rich:orderingList>
...
]]></programlisting>
+
<!-- copy/move control set -->
+
<para>The <emphasis role="bold">
- <property><rich:listShuttle></property>
- </emphasis>component also provides 4 predefined controls in <property> move/copy
- controls set</property> for moving or copying items between source and target lists.
+ <property><rich:listShuttle></property>
+ </emphasis>component also provides 4 predefined controls in <property>move
+ controls set</property> for moving items between source and target lists.
Every control has possibility to be disabled. </para>
- <para>
+ <para>A <property>move controls set</property> could be defined with
+ <emphasis><property>"copyControlLabel"</property></emphasis>, <emphasis><property>"removeControlLabel"</property></emphasis>,
+ <emphasis><property>"copyAllControlLabel"</property></emphasis>, <emphasis><property>"removeAllControlLabel"</property></emphasis>attributes.
+ </para>
+ <para>It is also possible to use
<emphasis>
- <property>"copyCotrol" </property>
- </emphasis>, <emphasis>
- <property>"copy_disabled" </property>
- </emphasis>, <emphasis>
+ <property>"copyControl" </property>
+ </emphasis>,
+ <emphasis>
<property>"removeControl" </property>
- </emphasis>, <emphasis>
- <property>"remove_disabled" </property>
- </emphasis>, <emphasis>
+ </emphasis>,
+ <emphasis>
<property>"copyAllControl" </property>
- </emphasis>, <emphasis>
- <property>"copyAll_disabled" </property>
- </emphasis>, <emphasis>
+ </emphasis>,
+ <emphasis>
<property>"removeAllControl" </property>
- </emphasis>, <emphasis>
- <property>"removeAll_disabled" </property>
- </emphasis> facets are used to replaces the default control with facets content. </para>
- <!-- attributes -->
- <para> The
- <emphasis><property>"sourceValue"
- </property></emphasis> attribute defines the collection to be shown in source list.</para>
- <para>The
- <emphasis><property>"value"
- </property></emphasis> attribute defines the collection to store the value from target list.</para>
- <para> The
- <emphasis><property>"var"
- </property></emphasis> could be shared between both collections to defined lists on the page.</para>
- <para>Controls rendering is based on the
- <emphasis><property>"controlsType"
- </property></emphasis> attribute. Possible types are <property>button</property> and <property>none</property>.</para> The position of the
- <property>ordering controls set</property> relatively to list should be customized with
- <emphasis><property>"orderControlsVerticalAlign"
- </property></emphasis> attribute. The position of the <property>move/copy controls set</property>
- relatively to lists should be customized with
- <emphasis><property>"moveControlsVerticalAlign"
- </property></emphasis> attribute.
+ </emphasis>
+ facets in order to replace the default controls with facets content.
+ </para>
+ <programlisting role="XML"><![CDATA[...
+<rich:listShuttle var="item" sourceValue="#{bean.source}" targetValue="#{bean.target}" converter="listShuttleconverter"
+ copyControlLabel="Copy" removeControlLabel="Remove"
+ copyAllControlLabel="Copy all" removeAllControlLabel="Remove all">
+ <h:column>
+ <f:facet name="header">
+ <h:outputText value="Cars" />
+ </f:facet>
+ <h:outputText value="#{item.name}" />
+ </h:column>
+<rich:orderingList>
+...
+]]></programlisting>
- <!-- template -->
+ <!-- The following facets currently do not work-->
+ <!--<emphasis>
+ <property>"copy_disabled" </property>
+ </emphasis>, -->
+ <!--<emphasis>
+ <property>"remove_disabled" </property>
+ </emphasis>, -->
+ <!--<emphasis>
+ <property>"copyAll_disabled" </property>
+ </emphasis>, -->
+ <!--<emphasis>
+ <property>"removeAll_disabled" </property>
+ </emphasis>-->
- <para>The <emphasis role="bold">
+ <para>Controls rendering is based on the <emphasis>
+ <property>"controlsType" </property>
+ </emphasis> attribute. Possible types are <property>button</property> and
+ <property>none</property>.</para>
+ <note>
+ <para>
+ Currently the button controls type is based on <div> element.
+ </para>
+ </note>
+ <!-- template wiil be done in 3.2.0 -->
+ <!--para>The <emphasis role="bold">
<property><rich:listShuttle></property>
</emphasis> component provides the possibility to be customized using templating. The
customization could be performed by layout definition nested to component.</para>
<para>10 elements could be provided to be defined inside template (all standard controls
- should also possible to use inside): {sourceList}, {targetList}, {CopyControl}, {removeCotrol},
- {copyAllControl}, {removeAllControl}, {topcontrol}, {bottomControl}, {downCotrol}, {upControl}.</para>
+ should also possible to use inside): {sourceList}, {targetList}, {CopyControl},
+ {removeCotrol}, {copyAllControl}, {removeAllControl}, {topcontrol}, {bottomControl},
+ {downCotrol}, {upControl}.</para>
<para>The markup defined in the initial picture could be defined as in the following
example.</para>
<para>
@@ -210,7 +243,7 @@
</h:panelGrid>
</rich:listShuttle>
...
-]]></programlisting>
+]]></programlisting-->
<table>
<title>Keyboard usage for elements selection</title>
<tgroup cols="2">
@@ -224,11 +257,12 @@
<!--Sorting API -->
<row>
<entry>CTRL+click</entry>
- <entry>Described in selection behaviour requirement</entry>
+ <entry>Inverts selection for an item</entry>
</row>
<row>
<entry>SHIFT+click</entry>
- <entry>Described in selection behaviour requirement</entry>
+ <entry>Selects all rows from active one to a clicked row if they differ,
+ else select the actve row. All other selections are cleared</entry>
</row>
<row>
<entry>CTRL+A</entry>
@@ -236,13 +270,9 @@
already present in a list</entry>
</row>
<row>
- <entry>Space</entry>
- <entry>Inverts selection on the active element</entry>
- </row>
- <row>
<entry>Up, Down arrows</entry>
- <entry>Change the active element to the next or previous in a list and make
- it the only selected. Scroll should follow the selection to keep it
+ <entry>Changes the active element to the next or previous in a list and make
+ it the only selected. Scroll follows the selection to keep it
visible</entry>
</row>
</tbody>
@@ -281,117 +311,97 @@
</section>
<section>
<title>JavaScript API</title>
- <para> Controls are accessible for developer on client-side using controls attribute of
- JavaScript component instance. The value of the attribute is an associative array of
- controls keyed by the following strings: <property>top</property>, <property>up</property>, <property>down</property>, <property>bottom</property>.</para>
+
<table>
<title>JavaScript API</title>
- <tgroup cols="3">
+ <tgroup cols="2">
<thead>
<row>
<entry>Function</entry>
<entry>Description</entry>
- <entry>Element</entry>
</row>
</thead>
<tbody>
<!--Sorting API -->
+ <!--
<row>
- <entry>doSortAscending()</entry>
- <entry>Sort items in the list ascending</entry>
- <entry>Component</entry>
+ <entry>SortAscending()</entry>
+ <entry>Sorts items in the list ascending</entry>
</row>
<row>
- <entry>doSortDescending()</entry>
- <entry>Sort items in the list descending</entry>
- <entry>Component</entry>
+ <entry>SortDescending()</entry>
+ <entry>Sorts items in the list descending</entry>
</row>
<row>
- <entry>doSort()</entry>
- <entry>Invert current sorting</entry>
- <entry>Component</entry>
+ <entry>Sort()</entry>
+ <entry>Inverts current sorting</entry>
</row>
+ -->
<!--Controls common API -->
<row>
- <entry>doHide()</entry>
- <entry>Hide ordering control</entry>
- <entry>Any Ordering control</entry>
+ <entry>Hide()</entry>
+ <entry>Hides ordering control</entry>
</row>
<row>
- <entry>doShow()</entry>
- <entry>Show ordering control</entry>
- <entry>Any Ordering control</entry>
+ <entry>Show()</entry>
+ <entry>Shows ordering control</entry>
</row>
<row>
<entry>isShown()</entry>
- <entry>Check if current control is shown</entry>
- <entry>Any Ordering control</entry>
+ <entry>Checks if current control is shown</entry>
</row>
<row>
- <entry>doEnable()</entry>
- <entry>Enable ordering control</entry>
- <entry>Any Ordering control</entry>
+ <entry>Enable()</entry>
+ <entry>Enables ordering control</entry>
</row>
<row>
- <entry>doDisable()</entry>
- <entry>Disable ordering control</entry>
- <entry>Any Ordering control</entry>
+ <entry>Disable()</entry>
+ <entry>Disables ordering control</entry>
</row>
<row>
<entry>isEnabled()</entry>
- <entry>Check if current control is enabled</entry>
- <entry>Any Ordering control</entry>
+ <entry>Checks if current control is enabled</entry>
</row>
<!--List managing API -->
<row>
<entry>moveUp()</entry>
- <entry>Move up selected item in the list</entry>
- <entry>Any Item</entry>
+ <entry>Moves up selected item in the list</entry>
</row>
<row>
<entry>moveDown()</entry>
- <entry>Move down selected item in the list</entry>
- <entry>Any Item</entry>
+ <entry>Moves down selected item in the list</entry>
</row>
<row>
<entry>moveTop()</entry>
- <entry>Move top selected item in the list</entry>
- <entry>Any Item</entry>
+ <entry>Moves top selected item in the list</entry>
</row>
<row>
<entry>moveBottom()</entry>
- <entry>Move bottom selected item in the list</entry>
- <entry>Any Item</entry>
+ <entry>Moves bottom selected item in the list</entry>
</row>
<row>
<entry>copy()</entry>
- <entry>Copy selected item from the source list to the target list</entry>
- <entry>Any Item</entry>
+ <entry>Copies selected item from the source list to the target list</entry>
</row>
<row>
<entry>remove()</entry>
- <entry>Remove selected item from the target list to the source list</entry>
- <entry>Any Item</entry>
+ <entry>Removes selected item from the target list to the source list</entry>
</row>
<row>
<entry>copyAll()</entry>
- <entry>Copy all items from the source list to the target list</entry>
- <entry>Any Item</entry>
+ <entry>Copies all items from the source list to the target list</entry>
</row>
<row>
<entry>removeAll()</entry>
- <entry>Remove all items from the target list to the source list</entry>
- <entry>Any Item</entry>
+ <entry>Removes all items from the target list to the source list</entry>
</row>
<row>
<entry>getSelection()</entry>
- <entry>Return currently selected item</entry>
- <entry>Any Item</entry>
+ <entry>Returns currently selected item</entry>
</row>
<row>
<entry>getItems()</entry>
- <entry>Return the collection of all items</entry>
- <entry>Any Item</entry>
+ <entry>Returns the collection of all items</entry>
</row>
</tbody>
</tgroup>
@@ -414,17 +424,397 @@
</itemizedlist>
</para>
</section>
+
<section>
+ <title>Skin Parameters Redefinition</title>
+ <table>
+ <title>Skin parameters redefinition for items in the source and target lists</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>generalBackgroundColor</entry>
+ <entry>background-color</entry>
+ </row>
+ <row>
+ <entry>tableBorderColor</entry>
+ <entry>border-color</entry>
+ </row>
+ <row>
+ <entry>tableBorderWidth</entry>
+ <entry>border-width</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Skin parameters redefinition for caption in the source and target lists</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>headerFamilyFont</entry>
+ <entry>font-family</entry>
+ </row>
+ <row>
+ <entry>headerSizeFont</entry>
+ <entry>font-size</entry>
+ </row>
+ <row>
+ <entry>headerWeightFont</entry>
+ <entry>font-weight</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Skin parameters redefinition for a selected rows in the source and target lists</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>additionalBackgroundColor</entry>
+ <entry>background-color</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Skin parameters redefinition for a header cell</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>headerBackgroundColor</entry>
+ <entry>background-color</entry>
+ </row>
+ <row>
+ <entry>headerTextColor</entry>
+ <entry>color</entry>
+ </row>
+ <row>
+ <entry>headerFamilyFont</entry>
+ <entry>font-family</entry>
+ </row>
+ <row>
+ <entry>headerSizeFont</entry>
+ <entry>font-size</entry>
+ </row>
+ <!--row>
+ <entry>headerWeightFont</entry>
+ <entry>font-weight</entry>
+ </row-->
+ <row>
+ <entry>tableBorderWidth</entry>
+ <entry>border-width</entry>
+ </row>
+ <row>
+ <entry>subBorderColor</entry>
+ <entry>border-top-color</entry>
+ </row>
+ <row>
+ <entry>panelBorderColor</entry>
+ <entry>border-bottom-color</entry>
+ </row>
+ <row>
+ <entry>panelBorderColor</entry>
+ <entry>border-right-color</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Skin parameters redefinition for a selected cell</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>generalTextColor</entry>
+ <entry>color</entry>
+ </row>
+ <row>
+ <entry>generalFamilyFont</entry>
+ <entry>font-family</entry>
+ </row>
+ <row>
+ <entry>generalSizeFont</entry>
+ <entry>font-size</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+
+
+ <table>
+ <title>Skin parameters redefinition for an active cell</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>generalSizeFont</entry>
+ <entry>font-size</entry>
+ </row>
+ <row>
+ <entry>generalFamilyFont</entry>
+ <entry>font-family</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Skin parameters redefinition for controls</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>tableBorderColor</entry>
+ <entry>border-color</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Skin parameters redefinition for a button</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>trimColor</entry>
+ <entry>background-color</entry>
+ </row>
+ <row>
+ <entry>generalTextColor</entry>
+ <entry>color</entry>
+ </row>
+ <row>
+ <entry>headerFamilyFont</entry>
+ <entry>font-family</entry>
+ </row>
+ <row>
+ <entry>headerSizeFont</entry>
+ <entry>font-size</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Skin parameters redefinition for a disabled button</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>trimColor</entry>
+ <entry>background-color</entry>
+ </row>
+ <row>
+ <entry>tabDisabledTextColor</entry>
+ <entry>color</entry>
+ </row>
+ <row>
+ <entry>headerFamilyFont</entry>
+ <entry>font-family</entry>
+ </row>
+ <row>
+ <entry>headerSizeFont</entry>
+ <entry>font-size</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Skin parameters redefinition for a button highlight</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>trimColor</entry>
+ <entry>background-color</entry>
+ </row>
+ <row>
+ <entry>selectControlColor</entry>
+ <entry>border-color</entry>
+ </row>
+ <row>
+ <entry>tableBorderWidth</entry>
+ <entry>border-width</entry>
+ </row>
+ <row>
+ <entry>headerFamilyFont</entry>
+ <entry>font-family</entry>
+ </row>
+ <row>
+ <entry>headerSizeFont</entry>
+ <entry>font-size</entry>
+ </row>
+ <row>
+ <entry>generalTextColor</entry>
+ <entry>color</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Skin parameters redefinition for a pressed button</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>additionalBackgroundColor</entry>
+ <entry>background-color</entry>
+ </row>
+ <row>
+ <entry>tableBorderColor</entry>
+ <entry>border-color</entry>
+ </row>
+ <row>
+ <entry>tableBorderWidth</entry>
+ <entry>border-width</entry>
+ </row>
+ <row>
+ <entry>headerFamilyFont</entry>
+ <entry>font-family</entry>
+ </row>
+ <row>
+ <entry>headerSizeFont</entry>
+ <entry>font-size</entry>
+ </row>
+ <row>
+ <entry>generalTextColor</entry>
+ <entry>color</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Skin parameters redefinition for a button content</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>headerFamilyFont</entry>
+ <entry>font-family</entry>
+ </row>
+ <row>
+ <entry>headerSizeFont</entry>
+ <entry>font-size</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Skin parameters redefinition for a button selection</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>generalTextColor</entry>
+ <entry>color</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ </section>
+
+ <section>
<title>Definition of Custom Style Classes</title>
<para>On the screenshot there are classes names that define styles for component elements.</para>
- <!-- ADD SCREENSHOT -->
+ <figure>
+ <title>Style classes</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/listShuttle_classes_s.png" scalefit="1"/>
+ </imageobject>
+ </mediaobject>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/listShuttle_classes_t.png" scalefit="1"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
- <!-- ADD ITEMS representations!!!-->
-
<table>
- <title>Classes names that define a caption representations in the source list</title>
+ <title>Classes names that define a list representation</title>
<tgroup cols="2">
<thead>
<row>
@@ -434,14 +824,43 @@
</thead>
<tbody>
<row>
- <entry>rich-shuttle-source-caption</entry>
- <entry>Defines a class for caption customization</entry>
+ <entry>rich-list-shuttle</entry>
+ <entry>Defines styles for a wrapper table element of a listShuttle</entry>
</row>
+ <row>
+ <entry>rich-list-shuttle-caption</entry>
+ <entry>Defines styles for a list caption</entry>
+ </row>
+ <row>
+ <entry>rich-shuttle-body</entry>
+ <entry>Defines styles for a list body</entry>
+ </row>
+ <row>
+ <entry>rich-shuttle-list-content</entry>
+ <entry>Defines styles for a list content</entry>
+ </row>
+ <row>
+ <entry>rich-shuttle-source-items</entry>
+ <entry>Defines styles for a wrapper <div> element for source list</entry>
+ </row>
+ <row>
+ <entry>rich-shuttle-target-items</entry>
+ <entry>Defines styles for a wrapper <div> element for target list</entry>
+ </row>
+ <row>
+ <entry>rich-shuttle-list-header</entry>
+ <entry>Defines styles for a lists header</entry>
+ </row>
+ <row>
+ <entry>rich-shuttle-header-tab-cell</entry>
+ <entry>Defines styles for a header cell</entry>
+ </row>
</tbody>
</tgroup>
</table>
+
<table>
- <title>Classes names that define a caption representations in the target list</title>
+ <title>Classes names that define a caption representations in a source and target lists</title>
<tgroup cols="2">
<thead>
<row>
@@ -451,14 +870,19 @@
</thead>
<tbody>
<row>
+ <entry>rich-shuttle-source-caption</entry>
+ <entry>Defines styles for a caption in a source list</entry>
+ </row>
+ <row>
<entry>rich-shuttle-target-caption</entry>
- <entry>Defines a class for caption customization</entry>
+ <entry>Defines styles for a caption in a target list</entry>
</row>
</tbody>
</tgroup>
</table>
+
<table>
- <title>Classes names that define a rows representations in the source list</title>
+ <title>Classes names that define a rows representations in a source list</title>
<tgroup cols="2">
<thead>
<row>
@@ -469,21 +893,21 @@
<tbody>
<row>
<entry>rich-shuttle-source-row</entry>
- <entry>Defines a default class for any item row</entry>
+ <entry>Defines styles for a row in a source list</entry>
</row>
<row>
- <entry>rich-shuttle-row-source-selected</entry>
- <entry>Defines class to be additionally added to selected item rows</entry>
+ <entry>rich-shuttle-source-row-selected</entry>
+ <entry>Defines styles for a selected row in a source list</entry>
</row>
<row>
- <entry>rich-shuttle-row-source-active</entry>
- <entry>Defines class to be additionally added to active item rows</entry>
+ <entry>rich-shuttle-source-row-active</entry>
+ <entry>Defines styles for an active row in a source list</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
- <title>Classes names that define a rows representations in the target list</title>
+ <title>Classes names that define a rows representations in a target list</title>
<tgroup cols="2">
<thead>
<row>
@@ -493,22 +917,22 @@
</thead>
<tbody>
<row>
- <entry>rich-shuttle-target -row</entry>
- <entry>Defines a default class for any item row</entry>
+ <entry>rich-shuttle-target-row</entry>
+ <entry>Defines styles for a row in a target list</entry>
</row>
<row>
- <entry>rich-shuttle-row-target -selected</entry>
- <entry>Defines class to be additionally added to selected item rows</entry>
+ <entry>rich-shuttle-target-row-selected</entry>
+ <entry>Defines styles for a selected row in a target list</entry>
</row>
<row>
- <entry>rich-shuttle-row-target -active</entry>
- <entry>Defines class to be additionally added to active item rows</entry>
+ <entry>rich-shuttle-target-row-active</entry>
+ <entry>Defines styles for an active row in a target list</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
- <title>Classes names that define a cells representations in the source list</title>
+ <title>Classes names that define a cells representations in a source list</title>
<tgroup cols="2">
<thead>
<row>
@@ -519,21 +943,21 @@
<tbody>
<row>
<entry>rich-shuttle-source-cell</entry>
- <entry>Defines a default class for any item cell</entry>
+ <entry>Defines styles for a cell in a source list</entry>
</row>
<row>
<entry>rich-shuttle-source-cell-selected</entry>
- <entry>Defines class to be additionally added to selected item cells</entry>
+ <entry>Defines styles for a selected cell in a source list</entry>
</row>
<row>
<entry>rich-shuttle-source-cell-active</entry>
- <entry>Defines class to be additionally added to active item cells</entry>
+ <entry>Defines styles for an active cell in a source list</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
- <title>Classes names that define a cells representations in the target list</title>
+ <title>Classes names that define a cells representations in a target list</title>
<tgroup cols="2">
<thead>
<row>
@@ -543,16 +967,16 @@
</thead>
<tbody>
<row>
- <entry>rich-shuttle-target -cell</entry>
- <entry>Defines a default class for any item cell</entry>
+ <entry>rich-shuttle-target-cell</entry>
+ <entry>Defines styles for a cell in a target list</entry>
</row>
<row>
- <entry>rich-shuttle-target -cell-selected</entry>
- <entry>Defines class to be additionally added to selected item cells</entry>
+ <entry>rich-shuttle-target-cell-selected</entry>
+ <entry>Defines styles for a selected cell in a target list</entry>
</row>
<row>
- <entry>rich-shuttle-target -cell-active</entry>
- <entry>Defines class to be additionally added to active item cells</entry>
+ <entry>rich-shuttle-target-cell-active</entry>
+ <entry>Defines styles for an active cell in a target list</entry>
</row>
</tbody>
</tgroup>
@@ -568,51 +992,89 @@
</thead>
<tbody>
<row>
- <entry>rich-ordering-controls</entry>
- <entry>Could be applied to the whole group of the controls.</entry>
+ <entry>rich-shuttle-controls</entry>
+ <entry>Defines styles for a controls group</entry>
</row>
<row>
<entry>rich-shuttle-top</entry>
- <entry>Defines class for Top control</entry>
+ <entry>Defines styles for a "Top" control</entry>
</row>
<row>
<entry>rich-shuttle-bottom</entry>
- <entry>Defines class for Bottom control</entry>
+ <entry>Defines styles for a "Bottom" control</entry>
</row>
<row>
<entry>rich-shuttle-up</entry>
- <entry>Defines class for Up control</entry>
+ <entry>Defines styles for a "Up" control</entry>
</row>
<row>
<entry>rich-shuttle-down</entry>
- <entry>Defines class for Down control</entry>
+ <entry>Defines styles for a "Down" control</entry>
</row>
<row>
<entry>rich-shuttle-copy</entry>
- <entry>Defines class for Copy control</entry>
+ <entry>Defines styles for a "Copy" control</entry>
</row>
<row>
<entry>rich-shuttle-remove</entry>
- <entry>Defines class for Remove control</entry>
+ <entry>Defines styles for a "Remove" control</entry>
</row>
<row>
<entry>rich-shuttle-copyAll</entry>
- <entry>Defines class for copyAll control</entry>
+ <entry>Defines styles for a "copyAll" control</entry>
</row>
<row>
<entry>rich-shuttle-removeAll</entry>
- <entry>Defines class for removeAll control</entry>
+ <entry>Defines styles for a "removeAll" control</entry>
</row>
<row>
<entry>rich-shuttle-control-disabled</entry>
- <entry>Defines a class for any control in a disabled state</entry>
+ <entry>Defines styles for a control in a disabled state</entry>
</row>
</tbody>
</tgroup>
</table>
+
+ <table>
+ <title>Classes names that define a button representation</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Class name</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>rich-list-shuttle-button</entry>
+ <entry>Defines styles for a button</entry>
+ </row>
+ <row>
+ <entry>rich-list-shuttle-button-disabled</entry>
+ <entry>Defines styles for a disabled button</entry>
+ </row>
+ <row>
+ <entry>rich-list-shuttle-button-light</entry>
+ <entry>Defines styles for a button highlight</entry>
+ </row>
+ <row>
+ <entry>rich-list-shuttle-button-press</entry>
+ <entry>Defines styles for a pressed button</entry>
+ </row>
+ <row>
+ <entry>rich-list-shuttle-button-content</entry>
+ <entry>Defines styles for a button content</entry>
+ </row>
+ <row>
+ <entry>rich-list-shuttle-button-selection</entry>
+ <entry>Defines styles for a button selection</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
<para>In order to redefine styles for all <emphasis role="bold">
<property><rich:listShuttle></property>
</emphasis> components on a page using CSS, it's enough to create classes with the same
@@ -624,4 +1086,13 @@
<property><rich:listShuttle></property>
</emphasis> component attributes.</para>
</section>
+
+ <section>
+ <title>Relevant Resources Links</title>
+ <para><ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/listShuttle.jsf?c=listShuttle"
+ >Here</ulink> you can see an example of <emphasis role="bold">
+ <property><rich:listShuttle></property>
+ </emphasis> usage and sources for the given example. </para>
+ </section>
+
</section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/menuItem.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/menuItem.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/en/src/main/docbook/included/menuItem.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -110,7 +110,7 @@
</listitem>
</itemizedlist>
- <para>The standard form submission is performed and the page is completely refreshed.</para>
+ <para>Regular form submission request is used.</para>
<itemizedlist>
<listitem>
@@ -118,9 +118,7 @@
</listitem>
</itemizedlist>
- <para>An Ajax form submission is performed, and specified elements in the <emphasis>
- <property>"reRender"</property>
- </emphasis> attribute are rerendered.</para>
+ <para>Ajax submission is used for switching.</para>
<itemizedlist>
<listitem>
@@ -132,14 +130,14 @@
<property>"action"</property>
</emphasis> and <emphasis>
<property>"actionListener"</property>
- </emphasis> item's attributes are ignored. Menu items don't fire any submits themselves.
- The behavior is fully defined by the components nested inside items.</para>
+ </emphasis> item's attributes are ignored. Menu items don' fire any submits themselves.
+ The behavior is fully defined by the components nested into items.</para>
<para> For example, you can put any content into an item, but, in this case, you should set
the <emphasis>
<property>"mode"</property>
</emphasis> attribute as <emphasis>
<property>"none"</property>
- </emphasis>. </para>
+ </emphasis>.</para>
<para> Here is an example: </para>
<programlisting role="XML"><![CDATA[...
<rich:dropDownMenu>
Modified: trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/en/src/main/docbook/included/modalPanel.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -302,6 +302,40 @@
url="http://www.jboss.com/index.html?module=bb&op=viewtopic&p=4064191"
>RichFaces Users Forum</ulink>.</para>
</section>
+
+ <section>
+ <title>JavaScript API</title>
+ <table>
+ <title>JavaScript API</title>
+
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Function</entry>
+
+ <entry>Description</entry>
+ </row>
+ </thead>
+
+ <tbody>
+
+ <row>
+ <entry>Show()</entry>
+
+ <entry>Shows the corresponding tooltip</entry>
+ </row>
+
+ <row>
+ <entry>Hide()</entry>
+
+ <entry>Hides the corresponding tooltip</entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+
+ </section>
<section>
<title>Look-and-Feel Customization</title>
Modified: trunk/docs/userguide/en/src/main/docbook/included/orderingList.desc.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/orderingList.desc.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/en/src/main/docbook/included/orderingList.desc.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -19,12 +19,12 @@
<section>
<title>Key Features</title>
<itemizedlist>
- <!--listitem>Skinnable <property>ordering list</property> and child items</listitem-->
<listitem>Highly customizable look and feel</listitem>
- <listitem>Reordering and sorting possibilities for list items</listitem>
+ <listitem>Reordering possibility for list items</listitem>
<!--listitem>Customizable component layout (captions, headers, list items and ordering control set)</listitem-->
<!--listitem>Disabled/enabled ordering controls</listitem-->
- <listitem>Multiple selection of list items</listitem>
+ <listitem>Multiple selection of list items</listitem>
+ <listitem>Keyboard support</listitem>
<!--listitem>Possibility to manage selection from
<itemizedlist>
<listitem>Keyboard</listitem>
Modified: trunk/docs/userguide/en/src/main/docbook/included/orderingList.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/orderingList.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/en/src/main/docbook/included/orderingList.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -59,7 +59,7 @@
<f:facet name="header">
<h:outputText value="Name" />
</f:facet>
- <h:inputText value="#{item.name}" />
+ <h:inputText value="#{list.name}" />
</rich:column>
<rich:orderingList>
...]]></programlisting>
@@ -94,44 +94,64 @@
<!-- attributes of component orderingList -->
- <para> The <emphasis>
+ <para>The <emphasis>
<property> "value"</property>
</emphasis> and <emphasis>
<property>"var" </property>
</emphasis> attributes are used to access the values of a list. </para>
- <para>The <emphasis>
+ <para>Controls rendering is based on the <emphasis>
+ <property>"controlsType" </property>
+ </emphasis> attribute. Possible types are button or none.
+ </para>
+ <note>
+ <para>
+ Currently the button controls type is based on <div> element.
+ </para>
+ </note>
+
+
+ <para> The <emphasis>
<property>"selection" </property>
- </emphasis> attribute is bound to a list, which stores a set of indexes for rows
- selected. If the index from a set is out of bounds, it should be ignored. </para>
- <para>Controls rendering is based on the <emphasis>
- <property>"controlsType" </property>
- </emphasis> attribute. Possible types are button, link, none.</para>
+ </emphasis> attribute stores the collection of items selected by user. In the example
+ below after submitting the form the current collection is placed in the object's
+ property and then <emphasis role="bold">
+ <property><rich:dataTable></property>
+ </emphasis> with selected items will be shown. </para>
+
<para>
<emphasis role="bold">Example:</emphasis>
</para>
<programlisting role="XML"><![CDATA[...
-<rich:orderingList value="#{bean.simpleItems}" var="item" selection="#{bean.selection}" controlsType="button">
- <rich:column>
- <f:facet name="header">
- <h:outputText value="Cars" />
- </f:facet>
- <h:outputText value="#{item}" />
- </rich:column>
-</rich:orderingList>
+<h:form>
+ <rich:orderingList value="#{bean.simpleItems}" var="item" selection="#{bean.selection}" controlsType="button">
+ <rich:column>
+ <f:facet name="header">
+ <h:outputText value="Cars" />
+ </f:facet>
+ <h:outputText value="#{item}" />
+ </rich:column>
+ </rich:orderingList>
+ <rich:dataTable id="infoPanelID" value="#{bean.info}" var="info" rendered="true">
+ <rich:column>
+ <h:outputText value="#{info}" />
+ </rich:column>
+ </rich:dataTable>
+ <a4j:commandButton value="reRender" reRender="infoPanelID" />
+</h:form>
...]]></programlisting>
-
<para> The <emphasis role="bold">
<property><rich:orderingList></property>
</emphasis> component allows to use <emphasis>
<property>"caption"</property>
- </emphasis>, <emphasis>
- <property>"header"</property>
- </emphasis> and <emphasis>
+ </emphasis>
+ <!--and <emphasis>
<property>"footer" </property>
- </emphasis> facets. A caption could be also defined with <emphasis>
- <property>"captionLabel"</property>
- </emphasis> attribute.</para>
+ </emphasis> -->
+ facet.
+ A caption could be also defined with <emphasis>
+ <property>"captionLabel"</property></emphasis> attribute.
+ </para>
<!-- ADD SCREENSHOT-->
@@ -141,22 +161,21 @@
</para>
<programlisting role="XML"><![CDATA[...
<rich:orderingList value="#{bean.simpleItems}" var="item" controlsType="button" selection="#{bean.selection}">
- <f:facet name="caption"><h:outputText value="Caption Facet" /></f:facet>
- <f:facet name="header"><h:outputText value="Header Facet" /></f:facet>
- <h:outputText value="#{item}" />
+ <f:facet name="caption">
+ <h:outputText value="Caption Facet" />
+ </f:facet>
<rich:column>
- <f:facet name="header">
- <h:outputText value="Cars" />
- </f:facet>
- <h:outputText value="#{item.name}" />
+ <f:facet name="header">
+ <h:outputText value="Cars" />
+ </f:facet>
+ <h:outputText value="#{item.name}" />
</rich:column>
- <rich:column>
- <f:facet name="header">
- <h:outputText value="Price" />
- </f:facet>
- <h:outputText value="#{item.price}" />
+ <rich:column>
+ <f:facet name="header">
+ <h:outputText value="Price" />
+ </f:facet>
+ <h:outputText value="#{item.price}" />
</rich:column>
- <f:facet name="footer"><h:outputText value="Footer Facet" /></f:facet>
</rich:orderingList>
...]]></programlisting>
@@ -165,8 +184,16 @@
<property><rich:orderingList></property>
</emphasis> component provides the possibility to use <property>ordering controls
set</property>, which performs reordering. Every control has possibility to be disabled. </para>
- <para>
- <emphasis>
+ <para>An <property>ordering controls set</property> could be defined with <emphasis>
+ <property>"topControlLabel"</property>
+ </emphasis>, <emphasis>
+ <property>"bottomControlLabel"</property>
+ </emphasis>, <emphasis>
+ <property>"upControlLabel"</property>
+ </emphasis>, <emphasis>
+ <property>"downControlLabel"</property>
+ </emphasis>attributes. </para>
+ <para>It is also possible to use <emphasis>
<property> "topControl" </property>
</emphasis>, <emphasis>
<property>"topControlDisabled"</property>
@@ -182,23 +209,23 @@
<property> "downControl"</property>
</emphasis> , <emphasis>
<property> "downControlDisabled" </property>
- </emphasis> facets are used to replaces the default control with facets content.</para>
+ </emphasis> facets in order to replace the default controls with facets content. </para>
<para>
<emphasis role="bold">Example:</emphasis>
</para>
<programlisting role="XML"><![CDATA[...
<rich:orderingList value="#{bean.simpleItems}" var="item" controlsType="button" selection="#{bean.selection}">
<f:facet name="topControl">
- <h:outputText value="Move to top">
+ <h:outputText value="Move to top" />
</f:facet>
- <f:facet name="upControl">
- <h:outputText value="Move up">
+ <f:facet name="upControl">
+ <h:outputText value="Move up" />
</f:facet>
- <f:facet name="downControl">
- <h:outputText value="Move down">
+ <f:facet name="downControl">
+ <h:outputText value="Move down" />
</f:facet>
- <f:facet name="bottomControl">
- <h:outputText value="Move to bottom">
+ <f:facet name="bottomControl">
+ <h:outputText value="Move to bottom" />
</f:facet>
<rich:orderingList>
...]]></programlisting>
@@ -213,7 +240,7 @@
list </listitem>
<listitem>top - controls could be rendered above the list </listitem>
<listitem>bottom - controls could be rendered below the list </listitem>
-
+ </itemizedlist>
</listitem-->
<listitem><emphasis>
<property> "controlsHorizontalAlign"</property>
@@ -237,7 +264,6 @@
</emphasis> attribute. Possible values: <itemizedlist>
<listitem>inline - controls defined one by one in line </listitem>
<listitem>block - controls defined in column </listitem>
- <listitem/>
</itemizedlist>
</listitem-->
</itemizedlist>
@@ -309,12 +335,8 @@
already present in a list</entry>
</row>
<row>
- <entry>Space</entry>
- <entry>Inverts selection on the active element</entry>
- </row>
- <row>
<entry>Up, Down arrows</entry>
- <entry>Changes the active elements to the next or previous in a list</entry>
+ <entry>Changes the active and selected elements to the next or previous in a list</entry>
</row>
</tbody>
</tgroup>
@@ -333,11 +355,11 @@
<tbody>
<!--Sorting API -->
<row>
- <entry>Top</entry>
+ <entry>Page Up</entry>
<entry>Moves selected set to the top of a list</entry>
</row>
<row>
- <entry>Bottom</entry>
+ <entry>Page Down</entry>
<entry>Moves selected set to the bottomof a list</entry>
</row>
<row>
@@ -357,92 +379,79 @@
<title>JavaScript API</title>
<table>
<title>JavaScript API</title>
- <tgroup cols="3">
+ <tgroup cols="2">
<thead>
<row>
<entry>Function</entry>
<entry>Description</entry>
- <!--entry>Element</entry-->
</row>
</thead>
<tbody>
<!--Sorting API -->
+ <!--
<row>
- <entry>doSortAscending()</entry>
+ <entry>SortAscending()</entry>
<entry>Sorts items in the list ascending</entry>
- <!--entry>Component</entry-->
</row>
<row>
- <entry>doSortDescending()</entry>
+ <entry>SortDescending()</entry>
<entry>Sorts items in the list descending</entry>
- <!--entry>Component</entry-->
</row>
<row>
- <entry>doSort()</entry>
+ <entry>Sort()</entry>
<entry>Inverts current sorting</entry>
- <!--entry>Component</entry-->
</row>
+ -->
+
<!--Controls common API -->
<row>
- <entry>doHide()</entry>
+ <entry>Hide()</entry>
<entry>Hides ordering control</entry>
- <!--entry>Any Ordering control</entry-->
</row>
<row>
- <entry>doShow()</entry>
+ <entry>Show()</entry>
<entry>Shows ordering control</entry>
- <!--entry>Any Ordering control</entry-->
</row>
<row>
<entry>isShown()</entry>
<entry>Checks if current control is shown</entry>
- <!--entry>Any Ordering control</entry-->
</row>
<row>
- <entry>doEnable()</entry>
+ <entry>Enable()</entry>
<entry>Enables ordering control</entry>
- <!--entry>Any Ordering control</entry-->
</row>
<row>
- <entry>doDisable()</entry>
+ <entry>Disable()</entry>
<entry>Disables ordering control</entry>
- <!--entry>Any Ordering control</entry-->
</row>
<row>
<entry>isEnabled()</entry>
<entry>Checksif current control is enabled</entry>
- <!--entry>Any Ordering control</entry-->
</row>
<!--List managing API -->
<row>
<entry>moveUp()</entry>
<entry>Moves up selected item in the list</entry>
- <!--entry>Any Item</entry-->
</row>
<row>
<entry>moveDown()</entry>
<entry>Moves down selected item in the list</entry>
- <!--entry>Any Item</entry-->
</row>
<row>
<entry>moveTop()</entry>
<entry>Moves top selected item in the list</entry>
- <!--entry>Any Item</entry-->
</row>
<row>
<entry>moveBottom()</entry>
<entry>Moves bottom selected item in the list</entry>
- <!--entry>Any Item</entry-->
</row>
<row>
<entry>getSelection()</entry>
<entry>Returns currently selected item</entry>
- <!--entry>Any Item</entry-->
</row>
<row>
<entry>getItems()</entry>
<entry>Returns the collection of all items</entry>
- <!--entry>Any Item</entry-->
</row>
</tbody>
</tgroup>
@@ -466,14 +475,475 @@
</itemizedlist>
</para>
</section>
+
<section>
+ <title>Skin Parameters Redefinition</title>
+
+ <table>
+ <title>Skin parameters redefinition for a wrapper <div> element of a list</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>tableBackgroundColor</entry>
+ <entry>background-color</entry>
+ </row>
+ <row>
+ <entry>tableBorderColor</entry>
+ <entry>border-color</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Skin parameters redefinition for a header cell of a list</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>trimColor</entry>
+ <entry>background-color</entry>
+ </row>
+ <row>
+ <entry>generalTextColor</entry>
+ <entry>color</entry>
+ </row>
+ <row>
+ <entry>headerFamilyFont</entry>
+ <entry>font-family</entry>
+ </row>
+ <row>
+ <entry>headerSizeFont</entry>
+ <entry>font-size</entry>
+ </row>
+
+ <row>
+ <entry>tableBorderWidth</entry>
+ <entry>border-right-width</entry>
+ </row>
+ <row>
+ <entry>tableBorderWidth</entry>
+ <entry>border-bottom-width</entry>
+ </row>
+ <row>
+ <entry>tableBorderColor</entry>
+ <entry>border-right-color</entry>
+ </row>
+ <row>
+ <entry>tableBorderColor</entry>
+ <entry>border-bottom-color</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Skin parameters redefinition for caption element</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>headerFamilyFont</entry>
+ <entry>font-family</entry>
+ </row>
+ <row>
+ <entry>headerSizeFont</entry>
+ <entry>font-size</entry>
+ </row>
+ <row>
+ <entry>headerWeightFont</entry>
+ <entry>font-weight</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Skin parameters redefinition for row element</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>headerGradientColor</entry>
+ <entry>background-color</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Skin parameters redefinition for selected row element</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>additionalBackgroundColor</entry>
+ <entry>background-color</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Skin parameters redefinition for cell element</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>generalTextColor</entry>
+ <entry>color</entry>
+ </row>
+ <row>
+ <entry>generalFamilyFont</entry>
+ <entry>font-family</entry>
+ </row>
+ <row>
+ <entry>generalSizeFont</entry>
+ <entry>font-size</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Skin parameters redefinition for selected cell element</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>generalTextColor</entry>
+ <entry>color</entry>
+ </row>
+ <row>
+ <entry>generalFamilyFont</entry>
+ <entry>font-family</entry>
+ </row>
+ <row>
+ <entry>generalSizeFont</entry>
+ <entry>font-size</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Skin parameters redefinition for active cell element</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>generalFamilyFont</entry>
+ <entry>font-family</entry>
+ </row>
+ <row>
+ <entry>generalSizeFont</entry>
+ <entry>font-size</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Skin parameters redefinition for a button</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>trimColor</entry>
+ <entry>background-color</entry>
+ </row>
+ <row>
+ <entry>generalTextColor</entry>
+ <entry>color</entry>
+ </row>
+ <row>
+ <entry>headerFamilyFont</entry>
+ <entry>font-family</entry>
+ </row>
+ <row>
+ <entry>headerSizeFont</entry>
+ <entry>font-size</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Skin parameters redefinition for a disabled button</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>trimColor</entry>
+ <entry>background-color</entry>
+ </row>
+ <row>
+ <entry>tabDisabledTextColor</entry>
+ <entry>color</entry>
+ </row>
+ <row>
+ <entry>headerFamilyFont</entry>
+ <entry>font-family</entry>
+ </row>
+ <row>
+ <entry>headerSizeFont</entry>
+ <entry>font-size</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Skin parameters redefinition for a button highlight</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>trimColor</entry>
+ <entry>background-color</entry>
+ </row>
+ <row>
+ <entry>selectControlColor</entry>
+ <entry>border-color</entry>
+ </row>
+ <row>
+ <entry>tableBorderWidth</entry>
+ <entry>border-width</entry>
+ </row>
+ <row>
+ <entry>headerFamilyFont</entry>
+ <entry>font-family</entry>
+ </row>
+ <row>
+ <entry>headerSizeFont</entry>
+ <entry>font-size</entry>
+ </row>
+ <row>
+ <entry>generalTextColor</entry>
+ <entry>color</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Skin parameters redefinition for a pressed button</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>additionalBackgroundColor</entry>
+ <entry>background-color</entry>
+ </row>
+ <row>
+ <entry>tableBorderColor</entry>
+ <entry>border-color</entry>
+ </row>
+ <row>
+ <entry>tableBorderWidth</entry>
+ <entry>border-width</entry>
+ </row>
+ <row>
+ <entry>headerFamilyFont</entry>
+ <entry>font-family</entry>
+ </row>
+ <row>
+ <entry>headerSizeFont</entry>
+ <entry>font-size</entry>
+ </row>
+ <row>
+ <entry>generalTextColor</entry>
+ <entry>color</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Skin parameters redefinition for a button content</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>headerFamilyFont</entry>
+ <entry>font-family</entry>
+ </row>
+ <row>
+ <entry>headerSizeFont</entry>
+ <entry>font-size</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Skin parameters redefinition for a button selection</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>generalTextColor</entry>
+ <entry>color</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Skin parameters redefinition for top, bottom, up, down controls and for controls
+ in disabled state</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Skin parameters</entry>
+ <entry>CSS properties</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>panelBorderColor</entry>
+ <entry>border-color</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ </section>
+
+ <section>
<title>Definition of Custom Style Classes</title>
<para>On the screenshot there are classes names that define styles for component elements.</para>
- <!-- ADD SCREENSHOT -->
+ <figure>
+ <title>Style classes</title>
+
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/orderingList_classes.png" scalefit="1"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+
<table>
+ <title>Classes names that define a list representation</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Class name</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>rich-ordering-list-body</entry>
+ <entry>Defines styles for a wrapper table element of an orderingList</entry>
+ </row>
+ <row>
+ <entry>rich-ordering-list-output</entry>
+ <entry>Defines styles for a wrapper <div> element of a
+ list</entry>
+ </row>
+ <row>
+ <entry>rich-ordering-list-items</entry>
+ <entry>Defines styles for a wrapper table element of items in the
+ list</entry>
+ </row>
+ <row>
+ <entry>rich-ordering-list-content</entry>
+ <entry>Defines styles for a list content</entry>
+ </row>
+ <row>
+ <entry>rich-ordering-list-header</entry>
+ <entry>Defines styles for a wrapper <div> element for a list
+ header</entry>
+ </row>
+ <row>
+ <entry>rich-ordering-list-table-header</entry>
+ <entry>Defines styles for a wrapper <tr> element for a list
+ header</entry>
+ </row>
+ <row>
+ <entry>rich-ordering-list-table-header-cell</entry>
+ <entry>Defines styles for a header cell</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
<title>Classes names that define a caption representation</title>
<tgroup cols="2">
<thead>
@@ -499,8 +969,9 @@
</tgroup>
</table>
+
<table>
- <title>Classes names that define item rows representations</title>
+ <title>Classes names that define rows representation</title>
<tgroup cols="2">
<thead>
<row>
@@ -511,25 +982,25 @@
<tbody>
<row>
<entry>rich-ordering-list-row</entry>
- <entry>Defines styles for an item row</entry>
+ <entry>Defines styles for a row</entry>
</row>
<row>
<entry>rich-ordering-list-row-selected</entry>
- <entry>Defines styles for a selected item row</entry>
+ <entry>Defines styles for a selected row</entry>
</row>
<row>
<entry>rich-ordering-list-row-active</entry>
- <entry>Defines styles for an active item row</entry>
+ <entry>Defines styles for an active row</entry>
</row>
<row>
<entry>rich-ordering-list-row-disabled</entry>
- <entry>Defines styles for a disabled item row</entry>
+ <entry>Defines styles for a disabled row</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
- <title>Classes names that define item cells representations</title>
+ <title>Classes names that define cells representation</title>
<tgroup cols="2">
<thead>
<row>
@@ -539,27 +1010,27 @@
</thead>
<tbody>
<row>
- <entry>rich-ordering-list-item-cell</entry>
- <entry>Defines styles for an item cell</entry>
+ <entry>rich-ordering-list-cell</entry>
+ <entry>Defines styles for a cell</entry>
</row>
<row>
- <entry>rich-ordering-list-item-cell-selected</entry>
- <entry>Defines styles for a selected item cell</entry>
+ <entry>rich-ordering-list-cell-selected</entry>
+ <entry>Defines styles for a selected cell</entry>
</row>
<row>
- <entry>rich-ordering-list-item-cell-active</entry>
- <entry>Defines styles for an active item cell</entry>
+ <entry>rich-ordering-list-cell-active</entry>
+ <entry>Defines styles for an active cell</entry>
</row>
<row>
<entry>rich-ordering-list-cell-disabled</entry>
- <entry>Defines styles for a disabled item cell</entry>
+ <entry>Defines styles for a disabled cell</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
- <title>Classes names that define controls representations</title>
+ <title>Classes names that define a button representation</title>
<tgroup cols="2">
<thead>
<row>
@@ -569,6 +1040,56 @@
</thead>
<tbody>
<row>
+ <entry>rich-ordering-list-button</entry>
+ <entry>Defines styles for a button</entry>
+ </row>
+ <row>
+ <entry>rich-ordering-list-button-disabled</entry>
+ <entry>Defines styles for a disabled button</entry>
+ </row>
+ <row>
+ <entry>rich-ordering-list-button-light</entry>
+ <entry>Defines styles for a button highlight</entry>
+ </row>
+ <row>
+ <entry>rich-ordering-list-button-press</entry>
+ <entry>Defines styles for a pressed button</entry>
+ </row>
+ <row>
+ <entry>rich-ordering-list-button-content</entry>
+ <entry>Defines styles for a button content</entry>
+ </row>
+ <row>
+ <entry>rich-ordering-list-button-selection</entry>
+ <entry>Defines styles for a button selection</entry>
+ </row>
+ <row>
+ <entry>rich-ordering-list-button-valign</entry>
+ <entry>Defines styles for a wrapper <td> element for buttons
+ vertical align</entry>
+ </row>
+ <row>
+ <entry>rich-ordering-list-button-layout</entry>
+ <entry>Defines styles for a wrapper <div> element of buttons
+ layout</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+
+
+ <table>
+ <title>Classes names that define controls representation</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Class name</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
<entry>rich-ordering-controls</entry>
<entry>Defines styles for a controls group</entry>
</row>
@@ -606,4 +1127,14 @@
<property><rich:orderingList></property>
</emphasis> component attributes.</para>
</section>
+
+ <section>
+ <title>Relevant Resources Links</title>
+ <para><ulink
+ url="http://livedemo.exadel.com/richfaces-demo/richfaces/orderingList.jsf?c=orderingList"
+ >Here</ulink> you can see an example of <emphasis role="bold">
+ <property><rich:orderingList></property>
+ </emphasis> usage and sources for the given example. </para>
+ </section>
+
</section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/en/src/main/docbook/included/outputPanel.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -99,8 +99,8 @@
none
</listitem>
</itemizedlist>
- <para>If layout="block" is chosen, the component is rendered as a pair of opening and closing <emphasis role="bold"><property><div></property></emphasis> tag, to which it's possible to apply any available style attributes available for block tags. </para>
- <para>Layout="none" helps to avoid an unnecessary tag round a context that could or couldn't be rendered according to the defined <emphasis><property>"rendered"</property></emphasis> attribute conditions. If an inner context isn't rendered, <emphasis role="bold">
+ <para>If layout="block" is chosen, the component is rendered as a pair of opening and closing <emphasis role="bold"><property><div></property></emphasis> tag, to which it's possible to apply any available style attributes available for block tags. </para>
+ <para>Layout="none" helps to avoid an unnecessary tag round a context that could or couldn't be rendered according to the defined <emphasis><property>"rendered"</property></emphasis> attribute conditions. If an inner context isn’t rendered, <emphasis role="bold">
<property><a4j:outputPanel></property>
</emphasis> is rendered as a <emphasis role="bold"><property><span></property></emphasis> tag with the id equal to an id of a child component and "display:none" style. If a child component is rendered, <emphasis role="bold">
<property><a4j:outputPanel></property>
Modified: trunk/docs/userguide/en/src/main/docbook/included/panelMenu.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/panelMenu.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/en/src/main/docbook/included/panelMenu.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -121,7 +121,7 @@
</listitem>
</itemizedlist>
- <para>The common submission of the form is performed and a page is completely refreshed.</para>
+ <para>Regular form submission request is used.</para>
<itemizedlist>
<listitem>
@@ -129,9 +129,7 @@
</listitem>
</itemizedlist>
- <para>An Ajax form submission is performed, and additionally specified elements in the <emphasis>
- <property>"reRender"</property>
- </emphasis> attribute are reRendered.</para>
+ <para>Ajax submission is used for switching.</para>
<itemizedlist>
<listitem>
@@ -143,8 +141,8 @@
<property>"Action"</property>
</emphasis> and <emphasis>
<property>"ActionListener"</property>
- </emphasis> attributes are ignored. Items don't fire any submits itself. Behavior is
- fully defined by the components nested to items. Groups expand on the client side.</para>
+ </emphasis> item's attributes are ignored. Items don't fire any submits itself. Behavior is
+ fully defined by the components nested into items.</para>
<para>
<emphasis role="bold">Example:</emphasis>
@@ -202,7 +200,7 @@
<section>
<title>JavaScript API</title>
<para>In Java Script code for expanding/collapsing group element creation it's
- necessary to use doExpand()/doCollapse() function.</para>
+ necessary to use Expand()/Collapse() function.</para>
<table>
<title>JavaScript API</title>
@@ -218,13 +216,13 @@
<tbody>
<row>
- <entry>doExpand()</entry>
+ <entry>Expand()</entry>
<entry>Expands group element</entry>
</row>
<row>
- <entry>doCollapse()</entry>
+ <entry>Collapse()</entry>
<entry>Collapses group element</entry>
</row>
Modified: trunk/docs/userguide/en/src/main/docbook/included/panelMenuGroup.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/panelMenuGroup.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/en/src/main/docbook/included/panelMenuGroup.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -104,7 +104,7 @@
</listitem>
</itemizedlist>
- <para>The common submission of the form is performed and a page is completely refreshed.</para>
+ <para>Regular form submission request is used.</para>
<itemizedlist>
<listitem>
@@ -112,9 +112,7 @@
</listitem>
</itemizedlist>
- <para>Ajax form submission is performed, and additionally specified elements in the <emphasis>
- <property>"reRender"</property>
- </emphasis> attribute are reRendered.</para>
+ <para>Ajax submission is used for switching.</para>
<itemizedlist>
<listitem>
@@ -127,7 +125,7 @@
</emphasis> and <emphasis>
<property>"ActionListener"</property>
</emphasis> attributes are ignored. Items don't fire any submits itself. Behavior is
- fully defined by the components nested to items.</para>
+ fully defined by the components nested into items.</para>
<para>There are three icon-related attributes. The <emphasis>
<property>"iconExpanded"</property>
@@ -199,7 +197,7 @@
<section>
<title>JavaScript API</title>
<para>In Java Script code for expanding/collapsing group element creation it's
- necessary to use doExpand()/doCollapse() function.</para>
+ necessary to use Expand()/Collapse() function.</para>
<table>
<title>JavaScript API</title>
@@ -215,13 +213,13 @@
<tbody>
<row>
- <entry>doExpand()</entry>
+ <entry>Expand()</entry>
<entry>Expand group element</entry>
</row>
<row>
- <entry>doCollapse()</entry>
+ <entry>Collapse()</entry>
<entry>Collapse group element</entry>
</row>
Modified: trunk/docs/userguide/en/src/main/docbook/included/panelMenuItem.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/panelMenuItem.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/en/src/main/docbook/included/panelMenuItem.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -101,7 +101,7 @@
</listitem>
</itemizedlist>
- <para>The common submission of the form is performed and a page is completely refreshed.</para>
+ <para>Regular form submission request is used.</para>
<itemizedlist>
<listitem>
@@ -109,9 +109,7 @@
</listitem>
</itemizedlist>
- <para>Ajax form submission is performed, and additionally specified elements in the <emphasis>
- <property>"reRender"</property>
- </emphasis> attribute are reRendered.</para>
+ <para>Ajax submission is used for switching.</para>
<itemizedlist>
<listitem>
@@ -124,7 +122,7 @@
</emphasis> and <emphasis>
<property>"ActionListener"</property>
</emphasis> attributes are ignored. Items don't fire any submits itself. Behavior is
- fully defined by the components nested to items.</para>
+ fully defined by the components nested into items.</para>
<para>Here is an example for value <emphasis>
<property>"none"</property>
Modified: trunk/docs/userguide/en/src/main/docbook/included/portlet.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/portlet.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/en/src/main/docbook/included/portlet.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -1,32 +1,32 @@
<?xml version='1.0' encoding='UTF-8'?>
<chapter>
-
- <table>
- <title>Component identification parameters </title>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Name</entry>
- <entry>Value</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>component-type</entry>
- <entry>org.ajax4jsf.Portlet</entry>
- </row>
- <row>
- <entry>component-family</entry>
- <entry>org.ajax4jsf.component.Portlet</entry>
- </row>
- <row>
- <entry>component-class</entry>
- <entry>org.ajax4jsf.component.html.HtmlPortlet</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
+
+ <table>
+ <title>Component identification parameters </title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Name</entry>
+ <entry>Value</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>component-type</entry>
+ <entry>org.ajax4jsf.Portlet</entry>
+ </row>
+ <row>
+ <entry>component-family</entry>
+ <entry>org.ajax4jsf.component.Portlet</entry>
+ </row>
+ <row>
+ <entry>component-class</entry>
+ <entry>org.ajax4jsf.component.html.HtmlPortlet</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
<section>
<title>Creating on a page</title>
<programlisting role="XML"><![CDATA[
@@ -37,8 +37,8 @@
</f:view>
]]></programlisting>
</section>
-
- <section>
+
+ <section>
<title>Dynamical creation of a component from Java code</title>
<programlisting role="JAVA"><![CDATA[
import org.ajax4jsf.component.html.HtmlPortlet;
@@ -46,27 +46,35 @@
HtmlPortlet myPortlet = new HtmlPortlet();
...]]></programlisting>
</section>
-
+
<section>
<title>Key attributes and ways of usage</title>
- <para>
- Portal page can include some instances of the same portlet but clientId of elements should be different for each window.
- In that case 'namespace' is used for each portlet. The <emphasis role="bold"><property><a4j:portlet></property></emphasis>
- implemets NaimingContainer interface and adds namespace to all componets on a page.
- All portlet content should be wrapped by <emphasis role="bold"><property><a4j:portlet></property></emphasis> for resolving problems mentioned
- before.
- </para>
+ <para> Portal page can include some instances of the same portlet but clientId of elements
+ should be different for each window. In that case 'namespace' is used for
+ each portlet. The <emphasis role="bold">
+ <property><a4j:portlet></property>
+ </emphasis> implemets NaimingContainer interface and adds namespace to all componets on a
+ page. All portlet content should be wrapped by <emphasis role="bold">
+ <property><a4j:portlet></property>
+ </emphasis> for resolving problems mentioned before. </para>
</section>
<section>
<title>Relevant resources links</title>
<para><ulink url="http://livedemo.exadel.com/richfaces-demo/richfaces/portlet.jsf?c=portlet"
- >Here</ulink> you can see the example of <emphasis role="bold"
- ><property><a4j:portlet></property></emphasis> usage and sources for the given example. </para>
- <para>
- The aditional information about component usage you can find here:
- <ulink url="http://www.jboss.com/index.html?module=bb&op=viewtopic&t=107325">Ajax4Jsf Users Forum.
- </ulink>
- </para>
- </section>
-</chapter>
\ No newline at end of file
+ >Here</ulink> you can see the example of <emphasis role="bold">
+ <property><a4j:portlet></property>
+ </emphasis> usage and sources for the given example. </para>
+ <para> The aditional information about component usage you can find here: <ulink
+ url="http://www.jboss.com/index.html?module=bb&op=viewtopic&t=107325"
+ >Ajax4Jsf Users Forum. </ulink>
+ </para>
+ <para>Portlet Sample could be checked out from JBoss SVN: <ulink
+ url="http://anonsvn.jboss.org/repos/ajax4jsf/trunk/samples/portal-echo/">portal-echo
+ application. </ulink>
+ </para>
+ <para>Usage instructions for this demo could be found at the corresponding: <ulink
+ url="http://www.jboss.com/index.html?module=bb&op=viewtopic&t=107325">portal-echo
+ application. </ulink></para>
+ </section>
+</chapter>
Modified: trunk/docs/userguide/en/src/main/docbook/included/scrollableDataTable.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/scrollableDataTable.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/en/src/main/docbook/included/scrollableDataTable.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -92,7 +92,7 @@
<para> The columns provides the possibility of expanding/collapsing on the client side through
the next JS API: <itemizedlist>
- <listitem>doCollapse(columnId) - Performs the collapse action for the column with the
+ <listitem>Collapse(columnId) - Performs the collapse action for the column with the
corresponding id</listitem>
</itemizedlist> It's possible to sort the table content after clicks on the header. The
feature is optional. Every column should be pointed to the comparator method that will be used
@@ -227,7 +227,7 @@
<tbody>
<row>
- <entry>doCollapse(columnId)</entry>
+ <entry>Collapse(columnId)</entry>
<entry>Performs a collapse action for column with corresponding Id</entry>
</row>
Modified: trunk/docs/userguide/en/src/main/docbook/included/toolTip.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/toolTip.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/en/src/main/docbook/included/toolTip.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -2,9 +2,9 @@
<section>
<sectioninfo>
<keywordset>
-<keyword>tooltip</keyword>
-<keyword>rich:tooltip</keyword>
-<keyword>HtmlTooltip</keyword>
+<keyword>toolTip</keyword>
+<keyword>rich:toolTip</keyword>
+<keyword>HtmltoolTip</keyword>
</keywordset>
</sectioninfo>
<table>
@@ -19,23 +19,23 @@
<tbody>
<row>
<entry>component-type</entry>
- <entry>org.richfaces.component.ToolTip</entry>
+ <entry>org.richfaces.component.toolTip</entry>
</row>
<row>
<entry>component-class</entry>
- <entry>org.richfaces.component.html.HtmlToolTip</entry>
+ <entry>org.richfaces.component.html.HtmltoolTip</entry>
</row>
<row>
<entry>component-family</entry>
- <entry>org.richfaces.component.ToolTip</entry>
+ <entry>org.richfaces.component.toolTip</entry>
</row>
<row>
<entry>renderer-type</entry>
- <entry>org.richfaces.renderkit.html.ToolTipRenderer</entry>
+ <entry>org.richfaces.renderkit.html.toolTipRenderer</entry>
</row>
<row>
<entry>tag-class</entry>
- <entry>org.richfaces.taglib.HtmlToolTipTag</entry>
+ <entry>org.richfaces.taglib.HtmltoolTipTag</entry>
</row>
</tbody>
</tgroup>
@@ -43,14 +43,14 @@
<section>
<title>Creating the Component with a Page Tag</title>
- <para>To create the simplest variant of <property>tooltip</property> on a page, use the following syntax:</para>
+ <para>To create the simplest variant of <property>toolTip</property> on a page, use the following syntax:</para>
<para>
<emphasis role="bold">Example:</emphasis>
</para>
<programlisting role="XML"><![CDATA[...
<h:commandButton value="Button">
- <rich:tooltip value="Tooltip content"/>
+ <rich:toolTip value="toolTip content"/>
</h:commandButton>
...
]]></programlisting>
@@ -61,9 +61,9 @@
<para>
<emphasis role="bold">Example:</emphasis>
</para>
- <programlisting role="JAVA"><![CDATA[import org.richfaces.component.html.HtmlToolTip;
+ <programlisting role="JAVA"><![CDATA[import org.richfaces.component.html.HtmltoolTip;
...
-HtmlToolTip myToolTip = new HtmlToolTip();
+HtmltoolTip mytoolTip = new HtmltoolTip();
...
]]></programlisting>
</section>
@@ -71,13 +71,13 @@
<section>
<title>Details of Usage</title>
<para>
-<property>Tooltip</property> main area is a simple rectangle area with any information inside. The content may be defined via
+<property>toolTip</property> main area is a simple rectangle area with any information inside. The content may be defined via
"value" attribute as text or via any nested content. When both are defined, the value is displayed as text and nested content
-after the text. <property>Tooltip</property> stretches if the content more than the <property>tooltip</property> sizes.
+after the text. <property>toolTip</property> stretches if the content more than the <property>toolTip</property> sizes.
</para>
<para>
There is possibility to define a facet with the name "defaultContent". This facet provides the default content to
-display while the main content is loaded to a page in an Ajax mode. Thus when <property>tooltip</property> called in an Ajax mode, it
+display while the main content is loaded to a page in an Ajax mode. Thus when <property>toolTip</property> called in an Ajax mode, it
appears with the content defined in the facet and when loading is completed, the content is changed to a loaded one.
</para>
<para>
@@ -91,7 +91,7 @@
<rich:toolTip followMouse="true" direction="top-right" mode="ajax" value="#{bean.toolTipContent}" horizontalOffset="5"
verticalOffset="5" layout="block">
<f:facet name="defaultContent">
- <f:verbatim>DEFAULT TOOLTIP CONTENT</f:verbatim>
+ <f:verbatim>DEFAULT toolTip CONTENT</f:verbatim>
</f:facet>
</rich:toolTip>
</h:commandLink>
@@ -102,41 +102,41 @@
This is the result:
</para>
<figure>
- <title>Tooltip component with default content</title>
+ <title>toolTip component with default content</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/tooltip2.png"/>
+ <imagedata fileref="images/toolTip2.png"/>
</imageobject>
</mediaobject>
</figure>
<para>
-And after <property>tooltip</property> loaded it will be changed to next one:
+And after <property>toolTip</property> loaded it will be changed to next one:
</para>
<figure>
- <title>Tooltip component with loaded content</title>
+ <title>toolTip component with loaded content</title>
<mediaobject>
<imageobject>
- <imagedata fileref="images/tooltip3.png"/>
+ <imagedata fileref="images/toolTip3.png"/>
</imageobject>
</mediaobject>
</figure>
<para>
-By default, <property>tooltip</property> appears smart positioned. But as you can see from the previous example, you
+By default, <property>toolTip</property> appears smart positioned. But as you can see from the previous example, you
can define an appearance direction via the corresponding attribute "direction". And also it's possible to define vertical and horizontal
offsets relatively to a mouse position.
</para>
<para>
-<property>Tooltip</property> appears attached to the corner dependent on the <emphasis><property>"direction"</property></emphasis> attribute. By default it is positioned bottom-right.
-<property>Tooltip</property> activation occurs after a defined event (default=mouseover) on the parent component takes into consideration
-the "delay" attribute (default=0) or after calling JS API function doShow(). <property>Tooltip</property> deactivation occurs after mouseout event on the parent component (excepting the situation when the mouse is hovered onto the <property>tooltip</property> itself) or after calling JS API function doHide().
+<property>toolTip</property> appears attached to the corner dependent on the <emphasis><property>"direction"</property></emphasis> attribute. By default it is positioned bottom-right.
+<property>toolTip</property> activation occurs after a defined event (default=mouseover) on the parent component takes into consideration
+the "delay" attribute (default=0) or after calling JS API function Show(). <property>toolTip</property> deactivation occurs after mouseout event on the parent component (excepting the situation when the mouse is hovered onto the <property>toolTip</property> itself) or after calling JS API function Hide().
</para>
<note>
<title>Note:</title>
-It is recommended to define parent component "id" for correction of <property>tooltip</property> work.
+It is recommended to define parent component "id" for correction of <property>toolTip</property> work.
</note>
- <para>The attribute <emphasis><property>"for"</property></emphasis> is used for defining the <emphasis><property>"id"</property></emphasis> of an element a tooltip should be attached to. Look at the example:
+ <para>The attribute <emphasis><property>"for"</property></emphasis> is used for defining the <emphasis><property>"id"</property></emphasis> of an element a toolTip should be attached to. Look at the example:
</para>
<para>
@@ -156,35 +156,26 @@
]]></programlisting>
<para>Here, the attribute <emphasis><property>"for"</property></emphasis> of a <emphasis role="bold">
- <property><rich:tooltip></property>
- </emphasis> component is required. Whithout it an example doesn't work because HTML elements aren't presented in component tree built by facelets.
+ <property><rich:toolTip></property>
+ </emphasis> component is required. Whithout it an example doesn’t work because HTML elements aren't presented in component tree built by facelets.
</para>
<para>
-The <emphasis><property>"mode"</property></emphasis> attribute is provided you to control the way of data loading to <property>tooltip</property>. It has following values:
+The <emphasis><property>"mode"</property></emphasis> attribute is provided you to control the way of data loading to <property>toolTip</property>. It has following values:
<itemizedlist>
<listitem>Client</listitem>
<listitem>Ajax</listitem>
</itemizedlist>
</para>
<para>
-In a client mode, <property>tooltip</property> content is rendered once on the server and could be reRendered only via external submit.
-In an Ajax mode, <property>tooltip</property> content is requested from server every activation.
+In a client mode, <property>toolTip</property> content is rendered once on the server and could be reRendered only via external submit.
+In an Ajax mode, <property>toolTip</property> content is requested from server every activation.
</para>
<para>
-Special JS API is provided to control the component behaviour:
- <itemizedlist>
- <listitem> - </listitem>
- <listitem> - </listitem>
- <listitem> - </listitem>
- <listitem> - </listitem>
- </itemizedlist>
+Disabled <property>toolTip</property> is rendered to a page as usual but JS that responds for its activation is
+disabled until Enable() is called.
</para>
<para>
-Disabled <property>tooltip</property> is rendered to a page as usual but JS that responds for its activation is
-disabled until doEnable() is called.
-</para>
-<para>
Moreover, to add some JavaScript effects, client events defined on it are used:
</para>
<para>
@@ -200,11 +191,11 @@
<para>
Special:
<itemizedlist>
- <listitem>onshow - Called after the tooltip is called (some element hovered) but before its request
+ <listitem>onshow - Called after the toolTip is called (some element hovered) but before its request
</listitem>
- <listitem>oncomplete - Called just after the tooltip is shown
+ <listitem>oncomplete - Called just after the toolTip is shown
</listitem>
- <listitem>onhide - Called after the tooltip is hidden
+ <listitem>onhide - Called after the toolTip is hidden
</listitem>
</itemizedlist>
</para>
@@ -227,27 +218,27 @@
<tbody>
<row>
- <entry>doShow()</entry>
+ <entry>Show()</entry>
- <entry>Shows the corresponding tooltip</entry>
+ <entry>Shows the corresponding toolTip</entry>
</row>
<row>
- <entry>doHide()</entry>
+ <entry>Hide()</entry>
- <entry>Hides the corresponding tooltip</entry>
+ <entry>Hides the corresponding toolTip</entry>
</row>
<row>
- <entry>doEnable()</entry>
+ <entry>Enable()</entry>
- <entry>Enables the corresponding tooltip</entry>
+ <entry>Enables the corresponding toolTip</entry>
</row>
<row>
- <entry>doDisable()</entry>
+ <entry>Disable()</entry>
- <entry>Disables the corresponding tooltip</entry>
+ <entry>Disables the corresponding toolTip</entry>
</row>
</tbody>
@@ -266,7 +257,7 @@
</emphasis></para>
<para>There are two ways to redefine the appearance of all <emphasis role="bold">
- <property><rich:tooltip></property>
+ <property><rich:toolTip></property>
</emphasis> components at once:</para>
<itemizedlist>
@@ -278,7 +269,7 @@
<para>Add to your style sheets <emphasis>
<property>style classes</property>
</emphasis> used by a <emphasis role="bold">
- <property><rich:tooltip></property>
+ <property><rich:toolTip></property>
</emphasis> component</para>
</listitem>
</itemizedlist>
@@ -337,25 +328,25 @@
<tbody>
<row>
<entry>rich-tool-tip</entry>
- <entry>Defines styles for a wrapper <span> or <div> element of a tooltip</entry>
+ <entry>Defines styles for a wrapper <span> or <div> element of a toolTip</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
- It depends on <emphasis role="bold"><property><rich:tooltip></property></emphasis> layout what a wrapper element <emphasis><property><span></property></emphasis> or <emphasis><property><div></property></emphasis>to choose.
+ It depends on <emphasis role="bold"><property><rich:toolTip></property></emphasis> layout what a wrapper element <emphasis><property><span></property></emphasis> or <emphasis><property><div></property></emphasis>to choose.
</para>
<para>In order to redefine styles for all <emphasis role="bold">
- <property><rich:tooltip></property>
+ <property><rich:toolTip></property>
</emphasis> components on a page using CSS, it's enough to create class with the
same name and define necessary properties in it.</para>
<para>To change styles of particular <emphasis role="bold">
- <property><rich:tooltip></property>
+ <property><rich:toolTip></property>
</emphasis> components define your own style class in the corresponding <emphasis
role="bold">
- <property><rich:tooltip></property>
+ <property><rich:toolTip></property>
</emphasis>attributes</para>
</section>
<section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/tree.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/tree.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/en/src/main/docbook/included/tree.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -248,7 +248,7 @@
<itemizedlist>
<listitem>Ajax - Ajax submission is used for switching </listitem>
- <listitem>Server - regular form submition request is used</listitem>
+ <listitem>Server - regular form submission request is used</listitem>
<listitem>Client - switching is done as a whole on a client, no interaction with the server
presents</listitem>
</itemizedlist>
Modified: trunk/docs/userguide/en/src/main/docbook/master.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/master.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/en/src/main/docbook/master.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -47,7 +47,13 @@
<!ENTITY treeModel_table SYSTEM "../../../target/generated/tree-model.xml">
<!ENTITY scrollableDataTable_table SYSTEM "../../../target/generated/scrollableDataTable.xml">
<!ENTITY jQuery_table SYSTEM "../../../target/generated/jQuery.xml">
+<!ENTITY contextMenu_table SYSTEM "../../../target/generated/contextMenu.xml">
+<!ENTITY listShuttle_table SYSTEM "../../../target/generated/listShuttle.xml">
+<!ENTITY orderingList_table SYSTEM "../../../target/generated/orderingList.xml">
+<!ENTITY componentControl_table SYSTEM "../../../target/generated/componentControl.xml">
+
+
<!ENTITY coreComponents_table SYSTEM "../../../target/generated/a4j.xml">
]>
@@ -80,6 +86,8 @@
-->
&coreComponents_table;
&calendar_table;
+&componentControl_table;
+&contextMenu_table;
&dataFilterSlider_table;
&dataScroller_table;
&dataTable_table;
@@ -93,8 +101,10 @@
&inputNumberSpinner_table;
&insert_table;
&jQuery_table;
+&listShuttle_table;
&message_table;
&modalPanel_table;
+&orderingList_table;
&paint2D_table;
&panel_table;
&panelBar_table;
Modified: trunk/docs/userguide/en/src/main/docbook/modules/AUGWADParams.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/modules/AUGWADParams.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/en/src/main/docbook/modules/AUGWADParams.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -1,15 +1,15 @@
<?xml version="1.0" encoding="UTF-8"?>
<section id="WebApplicationDescriptorParameters">
-<?dbhtml filename="WebApplicationParameters.html"?>
+ <?dbhtml filename="WebApplicationParameters.html"?>
<title>Web Application Descriptor Parameters</title>
- <para>RichFaces doesn't require any parameters to be defined in your
- web.xml. But the <property>RichFaces</property> parameters listed below may
- help with development and may increase the flexibility of RichFaces
- usage.</para>
+ <para>RichFaces doesn't require any parameters to be defined in your web.xml. But the
+ <property>RichFaces</property> parameters listed below may help with development and may
+ increase the flexibility of RichFaces usage.</para>
- <para><table>
+ <para>
+ <table>
<title>Initialization Parameters</title>
<tgroup cols="3">
@@ -24,33 +24,54 @@
</thead>
<tbody>
-
+
<row>
<entry>org.richfaces.SKIN</entry>
-
+
<entry>DEFAULT</entry>
-
- <entry>Is a name of a skin used in an application. It can be a
- literal string with a skin name, or the <emphasis
- ><property>EL</property></emphasis> expression
- (#{...}) pointed to a <emphasis
- ><property>String</property></emphasis> property
- (skin name) or a property of a org.richfaces.framework.skin type.
+
+ <entry>Is a name of a skin used in an application. It can be a literal string with a
+ skin name, or the <emphasis>
+ <property>EL</property>
+ </emphasis> expression (#{...}) pointed to a <emphasis>
+ <property>String</property>
+ </emphasis> property (skin name) or a property of a org.richfaces.framework.skin type.
Skin in last case, this instance is used as a current skin</entry>
</row>
-
+
<row>
+ <entry>org.richfaces.LoadScriptStrategy</entry>
+
+ <entry>DEFAULT</entry>
+
+ <entry>Defines how the RichFaces script files are loaded to application. Possible values
+ are: ALL, DEFAULT, NONE. For more information see <link
+ linkend="ScriptsandStylesLoadStrategy">"Scripts and Styles Load
+ Strategy"</link>.</entry>
+ </row>
+
+ <row>
+ <entry>org.richfaces.LoadStyleStrategy</entry>
+
+ <entry>DEFAULT</entry>
+
+ <entry>Defines how the RichFaces style files are loaded to application. Possible values
+ are: ALL, DEFAULT, NONE. For more information see <link
+ linkend="ScriptsandStylesLoadStrategy">"Scripts and Styles Load
+ Strategy"</link>.</entry>
+ </row>
+
+ <row>
<entry>org.ajax4jsf.LOGFILE</entry>
<entry>none</entry>
- <entry>Is an URL to an application or a container log file (if
- possible). If this parameter is set, content from the given URL is
- shown on a <emphasis
- ><property>Debug</property></emphasis> error page
- in the <emphasis
- ><property>iframe</property></emphasis>
- window</entry>
+ <entry>Is an URL to an application or a container log file (if possible). If this
+ parameter is set, content from the given URL is shown on a <emphasis>
+ <property>Debug</property>
+ </emphasis> error page in the <emphasis>
+ <property>iframe</property>
+ </emphasis> window</entry>
</row>
<row>
@@ -58,13 +79,12 @@
<entry>none</entry>
- <entry>Is a comma-separated list of custom <emphasis
- ><property>ViewHandler</property></emphasis>
- instances for inserting in chain. Handlers are inserted BEFORE
- RichFaces viewhandlers in the given order. For example, in facelets
- application this parameter must contain
- com.sun.facelets.FaceletViewHandler, instead of declaration in
- faces-config.xml</entry>
+ <entry>Is a comma-separated list of custom <emphasis>
+ <property>ViewHandler</property>
+ </emphasis> instances for inserting in chain. Handlers are inserted BEFORE RichFaces
+ viewhandlers in the given order. For example, in facelets application this parameter
+ must contain com.sun.facelets.FaceletViewHandler, instead of declaration in
+ faces-config.xml</entry>
</row>
<row>
@@ -72,13 +92,12 @@
<entry>none</entry>
- <entry>Is a comma-separated list of names for a component as a
- special control case, such as messages bundle loader, alias bean
- components, etc. Is a type of component got by a reflection from
- the static field <emphasis
- ><property>COMPONENT_TYPE</property></emphasis>.
- For components with such types encode methods always are called in
- rendering Ajax responses, even if a component isn't in an updated
+ <entry>Is a comma-separated list of names for a component as a special control case,
+ such as messages bundle loader, alias bean components, etc. Is a type of component got
+ by a reflection from the static field <emphasis>
+ <property>COMPONENT_TYPE</property>
+ </emphasis>. For components with such types encode methods always are called in
+ rendering Ajax responses, even if a component isn't in an updated
part</entry>
</row>
@@ -87,15 +106,13 @@
<entry>false</entry>
- <entry>For generated resources, such as encrypt generation data,
- it's encoded in the resource URL. For example, URL for an image
- generated from the <emphasis
- ><property>mediaOutput</property></emphasis>
- component contains a name of a generation method, since for a
- hacker attack, it is possible to create a request for any JSF
- baked beans or other attributes. To prevent such attacks, set this
- parameter to "true" in critical applications (works with JRE >
- 1.4 )</entry>
+ <entry>For generated resources, such as encrypt generation data, it's encoded
+ in the resource URL. For example, URL for an image generated from the <emphasis>
+ <property>mediaOutput</property>
+ </emphasis> component contains a name of a generation method, since for a hacker
+ attack, it is possible to create a request for any JSF baked beans or other
+ attributes. To prevent such attacks, set this parameter to "true" in
+ critical applications (works with JRE > 1.4 )</entry>
</row>
<row>
@@ -103,27 +120,29 @@
<entry>random</entry>
- <entry>Is a password for encryption of resources data. If isn't
- set, a random password is used</entry>
+ <entry>Is a password for encryption of resources data. If isn't set, a random
+ password is used</entry>
</row>
<row>
- <entry>org.ajax4jsf.COMPRESS_SCRIPT</entry>
- <entry>true</entry>
- <entry>It doesn't allow framework to reformat JavaScript files (makes it impossible to debug)
- </entry>
+ <entry>org.ajax4jsf.COMPRESS_SCRIPT</entry>
+ <entry>true</entry>
+ <entry>It doesn't allow framework to reformat JavaScript files (makes it
+ impossible to debug) </entry>
</row>
</tbody>
</tgroup>
- </table></para>
-
+ </table>
+ </para>
+
<note>
<title>Note:</title>
<para>org.richfaces.SKIN is used in the same way as org.ajax4jsf.SKIN</para>
- </note>
+ </note>
- <para><table>
+ <para>
+ <table>
<title>org.ajax4jsf.Filter Initialization Parameters</title>
<tgroup cols="3">
@@ -143,9 +162,10 @@
<entry>-</entry>
- <entry>Is a path (relative to web application context) to the
- <emphasis ><property>log4j.xml</property></emphasis> configuration file, it can be used to setup
- per-application custom logging</entry>
+ <entry>Is a path (relative to web application context) to the <emphasis>
+ <property>log4j.xml</property>
+ </emphasis> configuration file, it can be used to setup per-application custom
+ logging</entry>
</row>
<row>
@@ -153,9 +173,9 @@
<entry>true</entry>
- <entry>Enable caching of framework-generated resources (JavaScript, CSS, images, etc.).
- For debug purposes development custom JavaScript or Style prevents to use old cached data in a
- browser</entry>
+ <entry>Enable caching of framework-generated resources (JavaScript, CSS, images, etc.).
+ For debug purposes development custom JavaScript or Style prevents to use old cached
+ data in a browser</entry>
</row>
<row>
@@ -163,14 +183,15 @@
<entry>true</entry>
- <entry>Force parsing by a filter <emphasis
- ><property>HTML</property></emphasis> syntax
- checker on any JSF page. If "false", only Ajax responses are
- parsed to syntax check and conversion to well-formed XML. Setting
- to "false" improves performance, but can provide visual effects on
- Ajax updates</entry>
+ <entry>Force parsing by a filter <emphasis>
+ <property>HTML</property>
+ </emphasis> syntax checker on any JSF page. If "false", only Ajax
+ responses are parsed to syntax check and conversion to well-formed XML. Setting to
+ "false" improves performance, but can provide visual effects on Ajax
+ updates</entry>
</row>
</tbody>
</tgroup>
- </table></para>
-</section>
\ No newline at end of file
+ </table>
+ </para>
+</section>
Modified: trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/en/src/main/docbook/modules/RFCarchitectover.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -885,8 +885,60 @@
("TIDY" filter type is used for code correction). </para>
</section>
+ <section id="ScriptsandStylesLoadStrategy">
+ <?dbhtml filename="ScriptsandStylesLoadStrategy" ?>
+ <title>Scripts and Styles Load Strategy</title>
+ <para>Before the version 3.1.3, RichFaces loaded styles and script on demand. I.e. files are
+ loaded only if they are required on a particular page. Since RichFaces 3.1.3, it's
+ possible to manage how the RichFaces script and style files are loaded to application. </para>
+ <para>
+ <emphasis role="bold">org.richfaces.LoadScriptStrategy </emphasis>
+ </para>
+ <para>The following declaration in your web.xml allows loading the integrated script files.</para>
+ <programlisting role="XML"><![CDATA[...
+ <context-param>
+ <param-name>org.richfaces.LoadScriptStrategy</param-name>
+ <param-value>ALL</param-value>
+ </context-param>
+...
+]]></programlisting>
+ <para>If you do not declare the <property>org.richfaces.LoadScriptStrategy</property> in the
+ web.xml, it equals to:</para>
+ <programlisting role="XML"><![CDATA[...
+ <context-param>
+ <param-name>org.richfaces.LoadScriptStrategy</param-name>
+ <param-value>DEFAULT</param-value>
+ </context-param>
+...
+]]></programlisting>
+ <para>The third possible value is "NONE". You have no a special reason to
+ use it unless you obtain the newest (or modified) version of the script and want to include
+ it manually in a page header. </para>
+
+ <para>
+ <emphasis role="bold">org.richfaces.LoadStyleStrategy</emphasis>
+ </para>
+
+ <para> The following declaration allows to load only one integrated style sheet file.</para>
+ <programlisting role="XML"><![CDATA[...
+ <context-param>
+ <param-name>org.richfaces.LoadStyleStrategy</param-name>
+ <param-value>ALL</param-value>
+ </context-param>
+...
+]]></programlisting>
+ <para>The integrated style sheet contains style for all shipped components. The skinnability
+ feature still works. </para>
+ <para>The "DEFAULT" value is a classical on-demand variant. </para>
+ <para>The "NONE" stops loading the styles at all. The earlier introduced
+ plain skin resets all color and font parameters to null. The "NONE" value
+ for <property>org.richfaces.LoadStyleStrategy</property> means that predefined styles for
+ RichFaces are not used.</para>
+ <para>For more information see <ulink
+ url="http://www.jboss.com/index.html?module=bb&op=viewtopic&p=4114033"
+ >RichFaces User Forum</ulink>.</para>
+ </section>
-
<section id="RequestErrorsAndSessionExpirationHandling">
<?dbhtml filename="RequestErrorsAndSessionExpirationHandling.html"?>
<title>Request Errors and Session Expiration Handling</title>
Modified: trunk/docs/userguide/en/src/main/resources/css/html.css
===================================================================
--- trunk/docs/userguide/en/src/main/resources/css/html.css 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/en/src/main/resources/css/html.css 2007-12-21 15:43:17 UTC (rev 4950)
@@ -347,10 +347,15 @@
cursor: pointer;
}
-.css_comment {
-color:#3F5FBF;
+pre.CSS, pre.css {
+ line-height:0px;
+ margin-bottom:0em;
}
.css_normal {
+ line-height:0px;
+ color:#000000;
+}
+.css_colon {
color:#000000;
}
.css_semi_colon {
@@ -359,30 +364,34 @@
.css_curly_brace {
color:#000000;
}
-.css_atmark_rule {
-color:#3F7F7F;
+.css_comment {
+color:#939393;
}
+.css_error {
+color:#BF3F3F;
+}
.css_selector {
-color:#3F7F7F;
+color:#008cca;
}
-.css_media {
-color:#2A00FF;
+.css_null {
+color:#008cca;
}
-.css_string {
-color:#2A00FF;
+.css_property_name {
+color:#000000;
+font-weight:bold;
}
+.css_property_value {
+color:#ff6600;
+}
.css_uri {
color:#2A00FF;
}
-.css_property_value {
-color:#2A00FF;
+.css_atmark_rule {
+color:#3F7F7F;
}
-.css_colon {
-color:#000000;
+.css_media {
+color:#336699;
}
-.css_error {
-color:#BF3F3F;
-}
-.css_property_name {
-color:#7F007F;
-}
+.css_string {
+color:#336699;
+}
\ No newline at end of file
Added: trunk/docs/userguide/en/src/main/resources/images/calendar4.png
===================================================================
(Binary files differ)
Property changes on: trunk/docs/userguide/en/src/main/resources/images/calendar4.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Modified: trunk/docs/userguide/en/src/main/resources/images/contextMenu1.png
===================================================================
(Binary files differ)
Added: trunk/docs/userguide/en/src/main/resources/images/contextMenu_attached.png
===================================================================
(Binary files differ)
Property changes on: trunk/docs/userguide/en/src/main/resources/images/contextMenu_attached.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/docs/userguide/en/src/main/resources/images/contextMenu_classes.png
===================================================================
(Binary files differ)
Property changes on: trunk/docs/userguide/en/src/main/resources/images/contextMenu_classes.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/docs/userguide/en/src/main/resources/images/listShuttle1.png
===================================================================
(Binary files differ)
Property changes on: trunk/docs/userguide/en/src/main/resources/images/listShuttle1.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/docs/userguide/en/src/main/resources/images/listShuttle_classes_s.png
===================================================================
(Binary files differ)
Property changes on: trunk/docs/userguide/en/src/main/resources/images/listShuttle_classes_s.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Added: trunk/docs/userguide/en/src/main/resources/images/listShuttle_classes_t.png
===================================================================
(Binary files differ)
Property changes on: trunk/docs/userguide/en/src/main/resources/images/listShuttle_classes_t.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Modified: trunk/docs/userguide/en/src/main/resources/images/orderinList1.png
===================================================================
(Binary files differ)
Added: trunk/docs/userguide/en/src/main/resources/images/orderingList_classes.png
===================================================================
(Binary files differ)
Property changes on: trunk/docs/userguide/en/src/main/resources/images/orderingList_classes.png
___________________________________________________________________
Name: svn:mime-type
+ application/octet-stream
Modified: trunk/docs/userguide/pom.xml
===================================================================
--- trunk/docs/userguide/pom.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/docs/userguide/pom.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -55,17 +55,45 @@
<groupId>
org.richfaces.ui
</groupId>
- <artifactId>calendar</artifactId>
+ <artifactId>
+ calendar
+ </artifactId>
<version>
${project.version}
</version>
</artifactItem>
+
+ <artifactItem>
+ <groupId>
+ org.richfaces.ui
+ </groupId>
+ <artifactId>
+ componentControl
+ </artifactId>
+ <version>
+ ${project.version}
+ </version>
+ </artifactItem>
+
<artifactItem>
<groupId>
org.richfaces.ui
</groupId>
<artifactId>
+ contextMenu
+ </artifactId>
+ <version>
+ ${project.version}
+ </version>
+ </artifactItem>
+
+
+ <artifactItem>
+ <groupId>
+ org.richfaces.ui
+ </groupId>
+ <artifactId>
dataFilterSlider
</artifactId>
<version>
@@ -122,9 +150,7 @@
<groupId>
org.richfaces.ui
</groupId>
- <artifactId>
- effect
- </artifactId>
+ <artifactId>effect</artifactId>
<version>
${project.version}
</version>
@@ -197,8 +223,18 @@
${project.version}
</version>
</artifactItem>
+ <artifactItem>
+ <groupId>
+ org.richfaces.ui
+ </groupId>
+ <artifactId>
+ listShuttle
+ </artifactId>
+ <version>
+ ${project.version}
+ </version>
+ </artifactItem>
-
<artifactItem>
<groupId>
org.richfaces.ui
@@ -245,6 +281,18 @@
<groupId>
org.richfaces.ui
</groupId>
+ <artifactId>
+ orderingList
+ </artifactId>
+ <version>
+ ${project.version}
+ </version>
+ </artifactItem>
+
+ <artifactItem>
+ <groupId>
+ org.richfaces.ui
+ </groupId>
<artifactId>paint2D</artifactId>
<version>
${project.version}
@@ -398,6 +446,15 @@
${project.build.directory}/xslt
</outputDirectory>
</artifactItem>
+ <artifactItem>
+ <groupId>
+ org.richfaces.ui
+ </groupId>
+ <artifactId>jQuery</artifactId>
+ <version>
+ ${project.version}
+ </version>
+ </artifactItem>
</artifactItems>
<outputDirectory>
${project.build.directory}/library
@@ -430,6 +487,11 @@
<artifactId>saxon</artifactId>
<version>8.7</version>
</dependency>
+ <dependency>
+ <groupId>org.apache.xmlgraphics</groupId>
+ <artifactId>fop</artifactId>
+ <version>0.94</version>
+ </dependency>
</dependencies>
<configuration>
<transformationSets>
Modified: trunk/ui/core/src/main/config/component/commandButton.xml
===================================================================
--- trunk/ui/core/src/main/config/component/commandButton.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/ui/core/src/main/config/component/commandButton.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -106,8 +106,10 @@
<classname>int</classname>
<description>Timeout ( in ms ) for request.</description>
</property>
- <property hidden="true">
+ <property>
<name>actionExpression</name>
+ <classname>javax.el.MethodExpression</classname>
+ <description>The action method binding expression.</description>
</property>
</component>
</components>
\ No newline at end of file
Modified: trunk/ui/core/src/main/config/component/commandLink.xml
===================================================================
--- trunk/ui/core/src/main/config/component/commandLink.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/ui/core/src/main/config/component/commandLink.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -87,8 +87,10 @@
<classname>int</classname>
<description>Timeout ( in ms ) for request.</description>
</property>
- <property hidden="true">
+ <property>
<name>actionExpression</name>
+ <classname>javax.el.MethodExpression</classname>
+ <description>The action method binding expression.</description>
</property>
</component>
</components>
\ No newline at end of file
Modified: trunk/ui/core/src/main/config/component/function.xml
===================================================================
--- trunk/ui/core/src/main/config/component/function.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/ui/core/src/main/config/component/function.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -60,8 +60,10 @@
<name>value</name>
<classname>java.lang.Object</classname>
</property>
- <property hidden="true">
+ <property>
<name>actionExpression</name>
+ <classname>javax.el.MethodExpression</classname>
+ <description>The action method binding expression.</description>
</property>
</component>
</components>
\ No newline at end of file
Modified: trunk/ui/core/src/main/config/component/mediaOutput.xml
===================================================================
--- trunk/ui/core/src/main/config/component/mediaOutput.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/ui/core/src/main/config/component/mediaOutput.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -99,14 +99,14 @@
<name>element</name>
<classname>java.lang.String</classname>
<description>
- <![CDATA[Name of html element for resource link - may be <a> <img> <object> <applet> <script> or <link> ]]>
+ <![CDATA[Name of html element for resource link - may be <a> <img> <object> <applet> <script> or <link> ]]>
</description>
</property>
<property>
<name>uriAttribute</name>
<classname>java.lang.String</classname>
<description>
- <![CDATA[Name of attribute for resource-link attribute ( 'href' for <a>, 'src' for <img> or <script>, etc ]]>
+ <![CDATA[Name of attribute for resource-link attribute ( 'href' for <a>, 'src' for <img> or <script>, etc ]]>
</description>
</property>
Modified: trunk/ui/core/src/main/config/component/poll.xml
===================================================================
--- trunk/ui/core/src/main/config/component/poll.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/ui/core/src/main/config/component/poll.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -50,8 +50,10 @@
&ui_component_attributes;
&ui_command_attributes;
&ajax_component_attributes;
- <property hidden="true">
+ <property>
<name>actionExpression</name>
+ <classname>javax.el.MethodExpression</classname>
+ <description>The action method binding expression.</description>
</property>
<property>
<name>onsubmit</name>
Modified: trunk/ui/core/src/main/config/component/push.xml
===================================================================
--- trunk/ui/core/src/main/config/component/push.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/ui/core/src/main/config/component/push.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -52,16 +52,20 @@
&ui_command_attributes;
&ajax_component_attributes;
<property elonly="true" attachedstate="true">
- <name>eventProducer</name>
- <classname>javax.faces.el.MethodBinding</classname>
- <description>
+
+ <name>eventProducer</name>
+
+ <classname>javax.faces.el.MethodBinding</classname>
+ <description>
MethodBinding pointing at method accepting an PushEventListener with return type void.
User bean must register this listener and send EventObject to this listener on ready.
</description>
- <methodargs>java.util.EventListener</methodargs>
+ <methodargs>java.util.EventListener</methodargs>
</property>
- <property hidden="true">
+ <property>
<name>actionExpression</name>
+ <classname>javax.el.MethodExpression</classname>
+ <description>The action method binding expression.</description>
</property>
<!--
<property>
Modified: trunk/ui/core/src/main/config/component/support.xml
===================================================================
--- trunk/ui/core/src/main/config/component/support.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/ui/core/src/main/config/component/support.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -75,8 +75,10 @@
&ui_component_attributes;
&ui_command_attributes;
&ajax_component_attributes;
- <property hidden="true">
+ <property>
<name>actionExpression</name>
+ <classname>javax.el.MethodExpression</classname>
+ <description>The action method binding expression.</description>
</property>
<property>
<name>onsubmit</name>
Modified: trunk/ui/listShuttle/src/main/config/component/listShuttle.xml
===================================================================
--- trunk/ui/listShuttle/src/main/config/component/listShuttle.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/ui/listShuttle/src/main/config/component/listShuttle.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -50,7 +50,7 @@
<description>
MethodBinding pointing at a method that is called during Process Validations phase of the request processing lifecycle, to validate the current value of this component
</description>
- <methodargs>java.lang.Object.class</methodargs>
+ <methodargs>java.lang.Object</methodargs>
</property>
<property hidden="true">
<name>value</name>
@@ -139,7 +139,7 @@
<property>
<name>onorderchanged</name>
<classname>java.lang.String</classname>
- <description>HTML: script expression; called after ordering action</description>
+ <description>HTML: script expression; called after ordering action</description>
</property>
<property>
@@ -234,7 +234,7 @@
<name>valueChangeListener</name>
<classname>javax.faces.el.MethodBinding</classname>
<description>Listener for value changes</description>
- <methodargs>javax.faces.event.ValueChangeEvent.class</methodargs>
+ <methodargs>javax.faces.event.ValueChangeEvent</methodargs>
</property>
<property>
<name>immediate</name>
Modified: trunk/ui/orderingList/src/main/config/component/orderinglist.xml
===================================================================
--- trunk/ui/orderingList/src/main/config/component/orderinglist.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/ui/orderingList/src/main/config/component/orderinglist.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -372,7 +372,7 @@
<property attachedstate="true">
<name>valueChangeListener</name>
<classname>javax.faces.el.MethodBinding</classname>
- <methodargs>javax.faces.event.ValueChangeEvent.class</methodargs>
+ <methodargs>javax.faces.event.ValueChangeEvent</methodargs>
<description>Listener for value changes</description>
</property>
</component>
Modified: trunk/ui/togglePanel/src/main/config/component/togglePanel.xml
===================================================================
--- trunk/ui/togglePanel/src/main/config/component/togglePanel.xml 2007-12-21 15:34:23 UTC (rev 4949)
+++ trunk/ui/togglePanel/src/main/config/component/togglePanel.xml 2007-12-21 15:43:17 UTC (rev 4950)
@@ -92,10 +92,12 @@
</property>
<property hidden="true">
<name>localValueSet</name>
+ <classname>boolean</classname>
</property>
<property hidden="true">
<name>valid</name>
+ <classname>java.lang.String</classname>
</property>
More information about the richfaces-svn-commits
mailing list