com.smartgwt.client.widgets
Class Slider

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.smartgwt.client.widgets.BaseWidget
              extended by com.smartgwt.client.widgets.Canvas
                  extended by com.smartgwt.client.widgets.Slider
All Implemented Interfaces:
HasHandlers, com.google.gwt.user.client.EventListener, HasClickHandlers, HasDoubleClickHandlers, HasDragMoveHandlers, HasDragRepositionMoveHandlers, HasDragRepositionStartHandlers, HasDragRepositionStopHandlers, HasDragResizeMoveHandlers, HasDragResizeStartHandlers, HasDragResizeStopHandlers, HasDragStartHandlers, HasDragStopHandlers, HasDropHandlers, HasDropMoveHandlers, HasDropOutHandlers, HasDropOverHandlers, HasFocusChangedHandlers, HasHoverHandlers, HasHoverHiddenHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasMouseDownHandlers, HasMouseMoveHandlers, HasMouseOutHandlers, HasMouseOverHandlers, HasMouseStillDownHandlers, HasMouseUpHandlers, HasMouseWheelHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasValueChangedHandlers

public class Slider
extends Canvas
implements HasValueChangedHandlers

The Slider class implements a GUI slider widget allowing the user to select a numeric value from within a range by dragging a visual indicicator up and down a track.

The slider will generate events as the user interacts with it and changes its value. If slider.sliderTarget is specified, moving the slider thumb generates a custom event named 'sliderMove', sent to the sliderTarget. If a sliderMove handler stringMethod is defined on the target, it will be fired when the slider is moved. The second parameter (available via the variable name eventInfo if the handler is a string) is a pointer back to the slider.

The slider will also fire a valueChanged() method whenever its value is changed. This can be observed or overridden on the Slider instance to perform some action.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled
 
Field Summary
 
Fields inherited from class com.smartgwt.client.widgets.BaseWidget
config, configOnly, id, isElementSet
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
Slider()
           
Slider(com.google.gwt.core.client.JavaScriptObject jsObj)
           
Slider(java.lang.String title)
           
 
Method Summary
 HandlerRegistration addValueChangedHandler(ValueChangedHandler handler)
          Add a valueChanged handler.
protected  com.google.gwt.core.client.JavaScriptObject create()
           
 java.lang.Boolean getAnimateThumb()
          Should the thumb be animated to its new position when the value is changed programmatically, or by clicking in the slider track.
 java.lang.Boolean getAnimateThumbInit()
          If thumb animation is enabled, should the thumb be animated to its initial value?
 int getAnimateThumbTime()
          Duration of thumb animation, in milliseconds.
 java.lang.Boolean getCanFocus()
          Indicates whether keyboard manipulation of the slider is allowed.
 java.lang.Boolean getFlipValues()
          Specifies whether the value range of the slider should be flipped so that values increase as the thumb is moved down (for a vertical slider) or to the left (for a horizontal slider).
 int getLabelHeight()
          The height of the labels used to display the minimum, maximum and current values of the slider.
 int getLabelSpacing()
          The space around the labels used to display the minimum, maximum and current values of the slider.
 int getLabelWidth()
          The width of the labels used to display the minimum, maximum and current values of the slider.
 int getLength()
          Used to set slider height if vertical, slider width if horizontal. Applied to the slider track, not necessarily the entire widget. Overridden by an explicit width/height specification for the widget.
 float getMaxValue()
          The maximum slider value.
 java.lang.String getMaxValueLabel()
          The text displayed in the label for the maximum value of the slider.
 float getMinValue()
          The minimum slider value.
 java.lang.String getMinValueLabel()
          The text displayed in the label for the minimum value of the slider.
 java.lang.Integer getNumValues()
          The number of discrete values represented by slider.
static Slider getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
           
 int getRoundPrecision()
          If roundValues is false, the slider value will be rounded to this number of decimal places.
 java.lang.Boolean getRoundValues()
          Specifies whether the slider value should be rounded to the nearest integer.
 java.lang.Boolean getShowRange()
          Indicates whether labels for the min and max values of the slider should be displayed.
 java.lang.Boolean getShowTitle()
          Indicates whether the slider's title should be displayed.
 java.lang.Boolean getShowValue()
          Indicates whether a label for the value of the slider should be displayed.
 float getStepPercent()
          The percentage of the total slider that constitutes one discrete step.
 java.lang.String getThumbSrc()
          The base filename for the slider thumb images. The filenames for the thumb icons are assembled from this base filename and the state of the thumb, as follows:
Assume the thumbSrc is set to {baseName}.{extension}
The full set of images to be displayed is:
For horizontal sliders: h{baseName}.{extension}: default enabled appearance. h{baseName}_down.{extension}: appearance when the slider is enabled and the thumb is clicked. h{baseName}_off.{extension}: appearance when the slider is disabled. For vertical sliders: v{baseName}.{extension}: default enabled appearance. v{baseName}_down.{extension}: appearance when the slider is enabled and the thumb is clicked. v{baseName}_off.{extension}: appearance when the slider is disabled.
 int getThumbThickWidth()
          The dimension of the thumb perpendicular to the slider track.
 int getThumbThinWidth()
          The dimension of the thumb parallel to the slider track.
 java.lang.String getTitle()
          Optional display title for the slider.
 int getTrackCapSize()
          The height of vertical slider start and end images, or width of horizontal slider start and end images.
 ImageStyle getTrackImageType()
          The imageType setting for the slider track.
 java.lang.String getTrackSrc()
          The base filename for the slider track images. The filenames for the track icons are assembled from this base filename and the state of the slider, as follows:
Assume the trackSrc is set to {baseName}.{extension}
The full set of images to be displayed is:
For horizontal sliders: h{baseName}_start.{extension}: start (left edge) of the track for a slider that is enabled. h{baseName}_stretch.{extension}: the track for an enabled slider; this may be centered, tiled, or stretched. h{baseName}_end.{extension}: end (right edge) of the track for a slider that is enabled. h{baseName}_off_start.{extension}: start (left edge) of the track for a slider that is disabled. h{baseName}_off_stretch.{extension}: the track for a disabled slider; this may be centered, tiled, or stretched. h{baseName}_off_end.{extension}: end (right edge) of the track for a slider that is disabled. For vertical sliders: v{baseName}_start.{extension}: start (bottom edge) of the track for a slider that is enabled. v{baseName}_stretch.{extension}: the track for an enabled slider; this may be centered, tiled, or stretched. v{baseName}_end.{extension}: end (top edge) of the track for a slider that is enabled. v{baseName}_off_start.{extension}: start (bottom edge) of the track for a slider that is disabled. v{baseName}_off_stretch.{extension}: the track for a disabled slider; this may be centered, tiled, or stretched. v{baseName}_off_end.{extension}: end (top edge) of the track for a slider that is disabled.
 int getTrackWidth()
          The thickness of the track.
 float getValue()
          The slider value.
 java.lang.Boolean getVertical()
          Indicates whether this is a vertical or horizontal slider.
 void setAnimateThumb(java.lang.Boolean animateThumb)
          Should the thumb be animated to its new position when the value is changed programmatically, or by clicking in the slider track.
 void setAnimateThumbInit(java.lang.Boolean animateThumbInit)
          If thumb animation is enabled, should the thumb be animated to its initial value?
 void setAnimateThumbTime(int animateThumbTime)
          Duration of thumb animation, in milliseconds.
 void setCanFocus(java.lang.Boolean canFocus)
          Indicates whether keyboard manipulation of the slider is allowed.
 void setFlipValues(java.lang.Boolean flipValues)
          Specifies whether the value range of the slider should be flipped so that values increase as the thumb is moved down (for a vertical slider) or to the left (for a horizontal slider).
 void setLabelHeight(int labelHeight)
          The height of the labels used to display the minimum, maximum and current values of the slider.
 void setLabelSpacing(int labelSpacing)
          The space around the labels used to display the minimum, maximum and current values of the slider.
 void setLabelWidth(int labelWidth)
          The width of the labels used to display the minimum, maximum and current values of the slider.
 void setLength(int length)
          Used to set slider height if vertical, slider width if horizontal. Applied to the slider track, not necessarily the entire widget. Overridden by an explicit width/height specification for the widget.
 void setMaxValue(float maxValue)
          The maximum slider value.
 void setMaxValueLabel(java.lang.String maxValueLabel)
          The text displayed in the label for the maximum value of the slider.
 void setMinValue(float minValue)
          The minimum slider value.
 void setMinValueLabel(java.lang.String minValueLabel)
          The text displayed in the label for the minimum value of the slider.
 void setNumValues(java.lang.Integer numValues)
          The number of discrete values represented by slider.
 void setRoundPrecision(int roundPrecision)
          If roundValues is false, the slider value will be rounded to this number of decimal places.
 void setRoundValues(java.lang.Boolean roundValues)
          Specifies whether the slider value should be rounded to the nearest integer.
 void setShowRange(java.lang.Boolean showRange)
          Indicates whether labels for the min and max values of the slider should be displayed.
 void setShowTitle(java.lang.Boolean showTitle)
          Indicates whether the slider's title should be displayed.
 void setShowValue(java.lang.Boolean showValue)
          Indicates whether a label for the value of the slider should be displayed.
 void setStepPercent(float stepPercent)
          The percentage of the total slider that constitutes one discrete step.
 void setThumbSrc(java.lang.String thumbSrc)
          The base filename for the slider thumb images. The filenames for the thumb icons are assembled from this base filename and the state of the thumb, as follows:
Assume the thumbSrc is set to {baseName}.{extension}
The full set of images to be displayed is:
For horizontal sliders: h{baseName}.{extension}: default enabled appearance. h{baseName}_down.{extension}: appearance when the slider is enabled and the thumb is clicked. h{baseName}_off.{extension}: appearance when the slider is disabled. For vertical sliders: v{baseName}.{extension}: default enabled appearance. v{baseName}_down.{extension}: appearance when the slider is enabled and the thumb is clicked. v{baseName}_off.{extension}: appearance when the slider is disabled.
 void setThumbThickWidth(int thumbThickWidth)
          The dimension of the thumb perpendicular to the slider track.
 void setThumbThinWidth(int thumbThinWidth)
          The dimension of the thumb parallel to the slider track.
 void setTitle(java.lang.String title)
          Optional display title for the slider.
 void setTrackCapSize(int trackCapSize)
          The height of vertical slider start and end images, or width of horizontal slider start and end images.
 void setTrackImageType(ImageStyle trackImageType)
          The imageType setting for the slider track.
 void setTrackSrc(java.lang.String trackSrc)
          The base filename for the slider track images. The filenames for the track icons are assembled from this base filename and the state of the slider, as follows:
Assume the trackSrc is set to {baseName}.{extension}
The full set of images to be displayed is:
For horizontal sliders: h{baseName}_start.{extension}: start (left edge) of the track for a slider that is enabled. h{baseName}_stretch.{extension}: the track for an enabled slider; this may be centered, tiled, or stretched. h{baseName}_end.{extension}: end (right edge) of the track for a slider that is enabled. h{baseName}_off_start.{extension}: start (left edge) of the track for a slider that is disabled. h{baseName}_off_stretch.{extension}: the track for a disabled slider; this may be centered, tiled, or stretched. h{baseName}_off_end.{extension}: end (right edge) of the track for a slider that is disabled. For vertical sliders: v{baseName}_start.{extension}: start (bottom edge) of the track for a slider that is enabled. v{baseName}_stretch.{extension}: the track for an enabled slider; this may be centered, tiled, or stretched. v{baseName}_end.{extension}: end (top edge) of the track for a slider that is enabled. v{baseName}_off_start.{extension}: start (bottom edge) of the track for a slider that is disabled. v{baseName}_off_stretch.{extension}: the track for a disabled slider; this may be centered, tiled, or stretched. v{baseName}_off_end.{extension}: end (top edge) of the track for a slider that is disabled.
 void setTrackWidth(int trackWidth)
          The thickness of the track.
 void setValue(float value)
          The slider value.
 void setVertical(java.lang.Boolean vertical)
          Indicates whether this is a vertical or horizontal slider.
 java.lang.Boolean valueIsChanging()
          Call this method in your addValueChangedHandler(com.smartgwt.client.widgets.events.ValueChangedHandler) handler to determine whether the value change is due to an ongoing drag interaction (true) or due to a thumb-release, mouse click, keypress, or programmatic event (false).
 
Methods inherited from class com.smartgwt.client.widgets.Canvas
addChild, addChild, addChild, addClickHandler, addDoubleClickHandler, addDragMoveHandler, addDragRepositionMoveHandler, addDragRepositionStartHandler, addDragRepositionStopHandler, addDragResizeMoveHandler, addDragResizeStartHandler, addDragResizeStopHandler, addDragStartHandler, addDragStopHandler, addDropHandler, addDropMoveHandler, addDropOutHandler, addDropOverHandler, addFocusChangedHandler, addHoverHandler, addHoverHiddenHandler, addKeyDownHandler, addKeyPressHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseStillDownHandler, addMouseUpHandler, addMouseWheelHandler, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, adjustForContent, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, blur, bringToFront, clear, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsFocus, containsPoint, containsPoint, convertToCanvasArray, disable, enable, focus, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowTime, getAnimateTime, getAppImgDir, getAutoShowParent, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanHover, getCanSelectText, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getContents, getContextMenu, getCursor, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragOpacity, getDragRepositionCursor, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getExtraSpace, getGroupTitle, getHeight, getHeightAsString, getHoverAlign, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlPosition, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getLeft, getMargin, getMatchElement, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentElement, getPercentBox, getPosition, getPrefix, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowResizeBar, getShowShadow, getSkinImgDir, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getStyleName, getTabIndex, getTooltip, getTop, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWidth, getVSnapOrigin, getVSnapOrigin, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideContextMenu, imgHTML, imgHTML, imgHTML, intersects, isDirty, isDisabled, isDrawn, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, parentResized, redraw, redraw, removeChild, removeChild, resizeBy, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAlign, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowTime, setAnimateTime, setAppImgDir, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanHover, setCanSelectText, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDefaultHeight, setDefaultWidth, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragOpacity, setDragRepositionCursor, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setExtraSpace, setGroupTitle, setHeight, setHeight, setHeight100, setHoverAlign, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlPosition, setImage, setImage, setIsGroup, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNoDoubleClicks, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setParentElement, setPercentBox, setPosition, setPrefix, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setRight, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowResizeBar, setShowShadow, setSkinImgDir, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setStyleName, setTabIndex, setTooltip, setTop, setVisibility, setVisible, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showNextTo, showNextTo, showPrintPreview, updateHover, updateHover, updateShadow, visibleAtPoint, visibleAtPoint, willAcceptDrop
 
Methods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getElement, getElement, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, hashCode, isConfigOnly, isCreated, onDestroy, onDraw, onInit, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDragTracker, setElement, setHtmlElement, setID, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, toString
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
doAttachChildren, doDetachChildren, getParent, isAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setPixelSize, setSize, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkEvents, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 

Constructor Detail

Slider

public Slider()

Slider

public Slider(com.google.gwt.core.client.JavaScriptObject jsObj)

Slider

public Slider(java.lang.String title)
Method Detail

getOrCreateRef

public static Slider getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

create

protected com.google.gwt.core.client.JavaScriptObject create()
Overrides:
create in class Canvas

setTitle

public void setTitle(java.lang.String title)
Optional display title for the slider.

Overrides:
setTitle in class Canvas
Parameters:
title - title Default value is "Set Value"

getTitle

public java.lang.String getTitle()
Optional display title for the slider.

Overrides:
getTitle in class Canvas
Returns:
String

setLength

public void setLength(int length)
Used to set slider height if vertical, slider width if horizontal. Applied to the slider track, not necessarily the entire widget. Overridden by an explicit width/height specification for the widget.

Parameters:
length - length Default value is 200

getLength

public int getLength()
Used to set slider height if vertical, slider width if horizontal. Applied to the slider track, not necessarily the entire widget. Overridden by an explicit width/height specification for the widget.

Returns:
int

setVertical

public void setVertical(java.lang.Boolean vertical)
Indicates whether this is a vertical or horizontal slider.

Parameters:
vertical - vertical Default value is true

getVertical

public java.lang.Boolean getVertical()
Indicates whether this is a vertical or horizontal slider.

Returns:
Boolean

setThumbThickWidth

public void setThumbThickWidth(int thumbThickWidth)
The dimension of the thumb perpendicular to the slider track.

Parameters:
thumbThickWidth - thumbThickWidth Default value is 23

getThumbThickWidth

public int getThumbThickWidth()
The dimension of the thumb perpendicular to the slider track.

Returns:
int

setThumbThinWidth

public void setThumbThinWidth(int thumbThinWidth)
The dimension of the thumb parallel to the slider track.

Parameters:
thumbThinWidth - thumbThinWidth Default value is 17

getThumbThinWidth

public int getThumbThinWidth()
The dimension of the thumb parallel to the slider track.

Returns:
int

setTrackWidth

public void setTrackWidth(int trackWidth)
The thickness of the track. This is the width, for a vertical slider, or the height, for a horizontal slider.

Parameters:
trackWidth - trackWidth Default value is 7

getTrackWidth

public int getTrackWidth()
The thickness of the track. This is the width, for a vertical slider, or the height, for a horizontal slider.

Returns:
int

setThumbSrc

public void setThumbSrc(java.lang.String thumbSrc)
The base filename for the slider thumb images. The filenames for the thumb icons are assembled from this base filename and the state of the thumb, as follows:
Assume the thumbSrc is set to {baseName}.{extension}
The full set of images to be displayed is:
For horizontal sliders: For vertical sliders:

Parameters:
thumbSrc - thumbSrc Default value is "thumb.gif"

getThumbSrc

public java.lang.String getThumbSrc()
The base filename for the slider thumb images. The filenames for the thumb icons are assembled from this base filename and the state of the thumb, as follows:
Assume the thumbSrc is set to {baseName}.{extension}
The full set of images to be displayed is:
For horizontal sliders: For vertical sliders:

Returns:
String

setTrackSrc

public void setTrackSrc(java.lang.String trackSrc)
The base filename for the slider track images. The filenames for the track icons are assembled from this base filename and the state of the slider, as follows:
Assume the trackSrc is set to {baseName}.{extension}
The full set of images to be displayed is:
For horizontal sliders: For vertical sliders:

Parameters:
trackSrc - trackSrc Default value is "track.gif"

getTrackSrc

public java.lang.String getTrackSrc()
The base filename for the slider track images. The filenames for the track icons are assembled from this base filename and the state of the slider, as follows:
Assume the trackSrc is set to {baseName}.{extension}
The full set of images to be displayed is:
For horizontal sliders: For vertical sliders:

Returns:
String

setTrackCapSize

public void setTrackCapSize(int trackCapSize)
The height of vertical slider start and end images, or width of horizontal slider start and end images.

Parameters:
trackCapSize - trackCapSize Default value is 6

getTrackCapSize

public int getTrackCapSize()
The height of vertical slider start and end images, or width of horizontal slider start and end images.

Returns:
int

setTrackImageType

public void setTrackImageType(ImageStyle trackImageType)
The imageType setting for the slider track.

Parameters:
trackImageType - trackImageType Default value is "stretch"

getTrackImageType

public ImageStyle getTrackImageType()
The imageType setting for the slider track.

Returns:
ImageStyle

setShowTitle

public void setShowTitle(java.lang.Boolean showTitle)
Indicates whether the slider's title should be displayed. The default position for this label is to the left of a horizontal slider, or above a vertical slider.

Parameters:
showTitle - showTitle Default value is true

getShowTitle

public java.lang.Boolean getShowTitle()
Indicates whether the slider's title should be displayed. The default position for this label is to the left of a horizontal slider, or above a vertical slider.

Returns:
Boolean

setShowRange

public void setShowRange(java.lang.Boolean showRange)
Indicates whether labels for the min and max values of the slider should be displayed. The default positions for these labels are below the start/end of a horizontal slider, or to the right of the start/end of a vertical slider.

Parameters:
showRange - showRange Default value is true

getShowRange

public java.lang.Boolean getShowRange()
Indicates whether labels for the min and max values of the slider should be displayed. The default positions for these labels are below the start/end of a horizontal slider, or to the right of the start/end of a vertical slider.

Returns:
Boolean

setShowValue

public void setShowValue(java.lang.Boolean showValue)
Indicates whether a label for the value of the slider should be displayed. The default position for this label is to the right of a horizontal slider, or below a vertical slider.

Parameters:
showValue - showValue Default value is true

getShowValue

public java.lang.Boolean getShowValue()
Indicates whether a label for the value of the slider should be displayed. The default position for this label is to the right of a horizontal slider, or below a vertical slider.

Returns:
Boolean

setLabelWidth

public void setLabelWidth(int labelWidth)
The width of the labels used to display the minimum, maximum and current values of the slider.

Parameters:
labelWidth - labelWidth Default value is 50

getLabelWidth

public int getLabelWidth()
The width of the labels used to display the minimum, maximum and current values of the slider.

Returns:
int

setLabelHeight

public void setLabelHeight(int labelHeight)
The height of the labels used to display the minimum, maximum and current values of the slider.

Parameters:
labelHeight - labelHeight Default value is 20

getLabelHeight

public int getLabelHeight()
The height of the labels used to display the minimum, maximum and current values of the slider.

Returns:
int

setLabelSpacing

public void setLabelSpacing(int labelSpacing)
The space around the labels used to display the minimum, maximum and current values of the slider.

Parameters:
labelSpacing - labelSpacing Default value is 5

getLabelSpacing

public int getLabelSpacing()
The space around the labels used to display the minimum, maximum and current values of the slider.

Returns:
int

setValue

public void setValue(float value)
The slider value. This value should lie between the minValue and maxValue and increases as the thumb is moved up (for a vertical slider) or right (for a horizontal slider) unless flipValues is set to true. Sets the slider value to newValue and moves the slider thumb to the appropriate position for this value. Sends the 'sliderMove' event to the sliderTarget.

Parameters:
value - the new value. Default value is 1

getValue

public float getValue()
The slider value. This value should lie between the minValue and maxValue and increases as the thumb is moved up (for a vertical slider) or right (for a horizontal slider) unless flipValues is set to true.

Returns:
Returns the current slider value.

setMinValue

public void setMinValue(float minValue)
The minimum slider value. The slider value is equal to minValue when the thumb is at the bottom or left of the slider (unless flipValues is true, in which case the minimum value is at the top/right of the slider)

Parameters:
minValue - minValue Default value is 1

getMinValue

public float getMinValue()
The minimum slider value. The slider value is equal to minValue when the thumb is at the bottom or left of the slider (unless flipValues is true, in which case the minimum value is at the top/right of the slider)

Returns:
float

setMinValueLabel

public void setMinValueLabel(java.lang.String minValueLabel)
The text displayed in the label for the minimum value of the slider. If left as null, then slider.minValue will be displayed.

Parameters:
minValueLabel - minValueLabel Default value is null

getMinValueLabel

public java.lang.String getMinValueLabel()
The text displayed in the label for the minimum value of the slider. If left as null, then slider.minValue will be displayed.

Returns:
String

setMaxValue

public void setMaxValue(float maxValue)
The maximum slider value. The slider value is equal to maxValue when the thumb is at the top or right of the slider (unless flipValues is true, in which case the maximum value is at the bottom/left of the slider)

Parameters:
maxValue - maxValue Default value is 100

getMaxValue

public float getMaxValue()
The maximum slider value. The slider value is equal to maxValue when the thumb is at the top or right of the slider (unless flipValues is true, in which case the maximum value is at the bottom/left of the slider)

Returns:
float

setMaxValueLabel

public void setMaxValueLabel(java.lang.String maxValueLabel)
The text displayed in the label for the maximum value of the slider. If left as null, then slider.maxValue will be displayed.

Parameters:
maxValueLabel - maxValueLabel Default value is null

getMaxValueLabel

public java.lang.String getMaxValueLabel()
The text displayed in the label for the maximum value of the slider. If left as null, then slider.maxValue will be displayed.

Returns:
String

setNumValues

public void setNumValues(java.lang.Integer numValues)
The number of discrete values represented by slider. If specified, the range of valid values (between minValue and maxValue) will be divided into this many steps. As the thumb is moved along the track it will only select these values and appear to jump between the steps.

Parameters:
numValues - numValues Default value is null

getNumValues

public java.lang.Integer getNumValues()
The number of discrete values represented by slider. If specified, the range of valid values (between minValue and maxValue) will be divided into this many steps. As the thumb is moved along the track it will only select these values and appear to jump between the steps.

Returns:
Integer

setRoundValues

public void setRoundValues(java.lang.Boolean roundValues)
Specifies whether the slider value should be rounded to the nearest integer. If set to false, values will be rounded to a fixed number of decimal places controlled by roundPrecision.

Parameters:
roundValues - roundValues Default value is true

getRoundValues

public java.lang.Boolean getRoundValues()
Specifies whether the slider value should be rounded to the nearest integer. If set to false, values will be rounded to a fixed number of decimal places controlled by roundPrecision.

Returns:
Boolean

setRoundPrecision

public void setRoundPrecision(int roundPrecision)
If roundValues is false, the slider value will be rounded to this number of decimal places. If set to null the value will not be rounded

Parameters:
roundPrecision - roundPrecision Default value is 1

getRoundPrecision

public int getRoundPrecision()
If roundValues is false, the slider value will be rounded to this number of decimal places. If set to null the value will not be rounded

Returns:
int

setFlipValues

public void setFlipValues(java.lang.Boolean flipValues)
Specifies whether the value range of the slider should be flipped so that values increase as the thumb is moved down (for a vertical slider) or to the left (for a horizontal slider).

Parameters:
flipValues - flipValues Default value is false

getFlipValues

public java.lang.Boolean getFlipValues()
Specifies whether the value range of the slider should be flipped so that values increase as the thumb is moved down (for a vertical slider) or to the left (for a horizontal slider).

Returns:
Boolean

setCanFocus

public void setCanFocus(java.lang.Boolean canFocus)
Indicates whether keyboard manipulation of the slider is allowed.

Overrides:
setCanFocus in class Canvas
Parameters:
canFocus - canFocus Default value is true

getCanFocus

public java.lang.Boolean getCanFocus()
Indicates whether keyboard manipulation of the slider is allowed.

Overrides:
getCanFocus in class Canvas
Returns:
Boolean

setStepPercent

public void setStepPercent(float stepPercent)
The percentage of the total slider that constitutes one discrete step. The slider will move one step when the appropriate arrow key is pressed.

Parameters:
stepPercent - stepPercent Default value is 5

getStepPercent

public float getStepPercent()
The percentage of the total slider that constitutes one discrete step. The slider will move one step when the appropriate arrow key is pressed.

Returns:
float

setAnimateThumb

public void setAnimateThumb(java.lang.Boolean animateThumb)
Should the thumb be animated to its new position when the value is changed programmatically, or by clicking in the slider track.

Parameters:
animateThumb - animateThumb Default value is true

getAnimateThumb

public java.lang.Boolean getAnimateThumb()
Should the thumb be animated to its new position when the value is changed programmatically, or by clicking in the slider track.

Returns:
Boolean

setAnimateThumbTime

public void setAnimateThumbTime(int animateThumbTime)
Duration of thumb animation, in milliseconds.

Parameters:
animateThumbTime - animateThumbTime Default value is 250

getAnimateThumbTime

public int getAnimateThumbTime()
Duration of thumb animation, in milliseconds.

Returns:
int

setAnimateThumbInit

public void setAnimateThumbInit(java.lang.Boolean animateThumbInit)
If thumb animation is enabled, should the thumb be animated to its initial value?

Parameters:
animateThumbInit - animateThumbInit Default value is false

getAnimateThumbInit

public java.lang.Boolean getAnimateThumbInit()
If thumb animation is enabled, should the thumb be animated to its initial value?

Returns:
Boolean

addValueChangedHandler

public HandlerRegistration addValueChangedHandler(ValueChangedHandler handler)
Add a valueChanged handler.

This method is called when the slider value changes. This occurs when the setValue method is called, or when the slider is moved. Observe this method to be notified when the slider value changes.

Specified by:
addValueChangedHandler in interface HasValueChangedHandlers
Parameters:
handler - the valueChanged handler
Returns:
HandlerRegistration used to remove this handler

valueIsChanging

public java.lang.Boolean valueIsChanging()
Call this method in your addValueChangedHandler(com.smartgwt.client.widgets.events.ValueChangedHandler) handler to determine whether the value change is due to an ongoing drag interaction (true) or due to a thumb-release, mouse click, keypress, or programmatic event (false). You may choose to execute temporary or partial updates while the slider thumb is dragged, and final updates or persistence of the value in response to the other events.

Returns:
true if user is still dragging the slider thumb, false otherwise