The Slider Entry is a component that enables the user to adjust values in a finite range along a horizontal or vertical axis via dragging the slider control along the slider bar, or pressing the arrow-keys. It can be used as a visual replacement for an input box that takes a number as input.
Attributes |
Name | Required | Request-time | Type | Description |
animate | no | false | boolean | Defines whether or not the slider control will use an animated transition to move to a new location when the user clicks outside handle on the slider rail. Default = 'true'. |
axis | no | false | java.lang.String | The orientation that the slider is rendered in, either vertical ('y'), or horizontal ('x'). Default = 'x'. |
binding | no | false | javax.el.ValueExpression | Using an EL expression, bind the component reference to a bean property, so that the component may be accessed in the bean. |
clickableRail | no | false | boolean | Defines whether or not a mouse-click at a location along the slider rail should reposition the slider control to that location (and adjust the value accordingly). Default = 'true'. |
disabled | no | false | boolean | Defines whether or not the component is disabled. When disabled='true', this component is unable to receive focus and cannot be interacted with by the user. Default = 'false'. |
id | no | false | java.lang.String | The component identifier for this component. This value must be unique within the closest parent component that is a naming container. |
immediate | no | false | boolean | Defines whether or not conversion and validation of this component's value should occur during Apply Request Values phase instead of Process Validations phase. Default = 'false'. |
length | no | false | java.lang.String | The length of slider bar.Note: If the range of the slider (max-min) is greater than the length, then the slider can not accurately represent every value in the range. If the discrepancy is too great, then arrow key stepping may not precisely reflect the stepPercent property. Default = '150px'. |
max | no | false | int | The maximum int value that can be selected in the value-entry range represented by the slider bar. Default = '100'. |
min | no | false | int | The minimum int value that can be selected in the value-entry range represented by the slider bar. Default = '0'. |
onSlide | no | false | java.lang.String | This event is fired each time the the slider control is moved during a drag operation. |
onSlideEnd | no | false | java.lang.String | This event is fired when a drag operation is completed by releasing the slider control. |
onSlideStart | no | false | java.lang.String | This event is fired when a drag operation on the slider control is initiated. |
rendered | no | false | boolean | Return true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. Default = 'true'. |
showLabels | no | false | boolean | Defines whether or not labels for the min and max values should be rendered at the ends of the rail. Default = 'false'. |
stepPercent | no | false | float | The amount to move the slider position in response to keyboard arrow-key input. This float value represents a percentage of the value-entry range defined by the min and max attributes. For example, with min='0', max='50', and stepPercent='10', each arrow keypress will increment/decrement the slider value by 5 (10% of 50). Default = '1f'. |
style | no | false | java.lang.String | Custom inline CSS styles to use for this component. These styles are generally applied to the root DOM element of the component. This is intended for per-component basic style customizations. Note that due to browser CSS precedence rules, CSS rendered on a DOM element will take precedence over the external stylesheets used to provide the ThemeRoller theme on this component. If the CSS properties applied with this attribute do not affect the DOM element you want to style, you may need to create a custom theme styleClass for the theme CSS class that targets the particular DOM elements you wish to customize. |
styleClass | no | false | java.lang.String | Custom CSS style class(es) to use for this component. These style classes can be defined in your page or in a theme CSS file. |
tabindex | no | false | java.lang.Integer | The browser tabindex (int) of the component. |
value | no | false | int | The value of the slider control. Default = '0'. |
valueChangeListener | no | false | javax.el.MethodExpression | MethodExpression representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void, or to a public method that takes no arguments with a return type of void. In the latter case, the method has no way of easily knowing what the new value is, but this can be useful in cases where a notification is needed that "this value changed". |
widgetVar | no | false | java.lang.String | The JavaScript object name that implements the client-side JavaScript API for this component. |