Summary
Tag name: <hx:inputNumberSpinner>
UIComponent class: org.apache.myfaces.html5.component.input.HtmlInputNumberSpinner
Tag class: org.apache.myfaces.html5.tag.input.HtmlInputNumberSpinnerTag
Component type: org.apache.myfaces.html5.HtmlNumberSpinner
Component family: javax.faces.Input
Renderer type: org.apache.myfaces.html5.NumberSpinner
Renderer class: org.apache.myfaces.html5.renderkit.input.HtmlInputNumberSpinnerRenderer
Convenience component for Html5 number input.
Just like hx:inputNumberSlider, minimum and maximum values for the component is rendered based on
f:validateDoubleRange or f:validateLongRange if attached. If they are not attached, a default value of 0 is used for
minimum and 100 is used for maximum.
Supported Listeners
| Name | Listener | Event | Phases | Required | Description |
|---|---|---|---|---|---|
| valueChangeListeners | javax.faces.event.ValueChangeListener | javax.faces.event.ValueChangeEvent | false | The valueChange event is delivered when the value attribute is changed. |
Attributes
| Name | Type | Supports EL? | Description |
|---|---|---|---|
| accesskey | String | Yes | HTML: Sets the access key for this element. |
| alt | String | Yes | HTML: Specifies alternative text that can be used by a browser that can't show this element. |
| animationEnd | String | Yes | HTML : Script to run when the animation ends on Html element. |
| autoFocus | boolean | Yes | If this property is set to true, it will allow the user to just start typing without having to manually focus the main control when the page is loaded. Default to false. |
| autocomplete | String | Yes | If the value of this attribute is "off", render "off" as the value of the attribute. This indicates that the browser should disable its autocomplete feature for this component. This is useful for components that perform autocompletion and do not want the browser interfering. If this attribute is not set or the value is "on", render nothing. |
| binding | org.apache.myfaces.html5.component.input.HtmlInputNumberSpinner | Only EL | Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression. |
| converter | javax.faces.convert.Converter | Yes | An expression that specifies the Converter for this component.
The value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface. |
| converterMessage | String | Yes | Text to be displayed to the user as an error message when conversion of a submitted value to the target type
fails.
|
| dataList | String | Yes | Id of <hx:datalist> or HTML <datalist> for suggestions mechanism. By this way, suggestion options(datalist) can be shared across several input elements. If this attribute is set, other suggestion mechanisms(with f:selectItem(s) children or 'suggestions' attribute) should not be used |
| dir | String | Yes | HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left). |
| disabled | boolean | Yes | HTML: When true, this element cannot receive focus. |
| draggable | boolean | Yes | HTML: Specifies whether the element is draggable. |
| hidden | boolean | Yes | HTML: Whether the element is relevant. |
| id | String | Yes | Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view. |
| immediate | boolean | Yes | A boolean value that identifies the phase during which action events should fire.
During normal event processing, action methods and action listener methods are fired during the "invoke application" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase. |
| label | String | Yes | A display name for this component. |
| lang | String | Yes | HTML: The base language of this document. |
| onblur | String | Yes | HTML: Specifies a script to be invoked when the element loses focus. |
| onchange | String | Yes | HTML: Specifies a script to be invoked when the element is modified. |
| onclick | String | Yes | HTML: Script to be invoked when the element is clicked. |
| ondblclick | String | Yes | HTML: Script to be invoked when the element is double-clicked. |
| ondrag | String | Yes | HTML: Handler for event that is fired when the element is dragged. |
| ondragend | String | Yes | HTML: Handler for event that is fired when the drag operation is ended. Successfully or not, this handler will run. |
| ondragenter | String | Yes | HTML: Handler for event that is fired when the element is dragged into a valid drop target. |
| ondragleave | String | Yes | HTML: Handler for event that is fired when the element leaves a valid drop target. |
| ondragover | String | Yes | HTML: Handler for event that is fired when the element is being dragged over a valid drop target. |
| ondragstart | String | Yes | HTML: Handler for event that is fired when the drag operation starts. |
| ondrop | String | Yes | HTML: Handler for event that is fired when the element is being dropped. |
| onfocus | String | Yes | HTML: Specifies a script to be invoked when the element receives focus. |
| onformchange | String | Yes | HTML: Script to be invoked when the state of the owner form is changed. |
| onforminput | String | Yes | HTML: Script to be invoked when the owner form gets user input. |
| oninput | String | Yes | HTML: Script to be invoked when the element gets user input. |
| oninvalid | String | Yes | HTML: Script to be invoked when the owner form is validated and this element could not pass the validation. |
| onkeydown | String | Yes | HTML: Script to be invoked when a key is pressed down over this element. |
| onkeypress | String | Yes | HTML: Script to be invoked when a key is pressed over this element. |
| onkeyup | String | Yes | HTML: Script to be invoked when a key is released over this element. |
| onmousedown | String | Yes | HTML: Script to be invoked when the pointing device is pressed over this element. |
| onmousemove | String | Yes | HTML: Script to be invoked when the pointing device is moved while it is in this element. |
| onmouseout | String | Yes | HTML: Script to be invoked when the pointing device is moves out of this element. |
| onmouseover | String | Yes | HTML: Script to be invoked when the pointing device is moved into this element. |
| onmouseup | String | Yes | HTML: Script to be invoked when the pointing device is released over this element. |
| onmousewheel | String | Yes | HTML: Script to be invoked when the pointing device is wheeled over this element. |
| onselect | String | Yes | HTML: Specifies a script to be invoked when the element is selected. |
| rendered | boolean | Yes | A boolean value that indicates whether this component should be rendered. Default value: true. |
| required | boolean | Yes | A boolean value that indicates whether an input value is required.
If this value is true and no input value is provided by a postback operation, then the "requiredMessage" text is registered as a FacesMessage for the request, and validation fails. Default value: false. |
| requiredMessage | String | Yes | Text to be displayed to the user as an error message when this component is marked as "required" but no input data is present during a postback (ie the user left the required field blank). |
| segmentCount | int | Yes | Used to calculate step with minimum and maximum. Formula is: step ~= (max-min)/segmentCount.
Defaults to 100, if step is not defined too. It is and error to define both 'step' and 'segmentCount'. |
| step | double | Yes | Gap between each segment. If both 'step' and 'segmentCount' is not defined, 'step' is default to (max-min)/(100). |
| style | String | Yes | HTML: CSS styling instructions. |
| styleClass | String | Yes | The CSS class for this element. Corresponds to the HTML 'class' attribute. |
| suggestions | Object | Yes | Static(not Ajax) suggestion values. This attribute should not be defined if "list" is set. |
| tabindex | String | Yes | HTML: Specifies the position of this element within the tab order of the document. |
| title | String | Yes | HTML: An advisory title for this element. Often used by the user agent as a tooltip. |
| validator | javax.faces.el.MethodBinding | Only EL | A method-binding EL expression which is invoked during the validation phase for this component.
The invoked method is expected to check the submitted value for this component, and if not acceptable then report a validation error for the component. The method is expected to have the prototype public void aMethod(FacesContext, UIComponent,Object) |
| validatorMessage | String | Yes | Text which will be shown if validation fails. |
| value | Object | Yes | Gets The initial value of this component. |
| valueChangeListener | javax.faces.el.MethodBinding | Only EL | A method which is invoked during postback processing for the current view if the submitted value for this
component is not equal to the value which the "value" expression for this component returns.
The phase in which this method is invoked can be controlled via the immediate attribute. |