[richfaces-svn-commits] JBoss Rich Faces SVN: r11772 - trunk/docs/userguide/en/src/main/docbook/included.
richfaces-svn-commits at lists.jboss.org
richfaces-svn-commits at lists.jboss.org
Mon Dec 15 09:02:17 EST 2008
Author: smukhina
Date: 2008-12-15 09:02:17 -0500 (Mon, 15 Dec 2008)
New Revision: 11772
Modified:
trunk/docs/userguide/en/src/main/docbook/included/inputNumberSlider.desc.xml
trunk/docs/userguide/en/src/main/docbook/included/inputNumberSlider.xml
Log:
https://jira.jboss.org/jira/browse/RF-5387 -InputNumberSlider extended component description, merged the current description with the extended component one.
Modified: trunk/docs/userguide/en/src/main/docbook/included/inputNumberSlider.desc.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/inputNumberSlider.desc.xml 2008-12-15 13:11:19 UTC (rev 11771)
+++ trunk/docs/userguide/en/src/main/docbook/included/inputNumberSlider.desc.xml 2008-12-15 14:02:17 UTC (rev 11772)
@@ -1,13 +1,22 @@
<?xml version="1.0" encoding="UTF-8"?>
+
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN" "http://www.oasis-open.org/docbook/xml/4.3CR3/docbookx.dtd"
+[
+<!ENTITY slider "rich:inputNumberSlider">
+]
+>
<section>
<sectioninfo>
<keywordset>
+ <keyword>&slider;</keyword>
<keyword>rich:inputNumberSlider</keyword>
</keywordset>
</sectioninfo>
<section>
<title>Description</title>
- <para>A component that lets selecting a number from a numeric region. It's a horizontal
+ <para>The component extending standard component <emphasis role="bold">
+ <property><rich:inputNumberSlider></property>
+ </emphasis>.A component that lets selecting a number from a numeric region. It's a horizontal
aligned scroll-like control with its own input field (optional) present. The keyboard input in a
field is possible (optional). Also it's possible to see the current value in the toolTip
above a dragged handle control.</para>
@@ -30,6 +39,9 @@
<listitem><para>Dragged state is stable after the mouse moves</para></listitem>
<listitem><para>Optional manual input possible if a text input field is present</para></listitem>
<listitem><para>Validation of manual input</para></listitem>
+ <listitem><para>Possibility to display 2 controls that increase/decrease the value by the defined step width, when they will be clicked.</para></listitem>
+ <listitem><para>Attribute "orientation" that can have the values "vertical" and "horizontal" to define in which direction the slider should be moveable.
+ </para></listitem>
</itemizedlist>
</section>
-</section>
\ No newline at end of file
+</section>
Modified: trunk/docs/userguide/en/src/main/docbook/included/inputNumberSlider.xml
===================================================================
--- trunk/docs/userguide/en/src/main/docbook/included/inputNumberSlider.xml 2008-12-15 13:11:19 UTC (rev 11771)
+++ trunk/docs/userguide/en/src/main/docbook/included/inputNumberSlider.xml 2008-12-15 14:02:17 UTC (rev 11772)
@@ -1,8 +1,16 @@
<?xml version='1.0' encoding='UTF-8'?>
+
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN" "http://www.oasis-open.org/docbook/xml/4.3CR3/docbookx.dtd"
+[
+<!ENTITY slider "rich:inputNumberSlider">
+]
+>
+
<section>
<sectioninfo>
<keywordset>
<keyword>dragged handle control</keyword>
+ <keyword>&slider;</keyword>
<keyword>rich:inputNumberSlider</keyword>
<keyword>HtmlInputNumberSlider</keyword>
</keywordset>
@@ -221,6 +229,70 @@
<code>"ShortConverter.SHORT"</code>
.
</para>
+
+ <para>
+ Using the
+ <emphasis>
+ <property>"orientation"</property>
+ </emphasis>
+ attribute (default is "horizontal") is possible to change slider position.
+ </para>
+ <para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
+ <programlisting role="XML"><![CDATA[<rich:inputNumberSlider minValue="0" maxValue="100" value="84" orientation="vertical"/>]]></programlisting>
+ <para>It looks at page like:</para>
+ <figure>
+ <title>
+ <emphasis role="bold">
+ <property><&slider;></property>
+ </emphasis>
+ in a vertical orientation.
+ </title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/inputNumberSlider_vertical.png" />
+ </imageobject>
+ </mediaobject>
+ </figure>
+
+ <para>
+ Using the
+ <emphasis>
+ <property>"showArrows"</property>
+ </emphasis>
+ attribute (default is "false")
+ possible to display 2 controls that increase/decrease the value by the
+ defined step width, when they will be clicked. When the mouse will click and press,
+ the pointer will move with the delay set in miliseconds in<emphasis>
+ <property>"delay"</property>
+ </emphasis> attribute.
+ </para>
+
+ <para>
+ <emphasis role="bold">Example:</emphasis>
+ </para>
+ <programlisting role="XML"><![CDATA[
+ <rich:inputNumberSlider minValue="0"
+ maxValue="100"
+ showInput="false"
+ showArrows="true"
+ delay="150"/>
+ ]]></programlisting>
+ <para>It looks at page like:</para>
+ <figure>
+ <title>
+ <emphasis role="bold">
+ <property><&slider;></property>
+ </emphasis>
+ with horizontal arrows.
+ </title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/inputNumberSlider_arrows.png" />
+ </imageobject>
+ </mediaobject>
+ </figure>
</section>
<section>
@@ -414,6 +486,16 @@
</imageobject>
</mediaobject>
</figure>
+
+ <figure>
+ <title>Style classes for increase/decrease</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/inputNumberSlider_cn_vertical.png" />
+ </imageobject>
+ </mediaobject>
+ </figure>
<table id="tab_cn">
<title>
@@ -467,9 +549,31 @@
</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>
More information about the richfaces-svn-commits
mailing list