Create new RichFaces Documentation Jira issue

This will launch the RichFaces Jira page - to complete your feedback please login if needed, and submit the Jira.

JBoss.orgCommunity Documentation

6.62.  < rich:inputNumberSlider >

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.


Table 6.302. rich : inputNumberSlider attributes

Attribute NameDescription
accesskeyThis 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
barClassA name of CSS class for the bar element
barStyleStyle for a slider control line
bindingThe attribute takes a value-binding expression for a component property of a backing bean
clientErrorMessagean error message to use in client side validation events
converterId of Converter to be used or reference to a Converter
converterMessageA ValueExpression enabled attribute that, if present, will be used as the text of the converter message, replacing any message that comes from the converter
decreaseClassA name of CSS class for the decrease arrow element
decreaseSelectedClassA name of CSS class for a selected control decrease arrow element
decreaseStyleA style for the decrease arrow element
delayDelay in pressed increase/decrease arrows in miliseconds. Default value is "200".
disabledWhen set for a form control, this boolean attribute disables the control for your input
enableManualInputIf 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".
handleClassA name of CSS class for a control handle element
handleSelectedClassA name of CSS class for a selected control handle element
heightThe height of a slider control. Default value is "20px", for orientation="vertical" value is "20px"
idEvery component may have a unique id that is automatically created if omitted
immediateA 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
increaseClassA name of CSS class for increase arrow element
increaseSelectedClassA name of CSS class for a selected control increase arrow element
increaseStyleA style for the increase arrow element
inputClassStyle Class attribute for a text field
inputPositionIf "right", the InputText Box would be rendered on the right side of the ruler. If "top", the InputText Box would be rendered on the top of the ruler. If "bottom", the InputText Box would be rendered on the bottom of the ruler.
inputSizeSimilar to the "Size" attribute of h:inputText. Default value is "3".
inputStyleStyle attribute for text field
labelA localized user presentable name for this component.
maxlengthSpecifies 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.
maxValueAttribute to set an "end" value. Default value is "100"
minValueAttribute to set the "start" value. Default value is "0".
onblurHTML: script expression; the element lost the focus
onchangeHTML: script expression; the element value was changed
onclickHTML: a script expression; a pointer button is clicked
ondblclickHTML: a script expression; a pointer button is double-clicked
onerrorHTML: script expression; a non-number value or a number value that is out of the range is input
onfocusHTML: script expression; the element got the focus
oninputclickHTML: a script expression; a pointer button is clicked
oninputdblclickHTML: a script expression; a pointer button is double-clicked
oninputkeydownHTML: a script expression; a key is pressed down
oninputkeypressHTML: a script expression; a key is pressed and released
oninputkeyupHTML: a script expression; a key is released
oninputmousedownHTML: script expression; a pointer button is pressed down
oninputmousemoveHTML: a script expression; a pointer is moved within
oninputmouseoutHTML: a script expression; a pointer is moved away
oninputmouseoverHTML: a script expression; a pointer is moved onto
oninputmouseupHTML: script expression; a pointer button is released
onmousedownHTML: script expression; a pointer button is pressed down
onmousemoveHTML: a script expression; a pointer is moved within
onmouseoutHTML: a script expression; a pointer is moved away
onmouseoverHTML: a script expression; a pointer is moved onto
onmouseupHTML: script expression; a pointer button is released
onselectHTML: 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
onslideEvent occur on slide
orientationAttribute can have the values "vertical" and "horizontal" to define in which direction the slider should be moveable.
renderedIf "false", this component is not rendered
requiredIf "true", this component is checked for non-empty input
requiredMessageA 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
showArrowsFalse value for this attribute makes increase/decrease arrows invisible. Default value is "false".
showBoundaryValuesIf the min/max values are shown on the right/left borders of a control. Default value is "true".
showInputFalse value for this attribute makes text a field invisible. Default value is "true".
showToolTipIf "true"the current value is shown in the tooltip when a handle control is in a "dragged" state. Default value is "true".
stepParameter that determines a step between the nearest values while using a handle. Default value is "1".
styleStyles for main div element of the slider control
styleClassName of a CSS class
tabindexThis 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
tipClassA name of CSS class for the tool tip element
tipStyleA style for the tool tip element
validatorMethodBinding pointing at a method that is called during Process Validations phase of the request processing lifecycle, to validate the current value of this component
validatorMessageA ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator
valueThe current value of this component
valueChangeListenerListener for value changes
widthThe width of a slider control. Default value is "200px", for orientation="vertical" value is "200px"

Table 6.303. Component identification parameters

NameValue
component-typeorg.richfaces.inputNumberSlider
component-class org.richfaces.component.html.HtmlInputNumberSlider
component-familyorg.richfaces.inputNumberSlider
renderer-type org.richfaces.InputNumberSliderRenderer
tag-class org.richfaces.taglib.InputNumberSliderTag

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

Example:


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

Example:

import org.richfaces.component.html.HtmlInputNumberSlider;

...
HtmlInputNumberSlider mySlider = new HtmlInputNumberSlider();
...

<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:


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:


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:


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.

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:





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



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:


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:


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

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