Author: vkorluzhenko Date: 2007-12-11 10:55:55 -0500 (Tue, 11 Dec 2007) New Revision: 4718 Modified: branches/3.1.x/docs/userguide/en/src/main/docbook/included/listShuttle.xml Log: http://jira.jboss.com/jira/browse/RF-1174 - updated description for classes, added new classes and skins according to developer project. Modified: branches/3.1.x/docs/userguide/en/src/main/docbook/included/listShuttle.xml =================================================================== --- branches/3.1.x/docs/userguide/en/src/main/docbook/included/listShuttle.xml 2007-12-11 15:54:38 UTC (rev 4717) +++ branches/3.1.x/docs/userguide/en/src/main/docbook/included/listShuttle.xml 2007-12-11 15:55:55 UTC (rev 4718) @@ -473,6 +473,298 @@ </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>panelBorderColor</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> @@ -496,7 +788,7 @@ </figure> <table> - <title>Classes names that define a caption representations in the source and target lists</title> + <title>Classes names that define a list representation</title> <tgroup cols="2"> <thead> <row> @@ -506,19 +798,65 @@ </thead> <tbody> <row> + <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 &lt;div&gt; element for source list</entry> + </row> + <row> + <entry>rich-shuttle-target-items</entry> + <entry>Defines styles for a wrapper &lt;div&gt; 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 a source and target lists</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Class name</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> <entry>rich-shuttle-source-caption</entry> - <entry>Defines a class for caption customization in the source list</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 in the target list</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> @@ -529,21 +867,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>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>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> @@ -554,21 +892,21 @@ <tbody> <row> <entry>rich-shuttle-target-row</entry> - <entry>Defines a default class for any item 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>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>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> @@ -579,21 +917,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> @@ -604,15 +942,15 @@ <tbody> <row> <entry>rich-shuttle-target-cell</entry> - <entry>Defines a default class for any item 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>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>Defines styles for an active cell in a target list</entry> </row> </tbody> </tgroup> @@ -629,50 +967,88 @@ <tbody> <row> <entry>rich-shuttle-controls</entry> - <entry>Defines styles for a controls group.</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 &quot;Top&quot; control</entry> </row> <row> <entry>rich-shuttle-bottom</entry> - <entry>Defines class for Bottom control</entry> + <entry>Defines styles for a &quot;Bottom&quot; control</entry> </row> <row> <entry>rich-shuttle-up</entry> - <entry>Defines class for Up control</entry> + <entry>Defines styles for a &quot;Up&quot; control</entry> </row> <row> <entry>rich-shuttle-down</entry> - <entry>Defines class for Down control</entry> + <entry>Defines styles for a &quot;Down&quot; control</entry> </row> <row> <entry>rich-shuttle-copy</entry> - <entry>Defines class for Copy control</entry> + <entry>Defines styles for a &quot;Copy&quot; control</entry> </row> <row> <entry>rich-shuttle-remove</entry> - <entry>Defines class for Remove control</entry> + <entry>Defines styles for a &quot;Remove&quot; control</entry> </row> <row> <entry>rich-shuttle-copyAll</entry> - <entry>Defines class for copyAll control</entry> + <entry>Defines styles for a &quot;copyAll&quot; control</entry> </row> <row> <entry>rich-shuttle-removeAll</entry> - <entry>Defines class for removeAll control</entry> + <entry>Defines styles for a &quot;removeAll&quot; 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>&lt;rich:listShuttle&gt;</property> </emphasis> components on a page using CSS, it's enough to create classes with the same