Author: ochikvina
Date: 2009-09-18 09:25:36 -0400 (Fri, 18 Sep 2009)
New Revision: 15621
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_inputNumberSlider.xml
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_inputNumberSpinner.xml
Log:
https://jira.jboss.org/jira/browse/RF-7803 - the component description is reviewed;
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_inputNumberSlider.xml
===================================================================
---
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_inputNumberSlider.xml 2009-09-18
06:45:52 UTC (rev 15620)
+++
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_inputNumberSlider.xml 2009-09-18
13:25:36 UTC (rev 15621)
@@ -80,7 +80,7 @@
<emphasis>
<property moreinfo="none">"step"</property>
</emphasis>
- (on default is "1") attributes, which define the
+ (by default is "1") attributes, which define the
beginning and the end of a numerical area and a
<property moreinfo="none">slider</property>
property step.
@@ -89,7 +89,7 @@
<emphasis role="bold">Example:</emphasis>
</para>
<programlisting role="XML"
format="linespecific"><![CDATA[<rich:inputNumberSlider></rich:inputNumberSlider>]]></programlisting>
- <para>It's generated on a page:</para>
+ <para>Here is a component generated on a page:</para>
<figure float="0">
<title>
Generated
@@ -108,7 +108,7 @@
<emphasis>
<property
moreinfo="none">"showInput"</property>
</emphasis>
- (default is "true") and
+ (default value is "true") and
<emphasis>
<property
moreinfo="none">"enableManualInput"</property>
</emphasis>
@@ -125,7 +125,7 @@
<emphasis role="bold">Example:</emphasis>
</para>
<programlisting role="XML"
format="linespecific"><![CDATA[<rich:inputNumberSlider
minValue="1" maxValue="100"
showInput="false"/>]]></programlisting>
- <para>It's displayed at a page like:</para>
+ <para>It's displayed on a page like this:</para>
<figure float="0">
<title>
<emphasis role="bold">
@@ -148,12 +148,12 @@
<property
moreinfo="none">"showBoundaryValues"</property>
</emphasis>
which is responsible for "boundary values"
- displaying (default is true) and
+ displaying (default value is "true") and
<emphasis>
<property
moreinfo="none">"showToolTip"</property>
</emphasis>
- which is responsible for tooltTip displaying (default is
- "true").
+ which is responsible for tooltTip displaying (default value is
+ "true").
</para>
<para>
Moreover, to add e.g. some JavaScript effects, events
@@ -208,7 +208,7 @@
<emphasis>
<property moreinfo="none">"label"</property>
</emphasis>
- attribute provides an association between a component, and
+ attribute provides an association between the component and
the message that the component (indirectly) produced. This
attribute defines the parameters of a localized error and
informational messages that occur as a result of conversion,
@@ -246,7 +246,7 @@
</figure>--><para>The <emphasis>
<property
moreinfo="none">"showArrows"</property>
</emphasis> boolean attribute when set to "true" enables
additional controls for increasing and decreasing slider value.
- The controls (arrows by default) are placed in the beginning and in the end
of slider track:</para>
+ The controls (arrows by default) are placed in the beginning and in the end
of a slider track:</para>
<figure float="0">
<title>
<emphasis role="bold">
@@ -313,89 +313,194 @@
</tbody>
</tgroup>
</table>
- <table id="tab_cn">
- <title>
- Classes names that define a component appearance
- </title>
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Class name</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>rich-slider</entry>
- <entry>
- Defines styles for a wrapper table element
- of a component
- </entry>
- </row>
- <row>
- <entry>rich-inslider-track</entry>
- <entry>Defines styles for a bar</entry>
- </row>
- <row>
- <entry>rich-inslider-handler</entry>
- <entry>
- Defines styles for a slider handler
- </entry>
- </row>
- <row>
- <entry>rich-inslider-handler-selected</entry>
- <entry>
- Defines styles for a selected handler
- </entry>
- </row>
- <row>
- <entry>rich-inslider-field</entry>
- <entry>Defines styles for a text field</entry>
- </row>
- <row>
- <entry>rich-inslider-right-num</entry>
- <entry>
- Defines styles for the right number
- </entry>
- </row>
- <row>
- <entry>rich-inslider-left-num</entry>
- <entry>
- Defines styles for the left number
- </entry>
- </row>
- <row>
- <entry>rich-inslider-track-border</entry>
- <entry>
- Defines styles for track border
- </entry>
- </row>
- <row>
- <entry>rich-inslider-tip</entry>
- <entry>Defines styles for a hint</entry>
- </row>
- <row>
- <entry>inputNumberSlider-increase-vertical</entry>
- <entry>Defines styles for the top arrow</entry>
- </row>
- <row>
- <entry>inputNumberSlider-decrease-vertical</entry>
- <entry>Defines styles for the bottom arrow</entry>
- </row>
- <row>
- <entry>inputNumberSlider-increase-horizontal</entry>
- <entry>Defines styles for the right arrow</entry>
- </row>
- <row>
- <entry>inputNumberSlider-decrease-horizontal</entry>
- <entry>Defines styles for the left arrow</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- You can find all necessary information about style classes redefinition in
+
+ <table>
+ <title>Style classes (selectors) with the corresponding skin
parameters</title>
+ <tgroup cols="4">
+ <thead>
+ <row>
+ <entry>Class (selector) name</entry>
+ <entry>Description</entry>
+ <entry>Skin Parameters</entry>
+ <entry>CSS properties mapped</entry>
+
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry morerows="3">.rich-inslider-tip</entry>
+ <entry morerows="3">Defines styles for a hint</entry>
+ <entry>tipBackgroundColor</entry>
+ <entry>background-color</entry>
+ </row>
+ <row>
+ <entry>tipBorderColor</entry>
+ <entry>border-color</entry>
+ </row>
+ <row>
+ <entry>generalFamilyFont</entry>
+ <entry>font-family</entry>
+ </row>
+ <row>
+ <entry>generalSizeFont</entry>
+ <entry>font-size</entry>
+ </row>
+
+ <row>
+ <entry morerows="3">.rich-inslider-left-num</entry>
+ <entry morerows="3">Defines styles for the left
number</entry>
+ <entry>panelBorderColor</entry>
+ <entry>border-color</entry>
+ </row>
+ <row>
+ <entry>generalFamilyFont</entry>
+ <entry>font-family</entry>
+ </row>
+ <row>
+ <entry>generalSizeFont</entry>
+ <entry>font-size, line-height</entry>
+ </row>
+ <row>
+ <entry>generalTextColor</entry>
+ <entry>color</entry>
+ </row>
+
+ <row>
+ <entry morerows="3">.rich-inslider-right-num</entry>
+ <entry morerows="3">Defines styles for the right
number</entry>
+ <entry>panelBorderColor</entry>
+ <entry>border-color</entry>
+ </row>
+ <row>
+ <entry>generalFamilyFont</entry>
+ <entry>font-family</entry>
+ </row>
+ <row>
+ <entry>generalSizeFont</entry>
+ <entry>font-size, line-height</entry>
+ </row>
+ <row>
+ <entry>generalTextColor</entry>
+ <entry>color</entry>
+ </row>
+
+ <row>
+ <entry>.rich-inslider-track</entry>
+ <entry>Defines styles for the wrapper <div> element of the
slider track</entry>
+ <entry>controlBackgroundColor</entry>
+ <entry>background-color</entry>
+ </row>
+
+ <row>
+ <entry>.rich-inslider-track-decor-1</entry>
+ <entry>Defines styles for the wrapper <table> element of the
slider track</entry>
+ <entry>panelBorderColor</entry>
+ <entry>border-color</entry>
+ </row>
+
+ <row>
+ <entry>.rich-inslider-track-decor-2</entry>
+ <entry>Defines styles for the slider track</entry>
+ <entry>controlBackgroundColor</entry>
+ <entry>border-color</entry>
+ </row>
+
+ <row>
+ <entry morerows="4">.rich-inslider-field</entry>
+ <entry morerows="4">Defines styles for a text
field</entry>
+ <entry>controlBackgroundColor</entry>
+ <entry>background-color</entry>
+ </row>
+ <row>
+ <entry>generalFamilyFont</entry>
+ <entry>font-family</entry>
+ </row>
+ <row>
+ <entry>generalSizeFont</entry>
+ <entry>font-size</entry>
+ </row>
+ <row>
+ <entry>controlTextColor</entry>
+ <entry>color</entry>
+ </row>
+ <row>
+ <entry>panelBorderColor</entry>
+ <entry>border-color</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table id="tab_cn">
+ <title>Style classes (selectors) without skin parameters</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Class name</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>.rich-slider</entry>
+ <entry>Defines styles for the wrapper <table> element of the
component</entry>
+ </row>
+
+ <row>
+ <entry>.rich-inslider-handler</entry>
+ <entry>Defines styles for the slider handler</entry>
+ </row>
+
+ <row>
+ <entry>.rich-inslider-handler-vertical</entry>
+ <entry>Defines styles for the vertical slider handler</entry>
+ </row>
+
+ <row>
+ <entry>.rich-inslider-track-vertical</entry>
+ <entry>Defines styles for the vertical slider track</entry>
+ </row>
+
+ <row>
+ <entry>.rich-inslider-handler-selected</entry>
+ <entry>Defines styles for a selected handler</entry>
+ </row>
+
+ <row>
+ <entry>.rich-inslider-handler-selected-vertical</entry>
+ <entry>Defines styles for a selected handler on the vertical
slider</entry>
+ </row>
+
+ <row>
+ <entry>.rich-inslider-track-border</entry>
+ <entry>Defines styles for track border</entry>
+ </row>
+
+ <row>
+ <entry>.inputNumberSlider-increase-vertical</entry>
+ <entry>Defines styles for the top arrow</entry>
+ </row>
+
+ <row>
+ <entry>.inputNumberSlider-decrease-vertical</entry>
+ <entry>Defines styles for the bottom arrow</entry>
+ </row>
+
+ <row>
+ <entry>.inputNumberSlider-increase-horizontal</entry>
+ <entry>Defines styles for the right arrow</entry>
+ </row>
+
+ <row>
+ <entry>.inputNumberSlider-decrease-horizontal</entry>
+ <entry>Defines styles for the left arrow</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <para>You can find all necessary information about style classes redefinition
in
<link linkend="customstyles">Definition of Custom Style
Classes</link>
- section.
+ section.</para>
</section>
<section>
<title>Relevant Resources Links</title>
Modified:
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_inputNumberSpinner.xml
===================================================================
---
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_inputNumberSpinner.xml 2009-09-18
06:45:52 UTC (rev 15620)
+++
branches/community/3.3.X/docs/userguide/en/src/main/docbook/included/rich_inputNumberSpinner.xml 2009-09-18
13:25:36 UTC (rev 15621)
@@ -229,50 +229,83 @@
</tbody>
</tgroup>
</table>
- <table id="tab_cn1">
- <title> Classes names that define a component
appearance </title>
-
- <tgroup cols="2">
- <thead>
- <row>
- <entry>Class name</entry>
- <entry>Description</entry>
- </row>
- </thead>
- <tbody>
- <row>
-
<entry>rich-spinner-c</entry>
- <entry> Defines styles for a
wrapper
- table element of a component
- </entry>
- </row>
- <row>
-
<entry>rich-spinner-input-container</entry>
- <entry>Defines styles for a
- container</entry>
- </row>
- <row>
-
<entry>rich-spinner-input</entry>
- <entry> Defines styles for a
wrapper
- <td> element for
- input fields </entry>
- </row>
- <row>
-
<entry>rich-spinner-button</entry>
- <entry>Defines styles for a
- button</entry>
- </row>
- <row>
-
<entry>rich-spinner-buttons</entry>
- <entry>Defines styles for all
- buttons</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- You can find all necessary information about style classes redefinition in
+
+ <table>
+ <title>Style classes (selectors) with the corresponding skin
parameters</title>
+ <tgroup cols="4">
+ <thead>
+ <row>
+ <entry>Class (selector) name</entry>
+ <entry>Description</entry>
+ <entry>Skin Parameters</entry>
+ <entry>CSS properties mapped</entry>
+
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry morerows="1">.rich-spinner-buttons</entry>
+ <entry morerows="1">Defines styles for all buttons</entry>
+ <entry>headerBackgroundColor</entry>
+ <entry>background-color</entry>
+ </row>
+ <row>
+ <entry>panelBorderColor</entry>
+ <entry>border-color</entry>
+ </row>
+
+ <row>
+ <entry morerows="1">.rich-spinner-input</entry>
+ <entry morerows="1"> Defines styles for a wrapper
<td> element for input fields</entry>
+ <entry>buttonSizeFont</entry>
+ <entry>font-size</entry>
+ </row>
+ <row>
+ <entry>buttonFamilyFont</entry>
+ <entry>font-family</entry>
+ </row>
+
+ <row>
+ <entry morerows="1">.rich-spinner-input-container</entry>
+ <entry morerows="1">Defines styles for a container</entry>
+ <entry>controlBackgroundColor</entry>
+ <entry>background-color</entry>
+ </row>
+ <row>
+ <entry>panelBorderColor</entry>
+ <entry>border-color</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+
+ <table>
+ <title>Style classes (selectors) without skin parameters</title>
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry>Class name</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>.rich-spinner-c</entry>
+ <entry> Defines styles for a wrapper <table> element of a
component</entry>
+ </row>
+
+ <row>
+ <entry>.rich-spinner-button</entry>
+ <entry>Defines styles for a button</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>You can find all necessary information about style classes redefinition in
<link linkend="customstyles">Definition of Custom Style
Classes</link>
- section.
+ section.</para>
</section>
<section>
<title>Relevant Resources Links</title>