Summary
Tag name:
<tr:inputNumberSpinbox>
UIComponent class:
org.apache.myfaces.trinidad.component.core.input.CoreInputNumberSpinbox
Component type:
org.apache.myfaces.trinidad.CoreInputNumberSpinbox
The inputNumberSpinbox component creates a browser input widget and up/down arrows. It is used to enter numbers and quickly step through the numbers using the up/down arrows. The number needs to be within the minimum and maximum. It also supports displaying a label, text, and messages.
Example(s):
Simple inputNumberSpinbox with the some default text and a label.
<tr:form> <tr:inputNumberSpinbox label="Year:" value="2006" minimum="1900" maximum="2100"/> </tr:form>
Events
| Type | Phases | Description |
|---|---|---|
| javax.faces.event.ValueChangeEvent | Process Validations, Apply Request Values |
The valueChange event is delivered when the value attribute is changed. |
| org.apache.myfaces.trinidad.event.AttributeChangeEvent | Invoke Application, Apply Request Values |
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing. |
Attributes
| Name | Type | Supports EL? | Description |
|---|---|---|---|
| accessKey | char | Yes |
Character used to gain quick access to
the form element specified by the
for, if set (or this component itself,
if it is a "non-simple" form element).
For accessibility reasons, this functionality is not supported
in screen reader mode.
If the same access key appears in multiple locations in the
same page of output, the rendering user agent will cycle
among the elements accessed by the similar keys.
This attribute is sometimes referred to as the "mnemonic". |
| attributeChangeListener | javax.el.MethodExpression | Only EL | a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing. |
| autoComplete | String | Yes | Valid Values:
on, off whether previous values of text fields in the form should be remembered and offered for auto completion. |
| autoSubmit | boolean | Yes | If set to TRUE on a form element, the component will automatically submit the enclosing form when an appropriate action takes place (a click, text change, etc.). |
| binding | org.apache.myfaces.trinidad.component. |
Only EL | an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean. |
| columns | int | Yes | the number of columns to display in the text control. If no value is specified, a default of 1 columns is used. One column is approximately one character in the browser's current display font. |
| contentStyle | String | Yes | the CSS styles to attach to the content of the component. For example, you can set the width of that portion to 100 pixels by setting this attribute to "width: 100px". |
| converter | javax.faces.convert.Converter | Yes | a converter object |
| disabled | boolean | Yes | whether the element is disabled. |
| id | String | No | the identifier for the component. The identifier
must follow a subset of the syntax allowed in HTML:
|
| immediate | boolean | Yes | whether the value is converted and validated immediately in the Apply Request Values phase, or is handled in the Process Validators phase, the default. By default, values are converted and validated together in the Process Validators phase. However, if you need access to the value of a component during Apply Request Values - for example, if you need to get the value from an actionListener on an immediate commandButton - then setting this to "immediate" makes that possible. |
| inlineStyle | String | Yes | the inline CSS style for this element |
| label | String | Yes | the label of the bean. |
| labelAndAccessKey | String | Yes |
An attribute that will simultaneously set both the "value"
and "accessKey" attributes from a single value, using
conventional ampersand ('&') notation.
For example, setting this attribute to "L&abel" will set the label to "Label" and the access key to 'a'. |
| maximum | int | Yes | The maximum number allowed in the input field. |
| minimum | int | Yes | The minimum number allowed in the input field. |
| onblur | String | Yes |
the event handler for the component losing the focus. Not supported on the following agents: pda |
| onchange | String | Yes | event handler for when the value is changed. |
| onclick | String | Yes | an onclick Javascript handler. |
| ondblclick | String | Yes | an ondblclick Javascript handler. |
| onfocus | String | Yes |
the event handler for the component gaining the focus. Not supported on the following agents: pda |
| onkeydown | String | Yes | an onkeydown Javascript handler. |
| onkeypress | String | Yes | an onkeypress Javascript handler. |
| onkeyup | String | Yes | an onkeyup Javascript handler. |
| onmousedown | String | Yes | an onmousedown Javascript handler. |
| onmousemove | String | Yes | an onmousemove Javascript handler. |
| onmouseout | String | Yes | an onmouseout Javascript handler. |
| onmouseover | String | Yes | an onmouseover Javascript handler. |
| onmouseup | String | Yes | an onmouseup Javascript handler. |
| onselect | String | Yes | event handler for when text becomes selected. |
| partialTriggers | String[] | Yes | the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. |
| readOnly | boolean | Yes | whether the element is read-only. |
| rendered | boolean | Yes | whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client). |
| required | boolean | Yes | whether a non-null, non-empty value must be entered. If false, validators will not be executed when the value is null or empty. |
| requiredMessageDetail | String | Yes | the message to be displayed, if 'required' validation fails.
Parameters:
|
| shortDesc | String | Yes | the short description of the bean. This text is commonly used by user agents to display tooltip help text. |
| showRequired | boolean | Yes | whether the associated control displays a visual indication of required user input. If a "required" attribute is also present, both the "required" attribute and the "showRequired" attribute must be false for the visual indication not to be displayed. |
| simple | boolean | Yes | a boolean value that controls whether the component provides label and message support; when set to "true", the component will not display messaging support or the label (these attributes may be ignored: label, labelAndAccessKey, accessKey, showRequired, tip), and may use simpler layout primitives |
| stepSize | int | Yes | The step size by which the spinbox will increase or decrease the number in the input. |
| styleClass | String | Yes | Valid Values:
AFFieldTextMarker, AFFieldTextLTRMarker, AFFieldNumberMarker a CSS style class to use for this component. The styleClass attribute value is rendered on the root dom element. We provide some public style classes you can use that will affect only the 'content' piece of the component: AFFieldTextMarker, AFFieldTextLTRMarker, AFFieldNumberMarker. |
| validator | javax.faces.el.MethodBinding | Only EL | a method reference to a validator method |
| value | Object | Yes | the value of the component. If the EL binding for the "value" points to a bean property with a getter but no setter, and this is an editable component, the component will be rendered in read-only mode. |
| valueChangeListener | javax.faces.el.MethodBinding | Only EL | a method reference to a value change listener |