Classes

Files

Class YAHOO.widget.SliderThumb

Object
   |
   +--YAHOO.util.DD
         |
         +--YAHOO.widget.SliderThumb
class YAHOO.widget.SliderThumb
extends YAHOO.util.DD
Quick Links:  Field Summary | Constructor Summary | Method Summary | Method Details

Field Summary [top]

boolean maintainOffset
Informs the drag and drop util that the offsets should remain when resetting the constraints. 
string parentElId
The id of the thumbs parent HTML element (the slider background element). 
Object scroll
 
int[] startOffset
The (X and Y) difference between the thumb location and its parent (the slider background) when the control is instantiated. 
int tickSize
The tick size for this slider 

Constructor Summary [top]

YAHOO.widget.SliderThumb
A drag and drop implementation to be used as the thumb of a slider. 

Method Summary [top]

int[] getOffsetFromParent ()
Returns the difference between the location of the thumb and its parent. 
int getValue ()
Gets the current offset from the element's start position in pixels. 
int getXValue ()
Gets the current X offset from the element's start position in pixels. 
int getYValue ()
Gets the current Y offset from the element's start position in pixels. 
void initSlider (<int> iLeft, <int> iRight, <int> iUp, <int> iDown, <int> iTickSize)
Set up the slider, must be called in the constructor of all subclasses 

Field Detail [top]

maintainOffset

boolean   maintainOffset
Informs the drag and drop util that the offsets should remain when resetting the constraints. This preserves the slider value when the constraints are reset

parentElId

string   parentElId
The id of the thumbs parent HTML element (the slider background element).

scroll

Object   scroll

startOffset

int[]   startOffset
The (X and Y) difference between the thumb location and its parent (the slider background) when the control is instantiated.

tickSize

int   tickSize
The tick size for this slider

Constructor Detail [top]

YAHOO.widget.SliderThumb

YAHOO.widget.SliderThumb ()
A drag and drop implementation to be used as the thumb of a slider.
Parameters:
id - the id of the slider html element
sGroup - the group of related DragDrop items
iLeft - the number of pixels the element can move left
iRight - the number of pixels the element can move right
iUp - the number of pixels the element can move up
iDown - the number of pixels the element can move down
iTickSize - optional parameter for specifying that the element should move a certain number pixels at a time.

Method Detail [top]

getOffsetFromParent

int[] getOffsetFromParent ()
Returns the difference between the location of the thumb and its parent.

getValue

int getValue ()
Gets the current offset from the element's start position in pixels.
Returns:
the number of pixels (positive or negative) the slider has moved from the start position.

getXValue

int getXValue ()
Gets the current X offset from the element's start position in pixels.
Returns:
the number of pixels (positive or negative) the slider has moved horizontally from the start position.

getYValue

int getYValue ()
Gets the current Y offset from the element's start position in pixels.
Returns:
the number of pixels (positive or negative) the slider has moved vertically from the start position.

initSlider

void initSlider (<int> iLeft, <int> iRight, <int> iUp, <int> iDown, <int> iTickSize)
Set up the slider, must be called in the constructor of all subclasses
Parameters:
iLeft - the number of pixels the element can move left
iRight - the number of pixels the element can move right
iUp - the number of pixels the element can move up
iDown - the number of pixels the element can move down
iTickSize - the width of the tick interval.