Send your remarks, comments or wishes to doc team
Subject:
Message:
Your name:
Your email:

JBoss.org Community Documentation

- Prev
- Next

## 6.62. < rich:inputNumberSlider >

### 6.62.1. Description

The <rich:inputNumberSlider> component is a slider component. A handler's position corresponds to a definite value on the slider track. In order to change the value you can slide a handler or set the necessary value into the input field. You can dispose it horizontally or vertically on the page.

Figure 6.168. <rich:inputNumberSlider> component, horizontal and vertical views

### 6.62.2. Key Features

- Fully skinnable control and input elements

- Optional value text field with an attribute-managed position

- Optional disablement of the component on a page

- Optional toolTip to display the current value while a handle is dragged

- Dragged state is stable after the mouse moves

- Optional manual input possible if a text input field is present

- Validation of manual input

- Possibility to display 2 controls that increase/decrease the value by the defined step width, when they will be clicked.

- Attribute "orientation" that can have the values "vertical" and "horizontal" to define in which direction the slider should be movable.

Table 6.302. rich : inputNumberSlider attributes

Attribute Name | Description
--- | ---
accesskey | This attribute assigns an access key to an element. An access key is a single character from the document character set. Note: Authors should consider the input method of the expected reader when specifying an accesskey
barClass | A name of CSS class for the bar element
barStyle | Style for a slider control line
binding | The attribute takes a value-binding expression for a component property of a backing bean
clientErrorMessage | an error message to use in client side validation events
converter | Id of Converter to be used or reference to a Converter
converterMessage | A ValueExpression enabled attribute that, if present, will be used as the text of the converter message, replacing any message that comes from the converter
decreaseClass | A name of CSS class for the decrease arrow element
decreaseSelectedClass | A name of CSS class for a selected control decrease arrow element
decreaseStyle | A style for the decrease arrow element
delay | Delay in pressed increase/decrease arrows in miliseconds. Default value is "200".
disabled | When set for a form control, this boolean attribute disables the control for your input
enableManualInput | If set to "false" this attribute makes the text field "read-only", so the value can be changed only from a handle. Default value is "true".
handleClass | A name of CSS class for a control handle element
handleSelectedClass | A name of CSS class for a selected control handle element
height | The height of a slider control. Default value is "20px", for orientation="vertical" value is "20px"
id | Every component may have a unique id that is automatically created if omitted
immediate | A flag indicating that this component value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until a Process Validations phase
increaseClass | A name of CSS class for increase arrow element
increaseSelectedClass | A name of CSS class for a selected control increase arrow element
increaseStyle | A style for the increase arrow element
inputClass | Style Class attribute for a text field
inputPosition | If "right" the InputText Box would be rendered on the right side of the ruler
inputSize | Similar to the "Size" attribute of h:inputText. Default value is "3".
inputStyle | Style attribute for text field
label | A localized user presentable name for this component.
maxlength | Specifies the maximum number of digits that could be entered into the input field. The maximum number is unlimited by default. If entered value exceeds the value specified in "maxValue" attribute than the slider takes a maximum value position.
maxValue | Attribute to set an "end" value. Default value is "100"
minValue | Attribute to set the "start" value. Default value is "0".
onblur | HTML: script expression; the element lost the focus
onchange | HTML: script expression; the element value was changed
onclick | HTML: a script expression; a pointer button is clicked
ondblclick | HTML: a script expression; a pointer button is double-clicked
onerror | This error is called when a non-number value or a number value that is out of the range is input
onfocus | HTML: script expression; the element got the focus
oninputclick | HTML: a script expression; a pointer button is clicked
oninputdblclick | HTML: a script expression; a pointer button is double-clicked
oninputkeydown | HTML: a script expression; a key is pressed down
oninputkeypress | HTML: a script expression; a key is pressed and released
oninputkeyup | HTML: a script expression; a key is released
oninputmousedown | HTML: script expression; a pointer button is pressed down
oninputmousemove | HTML: a script expression; a pointer is moved within
oninputmouseout | HTML: a script expression; a pointer is moved away
oninputmouseover | HTML: a script expression; a pointer is moved onto
oninputmouseup | HTML: script expression; a pointer button is released
onmousedown | HTML: script expression; a pointer button is pressed down
onmousemove | HTML: a script expression; a pointer is moved within
onmouseout | HTML: a script expression; a pointer is moved away
onmouseover | HTML: a script expression; a pointer is moved onto
onmouseup | HTML: script expression; a pointer button is released
onselect | HTML: script expression; The onselect event occurs when you select some text in a text field. This attribute may be used with the INPUT and TEXTAREA elements
onslide | Event occur on slide
orientation | Attribute can have the values "vertical" and "horizontal" to define in which direction the slider should be moveable.
rendered | If "false", this component is not rendered
required | If "true", this component is checked for non-empty input
requiredMessage | A ValueExpression enabled attribute that, if present, will be used as the text of the validation message for the "required" facility, if the "required" facility is used
showArrows | False value for this attribute makes increase/decrease arrows invisible. Default value is "false".
showBoundaryValues | If the min/max values are shown on the right/left borders of a control. Default value is "true".
showInput | False value for this attribute makes text a field invisible. Default value is "true".
showToolTip | If "true"the current value is shown in the tooltip when a handle control is in a "dragged" state. Default value is "true".
step | Parameter that determines a step between the nearest values while using a handle. Default value is "1".
style | Styles for main div element of the slider control
styleClass | Name of a CSS class
tabindex | This attribute specifies the position of the current element in the tabbing order for the current document. This value must be a number between 0 and 32767. User agents should ignore leading zeros
tipClass | A name of CSS class for the tool tip element
tipStyle | A style for the tool tip element
validator | MethodBinding pointing at a method that is called during Process Validations phase of the request processing lifecycle, to validate the current value of this component
validatorMessage | A ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator
value | The current value of this component
valueChangeListener | Listener for value changes
width | The width of a slider control. Default value is "200px", for orientation="vertical" value is "200px"

Table 6.303. Component identification parameters

Name | Value
--- | ---
component-type | org.richfaces.inputNumberSlider
component-class | org.richfaces.component.html.HtmlInputNumberSlider
component-family | org.richfaces.inputNumberSlider
renderer-type | org.richfaces.InputNumberSliderRenderer
tag-class | org.richfaces.taglib.InputNumberSliderTag

### 6.62.3. Creating the Component with a Page Tag

To create the simplest variant on a page use the following syntax:

Example:

    ...

        <rich:inputNumberSlider minValue="0" maxValue="100" step="1"/>

    ...

### 6.62.4. Creating the Component Dynamically Using Java

Example:

    import org.richfaces.component.html.HtmlInputNumberSlider;

    ...

    HtmlInputNumberSlider mySlider = new HtmlInputNumberSlider();

    ...

### 6.62.5. Details of Usage

<rich:inputNumberSlider> is used to facilitate your data input with rich UI Controls.

Here is the simplest variant of a slider definition with "minValue" , "maxValue" and "step" (on default is "1") attributes, which define the beginning and the end of a numerical area and a slider property step.

Example:

    <rich:inputNumberSlider></rich:inputNumberSlider>

It's generated on a page:

Figure 6.169. Generated <rich:inputNumberSlider>

Using "showInput" (default is "true") and "enableManualInput" (default value is "true") attributes, it's possible to output the input area near the slider, and make it read-only or editable.

To remove input area use `showInput = "false"` :

Example:

    <rich:inputNumberSlider minValue="1"  maxValue="100" showInput="false"/>

It's displayed at a page like:

Figure 6.170. <rich:inputNumberSlider> without input field

It's also possible to switch off displaying of "boundary values" and a toolTip showing on a handle drawing. This could be performed with the help of the component defined attributes: "showBoundaryValues" which is responsible for "boundary values" displaying (default is true) and "showToolTip" which is responsible for tooltTip displaying (default is "true").

Moreover, to add e.g. some JavaScript effects, events defined on it are used.

- "onchange"

- "onmouseover"

- "onclick"

- "onfocus"

- "onmouseout"

- etc.

The "label" attribute is a generic attribute. The "label" attribute provides an association between a 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, validation, or other application actions during the request processing lifecycle. With the help of this attribute you can replace the last parameter substitution token shown in the messages. For example, {1} for `"DoubleRangeValidator.MAXIMUM"` , {2} for `"ShortConverter.SHORT"`.

The "showArrows" 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:

Figure 6.171. <rich:inputNumberSlider> with additional controls

Clicking an arrow changes the driven value on the amount defined with "step" attribute. Keepeng an arrow control pressed changes the value continuous. Time that value takes to change from one step to another is definded with "delay" attribute.

### 6.62.6. Look-and-Feel Customization

For skinnability implementation, the components use a style class redefinition method. Default style classes are mapped on skin parameters.

There are two ways to redefine the appearance of all <rich:inputNumberSlider> components at once:

- Redefine the corresponding skin parameters

- Add to your style sheets style classes used by a <rich:imputNumberSlider> component

### 6.62.7. Skin Parameters Redefinition

Table 6.304. Skin parameters redefinition for a bar

Skin parameters | CSS properties
--- | ---
controlBackgroundColor | background-color

Table 6.305. Skin parameters redefinition for numbers

Skin parameters | CSS properties
--- | ---
generalFamilyFont | font-family
generalSizeFont | font-size
generalTextColor | color
panelBorderColor | border-color
generalSizeFont | line-height

Table 6.306. Skin parameters redefinition for a text field

Skin parameters | CSS properties
--- | ---
controlBackgroundColor | background-color
generalFamilyFont | font-family
generalSizeFont | font-size
controlTextColor | color
panelBorderColor | border-color
subBorderColor | border-bottom-color
subBorderColor | border-right-color

Table 6.307. Skin parameters redefinition for a hint

Skin parameters | CSS properties
--- | ---
tipBackgroundColor | background-color
tipBorderColor | border-color
generalFamilyFont | font-family
generalSizeFont | font-size

### 6.62.8. Definition of Custom Style Classes

Style classes names that define styles for component elements are shown on the picture below:

Figure 6.172. Style classes

Table 6.308. Classes names that define a component appearance

Class name | Description
--- | ---
rich-slider | Defines styles for a wrapper table element of a component
rich-inslider-track | Defines styles for a bar
rich-inslider-handler | Defines styles for a slider handler
rich-inslider-handler-selected | Defines styles for a selected handler
rich-inslider-field | Defines styles for a text field
rich-inslider-right-num | Defines styles for the right number
rich-inslider-left-num | Defines styles for the left number
rich-inslider-track-border | Defines styles for track border
rich-inslider-tip | Defines styles for a hint
inputNumberSlider-increase-vertical | Defines styles for the top arrow
inputNumberSlider-decrease-vertical | Defines styles for the bottom arrow
inputNumberSlider-increase-horizontal | Defines styles for the right arrow
inputNumberSlider-decrease-horizontal | Defines styles for the left arrow

In order to redefine styles for all <rich:inputNumberSlider> components on a page using CSS, it's enough to create classes with the same names (possible classes could be found in the table above ) and define necessary properties in them. An example is placed below:

Example:

    ...

    .rich-inslider-tip{

        background-color: #FFDAB9;

        font-family: Arial Black;

    }

    ...

This is a result:

Figure 6.173. Redefinition styles with predefined classes

In the example a tip background color and font family was changed.

Also it's possible to change styles of particular <rich:inputNumberSlider> component. In this case you should create own style classes and use them in corresponding <rich:inputNumberSlider> styleClass attributes. An example is placed below:

Example:

    ...

    .myClass{

        font-style: italic;

        font-weight:bold;

        font-size:12px;

    }

    ...

The "inputClass" attribute for <rich:inputNumberSlider> is defined as it's shown in the example below:

Example:

    <rich: inputNumberSlider ... inputClass="myClass"/>

This is a result:

Figure 6.174. Redefinition styles with own classes and styleClass attributes

As it could be seen on the picture above, the font style for input text was changed.

### 6.62.9. Relevant Resources Links

Here you can see the example of <rich:inputNumberSlider> usage and sources for the given example.

- Prev6.61. < rich:inplaceSelect >
- Top of page
- Front page
- Next6.63. < rich:inputNumberSpinner >