[richfaces-svn-commits] JBoss Rich Faces SVN: r4468 - in trunk/docs/userguide/en/src/main: resources/images and 1 other directory.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Tue Dec 4 13:21:06 EST 2007
Author: vkorluzhenko
Date: 2007-12-04 13:21:06 -0500 (Tue, 04 Dec 2007)
New Revision: 4468
Modified:
trunk/docs/userguide/en/src/main/docbook/included/orderingList.xml
trunk/docs/userguide/en/src/main/resources/images/orderinList1.png
Log:
http://jira.jboss.com/jira/browse/RF-1184 - ewrote description for the component according to its functionality, rewrote description for classes, added new classes, wrote example for screenshort.
Modified: trunk/docs/userguide/en/src/main/docbook/included/orderingList.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/orderingList.xml 2007-12-04 18:15:59 UTC (rev 4467)
+++ trunk/docs/userguide/en/src/main/docbook/included/orderingList.xml 2007-12-04 18:21:06 UTC (rev 4468)
@@ -129,7 +129,9 @@
<property>"header"</property>
</emphasis> and <emphasis>
<property>"footer" </property>
- </emphasis> facets. </para>
+ </emphasis> facets. A caption could be also defined with <emphasis>
+ <property>"captionLabel"</property>
+ </emphasis> attribute.</para>
<!-- ADD SCREENSHOT-->
@@ -180,7 +182,7 @@
<property> "downControl"</property>
</emphasis> , <emphasis>
<property> "downControlDisabled" </property>
- </emphasis> facets are used to replaces the default control with facets content. </para>
+ </emphasis> facets are used to replaces the default control with facets content.</para>
<para>
<emphasis role="bold">Example:</emphasis>
</para>
@@ -201,8 +203,8 @@
<rich:orderingList>
...]]></programlisting>
- <para>The position of the controls relatively to a list could be customized with <itemizedlist>
- <listitem>
+ <para>The position of the controls relatively to a list could be customized with: <itemizedlist>
+ <!--listitem>
<emphasis>
<property>"controlsPosition"</property>
</emphasis> attribute. Possible values: <itemizedlist>
@@ -211,40 +213,33 @@
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-->
<listitem><emphasis>
<property> "controlsHorizontalAlign"</property>
</emphasis> attribute. Possible values: <itemizedlist>
- <listitem>left - controls could be rendered to the left side of a list</listitem>
- <listitem>right(default) - controls could be rendered to the right side of a
- list</listitem>
- <listitem>center - controls could be centered</listitem>
-
+ <listitem>left - controls render to the left side of a list</listitem>
+ <listitem>right(default) - controls render to the right side of a list</listitem>
+ <listitem>center - controls is centered</listitem>
</itemizedlist>
</listitem>
-
<listitem><emphasis>
<property> "controlsVerticalAlign"</property>
</emphasis> attribute. Possible values: <itemizedlist>
- <listitem>top - controls could be rendered aligned to top side of a list </listitem>
- <listitem>bottom - controls could be rendered aligned to bottom side of a
- list </listitem>
- <listitem>center(default) - controls could be rendered centered relatively
- to a list </listitem>
-
+ <listitem>top - controls render aligned to the top side of a list </listitem>
+ <listitem>bottom - controls render aligned to the bottom side of a list </listitem>
+ <listitem>center(default) - controls is centered relatively to a list
+ </listitem>
</itemizedlist>
</listitem>
-
- <listitem><emphasis>
+ <!--listitem><emphasis>
<property>"controlsLayout"</property>
</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>
+ </listitem-->
</itemizedlist>
</para>
@@ -255,19 +250,19 @@
<listitem>
<emphasis>
<property>"orderControlsVisible"</property>
- </emphasis> attribute may have two values: true or false. If false
- <property>Up</property> and <property>Down</property> controls couldn't be
+ </emphasis> attribute has two values: true or false. If false
+ <property>Up</property> and <property>Down</property> controls are not
displayed.</listitem>
<listitem>
<emphasis>
<property>"fastOrderControlsVisible"</property>
- </emphasis> attribute may have two values: true or false. If false
- <property>Top</property> and <property>Bottom</property> controls couldn't be
+ </emphasis> attribute has two values: true or false. If false
+ <property>Top</property> and <property>Bottom</property> controls are not
displayed.</listitem>
</itemizedlist>
</para>
-
- <para>The component provides possibility to be customized using templating. The
+ <!-- Wiil be done for 3.2.0 version-->
+ <!--para>The component provides possibility to be customized using templating. The
customization could be performed by a layout definition nested into the component. 5
elements are provided to be defined inside template: {list}, {topControl},
{bottomControl}, {downCotrol}, {upControl}. <para>The example is placed below.</para>
@@ -286,112 +281,80 @@
</h:panelGrid>
</rich:orderingList>
...]]>
- </programlisting>
- <!--para>The <emphasis role="bold">
- <property><rich:orderingList></property>
- </emphasis> component provides the possibility to be customized using templating. The
- customization could be performed by layout definition nested to component.</para>
- <para>5 elements could be provided to be defined inside template (all standard controls
- should also possible to use inside): list, topcontrol, bottomControl, downCotrol,
- upControl.</para>
- <para>The markup defined in the initial picture could be defined as in the following
- example.</para>
- <para>
- <emphasis role="bold">Example:</emphasis>
- </para>
- <programlisting role="XML"><![CDATA[...
-<rich:orderingList>
-...
- <h:panelGrid columns="2" columnClasses="class1 class2">
- <h:outputText value="{list}"/>
- <h:panelGroup>
- <h:outputText value="{topControl}"/>
- <h:outputText value="{upControl}"/>
- <h:outputText value="{downControl}"/>
- <h:outputText value="{bottomControl}"/>
- </h:panelGroup>
- </h:panelGrid>
- </rich:orderingList>
-...]]></programlisting-->
- </section>
+ </programlisting-->
- <table>
- <title>Keyboard usage for elements selection</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 selection</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>Inverts selection for an item</entry>
+ </row>
+ <row>
+ <entry>SHIFT+click</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>
+ <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 upper</entry>
- </row>
- <row>
- <entry>CTRL+Down arrow</entry>
- <entry>Moves selected item to one position lower</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 upper</entry>
+ </row>
+ <row>
+ <entry>CTRL+Down arrow</entry>
+ <entry>Moves selected item to one position lower</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
- <para>All the changes uses the same rules that defined in requirement for ordering with
- controls.</para>
-
<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">
@@ -399,87 +362,87 @@
<row>
<entry>Function</entry>
<entry>Description</entry>
- <entry>Element</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>Sorts items in the list ascending</entry>
+ <!--entry>Component</entry-->
</row>
<row>
<entry>doSortDescending()</entry>
- <entry>Sort items in the list descending</entry>
- <entry>Component</entry>
+ <entry>Sorts items in the list descending</entry>
+ <!--entry>Component</entry-->
</row>
<row>
<entry>doSort()</entry>
- <entry>Invert current sorting</entry>
- <entry>Component</entry>
+ <entry>Inverts current sorting</entry>
+ <!--entry>Component</entry-->
</row>
<!--Controls common API -->
<row>
<entry>doHide()</entry>
- <entry>Hide ordering control</entry>
- <entry>Any Ordering control</entry>
+ <entry>Hides ordering control</entry>
+ <!--entry>Any Ordering control</entry-->
</row>
<row>
<entry>doShow()</entry>
- <entry>Show ordering control</entry>
- <entry>Any Ordering control</entry>
+ <entry>Shows ordering control</entry>
+ <!--entry>Any 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>
+ <!--entry>Any Ordering control</entry-->
</row>
<row>
<entry>doEnable()</entry>
- <entry>Enable ordering control</entry>
- <entry>Any Ordering control</entry>
+ <entry>Enables ordering control</entry>
+ <!--entry>Any Ordering control</entry-->
</row>
<row>
<entry>doDisable()</entry>
- <entry>Disable ordering control</entry>
- <entry>Any Ordering control</entry>
+ <entry>Disables ordering control</entry>
+ <!--entry>Any Ordering control</entry-->
</row>
<row>
<entry>isEnabled()</entry>
- <entry>Check if current control is enabled</entry>
- <entry>Any Ordering control</entry>
+ <entry>Checksif current control is enabled</entry>
+ <!--entry>Any Ordering control</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>
+ <!--entry>Any Item</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>
+ <!--entry>Any Item</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>
+ <!--entry>Any Item</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>
+ <!--entry>Any Item</entry-->
</row>
<row>
<entry>getSelection()</entry>
- <entry>Return currently selected item</entry>
- <entry>Any Item</entry>
+ <entry>Returns currently selected item</entry>
+ <!--entry>Any 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>
+ <!--entry>Any Item</entry-->
</row>
</tbody>
</tgroup>
@@ -511,7 +474,7 @@
<!-- ADD SCREENSHOT -->
<table>
- <title>Classes names that define a rows representations</title>
+ <title>Classes names that define a caption representation</title>
<tgroup cols="2">
<thead>
<row>
@@ -521,26 +484,52 @@
</thead>
<tbody>
<row>
+ <entry>rich-ordering-list-caption</entry>
+ <entry>Defines styles for a caption</entry>
+ </row>
+ <row>
+ <entry>rich-ordering-list-caption-disabled</entry>
+ <entry>Defines styles for a caption in disabled state</entry>
+ </row>
+ <row>
+ <entry>rich-ordering-list-caption-active</entry>
+ <entry>Defines styles for a caption in active state</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Classes names that define item rows representations</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Class name</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
<entry>rich-ordering-list-row</entry>
- <entry>Defines a default class for any item row</entry>
+ <entry>Defines styles for an item row</entry>
</row>
<row>
<entry>rich-ordering-list-row-selected</entry>
- <entry>Defines class to be added to selected item rows</entry>
+ <entry>Defines styles for a selected item row</entry>
</row>
<row>
<entry>rich-ordering-list-row-active</entry>
- <entry>Defines class to be added to active item rows</entry>
+ <entry>Defines styles for an active item row</entry>
</row>
<row>
- <entry>rich-ordering-list-cell-disabled</entry>
- <entry>Defines a class for row in disabled state</entry>
+ <entry>rich-ordering-list-row-disabled</entry>
+ <entry>Defines styles for a disabled item row</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
- <title>Classes names that define a cells representations</title>
+ <title>Classes names that define item cells representations</title>
<tgroup cols="2">
<thead>
<row>
@@ -551,19 +540,19 @@
<tbody>
<row>
<entry>rich-ordering-list-item-cell</entry>
- <entry>Defines a default class for any item cell</entry>
+ <entry>Defines styles for an item cell</entry>
</row>
<row>
<entry>rich-ordering-list-item-cell-selected</entry>
- <entry>Defines class to be added to selected item cells</entry>
+ <entry>Defines styles for a selected item cell</entry>
</row>
<row>
<entry>rich-ordering-list-item-cell-active</entry>
- <entry>Defines class to be added to active item cells</entry>
+ <entry>Defines styles for an active item cell</entry>
</row>
<row>
<entry>rich-ordering-list-cell-disabled</entry>
- <entry>Defines a class for cell in disabled state</entry>
+ <entry>Defines styles for a disabled item cell</entry>
</row>
</tbody>
</tgroup>
@@ -581,27 +570,27 @@
<tbody>
<row>
<entry>rich-ordering-controls</entry>
- <entry>Could be applied to the whole group of the controls.</entry>
+ <entry>Defines styles for a controls group</entry>
</row>
<row>
<entry>rich-ordering-control-top</entry>
- <entry>Defines class for Top control</entry>
+ <entry>Defines styles for a "top" control</entry>
</row>
<row>
<entry>rich-ordering-control-bottom</entry>
- <entry>Defines class for Bottom control</entry>
+ <entry>Defines styles for a "bottom" control</entry>
</row>
<row>
<entry>rich-ordering-control-up</entry>
- <entry>Defines class for Up control</entry>
+ <entry>Defines styles for a "up" control</entry>
</row>
<row>
<entry>rich-ordering-control-down</entry>
- <entry>Defines class for Down control</entry>
+ <entry>Defines styles for a "down" control</entry>
</row>
<row>
<entry>rich-ordering-control-disabled</entry>
- <entry>Defines a class for any control in a disabled state</entry>
+ <entry>Defines styles for controls in disabled state</entry>
</row>
</tbody>
</tgroup>
Modified: trunk/docs/userguide/en/src/main/resources/images/orderinList1.png
===================================================================
(Binary files differ)
More information about the richfaces-svn-commits
mailing list