Slider

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.smartgwt.client.widgets
Class Slider

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.smartgwt.client.widgets.BaseWidget
              com.smartgwt.client.widgets.Canvas
                  com.smartgwt.client.widgets.Slider

All Implemented Interfaces:: HasAttachHandlers, HasHandlers, EventListener, IsWidget, 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, HasMovedHandlers, HasParentMovedHandlers, HasResizedHandlers, HasRightMouseDownHandlers, HasScrolledHandlers, HasShowContextMenuHandlers, HasValueChangedHandlers, HasVisibilityChangedHandlers

public class Slider
extends Canvas
implements HasValueChangedHandlers
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 indicator 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
`UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled`

Field Summary

Fields inherited from class com.smartgwt.client.widgets.BaseWidget
`config, configOnly, id, isElementSet, scClassName`

Fields inherited from class com.google.gwt.user.client.ui.UIObject
`DEBUG_ID_PREFIX`

Constructor Summary
`Slider()`
`Slider(JavaScriptObject jsObj)`
`Slider(String title)`

Method Summary
`HandlerRegistration`	`addValueChangedHandler(ValueChangedHandler handler)` Add a valueChanged handler.
`protected JavaScriptObject`	`create()`
`Boolean`	`getAnimateThumb()` Should the thumb be animated to its new position when the value is changed programmatically, or by clicking in the slider track.
`Boolean`	`getAnimateThumbInit()` If thumb animation is enabled, should the thumb be animated to its initial value?
`int`	`getAnimateThumbTime()` Duration of thumb animation, in milliseconds.
`Boolean`	`getCanFocus()` Indicates whether keyboard manipulation of the slider is allowed.
`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).
`String`	`getHThumbStyle()` Optional CSS style for the thumb for a horizontally oriented slider.
`String`	`getHTrackStyle()` Optional CSS style for the track for a horizontally oriented 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.
`float`	`getMaxValue()` The maximum slider value.
`String`	`getMaxValueLabel()` The text displayed in the label for the maximum value of the slider.
`float`	`getMinValue()` The minimum slider value.
`String`	`getMinValueLabel()` The text displayed in the label for the minimum value of the slider.
`Integer`	`getNumValues()` The number of discrete values represented by slider.
`static Slider`	`getOrCreateRef(JavaScriptObject jsObj)`
`int`	`getRoundPrecision()` If `roundValues` is false, the slider value will be rounded to this number of decimal places.
`Boolean`	`getRoundValues()` Specifies whether the slider value should be rounded to the nearest integer.
`Boolean`	`getShowRange()` Indicates whether labels for the min and max values of the slider should be displayed.
`Boolean`	`getShowTitle()` Indicates whether the slider's title should be displayed.
`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.
`String`	`getThumbSrc()` The base filename for the slider thumb images.
`int`	`getThumbThickWidth()` The dimension of the thumb perpendicular to the slider track.
`int`	`getThumbThinWidth()` The dimension of the thumb parallel to the slider track.
`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.
`String`	`getTrackSrc()` The base filename for the slider track images.
`int`	`getTrackWidth()` The thickness of the track.
`float`	`getValue()` The slider value.
`Boolean`	`getVertical()` Indicates whether this is a vertical or horizontal slider.
`String`	`getVThumbStyle()` Optional CSS style for the thumb for a vertically oriented slider.
`String`	`getVTrackStyle()` Optional CSS style for the track for a vertically oriented slider.
`void`	`setAnimateThumb(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(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(Boolean canFocus)` Indicates whether keyboard manipulation of the slider is allowed.
`static void`	`setDefaultProperties(Slider sliderProperties)` Class level method to set the default properties of this class.
`void`	`setFlipValues(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`	`setHThumbStyle(String hThumbStyle)` Optional CSS style for the thumb for a horizontally oriented slider.
`void`	`setHTrackStyle(String hTrackStyle)` Optional CSS style for the track for a horizontally oriented 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.
`void`	`setMaxValue(float maxValue)` The maximum slider value.
`void`	`setMaxValueLabel(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(String minValueLabel)` The text displayed in the label for the minimum value of the slider.
`void`	`setNumValues(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(Boolean roundValues)` Specifies whether the slider value should be rounded to the nearest integer.
`void`	`setShowRange(Boolean showRange)` Indicates whether labels for the min and max values of the slider should be displayed.
`void`	`setShowTitle(Boolean showTitle)` Indicates whether the slider's title should be displayed.
`void`	`setShowValue(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(String thumbSrc)` The base filename for the slider thumb images.
`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(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(String trackSrc)` The base filename for the slider track images.
`void`	`setTrackWidth(int trackWidth)` The thickness of the track.
`void`	`setValue(float value)` The slider value.
`void`	`setVertical(Boolean vertical)` Indicates whether this is a vertical or horizontal slider.
`void`	`setVThumbStyle(String vThumbStyle)` Optional CSS style for the thumb for a vertically oriented slider.
`void`	`setVTrackStyle(String vTrackStyle)` Optional CSS style for the track for a vertically oriented slider.
`Boolean`	`valueIsChanging()` Call this method in your `Slider.valueChanged` 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, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, addVisibilityChangedHandler, 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, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoDraw, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanHover, getCanSelectText, getCanvasItem, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getExtraSpace, getFacetId, getFullDataPath, getGroupTitle, getHeight, getHeightAsString, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlPosition, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinWidth, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentElement, getPercentBox, getPosition, getPrefix, getPrintHTML, getPrintHTML, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowResizeBar, getShowShadow, getSkinImgDir, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getStyleName, getTabIndex, getTooltip, getTop, getTopAsString, getUseOpacityFilter, getValuesManager, 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, onInit, parentResized, printComponents, redraw, redraw, removeChild, removeChild, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAlign, setAllowExternalFilters, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAutoDraw, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanHover, setCanSelectText, setCanvasItem, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setExtraSpace, setFacetId, setGroupTitle, setHeight, setHeight, setHeight100, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlPosition, setImage, setImage, setIsGroup, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinWidth, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setParentElement, setPercentBox, setPosition, setPrefix, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setRight, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setSkinImgDir, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setStyleName, setTabIndex, setTooltip, setTop, setTop, setUseOpacityFilter, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateHover, updateHover, updateShadow, visibleAtPoint, willAcceptDrop

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, addMovedHandler, addParentMovedHandler, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addScrolledHandler, addShowContextMenuHandler, addStyleName, addVisibilityChangedHandler, 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, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaRole, getAutoDraw, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBottom, getById, getCanAcceptDrop, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanHover, getCanSelectText, getCanvasItem, getChildren, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getContents, getContextMenu, getCursor, getDataPath, getDefaultHeight, getDefaultWidth, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragType, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getExtraSpace, getFacetId, getFullDataPath, getGroupTitle, getHeight, getHeightAsString, getHoverAlign, getHoverAutoDestroy, getHoverComponent, getHoverDelay, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapOrigin, getHSnapOrigin, getHSnapPosition, getHSnapPosition, getHtmlPosition, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getLeft, getLeftAsString, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getMargin, getMatchElement, getMaxHeight, getMaxWidth, getMenuConstructor, getMinHeight, getMinWidth, getMouseStillDownDelay, getMouseStillDownInitialDelay, getNextZIndex, getNoDoubleClicks, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getParentElement, getPercentBox, getPosition, getPrefix, getPrintHTML, getPrintHTML, getPrompt, getRect, getRedrawOnResize, getResizeBarTarget, getRight, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowDepth, getShadowImage, getShadowOffset, getShadowSoftness, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowResizeBar, getShowShadow, getSkinImgDir, getSnapAxis, getSnapEdge, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapResizeToGrid, getSnapTo, getSnapToGrid, getSnapVDirection, getSnapVGap, getStyleName, getTabIndex, getTooltip, getTop, getTopAsString, getUseOpacityFilter, getValuesManager, 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, onInit, parentResized, printComponents, redraw, redraw, removeChild, removeChild, resizeBy, resizeTo, resizeTo, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAlign, setAllowExternalFilters, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAutoDraw, setAutoHeight, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBottom, setCanAcceptDrop, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanHover, setCanSelectText, setCanvasItem, setChildren, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setContents, setContextMenu, setCursor, setDataPath, setDefaultHeight, setDefaultProperties, setDefaultWidth, setDisabled, setDisabledCursor, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragType, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setExtraSpace, setFacetId, setGroupTitle, setHeight, setHeight, setHeight100, setHoverAlign, setHoverAutoDestroy, setHoverDelay, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlPosition, setImage, setImage, setIsGroup, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeft, setLeft, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setMargin, setMatchElement, setMaxHeight, setMaxWidth, setMenuConstructor, setMinHeight, setMinWidth, setMouseStillDownDelay, setMouseStillDownInitialDelay, setNeverUseFilters, setNoDoubleClicks, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setParentElement, setPercentBox, setPosition, setPrefix, setPrompt, setRect, setRect, setRedrawOnResize, setResizeBarTarget, setResizeFrom, setRight, setScrollbarSize, setShadowDepth, setShadowImage, setShadowOffset, setShadowSoftness, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowResizeBar, setShowShadow, setSkinImgDir, setSmoothFade, setSnapAxis, setSnapEdge, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToGrid, setSnapTo, setSnapToGrid, setSnapVDirection, setSnapVGap, setStyleName, setTabIndex, setTooltip, setTop, setTop, setUseOpacityFilter, setValuesManager, setVisibility, setVisible, setWidth, setWidth, setWidth100, setZIndex, shouldDragScroll, show, showClickMask, showNextTo, showNextTo, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, updateHover, updateHover, updateShadow, 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, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getElement, getElement, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hashCode, isConfigOnly, isCreated, onDestroy, onDraw, setAttribute, 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, setScClassName, toString

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, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getElement, getElement, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hashCode, isConfigOnly, isCreated, onDestroy, onDraw, setAttribute, 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, setScClassName, toString

Methods inherited from class com.google.gwt.user.client.ui.Widget
`addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents`

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, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, 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(JavaScriptObject jsObj)

Slider

public Slider(String title)

Method Detail

getOrCreateRef

public static Slider getOrCreateRef(JavaScriptObject jsObj)

create

protected JavaScriptObject create()

Overrides:: create in class Canvas

setAnimateThumb

public void setAnimateThumb(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 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

setAnimateThumbInit

public void setAnimateThumbInit(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 Boolean getAnimateThumbInit()

If thumb animation is enabled, should the thumb be animated to its initial value?

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

setCanFocus

public void setCanFocus(Boolean canFocus)

Indicates whether keyboard manipulation of the slider is allowed.

Overrides:: setCanFocus in class Canvas

Parameters:: canFocus - canFocus Default value is true
See Also:: Focus overview and related methods, Focus & Tabbing Example

getCanFocus

public Boolean getCanFocus()

Indicates whether keyboard manipulation of the slider is allowed.

Overrides:: getCanFocus in class Canvas

Returns:: Boolean
See Also:: Focus overview and related methods, Focus & Tabbing Example

setFlipValues

public void setFlipValues(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).

If this method is called after the component has been drawn/initialized: Sets the flipValues property of the slider

Parameters:: flipValues - flip slider values?. Default value is false

getFlipValues

public 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

setHThumbStyle

public void setHThumbStyle(String hThumbStyle)
                    throws IllegalStateException

Optional CSS style for the thumb for a horizontally oriented slider.

Will have the suffix "down" added when the mouse is down on the thumb, and "Disabled" added when the slider is disabled.

Parameters:: hThumbStyle - hThumbStyle Default value is null
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getHThumbStyle

public String getHThumbStyle()

Optional CSS style for the thumb for a horizontally oriented slider.

Will have the suffix "down" added when the mouse is down on the thumb, and "Disabled" added when the slider is disabled.

Returns:: String

setHTrackStyle

public void setHTrackStyle(String hTrackStyle)
                    throws IllegalStateException

Optional CSS style for the track for a horizontally oriented slider.

Will have the suffix "Disabled" added when the slider is disabled.

Parameters:: hTrackStyle - hTrackStyle Default value is null
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getHTrackStyle

public String getHTrackStyle()

Optional CSS style for the track for a horizontally oriented slider.

Will have the suffix "Disabled" added when the slider is disabled.

Returns:: String

setLabelHeight

public void setLabelHeight(int labelHeight)

The height of the labels used to display the minimum, maximum and current values of the slider.

If this method is called after the component has been drawn/initialized: Sets the labelHeight property of the slider

Parameters:: labelHeight - new label height. 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.

If this method is called after the component has been drawn/initialized: Sets the labelSpacing property of the slider

Parameters:: labelSpacing - new label spacing. 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

setLabelWidth

public void setLabelWidth(int labelWidth)

The width of the labels used to display the minimum, maximum and current values of the slider.

If this method is called after the component has been drawn/initialized: Sets the labelWidth property of the slider

Parameters:: labelWidth - new label width. 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

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

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)

If this method is called after the component has been drawn/initialized: Sets the maximum value of the slider

Parameters:: maxValue - the new maximum value. Default value is 100
See Also:: setFlipValues(java.lang.Boolean), Slider Example

getMaxValue

public float getMaxValue()

Returns:: float
See Also:: getFlipValues(), Slider Example

setMaxValueLabel

public void setMaxValueLabel(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.

If this method is called after the component has been drawn/initialized: Sets the maxValueLabel property of the slider

Parameters:: maxValueLabel - new label text. Default value is null
See Also:: setShowRange(java.lang.Boolean), setMaxValue(float)

getMaxValueLabel

public 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
See Also:: getShowRange(), getMaxValue()

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)

If this method is called after the component has been drawn/initialized: Sets the minimum value of the slider

Parameters:: minValue - the new minimum value. Default value is 1
See Also:: setFlipValues(java.lang.Boolean), Slider Example

getMinValue

public float getMinValue()

Returns:: float
See Also:: getFlipValues(), Slider Example

setMinValueLabel

public void setMinValueLabel(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
See Also:: setShowRange(java.lang.Boolean), setMinValue(float)

getMinValueLabel

public 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
See Also:: getShowRange(), getMinValue()

setNumValues

public void setNumValues(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.

If this method is called after the component has been drawn/initialized: Sets the number of values for the slider

Parameters:: numValues - the new number of values. Default value is null
See Also:: Slider Example

getNumValues

public Integer getNumValues()

Returns:: Integer
See Also:: Slider Example

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

If this method is called after the component has been drawn/initialized: Sets the roundPrecision property of the slider

Parameters:: roundPrecision - new round precision. 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

setRoundValues

public void setRoundValues(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.

If this method is called after the component has been drawn/initialized: Sets the roundValues property of the slider

Parameters:: roundValues - round slider values?. Default value is true

getRoundValues

public 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

setShowRange

public void setShowRange(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.

If this method is called after the component has been drawn/initialized: Sets the showRange property of the slider

Parameters:: showRange - show the slider range?. Default value is true
See Also:: setMinValueLabel(java.lang.String), setMaxValueLabel(java.lang.String)

getShowRange

public Boolean getShowRange()

Returns:: Boolean
See Also:: getMinValueLabel(), getMaxValueLabel()

setShowTitle

public void setShowTitle(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.

If this method is called after the component has been drawn/initialized: Sets the showTitle property of the slider

Parameters:: showTitle - show the slider title?. Default value is true
See Also:: setTitle(java.lang.String)

getShowTitle

public 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
See Also:: getTitle()

setShowValue

public void setShowValue(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 vertical slider, or below a horizontal slider.

If this method is called after the component has been drawn/initialized: Sets the showValue property of the slider

Parameters:: showValue - show the slider value?. Default value is true
See Also:: setValue(float)

getShowValue

public 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 vertical slider, or below a horizontal slider.

Returns:: Boolean
See Also:: getValue()

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.

If this method is called after the component has been drawn/initialized: Sets the stepPercent property of the slider

Parameters:: stepPercent - new slider step percent. 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

setThumbSrc

public void setThumbSrc(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}_Disabled.{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}_Disabled.{extension}: appearance when the slider is disabled.

If this method is called after the component has been drawn/initialized: Sets the thumbSrc property of the slider

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

getThumbSrc

public String getThumbSrc()

h{baseName}.{extension}: default enabled appearance.
h{baseName}_down.{extension}: appearance when the slider is enabled and the thumb is clicked.
h{baseName}_Disabled.{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}_Disabled.{extension}: appearance when the slider is disabled.

Returns:: String

setThumbThickWidth

public void setThumbThickWidth(int thumbThickWidth)

The dimension of the thumb perpendicular to the slider track.

If this method is called after the component has been drawn/initialized: Sets the thumbThickWidth property of the slider

Parameters:: thumbThickWidth - new 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.

If this method is called after the component has been drawn/initialized: Sets the thumbThinWidth property of the slider

Parameters:: thumbThinWidth - new thumbThinWidth. Default value is 17

getThumbThinWidth

public int getThumbThinWidth()

The dimension of the thumb parallel to the slider track.

Returns:: int

setTitle

public void setTitle(String title)

Optional display title for the slider.

If this method is called after the component has been drawn/initialized: Sets the title of the slider

Overrides:: setTitle in class Canvas

Parameters:: title - new title for the slider. Default value is "Set Value"
See Also:: setShowTitle(java.lang.Boolean)

getTitle

public String getTitle()

Optional display title for the slider.

Overrides:: getTitle in class Canvas

Returns:: String
See Also:: getShowTitle()

setTrackCapSize

public void setTrackCapSize(int trackCapSize)

The height of vertical slider start and end images, or width of horizontal slider start and end images.

If this method is called after the component has been drawn/initialized: Sets the trackCapSize property of the slider

Parameters:: trackCapSize - new 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.

If this method is called after the component has been drawn/initialized: Sets the trackImageType property of the slider

Parameters:: trackImageType - new trackImageType. Default value is "stretch"
See Also:: ImageStyle, StretchImg.setImageType(com.smartgwt.client.types.ImageStyle)

getTrackImageType

public ImageStyle getTrackImageType()

The imageType setting for the slider track.

Returns:: ImageStyle
See Also:: ImageStyle, StretchImg.getImageType()

setTrackSrc

public void setTrackSrc(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}_Disabled_start.{extension}: start (left edge) of the track for a slider that is disabled.
h{baseName}_Disabled_stretch.{extension}: the track for a disabled slider; this may be centered, tiled, or stretched.
h{baseName}_Disabled_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}_Disabled_start.{extension}: start (bottom edge) of the track for a slider that is disabled.
v{baseName}_Disabled_stretch.{extension}: the track for a disabled slider; this may be centered, tiled, or stretched.
v{baseName}_end.{extension}: end (top edge) of the track for a slider that is disabled.

If this method is called after the component has been drawn/initialized: Sets the trackSrc property of the slider

Parameters:: trackSrc - new trackSrc. Default value is "track.gif"
See Also:: setTrackImageType(com.smartgwt.client.types.ImageStyle)

getTrackSrc

public String getTrackSrc()

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}_Disabled_start.{extension}: start (left edge) of the track for a slider that is disabled.
h{baseName}_Disabled_stretch.{extension}: the track for a disabled slider; this may be centered, tiled, or stretched.
h{baseName}_Disabled_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}_Disabled_start.{extension}: start (bottom edge) of the track for a slider that is disabled.
v{baseName}_Disabled_stretch.{extension}: the track for a disabled slider; this may be centered, tiled, or stretched.
v{baseName}_end.{extension}: end (top edge) of the track for a slider that is disabled.

Returns:: String
See Also:: getTrackImageType()

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.

If this method is called after the component has been drawn/initialized: Sets the trackWidth property of the slider

Parameters:: trackWidth - new 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

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.

If this method is called after the component has been drawn/initialized: 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
See Also:: setMinValue(float), setMaxValue(float), setFlipValues(java.lang.Boolean), setShowValue(java.lang.Boolean)

getValue

public float getValue()

Returns:: Returns the current slider value.
See Also:: getMinValue(), getMaxValue(), getFlipValues(), getShowValue()

setVertical

public void setVertical(Boolean vertical)

Indicates whether this is a vertical or horizontal slider.

If this method is called after the component has been drawn/initialized: Sets the vertical property of the slider

Parameters:: vertical - is the slider vertical. Default value is true
See Also:: Slider Example

getVertical

public Boolean getVertical()

Indicates whether this is a vertical or horizontal slider.

Returns:: Boolean
See Also:: Slider Example

setVThumbStyle

public void setVThumbStyle(String vThumbStyle)
                    throws IllegalStateException

Optional CSS style for the thumb for a vertically oriented slider. See hThumbStyle for state suffixes.

Parameters:: vThumbStyle - vThumbStyle Default value is null
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getVThumbStyle

public String getVThumbStyle()

Optional CSS style for the thumb for a vertically oriented slider. See hThumbStyle for state suffixes.

Returns:: String

setVTrackStyle

public void setVTrackStyle(String vTrackStyle)
                    throws IllegalStateException

Optional CSS style for the track for a vertically oriented slider.

Will have the suffix "Disabled" added when the slider is disabled.

Parameters:: vTrackStyle - vTrackStyle Default value is null
Throws:: IllegalStateException - this property cannot be changed after the component has been created

getVTrackStyle

public String getVTrackStyle()

Optional CSS style for the track for a vertically oriented slider.

Will have the suffix "Disabled" added when the slider is disabled.

Returns:: String

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 Boolean valueIsChanging()

Call this method in your Slider.valueChanged 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

setDefaultProperties

public static void setDefaultProperties(Slider sliderProperties)

Class level method to set the default properties of this class. If set, then all subsequent instances of this class will automatically have the default properties that were set when this method was called. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.

Note: This method is intended for setting default attributes only and will effect all instances of the underlying class (including those automatically generated in JavaScript). This method should not be used to apply standard EventHandlers or override methods for a class - use a custom subclass instead.

Parameters:: sliderProperties - properties that should be used as new defaults when instances of this class are created

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.smartgwt.client.widgets Class Slider

Slider

Slider

Slider

getOrCreateRef

create

setAnimateThumb

getAnimateThumb

setAnimateThumbInit

getAnimateThumbInit

setAnimateThumbTime

getAnimateThumbTime

setCanFocus

getCanFocus

setFlipValues

getFlipValues

setHThumbStyle

getHThumbStyle

setHTrackStyle

getHTrackStyle

setLabelHeight

getLabelHeight

setLabelSpacing

getLabelSpacing

setLabelWidth

getLabelWidth

setLength

getLength

setMaxValue

getMaxValue

setMaxValueLabel

getMaxValueLabel

setMinValue

getMinValue

setMinValueLabel

getMinValueLabel

setNumValues

getNumValues

setRoundPrecision

getRoundPrecision

setRoundValues

getRoundValues

setShowRange

getShowRange

setShowTitle

getShowTitle

setShowValue

getShowValue

setStepPercent

getStepPercent

setThumbSrc

getThumbSrc

setThumbThickWidth

getThumbThickWidth

setThumbThinWidth

getThumbThinWidth

setTitle

getTitle

setTrackCapSize

getTrackCapSize

setTrackImageType

getTrackImageType

setTrackSrc

getTrackSrc

setTrackWidth

getTrackWidth

setValue

getValue

setVertical

getVertical

setVThumbStyle

getVThumbStyle

setVTrackStyle

getVTrackStyle

addValueChangedHandler

valueIsChanging

setDefaultProperties

com.smartgwt.client.widgets
Class Slider