From richfaces-svn-commits at lists.jboss.org Sat Dec 1 09:29:49 2007 Content-Type: multipart/mixed; boundary="===============1166590304055031936==" MIME-Version: 1.0 From: richfaces-svn-commits at lists.jboss.org To: richfaces-svn-commits at lists.jboss.org Subject: [richfaces-svn-commits] JBoss Rich Faces SVN: r4404 - trunk/docs/userguide/en/src/main/docbook/included. Date: Sat, 01 Dec 2007 09:29:16 -0500 Message-ID: --===============1166590304055031936== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: artdaw Date: 2007-12-01 09:29:16 -0500 (Sat, 01 Dec 2007) New Revision: 4404 Modified: trunk/docs/userguide/en/src/main/docbook/included/orderingList.xml Log: RF-1184 - fix the Deatils of Usage section of the orderingList component, a= dd screenshot Modified: trunk/docs/userguide/en/src/main/docbook/included/orderingList.xml =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --- trunk/docs/userguide/en/src/main/docbook/included/orderingList.xml 2007= -12-01 14:28:45 UTC (rev 4403) +++ trunk/docs/userguide/en/src/main/docbook/included/orderingList.xml 2007= -12-01 14:29:16 UTC (rev 4404) @@ -62,8 +62,7 @@ -... -]]> +...]]>
Creating the Component Dynamically Using Java @@ -74,8 +73,7 @@ +...]]>
Details of Usage @@ -96,27 +94,27 @@ = = - The - "value" - and - "var" - attributes are used to access the values of a list= . + The + "value" + and + "var" + attributes are used to access the values of a list= . = - The - "selection" - attribute is bound to a list, which stores a set o= f indexes for rows + The + "selection" + attribute is bound to a list, which stores a set o= f indexes for rows selected. If the index from a set is out of bounds, it should = be ignored. - Controls rendering is based on the - "controlsType" - attribute. Possible types are button, link, none.<= /para> + Controls rendering is based on the + "controlsType" + attribute. Possible types are button, link, none.<= /para> Example: + - + @@ -127,14 +125,12 @@ <rich:orderingList> component provides to use optional "caption" - , - "header" - (It's possible to define facet. It has two pos= sible types of - representation: sortable and non-sortable) and - "footer" - facets. + , + "header" + (It's possible to define facet. It has two pos= sible types of + representation: sortable and non-sortable) facets. = - + = = Simple example is placed below. @@ -142,49 +138,53 @@ Example: + - + - + - + + + + + + + ...]]> = The <rich:orderingList> - component provides the possibility to use - "ordering controls set" - , which performs reordering. Every control has poss= ibility to be disabled. + component provides the possibility to use ordering controls set, which performs reordering. Every contro= l has possibility to be disabled. - - "topControl" - , - "topControlDisabled" - , - "bottomControl" - , - "bottomControlDisabled" - , - "upControl" - , - "upControlDisabled" - , - "downControl" - , - "downControlDisabled" - facets are used to replaces the default control wi= th facets content. + + "topControl" + , + "topControlDisabled" + , + "bottomControl" + , + "bottomControlDisabled" + , + "upControl" + , + "upControlDisabled" + , + "downControl" + , + "downControlDisabled" + facets are used to replaces the default control wi= th facets content. Example: - + @@ -198,40 +198,35 @@ -... -]]> +...]]> = - - - - The position of the controls relatively to a list could be c= ustomized with - - controlsPosition - attribute. Possible values: + + "controlsPosition" + attribute. Possible values: left - controls could be rendered to the= left side of a list - right(default) controls could be rendere= d to the right side of a + right(default) - controls could be rende= red to the right side of a list top - controls could be rendered above t= he list bottom - controls could be rendered belo= w the list = - - controlsHorizontalAlign - attribute. Possible values: + + "controlsHorizontalAlign" + attribute. Possible values: left - controls could be rendered to the= left side of a list - right(default) controls could be rendere= d to the right side of a + right(default) - controls could be rende= red to the right side of a list center - controls could be centered = = - - controlsVerticalAlign - attribute. Possible values: + + "controlsVerticalAlign" + attribute. Possible values: top - controls could be rendered aligned= to top side of a list bottom - controls could be rendered alig= ned to bottom side of a list @@ -241,15 +236,14 @@ = - - controlsLayout - attribute. Possible values: + + "controlsLayout" + attribute. Possible values: inline - controls defined one by one in = line block - controls defined in column - = @@ -257,21 +251,21 @@ <rich:orderingList> component has a possibility to hide any of the con= trols by pairs using following attributes: - - "orderControlsVisible" - attribute may have two values: true or fals= e. If false - "Up" and "Down" controls couldn't = be + + + "orderControlsVisible" + attribute may have two values: true or fal= se. If false + Up and Down = controls couldn't be displayed. - - "fastOrderControlsVisible" - attribute may have two values: true or fals= e. If false - "Top" and "Bottom" controls couldn= 't be - displayed + + + "fastOrderControlsVisible" + attribute may have two values: true or fal= se. If false + Top and Bottom controls couldn't be + displayed. = - - The component provides possibility to be customized using te= mplating. The customization could be performed by a layout definition nested= into the component. 5 elements are provided to be defined inside template: {list}, {= topControl}, @@ -280,7 +274,6 @@ Example: @@ -292,25 +285,24 @@ - = - ...]]> +...]]> The - <rich:orderingList> - component provides the possibility to be customized us= ing templating. The + <rich:orderingList> + component provides the possibility to be customize= d using templating. The customization could be performed by layout definition nested t= o component. 5 elements could be provided to be defined inside template (= all standard controls - should also possible to use inside): list, topcontrol, bottomC= ontrol, downCotrol, upControl. - The markup defined in the initial picture could be defined a= s in the following example. + should also possible to use inside): list, topcontrol, bottomC= ontrol, downCotrol, + upControl. + The markup defined in the initial picture could be defined a= s in the following + example. Example: - - ... - - +... + @@ -320,16 +312,11 @@ - -... -]]> - = - = +...]]>
= - Keyboard usage - Keyboard usage for elements selection TO DO + Keyboard usage for elements selection @@ -399,12 +386,12 @@ All the changes uses the same rules that defined in requirement = for ordering with controls. = -
+
JavaScript API Controls are accessible for developer on client-side using = controls attribute of JavaScript component instance. The value of the attribute is a= n associative array of - controls keyed by the following strings: "top", - "up", "down", "bottom". + controls keyed by the following strings: top, + up, down, = bottom.
JavaScript API @@ -521,15 +508,7 @@ = On the screenshot there are classes names that define styles= for component elements. = - -
- Style classes - - - - - -
+ =
Classes names that define a rows representations @@ -628,13 +607,14 @@
In order to redefine styles for all - <rich:orderingList> - components on a page using CSS, it's enough to create = classes with the same names and define necessary properties in them. - - To change styles of particular <rich:orderingList> - components, define your own style classes in the = corresponding + components on a page using CSS, it's enough to cre= ate classes with the same + names and define necessary properties in them. + To change styles of particular <rich:orderingList> + components, define your own style classes in the c= orresponding + <rich:orderingList> component attributes. --===============1166590304055031936==--