Author: SeanRogers Date: 2010-09-22 02:45:55 -0400 (Wed, 22 Sep 2010) New Revision: 19305 Added: modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richcollapsiblePanel-richcollapsiblePanel.png modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richinputNumberSlider-richinputNumberSlider.png modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richinputNumberSpinner-richinputNumberSpinner.png Modified: modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml Log: rich:inputNumberSlider (RF-9202) Modified: modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml =================================================================== --- modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml 2010-09-22 06:08:00 UTC (rev 19304) +++ modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/chap-Component_Reference-Rich_inputs.xml 2010-09-22 06:45:55 UTC (rev 19305) @@ -510,6 +510,20 @@ <para> The <sgmltag>&lt;rich:inputNumberSlider&gt;</sgmltag> component provides a slider for changing numerical values. Optional features include control arrows to step through the values, a tool-tip to display the value while sliding, and a text field for typing the numerical value which can then be validated against the slider's range. </para> + <figure id="figu-Component_Reference-richinputNumberSlider-richinputNumberSlider"> + <title><sgmltag>&lt;rich:inputNumberSlider&gt;</sgmltag></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richinputNumberSlider-richinputNumberSlider.png" format="PNG" /> + </imageobject> + <textobject> + <para> + Two <sgmltag>&lt;rich:inputNumberSlider&gt;</sgmltag> components, one oriented horizontally and the other oriented vertically. + </para> + </textobject> + </mediaobject> + </figure> + <section id="sect-Component_Reference-richinputNumberSlider-Basic_usage"> <title>Basic usage</title> <para> @@ -565,24 +579,77 @@ </section> </section> - <!-- TODO not in M2 --> - <!-- + <!-- <rich:inputNumberSpinner> --> <section id="sect-Component_Reference-Rich_inputs-richinputNumberSpinner"> <title><sgmltag>&lt;rich:inputNumberSpinner&gt;</sgmltag></title> <para> The <sgmltag>&lt;rich:inputNumberSpinner&gt;</sgmltag> component is a single-line input field with buttons to increase and decrease a numerical value. The value can be changed using the corresponding directional keys on a keyboard, or by typing into the field. </para> - <para> - Basic use of the component with no attributes specified will render a number spinner with a minimum value of 1, a maximum value of 100, and a gradient step of 1. These default properties can be re-defined with the attributes <varname>minValue</varname>, <varname>maxValue</varname>, and <varname>step</varname> respectively. The starting value of the spinner is the minimum value unless otherwise specified with the <varname>value</varname> attribute. - </para> - <para> - When changing the value using the buttons, raising the value above the maximum or cause the spinner to restart at the minimum value. Likewise, when lowering below the minimum value the spinner will reset to the maximum value. This behavior can be deactivated by setting <code>cycled="false"</code>, which will cause the buttons to stop responding when the reach the maximum or minimum value. - </para> - <para> - The ability to change the value by typing into the text field can be disabled by setting <code>enableManualInput="false"</code>. - </para> + <figure id="figu-Component_Reference-richinputNumberSpinner-richinputNumberSpinner"> + <title><sgmltag>&lt;rich:inputNumberSpinner&gt;</sgmltag></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/figu-Component_Reference-richinputNumberSpinner-richinputNumberSpinner.png" format="PNG" /> + </imageobject> + <textobject> + <para> + A <sgmltag>&lt;rich:inputNumberSpinner&gt;</sgmltag> component. The spinner currently has a value of 20, and the arrow buttons are used to increment or decrement the value. + </para> + </textobject> + </mediaobject> + </figure> + + <section id="sect-Component_Reference-richinputNumberSpinner-Basic_usage"> + <title>Basic usage</title> + <para> + Basic use of the component with no attributes specified will render a number spinner with a minimum value of 1, a maximum value of 100, and a gradient step of 1. + </para> + <para> + These default properties can be re-defined with the attributes <varname>minValue</varname>, <varname>maxValue</varname>, and <varname>step</varname> respectively. The starting value of the spinner is the minimum value unless otherwise specified with the <varname>value</varname> attribute. + </para> + </section> + + <section id="sect-Component_Reference-richinputNumberSpinner-Interactivity_options"> + <title>Interactivity options</title> + <para> + When changing the value using the buttons, raising the value above the maximum or cause the spinner to restart at the minimum value. Likewise, when lowering below the minimum value the spinner will reset to the maximum value. This behavior can be deactivated by setting <code>cycled="false"</code>, which will cause the buttons to stop responding when the reach the maximum or minimum value. + </para> + <para> + The ability to change the value by typing into the text field can be disabled by setting <code>enableManualInput="false"</code>. + </para> + </section> + + <section id="sect-Component_Reference-richinputNumberSpinner-Reference_data"> + <title>Reference data</title> + <itemizedlist> + <listitem> + <para> + <parameter>component-type</parameter>: <classname>org.richfaces.inputNumberSpinner</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-class</parameter>: <classname>org.richfaces.component.html.HtmlInputNumberSpinner</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>component-family</parameter>: <classname>org.richfaces.inputNumberSpinner</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>renderer-type</parameter>: <classname>org.richfaces.renderkit.inputNumberSpinnerRenderer</classname> + </para> + </listitem> + <listitem> + <para> + <parameter>tag-class</parameter>: <classname>org.richfaces.taglib.inputNumberSpinnerTag</classname> + </para> + </listitem> + </itemizedlist> + </section> </section> - --> <!--<rich:suggestionBox>--> <!-- Added: modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richcollapsiblePanel-richcollapsiblePanel.png =================================================================== (Binary files differ) Property changes on: modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richcollapsiblePanel-richcollapsiblePanel.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richinputNumberSlider-richinputNumberSlider.png =================================================================== (Binary files differ) Property changes on: modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richinputNumberSlider-richinputNumberSlider.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richinputNumberSpinner-richinputNumberSpinner.png =================================================================== (Binary files differ) Property changes on: modules/docs/branches/M3_draft/Component_Reference/src/main/docbook/en-US/images/figu-Component_Reference-richinputNumberSpinner-richinputNumberSpinner.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream