From richfaces-svn-commits at lists.jboss.org Sat Dec 1 10:23:16 2007 Content-Type: multipart/mixed; boundary="===============0416723767551189290==" 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: r4407 - trunk/docs/userguide/en/src/main/docbook/included. Date: Sat, 01 Dec 2007 10:23:16 -0500 Message-ID: --===============0416723767551189290== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Author: artdaw Date: 2007-12-01 10:23:16 -0500 (Sat, 01 Dec 2007) New Revision: 4407 Modified: trunk/docs/userguide/en/src/main/docbook/included/listShuttle.xml Log: RF-1174 - listShuttle. Fix Details of Usage Modified: trunk/docs/userguide/en/src/main/docbook/included/listShuttle.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/listShuttle.xml 2007-= 12-01 14:30:57 UTC (rev 4406) +++ trunk/docs/userguide/en/src/main/docbook/included/listShuttle.xml 2007-= 12-01 15:23:16 UTC (rev 4407) @@ -9,7 +9,6 @@
Creating the Component with a Page Tag Here is a simple example as it could be used on a page: - Example: @@ -26,7 +25,6 @@
Creating the Component Dynamically Using Java - Example: @@ -40,12 +38,12 @@ The <rich:listShuttle> component consists of the following parts: - two item lists (source and target). List consist= s of items; each item has + two item lists (source and = target). List consists of items; each item has three different representations: common, selected, act= ive - optional caption, header (sorted and non-sorted)= , footer elements - copy/moving controls set, a set of controls, whi= ch performs moving/copying + optional caption, header (sorted and non-sorted), footer ele= ments + copy/moving controls set, a= set of controls, which performs moving/copying items between lists - optional ordering controls set, a set of control= s that performs + optional ordering controls set, a set of controls that performs reordering @@ -78,46 +76,45 @@ - ...]]> Captions could be added to a list only after it was defined = as a - sourceCaption + "sourceCaption" and - targetCaption + "targetCaption" named facets inside the component or defined with = the - sourceCaptionLabel + "sourceCaptionLabel" and - targetCaptionLabel + "targetCaptionLabel" attribute. The <rich:listShuttle> - component provides the possibility to use "ordering - controls set" , which performs reordering = in the target item - list. Every control has possibility to be disabled. + component provides the possibility to use ordering controls + set, which performs reordering in the target item l= ist. Every control 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: - @@ -137,63 +134,64 @@ The <rich:listShuttle> - component also provides 4 predefined controls in - "move/copy controls set" for moving = or copying items - between source and target lists. Every control has possibility= to be disabled. + component also provides 4 predefined controls in move/copy + controls set for moving or copying items betwee= n source and target lists. + Every control has possibility to be disabled. - - "copyCotrol" - , - "copy_disabled" - , - "removeControl" - , - "remove_disabled" - , - "copyAllControl" - , - "copyAll_disabled" - , - "removeAllControl" - , - "removeAll_disabled" - facets are used to replaces the default control wi= th facets content. + + "copyCotrol" + , + "copy_disabled" + , + "removeControl" + , + "remove_disabled" + , + "copyAllControl" + , + "copyAll_disabled" + , + "removeAllControl" + , + "removeAll_disabled" + facets are used to replaces the default control wi= th facets content. - The - "sourceValue" - attribute defines the collection to be shown in so= urce list. - The - "value" - attribute defines the collection to store the valu= e from target list. - The - "var" - could be shared between both collections to define= d lists on the page. - Controls rendering is based on the - "controlsType" - attribute. Possible types are button, link, none.<= /para> The position of the - ordering controls set relatively to list = should be customized with - "orderControlsVerticalAlign" - attribute. The position of the move/copy con= trols set - relatively to lists should be customized with - "moveControlsVerticalAlign" - attribute. = + The = + "sourceValue" + attribute defines the collection to be = shown in source list. + The = + "value" + attribute defines the collection to sto= re the value from target list. + The = + "var" + could be shared between both collection= s to defined lists on the page. + Controls rendering is based on the + "controlsType" + attribute. Possible types are button and none. The position of the + ordering controls set relatively to list = should be customized with = + "orderControlsVerticalAlign" + attribute. The position of the mo= ve/copy controls set + relatively to lists should be customized with = + "moveControlsVerticalAlign" + attribute. = + = + = The <rich:listShuttle> component provides the possibility to be customize= d using templating. The customization could be performed by layout definition nested t= o component. 10 elements could be provided to be defined inside template = (all standard controls - should also possible to use inside): sourceList, targetList, C= opyControl, removeCotrol, - copyAllControl, removeAllControl, topcontrol, bottomControl, d= ownCotrol, upControl. - The markup defined in the initial picture could be defined a= s in the following example. + should also possible to use inside): {sourceList}, {targetList= }, {CopyControl}, {removeCotrol}, + {copyAllControl}, {removeAllControl}, {topcontrol}, {bottomCon= trol}, {downCotrol}, {upControl}. + The markup defined in the initial picture could be defined a= s in the following + example. Example: - - - ... - +... @@ -211,11 +209,8 @@ - ... ]]> - = - Keyboard usage Keyboard usage for elements selection @@ -288,8 +283,7 @@ 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 @@ -425,17 +419,8 @@ = On the screenshot there are classes names that define styles= for component elements. = - + = -
- Style classes - - - - - -
- =
--===============0416723767551189290==--