Keywords: rich:inputNumberSpinner

JBoss.org Community Documentation

- Prev
- Next

## 6.56. < rich:inputNumberSpinner >

### 6.56.1. Description

A single line input field that lets selecting a number using controls near a text field. It's possible to change a value using "Up/Down" keyboard keys. The keyboard input in a field is possible if it isn't locked by the "manualInput" attribute. When arrow controls are pressed, the cursor can be moved in any way without losing a dragged state.

Figure 6.153. <rich:InputNumberSpinner> component

### 6.56.2. Key Features

- Fully skinnable control and input elements

- 3D look and feel with an easily customizable appearance

- Attribute-managed positions of the controls (inside/outside of the input field)

- Keyboard controls support

- Optional disablement of the component on a page

- Optional "cycled" mode of scrolling values

- Optional manual/controls-only input into a value text field

- Validation of manual input

Table 6.250. rich : inputNumberSpinner 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
binding | The attribute takes a value-binding expression for a component property of a backing bean
clientErrorMessage | client error message
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
cycled | If "true" after the current value reaches the border value it is reversed to another border value after next increasing/decreasing. In other case possibilities of next increasing (or decreasing) will be locked. Default value is " true ".
disabled | When set for a form control, this boolean attribute disables the control for your input
enableManualInput | if "false" your's input to the text field using keyboard will be locked. Default value is "true"
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
inputClass | Class attribute for text field
inputSize | Attribute specifies the initial length of input in characters. Default value is "10".
inputStyle | Style attribute for text field
label | A localized user presentable name for this component.
maxValue | Maximum value. . Default value is "100".
minValue | Minimum 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
ondownclick | HTML: a script expression; a button "Down" is clicked
onerror | HTML: a script expression; event fires whenever an JavaScript error occurs
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
onupclick | HTML: a script expression; a button "Up" is clicked
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
step | Parameter that determines the step between nearest values while using controls. Default value is "1"
style | CSS style(s) is/are to be applied when this component is rendered
styleClass | Corresponds to the HTML class attribute
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
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

Table 6.251. Component identification parameters

Name | Value
--- | ---
component-type | org.richfaces.inputNumberSpinner
component-class | org.richfaces.component.html.HtmlInputNumberSpinner
component-family | org.richfaces.inputNumberSpinner
renderer-type | org.richfaces.InputNumberSpinnerRenderer
tag-class | org.richfaces.taglib.InputNumberSpinnerTag

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

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

Example:

    ...

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

    ...

### 6.56.4. Creating the Component Dynamically Using Java

Example:

    import org.richfaces.component.html.HtmlInputNumberSpinner;

    ...

    HtmlInputNumberSpinner mySpinner = new HtmlInputNumberSpinner ();

    ...

### 6.56.5. Details of Usage

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

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

Example:

    ...

        <rich:inputNumberSpinner minValue="1" maxValue="100"/>

    ...

It generates on a page:

Figure 6.154. Generated <rich:InputNumberSpinner>

There are also several attributes to define functionality peculiarities:

- "cycled" if the attribute is "true" after the current value reaches the border value it's be reversed to another border value after next increasing/decreasing. In other case possibilities of next increasing/decreasing are locked

- "disabled" is an attribute that defines whether a component is active on a page

- "manualInput" is an attribute that defines whether a keyboard input is possible or only UI controls could be used

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 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”.

### 6.56.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:inputNumberSpinner> components at once:

- Redefine the corresponding skin parameters

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

### 6.56.7. Skin Parameters Redefinition

Table 6.252. Skin parameters redefinition for a container

Skin parameters | CSS properties
--- | ---
controlBackgroundColor | background-color
panelBorderColor | border-color
subBorderColor | border-bottom-color
subBorderColor | border-right-color

Table 6.253. Skin parameters redefinition for an input field

Skin parameters | CSS properties
--- | ---
buttonSizeFont | font-size
buttonFamilyFont | font-family

### 6.56.8. Definition of Custom Style Classes

On the screenshot there are classes names that define styles for component elements.

Figure 6.155. Style classes

Table 6.254. Classes names that define a component appearance

Class name | Description
--- | ---
rich-spinner-c | Defines styles for a wrapper table element of a component
rich-spinner-input-container | Defines styles for a container
rich-spinner-input | Defines styles for an input field
rich-spinner-button | Defines styles for a button
rich-spinner-buttons | Defines styles for buttons

In order to redefine styles for all <rich:inputNumberSpinner> 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-spinner-input{

        font-style:italic;

    }

    ...

This is a result:

Figure 6.156. Redefinition styles with predefined classes

In the example an input text font style was changed.

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

Example:

    ...

    .myClass{

        font-family: Arial Black;

    }

    ...

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

Example:

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

This is a result:

Figure 6.157. Redefinition styles with own classes and styleClass attributes

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

### 6.56.9. Relevant Resources Links

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

- Prev6.55. < rich:inputNumberSlider >
- Top of page
- Front page
- Next6.57. < rich:insert >