9:12 a.m.
Author: artdaw
Date: 2007-11-09 10:12:42 -0500 (Fri, 09 Nov 2007)
New Revision: 3865
Modified:
trunk/docs/userguide/en/src/main/docbook/included/orderingList.xml
Log:
RF-1184 - add Keyboard usage, facets and attributes to Details of Usage
Modified: trunk/docs/userguide/en/src/main/docbook/included/orderingList.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/orderingList.xml 2007-11-09 15:11:03
UTC (rev 3864)
+++ trunk/docs/userguide/en/src/main/docbook/included/orderingList.xml 2007-11-09 15:12:42
UTC (rev 3865)
@@ -14,11 +14,11 @@
<emphasis role="bold">Example:</emphasis>
</para>
<programlisting role="XML"><![CDATA[...
- <rich:orderingList value=”#{bean.list}” var=”list”>
- <rich:column>
- <h:outputText value=”#{list.text}”>
- </rich:column>
- <rich:orderingList>
+<rich:orderingList value=”#{bean.list}” var=”list”>
+ <rich:column>
+ <h:outputText value=”#{list.text}”>
+ </rich:column>
+<rich:orderingList>
...
]]></programlisting>
</section>
@@ -35,67 +35,170 @@
]]></programlisting>
</section>
<section>
- <title>Details of Usage</title>
- <para>The <property>orderingList</property> component consists
of <property>
- <emphasis>Item list</emphasis></property> element,
- which displays a list of items. It has three different representations
- for a single element:
- <itemizedlist>
- <listitem>common</listitem>
- <listitem>selected</listitem>
- <listitem>active</listitem>
- </itemizedlist>
- Combination of these states is possible
+ <title>Details of Usage</title>
+ <!--maintenance of component orderingList-->
+ <para>The <emphasis role="bold">
+ <property><rich:orderingList></property>
+ </emphasis> component consists of <property>
+ <emphasis>Item list</emphasis>
+ </property> element that displays a list of items. It has three
different
+ representations for a single element: <itemizedlist>
+ <listitem>common</listitem>
+ <listitem>selected</listitem>
+ <listitem>active</listitem>
+ </itemizedlist> Combination of these states is possible </para>
+ <para> The <emphasis role="bold">
+ <property><rich:orderingList></property>
+ </emphasis> component provides to use <emphasis>
+ <property>"optionalCaption"</property>
+ </emphasis> facet.</para>
+ <para>It's possible to define <property>
+ <emphasis>"optionalHeader"</emphasis>
+ </property> facet. It has two possible types of representation:
<itemizedlist>
+ <listitem>sortable</listitem>
+ <listitem>non-sortable</listitem>
+ </itemizedlist>
</para>
-
- <para>
- The
- <property><rich:orderingList></property> component
provides to use
- <property>caption</property> facet defined with an end developer.
+ <para> Also you can use<property>
+ <emphasis>"optionalFooter"</emphasis>
+ </property> facet is an optional element.</para>
+
+ <!-- add simple and screenshot-->
+
+ <para>The <emphasis role="bold">
+ <property><rich:orderingList></property>
+ </emphasis> component provides the possibility to use <property>
+ <emphasis>"ordering controls
set"</emphasis>
+ </property>, which performs reordering. Every control has possibility
to be disabled.
+ The <emphasis role="bold">
+ <property><rich:orderingList></property>
+ </emphasis> component has a possibility to hide any of the controls by
pairs:<itemizedlist>
+ <listitem>"Up" and
"Down"</listitem>
+ <listitem>"Top" and
"Bottom"</listitem>
+ </itemizedlist>
</para>
-
- <para>It's possible to define
- <property><emphasis>"header"</emphasis>
- </property> facet. It has two possible
- types of representation: <itemizedlist>
- <listitem>sortable</listitem>
- <listitem>non-sortable</listitem>
- </itemizedlist>
- </para>
-
- <para>
- <property>
- IAlso you can
use<property><emphasis>"footer"</emphasis></property>/
facet
- </property> is an optional element defined with an end developer
- </para>
-
- <para>The
<property><rich:orderingList></property> component provides the
possibility to use
- <property>
- <emphasis>"ordering controls
set"</emphasis></property>, which performs reordering. Every control
has possibility
- to be disabled. All controls are disabled when the whole component is disabled.
The
- component has a possibility to hide any of the controls by pairs
<itemizedlist>
- <listitem>"Up" and
"Down"</listitem>
- <listitem>"Top" and
"Bottom"</listitem>
- </itemizedlist>
- </para>
-
+ <para> "topControl",
"topControlDisabled",
+ "bottomControl",
"bottomControlDisabled",
+ "upControl", "upControlDisabled",
+ "downControl", "downControlDisabled"
facets are used
+ to replaces the default control with facets content. </para>
+
+ <!-- attributes of component orderingList -->
+
<para> The <property>
<emphasis>"value"</emphasis>
</property> and <property>
<emphasis>"var"</emphasis>
</property> attributes are used to access the values of a list. Example
of page
definition: <programlisting role="XML"><![CDATA[...
- <rich:orderingList value=”#{bean.list}” var=”list”>
- <f:facet name=header><h:outputText
value=”Header1”/></f:facet>
- <rich:column>
- <h:outputText value=”#{list.text}”>
- </rich:column>
- <rich:orderingList>
+<rich:orderingList value=”#{bean.list}” var=”list”>
+ <f:facet name=header><h:outputText value=”Header1”/></f:facet>
+ <rich:column>
+ <h:outputText value=”#{list.text}”>
+ </rich:column>
+<rich:orderingList>
...]]>
</programlisting>
</para>
+
+ <para>The <property>
+ <emphasis>"selection "</emphasis>
+ </property> 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 <property>
+ <emphasis>"controlsType"</emphasis>
+ </property> attribute. Possible types are <itemizedlist>
+ <listitem>button</listitem>
+ <listitem>link</listitem>
+ <listitem>none</listitem>
+ </itemizedlist></para>
</section>
+
+<para>Keyboard usage</para>
+ <table>
+ <title>Keyboard usage for elements selection TO DO</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Keys and combinations </entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <!--Sorting API -->
+ <row>
+ <entry>CTRL+click</entry>
+ <entry>Described in selection behaviour
requirement</entry>
+ </row>
+ <row>
+ <entry>SHIFT+click</entry>
+ <entry>Described in selection behaviour
requirement</entry>
+ </row>
+ <row>
+ <entry>CTRL+A</entry>
+ <entry>Selects all elements inside the list if some active
element is
+ 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>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+
+ <table>
+ <title>Keyboard usage for elements reordering</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Keys and combinations </entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <!--Sorting API -->
+ <row>
+ <entry>Top</entry>
+ <entry>Moves selected set to the top of a
list</entry>
+ </row>
+ <row>
+ <entry>Bottom</entry>
+ <entry>Moves selected set to the bottomof a
list</entry>
+ </row>
+ <row>
+ <entry>CTRL+Up arrow</entry>
+ <entry>Moves selected item to one position
uppert</entry>
+ </row>
+ <row>
+ <entry>CTRL+Down arrow</entry>
+ <entry>Moves selected item to one position
lower</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>All the changes uses the same rules that defined in requirement for
ordering with
+ controls.</para>
+
<section>
+ <title>Drag-and-Drop support in the list</title>
+ <para> It's possible to drag items and drop to the position
needed. </para>
+ <para>In this case component <emphasis role="bold">
+ <property><rich:orderingList></property>
+ </emphasis> provides <property>
+ <emphasis>"dragIndicator"</emphasis>
+ </property> attribute. </para>
+
+ <!-- add an example!!! -->
+
+ </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
@@ -199,6 +302,7 @@
</tgroup>
</table>
</section>
+
<section>
<title>Look-and-Feel Customization</title>
<para>For skinnability implementation, the components use a
<emphasis>