Class Index | File Index

Classes


Class adf.Slider


Extends adf.PageElement.

Defined in: Slider.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
adf.Slider(id, container, callbackFunc, left, top)
A Slider allows users to visually change a value in a range from 0-n Creates a new slider object with an unique id placed inside the argument container given.
Field Summary
Field Attributes Field Name and Description
 
Whether to allow values out of range
 
Whether to call callback function whule user drags sldier and changes the value
 
Id of div within which this slider is rendered.
 
Initial value of the slider
 
Provides information whether the slider is horizontal or vertical
 
Number of Segments displayed in the slider
 
Should round values or allow double precision values
 
Show ticks in slider to show round values
Fields borrowed from class adf.PageElement:
bounds, divObject, id
Method Summary
Method Attributes Method Name and Description
 
init(containing)
Initalizes slider withing the argument conatiner node
 
setValue(value, doUpdate)
Set the value for this slider, when doUpdate is set to true and the new value is different than the previous value, the configured callback function is executed with the new value as its only parameter
Methods borrowed from class adf.PageElement:
hide, resize, show
Class Detail
adf.Slider(id, container, callbackFunc, left, top)
A Slider allows users to visually change a value in a range from 0-n Creates a new slider object with an unique id placed inside the argument container given. callbackFunc is called when slider updates. Optionally the offset from the top-left of container may also be set
Parameters:
{String} id
this is the slider's id
{Element} container
Element on which this slider instance is placed
{Function} callbackFunc
The calling method registers a callback to get the updated slider's values from this instance
{Number} left
The left offset from the container
{Number} top
The top offset from the container
Field Detail
{Boolean} allowValuesOutOfRange
Whether to allow values out of range
Default Value:
false

{Boolean} callContinuously
Whether to call callback function whule user drags sldier and changes the value
Default Value:
true

{String} divId
Id of div within which this slider is rendered.
Default Value:
"adf.Slider." + id

{Number} initValue
Initial value of the slider
Default Value:
0

{Boolean} isHorizontal
Provides information whether the slider is horizontal or vertical
Default Value:
true

{Number} numSegments
Number of Segments displayed in the slider
Default Value:
10

{Boolean} roundValues
Should round values or allow double precision values
Default Value:
true

{Boolean} showTicks
Show ticks in slider to show round values
Default Value:
true
Method Detail
init(containing)
Initalizes slider withing the argument conatiner node
Parameters:
{Element} containing
Element on which the slider is placed to

setValue(value, doUpdate)
Set the value for this slider, when doUpdate is set to true and the new value is different than the previous value, the configured callback function is executed with the new value as its only parameter
Parameters:
{Number} value
The new value to set the slider position to
{Boolean} doUpdate
When true, the configured callback is called after the slider has been updated

Documentation generated by JsDoc Toolkit 2.1.0 on Mon May 17 2010 13:45:43 GMT-0700 (PDT)