jsdoc

$.ui.simplicitySelectSlider

Namespace $.ui.simplicitySelectSlider

Single handled slider bound to a select input.

Creates a progressive enhanced jQuery UI slider that is backed by a select input.

The widget options are passed through to the created slider. For more information see the jQuery UI slider documentation.
Defined in: ui.simplicitySelectSlider.js.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
<static>  
$.ui.simplicitySelectSlider.options
Widget options.
Method Summary
Method Attributes Method Name and Description
<private> <static>  
$.ui.simplicitySelectSlider._selectChangeHandler()
Event handler for the change event on the select input.
<private> <static>  
$.ui.simplicitySelectSlider._setOption()
Override of _setOption that is used to refresh the slider tick marks, labels and tooltip when the assocaited options are changed.
<private> <static>  
$.ui.simplicitySelectSlider._sliderChangeHandler()
Event handler for the slidechange and slide events.
<private> <static>  
$.ui.simplicitySelectSlider.refreshScale()
Recreates the scale on the slider.
<private> <static>  
$.ui.simplicitySelectSlider.refreshTooltip()
Updates the content of the tooltip(s) and hides or shows it as appropriate.
Namespace Detail
$.ui.simplicitySelectSlider
  <select id="weight" name="w">
    <option value="l">Light</option>
    <option value="m">Medium</option>
    <option value="h">Heavy</option>
  <select>
  <div id="weightSlider"></div>
  <script type="text/javascript">
    $('#weightSlider').simplicitySelectSlider({
      select: '#weight'
    });
  </script>
Field Detail
<static> $.ui.simplicitySelectSlider.options
Widget options.
select
A single select input to associate the slider handle with.
secondSelect
Enables dual-handle mode and specifies a single select input to associate the second slider handle with. Defaults to '' which leaves the widget in single handle mode.
allowHandleOverlap
Only affects dual-handled sliders and controls whether the two handles can have the same position. Defaults to false.
populateSecondSelect
Only affects dual-handled sliders and controls how the widget deals with missing options in the second select input. When true it will automatically populate them with the label from the primary select. Defaults to false.
changeOnSlide
Set this to true to cause slide events to change the bound select input. Defaults to false.
showTicks
Set this to true to cause the display of tick marks on the slider. Defaults to true.
showLabels
Set this to true to cause the display of labels under the tick marks of the slider. All labels are displayed, if you have too many labels then you will want to disable this option. Defaults to true.
centerLabels
When labels are displayed this option causes their css to be adjusted to cause them to be centered around their tick mark. You would disable this if you had fixed width labels and wanted to fully control their position from css. Defaults to true.
justifyEndLabels
When labels are displayed this option causes the first label to be left justified and the right label to be right justified with the ends of the slider. You would disable this if you had fixed width labels and wanted to fully control their position from css. Defaults to true.
showTooltip
Set this to true to cause a tooltip to appear above the slider handle. Defaults to false.
centerTooltip
When tooltip display is enabled this option causes the tooltip to be centered on the slider handle. You would disable this if you had a fixed width tooltip and wanted to fully control it's position from css. Defaults to true.
Method Detail
<private> <static> $.ui.simplicitySelectSlider._selectChangeHandler()
Event handler for the change event on the select input. Updates the slider with the new value.

<private> <static> $.ui.simplicitySelectSlider._setOption()
Override of _setOption that is used to refresh the slider tick marks, labels and tooltip when the assocaited options are changed.

<private> <static> $.ui.simplicitySelectSlider._sliderChangeHandler()
Event handler for the slidechange and slide events. Updates the associated select input with the new slider value.

This handler calls change() on the select input immediately after changing it's value.


<private> <static> $.ui.simplicitySelectSlider.refreshScale()
Recreates the scale on the slider. This contains the tick marks and labels. Tick marks and labels are created only if shown. Toggling the showTicks or showLabels options will cause this method to be called and the ticks or labels to be created.

<private> <static> $.ui.simplicitySelectSlider.refreshTooltip()
Updates the content of the tooltip(s) and hides or shows it as appropriate.

Documentation generated by JsDoc Toolkit 2.4.0