Class Slider
- All Implemented Interfaces:
HasAttachHandlers,HasHandlers,EventListener,HasVisibility,IsWidget,LogicalStructure,HasClearHandlers,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,HasRuleContextChangedHandlers,HasScrolledHandlers,HasShowContextMenuHandlers,HasValueChangedHandlers,HasVisibilityChangedHandlers
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, factoryCreated, factoryProperties, id, nativeObject, scClassNameFields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionAdd a valueChanged handler.static voidchangeAutoChildDefaults(String autoChildName, Canvas defaults) Changes the defaults for Canvas AutoChildren namedautoChildName.static voidchangeAutoChildDefaults(String autoChildName, FormItem defaults) Changes the defaults for FormItem AutoChildren namedautoChildName.protected JavaScriptObjectcreate()A styled canvas used to highlight theactivepart of the slider track.CSS style used to highlight theactivepart of the slider track.Should the thumb be animated to its new position when the value is changed programmatically, or by clicking in the slider track.If thumb animation is enabled, should the thumb be animated to its initial value?intDuration of thumb animation, in milliseconds.Indicates whether keyboard manipulation of the slider is allowed.Specifies whether the value range of the slider should be flipped so that values increase as the thumb is moved down (for averticalslider) or to the left (for a horizontal slider).The space around the labels used to display theminimum, maximumandcurrentvalues of the slider, whenverticalis false.Optional CSS style for the thumb for ahorizontally orientedslider.Optional CSS style for the track for ahorizontally orientedslider.Optional CSS style for the floatingvalueLabel, visible whenshowValueis true andverticalis false.intThe height of the labels used to display theminimum, maximumandcurrentvalues of the slider.intThe space around the labels used to display theminimum, maximumandcurrentvalues of the slider.intThe width of the labels used to display the minimum, maximum and current values of the slider.intUsed to set slider height if vertical, slider width if horizontal.Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.floatDeprecated.doubleThe maximum slider value.The text displayed in the label for the maximum value of the slider.floatDeprecated.doubleThe minimum slider value.The text displayed in the label for the minimum value of the slider.The number of discrete values represented by slider.static SlidergetOrCreateRef(JavaScriptObject jsObj) FormatStringfor numeric formatting of the range labels.Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists.CSS style for themin and maxrange-labels, whenshowRangeis true.intIfroundValuesis false, the slider value will be rounded to this number of decimal places.Specifies whether the slider value should be rounded to the nearest integer.Whether to show theactiveTrack, which highlights the 'active' portion of a slider, from its minimum to its currentvalue.Indicates whether labels for themin and max valuesof the slider should be displayed.Indicates whether the slider'stitleshould be displayed.Indicates whether alabelfor the value of the slider should be displayed.floatDeprecated.doubleThe percentage of the total slider that constitutes one discrete step.The base filename for the slider thumb images.intThe dimension of the thumb perpendicular to the slider track.intThe dimension of the thumb parallel to the slider track.getTitle()Optional display title for the slider.intThe space between thetitleand the track.CSS style for thetitle-text, whenshowTitleis true.intThe height ofverticalslider start and end images, or width of horizontal slider start and end images.The imageType setting for the slider track.The base filename for the slider track images.intThe thickness of the track.floatgetValue()Deprecated.doubleThe slider value.FormatStringfor numeric formatting of the value and range labels.com.smartgwt.client.types.AutoChilddisplaying the current value as a floating label whenshowValueis true.CSS style for the floatingvalueLabel, visible whenshowValueis true.CSS style for the text in the floatingvalueLabel, visible whenshowValueis true.Indicates whether this is a vertical or horizontal slider.The space around the labels used to display theminimum, maximumandcurrentvalues of the slider, whenverticalis true.Optional CSS style for the thumb for avertically orientedslider.Optional CSS style for the track for avertically orientedslider.Optional CSS style for the floatingvalueLabel, visible whenshowValueis true andverticalis true.setActiveTrackStyle(String activeTrackStyle) CSS style used to highlight theactivepart of the slider track.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.setAnimateThumbInit(Boolean animateThumbInit) If thumb animation is enabled, should the thumb be animated to its initial value?setAnimateThumbTime(int animateThumbTime) Duration of thumb animation, in milliseconds.setCanFocus(Boolean canFocus) Indicates whether keyboard manipulation of the slider is allowed.static voidsetDefaultProperties(Slider sliderProperties) Class level method to set the default properties of this class.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 averticalslider) or to the left (for a horizontal slider).setHLabelSpacing(Integer hLabelSpacing) The space around the labels used to display theminimum, maximumandcurrentvalues of the slider, whenverticalis false.setHThumbStyle(String hThumbStyle) Optional CSS style for the thumb for ahorizontally orientedslider.setHTrackStyle(String hTrackStyle) Optional CSS style for the track for ahorizontally orientedslider.setHValueStyle(String hValueStyle) Optional CSS style for the floatingvalueLabel, visible whenshowValueis true andverticalis false.setLabelHeight(int labelHeight) The height of the labels used to display theminimum, maximumandcurrentvalues of the slider.setLabelSpacing(int labelSpacing) The space around the labels used to display theminimum, maximumandcurrentvalues of the slider.setLabelWidth(int labelWidth) The width of the labels used to display the minimum, maximum and current values of the slider.setLength(int length) Used to set slider height if vertical, slider width if horizontal.Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.setMaxValue(double maxValue) The maximum slider value.setMaxValue(float maxValue) Deprecated.setMaxValueLabel(String maxValueLabel) The text displayed in the label for the maximum value of the slider.setMinValue(double minValue) The minimum slider value.setMinValue(float minValue) Deprecated.setMinValueLabel(String minValueLabel) The text displayed in the label for the minimum value of the slider.setNumValues(Integer numValues) The number of discrete values represented by slider.setRangeFormat(String rangeFormat) FormatStringfor numeric formatting of the range labels.setRangeStyle(String rangeStyle) CSS style for themin and maxrange-labels, whenshowRangeis true.setRoundPrecision(int roundPrecision) IfroundValuesis false, the slider value will be rounded to this number of decimal places.setRoundValues(Boolean roundValues) Specifies whether the slider value should be rounded to the nearest integer.setShowActiveTrack(Boolean showActiveTrack) Whether to show theactiveTrack, which highlights the 'active' portion of a slider, from its minimum to its currentvalue.setShowRange(Boolean showRange) Indicates whether labels for themin and max valuesof the slider should be displayed.setShowTitle(Boolean showTitle) Indicates whether the slider'stitleshould be displayed.setShowValue(Boolean showValue) Indicates whether alabelfor the value of the slider should be displayed.setStepPercent(double stepPercent) The percentage of the total slider that constitutes one discrete step.setStepPercent(float stepPercent) Deprecated.setThumbSrc(String thumbSrc) The base filename for the slider thumb images.setThumbThickWidth(int thumbThickWidth) The dimension of the thumb perpendicular to the slider track.setThumbThinWidth(int thumbThinWidth) The dimension of the thumb parallel to the slider track.voidOptional display title for the slider.setTitleSpacing(int titleSpacing) The space between thetitleand the track.setTitleStyle(String titleStyle) CSS style for thetitle-text, whenshowTitleis true.setTrackCapSize(int trackCapSize) The height ofverticalslider start and end images, or width of horizontal slider start and end images.setTrackImageType(ImageStyle trackImageType) The imageType setting for the slider track.setTrackSrc(String trackSrc) The base filename for the slider track images.setTrackWidth(int trackWidth) The thickness of the track.setValue(double value) The slider value.setValue(float value) Deprecated.setValueFormat(String valueFormat) FormatStringfor numeric formatting of the value and range labels.setValueStyle(String valueStyle) CSS style for the floatingvalueLabel, visible whenshowValueis true.setValueTextStyle(String valueTextStyle) CSS style for the text in the floatingvalueLabel, visible whenshowValueis true.setVertical(Boolean vertical) Indicates whether this is a vertical or horizontal slider.setVLabelSpacing(Integer vLabelSpacing) The space around the labels used to display theminimum, maximumandcurrentvalues of the slider, whenverticalis true.setVThumbStyle(String vThumbStyle) Optional CSS style for the thumb for avertically orientedslider.setVTrackStyle(String vTrackStyle) Optional CSS style for the track for avertically orientedslider.setVValueStyle(String vValueStyle) Optional CSS style for the floatingvalueLabel, visible whenshowValueis true andverticalis true.Call this method in yourSlider.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, addChild, addChild, addClearHandler, 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, addPeer, addPeer, addResizedHandler, addRightMouseDownHandler, addRuleContextChangedHandler, addScrolledHandler, addShowContextMenuHandler, addSnapAlignCandidate, addStyleName, addVisibilityChangedHandler, adjustForContent, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateFade, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateHide, animateMove, animateMove, animateMove, animateMove, animateRect, animateRect, animateRect, animateRect, animateResize, animateResize, animateResize, animateResize, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateScroll, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, animateShow, asSGWTComponent, blur, bringToFront, clear, clearExplicitTabIndex, clickMaskUp, clickMaskUp, contains, contains, containsEvent, containsEventTarget, containsFocus, containsPoint, containsPoint, dataContextChanged, deparent, depeer, disable, enable, encloses, focus, focusAfterGroup, focusAtEnd, focusInNextTabElement, focusInPreviousTabElement, getAbsoluteLeft, getAbsoluteTop, getAccessKey, getAdaptiveHeightPriority, getAdaptiveWidthPriority, getAlwaysManageFocusNavigation, getAlwaysShowScrollbars, getAnimateAcceleration, getAnimateFadeTime, getAnimateHideAcceleration, getAnimateHideEffect, getAnimateHideTime, getAnimateMoveAcceleration, getAnimateMoveTime, getAnimateRectAcceleration, getAnimateRectTime, getAnimateResizeAcceleration, getAnimateResizeLayoutMode, getAnimateResizeTime, getAnimateScrollAcceleration, getAnimateScrollTime, getAnimateShowAcceleration, getAnimateShowEffect, getAnimateShowTime, getAnimateTime, getAppImgDir, getAriaHandleID, getAriaRole, getAriaStateDefaults, getAutoMaskComponents, getAutoParent, getAutoPopulateData, getAutoShowParent, getBackgroundColor, getBackgroundImage, getBackgroundPosition, getBackgroundRepeat, getBorder, getBorderRadius, getBottom, getById, getByJSObject, getByLocalId, getCanAcceptDrop, getCanAdaptHeight, getCanAdaptWidth, getCanDrag, getCanDragReposition, getCanDragResize, getCanDragScroll, getCanDrop, getCanDropBefore, getCanHover, getCanSelectText, getCanvasAutoChild, getCanvasItem, getChildren, getChildrenResizeSnapAlign, getChildrenSnapAlign, getChildrenSnapCenterAlign, getChildrenSnapEdgeAlign, getChildrenSnapResizeToGrid, getChildrenSnapToGrid, getChildTabPosition, getClassName, getComponentMask, getComponentMaskDefaults, getContentElement, getContents, getContextMenu, getCorrectZoomOverflow, getCursor, getDataContext, getDataPath, getDefaultHeight, getDefaultWidth, getDefiningProperty, getDefiningPropertyName, getDefiningPropertyNameOptions, getDestroyed, getDestroying, getDisabled, getDisabledCursor, getDisableTouchScrollingForDrag, getDoubleClickDelay, getDragAppearance, getDragIntersectStyle, getDragMaskType, getDragMaxHeight, getDragMaxWidth, getDragMinHeight, getDragMinWidth, getDragOpacity, getDragRepositionAppearance, getDragRepositionCursor, getDragResizeAppearance, getDragScrollDelay, getDragStartDistance, getDragTarget, getDragTargetAsString, getDragType, getDropTarget, getDropTargetAsString, getDropTypes, getDropTypesAsString, getDynamicContents, getEdgeBackgroundColor, getEdgeCenterBackgroundColor, getEdgeImage, getEdgeMarginSize, getEdgeOffset, getEdgeOpacity, getEdgeShowCenter, getEdgeSize, getEditNode, getEditProxy, getEditProxyConstructor, getElement, getElement, getEnableWhen, getEndLine, getEventEdge, getEventEdge, getExtraSpace, getFacetId, getFloatingScrollbars, getFormItemAutoChild, getForwardSVGeventsToObject, getFullDataPath, getGroupBorderCSS, getGroupLabelBackgroundColor, getGroupLabelStyleName, getGroupPadding, getGroupTitle, getHeight, getHeightAsString, getHideUsingDisplayNone, getHoverAlign, getHoverAutoDestroy, getHoverAutoFitMaxWidth, getHoverAutoFitMaxWidthAsString, getHoverAutoFitWidth, getHoverComponent, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHTML, getHoverMoveWithMouse, getHoverOpacity, getHoverPersist, getHoverScreen, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWrap, getHSnapPosition, getHSnapPosition, getHtmlElement, getHtmlElementAsString, getHtmlPosition, getImage, getImgURL, getImgURL, getInnerContentHeight, getInnerContentWidth, getInnerHeight, getInnerWidth, getIsGroup, getIsPrinting, getIsRuleScope, getIsSnapAlignCandidate, getKeepInParentRect, getLayoutAlign, getLeaveGroupLabelSpace, getLeavePageSpace, getLeft, getLeftAsString, getLocalId, getLocateByIDOnly, getLocateChildrenBy, getLocateChildrenType, getLocatePeersBy, getLocatePeersType, getLocatorName, getMargin, getMasterCanvas, getMasterElement, getMatchElement, getMatchElementHeight, getMatchElementWidth, getMaxHeight, getMaxWidth, getMaxZoomOverflowError, getMenuConstructor, getMinHeight, getMinNonEdgeSize, getMinWidth, getMomentumScrollMinSpeed, getMouseStillDownDelay, getMouseStillDownInitialDelay, getName, getNativeAutoHideScrollbars, getNextZIndex, getNoDoubleClicks, getNoDropCursor, getOffsetHeight, getOffsetWidth, getOffsetX, getOffsetY, getOpacity, getOuterElement, getOverflow, getPadding, getPageBottom, getPageLeft, getPageRect, getPageRight, getPageTop, getPaletteDefaults, getPanelContainer, getParentCanvas, getParentElement, getPeers, getPendingMarkerStyle, getPendingMarkerVisible, getPercentBox, getPercentSource, getPersistentMatchElement, getPointerSettings, getPointerTarget, getPointerTargetAsString, getPosition, getPrefix, getPrintChildrenAbsolutelyPositioned, getPrintHTML, getPrintHTML, getPrintStyleName, getPrompt, getProportionalResizeModifiers, getProportionalResizing, getReceiveScrollbarEvents, getRect, getRedrawOnResize, getResizeBarTarget, getResizeFrom, getRight, getRuleContext, getRuleContext, getRuleScope, getScrollbarSize, getScrollBottom, getScrollHeight, getScrollLeft, getScrollRight, getScrollTop, getScrollWidth, getShadowColor, getShadowDepth, getShadowHOffset, getShadowImage, getShadowOffset, getShadowSoftness, getShadowSpread, getShadowVOffset, getShouldPrint, getShowCustomScrollbars, getShowDragShadow, getShowEdges, getShowHover, getShowHoverComponents, getShowPointer, getShowResizeBar, getShowShadow, getShowSnapGrid, getShrinkElementOnHide, getSizeMayChangeOnRedraw, getSkinImgDir, getSnapAlignCandidates, getSnapAlignCenterLineStyle, getSnapAlignEdgeLineStyle, getSnapAxis, getSnapEdge, getSnapGridLineProperties, getSnapGridStyle, getSnapHDirection, getSnapHGap, getSnapOffsetLeft, getSnapOffsetTop, getSnapOnDrop, getSnapPosition, getSnapPosition, getSnapResizeToAlign, getSnapResizeToGrid, getSnapTo, getSnapToAlign, getSnapToCenterAlign, getSnapToEdgeAlign, getSnapToGrid, getSnapVDirection, getSnapVGap, getStartLine, getStyleName, getTabIndex, getTestDataContext, getTestInstance, getTooltip, getTop, getTopAsString, getTopElement, getUISummary, getUpdateTabPositionOnDraw, getUpdateTabPositionOnReparent, getUseBackMask, getUseCSSShadow, getUseDragMask, getUseImageForSVG, getUseNativeDrag, getUseOpacityFilter, getUseTouchScrolling, getValuesManager, getValuesManagerAsString, getViewportHeight, getViewportWidth, getVisibility, getVisibleHeight, getVisibleWhen, getVisibleWidth, getVSnapPosition, getVSnapPosition, getWidth, getWidthAsString, getWorkflows, getZIndex, getZIndex, handleHover, hide, hideClickMask, hideClickMask, hideComponentMask, hideComponentMask, hideContextMenu, imgHTML, imgHTML, imgHTML, initComplete, intersects, isDirty, isDisabled, isFocused, isVisible, keyUp, layoutChildren, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, linkHTML, markForDestroy, markForRedraw, markForRedraw, moveAbove, moveBelow, moveBy, moveTo, onAttach, onDetach, onInit, pageScrollDown, pageScrollUp, parentResized, placeNear, placeNear, placeNear, print, print, print, print, printComponents, provideRuleContext, provideRuleContext, redraw, redraw, registerFontScaledPaddingStyles, removeChild, removeChild, removePeer, removePeer, removeRuleContext, removeSnapAlignCandidate, resizeAutoChildAttributes, resizeBy, resizeControls, resizeControlsTo, resizeFonts, resizeFonts, resizeFonts, resizeFontsTo, resizeIcons, resizePadding, resizePadding, resizeTo, resizeTo, revealChild, revealChild, scrollBy, scrollByPercent, scrollTo, scrollTo, scrollTo, scrollTo, scrollTo, scrollToBottom, scrollToLeft, scrollToPercent, scrollToRight, scrollToTop, sendToBack, setAccessKey, setAdaptHeightByCustomizer, setAdaptiveHeightPriority, setAdaptiveWidthPriority, setAdaptWidthByCustomizer, setAlign, setAllowExternalFilters, setAlwaysManageFocusNavigation, setAlwaysShowScrollbars, setAnimateAcceleration, setAnimateFadeTime, setAnimateHideAcceleration, setAnimateHideEffect, setAnimateHideTime, setAnimateMoveAcceleration, setAnimateMoveTime, setAnimateRectAcceleration, setAnimateRectTime, setAnimateResizeAcceleration, setAnimateResizeLayoutMode, setAnimateResizeTime, setAnimateScrollAcceleration, setAnimateScrollTime, setAnimateShowAcceleration, setAnimateShowEffect, setAnimateShowTime, setAnimateTime, setAppImgDir, setAriaRole, setAriaState, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setAutoHeight, setAutoMaskComponents, setAutoParent, setAutoPopulateData, setAutoResizeAutoChildAttributes, setAutoResizeIcons, setAutoShowParent, setAutoWidth, setBackgroundColor, setBackgroundImage, setBackgroundPosition, setBackgroundRepeat, setBorder, setBorderRadius, setBottom, setCanAcceptDrop, setCanAdaptHeight, setCanAdaptWidth, setCanDrag, setCanDragReposition, setCanDragResize, setCanDragScroll, setCanDrop, setCanDropBefore, setCanHover, setCanSelectText, setChildren, setChildrenResizeSnapAlign, setChildrenSnapAlign, setChildrenSnapCenterAlign, setChildrenSnapEdgeAlign, setChildrenSnapResizeToGrid, setChildrenSnapToGrid, setComponentMaskDefaults, setContents, setContextMenu, setCorrectZoomOverflow, setCursor, setDataContext, setDataPath, setDefaultHeight, setDefaultPageSpace, setDefaultProperties, setDefaultShowCustomScrollbars, setDefaultWidth, setDefiningProperty, setDefiningPropertyNameOptions, setDisabled, setDisabledCursor, setDisableTouchScrollingForDrag, setDoubleClickDelay, setDragAppearance, setDragIntersectStyle, setDragMaskType, setDragMaxHeight, setDragMaxWidth, setDragMinHeight, setDragMinWidth, setDragOpacity, setDragRepositionAppearance, setDragRepositionCursor, setDragResizeAppearance, setDragScrollDelay, setDragStartDistance, setDragTarget, setDragTarget, setDragType, setDropTarget, setDropTarget, setDropTypes, setDropTypes, setDynamicContents, setEdgeBackgroundColor, setEdgeCenterBackgroundColor, setEdgeImage, setEdgeMarginSize, setEdgeOffset, setEdgeOpacity, setEdgeShowCenter, setEdgeSize, setEditMode, setEditMode, setEditMode, setEditProxyConstructor, setElement, setEnableWhen, setEndLine, setExtraSpace, setFacetId, setFloatingScrollbars, setForwardSVGeventsToObject, setGroupBorderCSS, setGroupLabelBackgroundColor, setGroupLabelStyleName, setGroupPadding, setGroupTitle, setHeight, setHeight, setHeight, setHeight100, setHideUsingDisplayNone, setHoverAlign, setHoverAutoDestroy, setHoverAutoFitMaxWidth, setHoverAutoFitMaxWidth, setHoverAutoFitWidth, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverMoveWithMouse, setHoverOpacity, setHoverPersist, setHoverScreen, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWrap, setHtmlElement, setHtmlElement, setHtmlPosition, setImage, setImage, setInitHandler, setIsGroup, setIsRuleScope, setIsSnapAlignCandidate, setKeepInParentRect, setKeepInParentRect, setKeepInParentRect, setLayoutAlign, setLayoutAlign, setLeaveGroupLabelSpace, setLeavePageSpace, setLeft, setLeft, setLocateByIDOnly, setLocateChildrenBy, setLocateChildrenType, setLocatePeersBy, setLocatePeersType, setLocatorName, setLocatorParent, setLocatorParent, setLogicalStructure, setMargin, setMatchElement, setMatchElementHeight, setMatchElementWidth, setMaxHeight, setMaxWidth, setMaxZoomOverflowError, setMenuConstructor, setMinHeight, setMinNonEdgeSize, setMinWidth, setMomentumScrollMinSpeed, setMouseStillDownDelay, setMouseStillDownInitialDelay, setName, setNativeAutoHideScrollbars, setNeverUseFilters, setNoDoubleClicks, setNoDropCursor, setOpacity, setOverflow, setPadding, setPageLeft, setPageTop, setPanelContainer, setParentCanvas, setParentElement, setPeers, setPendingMarkerStyle, setPendingMarkerVisible, setPercentBox, setPercentSource, setPersistentMatchElement, setPointerSettings, setPointerTarget, setPosition, setPrefix, setPrintChildrenAbsolutelyPositioned, setPrintStyleName, setPrompt, setProportionalResizeModifiers, setProportionalResizing, setReceiveScrollbarEvents, setRect, setRect, setRedrawOnResize, setRelativeTabPosition, setResizeBarTarget, setResizeFrom, setResizeFrom, setRight, setRuleScope, setScrollbarConstructor, setScrollbarSize, setShadowColor, setShadowDepth, setShadowHOffset, setShadowImage, setShadowOffset, setShadowSoftness, setShadowSpread, setShadowVOffset, setShouldPrint, setShowCustomScrollbars, setShowDragShadow, setShowEdges, setShowHover, setShowHoverComponents, setShowPointer, setShowResizeBar, setShowShadow, setShowSnapGrid, setShrinkElementOnHide, setSizeMayChangeOnRedraw, setSkinImgDir, setSmoothFade, setSnapAlignCandidates, setSnapAlignCenterLineStyle, setSnapAlignEdgeLineStyle, setSnapAxis, setSnapEdge, setSnapGridLineProperties, setSnapGridStyle, setSnapHDirection, setSnapHGap, setSnapOffsetLeft, setSnapOffsetTop, setSnapOnDrop, setSnapResizeToAlign, setSnapResizeToGrid, setSnapTo, setSnapToAlign, setSnapToCenterAlign, setSnapToEdgeAlign, setSnapToGrid, setSnapVDirection, setSnapVGap, setStartLine, setStyleName, setTabIndex, setTestDataContext, setTooltip, setTop, setTop, setUpdateTabPositionOnDraw, setUpdateTabPositionOnReparent, setUseBackMask, setUseCSSShadow, setUseDragMask, setUseImageForSVG, setUseNativeDrag, setUseOpacityFilter, setUseTouchScrolling, setValuesManager, setValuesManager, setVisibility, setVisible, setVisibleWhen, setWidth, setWidth, setWidth, setWidth100, setWorkflows, setZIndex, shouldDragScroll, show, showClickMask, showComponentMask, showComponentMask, showNextTo, showNextTo, showNextTo, showNextTo, showPendingMarker, showPrintPreview, showPrintPreview, showPrintPreview, showPrintPreview, showRecursively, startDebuggingOverflow, stopDebuggingOverflow, updateChildTabPosition, updateChildTabPositions, updateEditNode, updateHover, updateHover, updateShadow, updateTabPositionForDraw, visibleAtPoint, willAcceptDropMethods inherited from class com.smartgwt.client.widgets.BaseWidget
addDrawHandler, addDynamicProperty, addDynamicProperty, addDynamicProperty, addDynamicProperty, applyFactoryProperties, clearDynamicProperty, completeCreation, destroy, doAddHandler, doInit, doOnRender, draw, equals, error, errorIfNotCreated, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDateArray, getAttributeAsDouble, getAttributeAsElement, getAttributeAsFloat, getAttributeAsFloatArray, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getConfig, getDOM, getHandlerCount, getID, getInnerHTML, getJsObj, getOrCreateJsObj, getRef, getScClassName, hasAutoAssignedID, hasDynamicProperty, hashCode, initNativeObject, internalSetID, internalSetID, isConfigOnly, isCreated, isDrawn, isFactoryCreated, onBind, onDestroy, onDraw, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setConfig, setConfigOnly, setDefaultProperties, setDragTracker, setFactoryCreated, setID, setJavaScriptObject, setLogicalStructure, setLogicalStructure, setNullProperty, setPosition, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setProperty, setScClassName, toStringMethods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getLayoutData, getParent, isAttached, isOrWasAttached, onBrowserEvent, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEventsMethods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getStyleElement, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEventMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
Constructor Details
-
Slider
public Slider() -
Slider
-
Slider
-
-
Method Details
-
getOrCreateRef
-
changeAutoChildDefaults
Changes the defaults for Canvas AutoChildren namedautoChildName.- Parameters:
autoChildName- name of an AutoChild to customize the defaults for.defaults- Canvas defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, seeSGWTProperties.- See Also:
-
changeAutoChildDefaults
Changes the defaults for FormItem AutoChildren namedautoChildName.- Parameters:
autoChildName- name of an AutoChild to customize the defaults for.defaults- FormItem defaults to apply. These defaults override any existing properties without destroying or wiping out non-overridden properties. For usage tips on this param, seeSGWTProperties.- See Also:
-
create
-
getActiveTrack
A styled canvas used to highlight theactivepart of the slider track.This component is an AutoChild named "activeTrack". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current activeTrack value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setActiveTrackStyle
CSS style used to highlight theactivepart of the slider track.Will have the suffix "Disabled" added when the slider is disabled.
- Parameters:
activeTrackStyle- New activeTrackStyle value. Default value is "sliderTrackActive"- Returns:
Sliderinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getActiveTrackStyle
CSS style used to highlight theactivepart of the slider track.Will have the suffix "Disabled" added when the slider is disabled.
- Returns:
- Current activeTrackStyle value. Default value is "sliderTrackActive"
- See Also:
-
setAnimateThumb
Should the thumb be animated to its new position when the value is changed programmatically, or by clicking in the slider track.- Parameters:
animateThumb- New animateThumb value. Default value is true- Returns:
Sliderinstance, for chaining setter calls
-
getAnimateThumb
Should the thumb be animated to its new position when the value is changed programmatically, or by clicking in the slider track.- Returns:
- Current animateThumb value. Default value is true
-
setAnimateThumbInit
If thumb animation is enabled, should the thumb be animated to its initial value?- Parameters:
animateThumbInit- New animateThumbInit value. Default value is false- Returns:
Sliderinstance, for chaining setter calls
-
getAnimateThumbInit
If thumb animation is enabled, should the thumb be animated to its initial value?- Returns:
- Current animateThumbInit value. Default value is false
-
setAnimateThumbTime
Duration of thumb animation, in milliseconds.- Parameters:
animateThumbTime- New animateThumbTime value. Default value is 250- Returns:
Sliderinstance, for chaining setter calls
-
getAnimateThumbTime
public int getAnimateThumbTime()Duration of thumb animation, in milliseconds.- Returns:
- Current animateThumbTime value. Default value is 250
-
setCanFocus
Indicates whether keyboard manipulation of the slider is allowed.- Overrides:
setCanFocusin classCanvas- Parameters:
canFocus- New canFocus value. Default value is true- Returns:
Sliderinstance, for chaining setter calls- See Also:
-
getCanFocus
Indicates whether keyboard manipulation of the slider is allowed.- Overrides:
getCanFocusin classCanvas- Returns:
- Current canFocus value. Default value is true
- See Also:
-
setFlipValues
Specifies whether the value range of the slider should be flipped so that values increase as the thumb is moved down (for averticalslider) or to the left (for a horizontal slider).
If this method is called after the component has been drawn/initialized: Sets theflipValuesproperty of the slider- Parameters:
flipValues- flip slider values?. Default value is false- Returns:
Sliderinstance, for chaining setter calls
-
getFlipValues
Specifies whether the value range of the slider should be flipped so that values increase as the thumb is moved down (for averticalslider) or to the left (for a horizontal slider).- Returns:
- Current flipValues value. Default value is false
-
setHLabelSpacing
The space around the labels used to display theminimum, maximumandcurrentvalues of the slider, whenverticalis false. If unset, defaults tolabelSpacing.- Parameters:
hLabelSpacing- New hLabelSpacing value. Default value is null- Returns:
Sliderinstance, for chaining setter calls
-
getHLabelSpacing
The space around the labels used to display theminimum, maximumandcurrentvalues of the slider, whenverticalis false. If unset, defaults tolabelSpacing.- Returns:
- Current hLabelSpacing value. Default value is null
-
setHThumbStyle
Optional CSS style for the thumb for ahorizontally orientedslider.Will have the suffix "down" added when the mouse is down on the thumb, and "Disabled" added when the slider is disabled.
- Parameters:
hThumbStyle- New hThumbStyle value. Default value is null- Returns:
Sliderinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getHThumbStyle
Optional CSS style for the thumb for ahorizontally orientedslider.Will have the suffix "down" added when the mouse is down on the thumb, and "Disabled" added when the slider is disabled.
- Returns:
- Current hThumbStyle value. Default value is null
- See Also:
-
setHTrackStyle
Optional CSS style for the track for ahorizontally orientedslider.Will have the suffix "Disabled" added when the slider is disabled.
- Parameters:
hTrackStyle- New hTrackStyle value. Default value is null- Returns:
Sliderinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getHTrackStyle
Optional CSS style for the track for ahorizontally orientedslider.Will have the suffix "Disabled" added when the slider is disabled.
- Returns:
- Current hTrackStyle value. Default value is null
- See Also:
-
setHValueStyle
Optional CSS style for the floatingvalueLabel, visible whenshowValueis true andverticalis false.- Parameters:
hValueStyle- New hValueStyle value. Default value is null- Returns:
Sliderinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getHValueStyle
Optional CSS style for the floatingvalueLabel, visible whenshowValueis true andverticalis false.- Returns:
- Current hValueStyle value. Default value is null
- See Also:
-
setLabelHeight
The height of the labels used to display theminimum, maximumandcurrentvalues of the slider.
If this method is called after the component has been drawn/initialized: Sets thelabelHeightproperty of the slider- Parameters:
labelHeight- new label height. Default value is 20- Returns:
Sliderinstance, for chaining setter calls
-
getLabelHeight
public int getLabelHeight()The height of the labels used to display theminimum, maximumandcurrentvalues of the slider.- Returns:
- Current labelHeight value. Default value is 20
-
setLabelSpacing
The space around the labels used to display theminimum, maximumandcurrentvalues of the slider.
If this method is called after the component has been drawn/initialized: Sets thelabelSpacingproperty of the slider- Parameters:
labelSpacing- new label spacing. Default value is 5- Returns:
Sliderinstance, for chaining setter calls
-
getLabelSpacing
public int getLabelSpacing()The space around the labels used to display theminimum, maximumandcurrentvalues of the slider.- Returns:
- Current labelSpacing value. Default value is 5
-
setLabelWidth
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 thelabelWidthproperty of the slider- Parameters:
labelWidth- new label width. Default value is 50- Returns:
Sliderinstance, for chaining setter calls
-
getLabelWidth
public int getLabelWidth()The width of the labels used to display the minimum, maximum and current values of the slider.- Returns:
- Current labelWidth value. Default value is 50
-
setLength
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- New length value. Default value is 200- Returns:
Sliderinstance, for chaining setter calls
-
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:
- Current length value. Default value is 200
-
setMaxValue
Deprecated.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 themaximum valueof the slider- Parameters:
maxValue- the new maximum value Note:Use Doubles rather Floats when manipulating decimal values. SeeGwtFloatVsDoublefor details. Default value is 100- Returns:
Sliderinstance, for chaining setter calls- See Also:
-
getMaxValue
public float getMaxValue()Deprecated.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:
- Current maxValue value. Default value is 100
- See Also:
-
setMaxValue
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 themaximum valueof the slider- Parameters:
maxValue- the new maximum value Note:Use Doubles rather Floats when manipulating decimal values. SeeGwtFloatVsDoublefor details. Default value is 100- Returns:
Sliderinstance, for chaining setter calls- See Also:
-
getMaxValueAsDouble
public double getMaxValueAsDouble()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:
- Current maxValue value. Default value is 100
- See Also:
-
setMaxValueLabel
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 themaxValueLabelproperty of the slider- Parameters:
maxValueLabel- new label text. Default value is null- Returns:
Sliderinstance, for chaining setter calls- See Also:
-
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:
- Current maxValueLabel value. Default value is null
- See Also:
-
setMinValue
Deprecated.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 theminimum valueof the slider- Parameters:
minValue- the new minimum value Note:Use Doubles rather Floats when manipulating decimal values. SeeGwtFloatVsDoublefor details. Default value is 1- Returns:
Sliderinstance, for chaining setter calls- See Also:
-
getMinValue
public float getMinValue()Deprecated.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:
- Current minValue value. Default value is 1
- See Also:
-
setMinValue
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 theminimum valueof the slider- Parameters:
minValue- the new minimum value Note:Use Doubles rather Floats when manipulating decimal values. SeeGwtFloatVsDoublefor details. Default value is 1- Returns:
Sliderinstance, for chaining setter calls- See Also:
-
getMinValueAsDouble
public double getMinValueAsDouble()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:
- Current minValue value. Default value is 1
- See Also:
-
setMinValueLabel
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- New minValueLabel value. Default value is null- Returns:
Sliderinstance, for chaining setter calls- See Also:
-
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:
- Current minValueLabel value. Default value is null
- See Also:
-
setNumValues
The number of discrete values represented by slider. If specified, the range of valid values (betweenminValueandmaxValue) 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 thenumber of valuesfor the slider- Parameters:
numValues- the new number of values Note:Use Doubles rather Floats when manipulating decimal values. SeeGwtFloatVsDoublefor details. Default value is null- Returns:
Sliderinstance, for chaining setter calls- See Also:
-
getNumValues
The number of discrete values represented by slider. If specified, the range of valid values (betweenminValueandmaxValue) 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:
- Current numValues value. Default value is null
- See Also:
-
setRangeFormat
FormatStringfor numeric formatting of the range labels. If unset, defaults tovalueFormat- Parameters:
rangeFormat- New rangeFormat value. Default value is null- Returns:
Sliderinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getRangeFormat
FormatStringfor numeric formatting of the range labels. If unset, defaults tovalueFormat- Returns:
- Current rangeFormat value. Default value is null
- See Also:
-
getRangeLabel
Note : This API is non-functional (always returns null) and exists only to make you aware that this MultiAutoChild exists. SeeUsing AutoChildrenfor details.Used to create both of the min and max range-labels, via the
com.smartgwt.client.types.AutoChildpattern, hencerangeLabelConstructor,rangeLabelDefaultsandrangeLabelPropertiesare valid.- Returns:
- null
-
setRangeStyle
CSS style for themin and maxrange-labels, whenshowRangeis true.- Parameters:
rangeStyle- New rangeStyle value. Default value is "sliderRange"- Returns:
Sliderinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getRangeStyle
CSS style for themin and maxrange-labels, whenshowRangeis true.- Returns:
- Current rangeStyle value. Default value is "sliderRange"
- See Also:
-
setRoundPrecision
IfroundValuesis 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 theroundPrecisionproperty of the slider- Parameters:
roundPrecision- new round precision. Default value is 1- Returns:
Sliderinstance, for chaining setter calls
-
getRoundPrecision
public int getRoundPrecision()IfroundValuesis false, the slider value will be rounded to this number of decimal places. If set to null the value will not be rounded- Returns:
- Current roundPrecision value. Default value is 1
-
setRoundValues
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 byroundPrecision.
If this method is called after the component has been drawn/initialized: Sets theroundValuesproperty of the slider- Parameters:
roundValues- round slider values?. Default value is true- Returns:
Sliderinstance, for chaining setter calls
-
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 byroundPrecision.- Returns:
- Current roundValues value. Default value is true
-
setShowActiveTrack
Whether to show theactiveTrack, which highlights the 'active' portion of a slider, from its minimum to its currentvalue.- Parameters:
showActiveTrack- New showActiveTrack value. Default value is false- Returns:
Sliderinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created
-
getShowActiveTrack
Whether to show theactiveTrack, which highlights the 'active' portion of a slider, from its minimum to its currentvalue.- Returns:
- Current showActiveTrack value. Default value is false
-
setShowRange
Indicates whether labels for themin and max valuesof 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 averticalslider.
If this method is called after the component has been drawn/initialized: Sets theshowRangeproperty of the slider- Parameters:
showRange- show the slider range?. Default value is true- Returns:
Sliderinstance, for chaining setter calls- See Also:
-
getShowRange
Indicates whether labels for themin and max valuesof 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 averticalslider.- Returns:
- Current showRange value. Default value is true
- See Also:
-
setShowTitle
Indicates whether the slider'stitleshould be displayed. The default position for the title-label is to the left of a horizontal slider, or above averticalslider.
If this method is called after the component has been drawn/initialized: Sets theshowTitleproperty of the slider- Parameters:
showTitle- show the slider title?. Default value is true- Returns:
Sliderinstance, for chaining setter calls- See Also:
-
getShowTitle
Indicates whether the slider'stitleshould be displayed. The default position for the title-label is to the left of a horizontal slider, or above averticalslider.- Returns:
- Current showTitle value. Default value is true
- See Also:
-
setShowValue
Indicates whether alabelfor the value of the slider should be displayed. The default position for this label is to the right of averticalslider, or below a horizontal slider.
If this method is called after the component has been drawn/initialized: Sets theshowValueproperty of the slider- Parameters:
showValue- show the slider value?. Default value is true- Returns:
Sliderinstance, for chaining setter calls- See Also:
-
getShowValue
Indicates whether alabelfor the value of the slider should be displayed. The default position for this label is to the right of averticalslider, or below a horizontal slider.- Returns:
- Current showValue value. Default value is true
- See Also:
-
setStepPercent
Deprecated.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 thestepPercentproperty of the slider- Parameters:
stepPercent- new slider step percent. Default value is 5- Returns:
Sliderinstance, for chaining setter calls
-
getStepPercent
public float getStepPercent()Deprecated.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:
- Current stepPercent value. Default value is 5
-
setStepPercent
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 thestepPercentproperty of the slider- Parameters:
stepPercent- new slider step percent. Default value is 5- Returns:
Sliderinstance, for chaining setter calls
-
getStepPercentAsDouble
public double getStepPercentAsDouble()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:
- Current stepPercent value. Default value is 5
-
setThumbSrc
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.
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 thethumbSrcproperty of the slider- Parameters:
thumbSrc- new thumbSrc. Default value is "thumb.gif"- Returns:
Sliderinstance, for chaining setter calls
-
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}_Disabled.{extension}: appearance when the slider is disabled.
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:
- Current thumbSrc value. Default value is "thumb.gif"
-
setThumbThickWidth
The dimension of the thumb perpendicular to the slider track.
If this method is called after the component has been drawn/initialized: Sets thethumbThickWidthproperty of the slider- Parameters:
thumbThickWidth- new thumbThickWidth. Default value is 23- Returns:
Sliderinstance, for chaining setter calls
-
getThumbThickWidth
public int getThumbThickWidth()The dimension of the thumb perpendicular to the slider track.- Returns:
- Current thumbThickWidth value. Default value is 23
-
setThumbThinWidth
The dimension of the thumb parallel to the slider track.
If this method is called after the component has been drawn/initialized: Sets thethumbThinWidthproperty of the slider- Parameters:
thumbThinWidth- new thumbThinWidth. Default value is 17- Returns:
Sliderinstance, for chaining setter calls
-
getThumbThinWidth
public int getThumbThinWidth()The dimension of the thumb parallel to the slider track.- Returns:
- Current thumbThinWidth value. Default value is 17
-
setTitle
Optional display title for the slider.
If this method is called after the component has been drawn/initialized: Sets thetitleof the slider -
getTitle
Optional display title for the slider. -
setTitleSpacing
The space between thetitleand the track.- Parameters:
titleSpacing- New titleSpacing value. Default value is 5- Returns:
Sliderinstance, for chaining setter calls
-
getTitleSpacing
public int getTitleSpacing()The space between thetitleand the track.- Returns:
- Current titleSpacing value. Default value is 5
-
setTitleStyle
CSS style for thetitle-text, whenshowTitleis true.- Parameters:
titleStyle- New titleStyle value. Default value is "sliderTitle"- Returns:
Sliderinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getTitleStyle
CSS style for thetitle-text, whenshowTitleis true.- Returns:
- Current titleStyle value. Default value is "sliderTitle"
- See Also:
-
setTrackCapSize
The height ofverticalslider 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 thetrackCapSizeproperty of the slider- Parameters:
trackCapSize- new trackCapSize. Default value is 6- Returns:
Sliderinstance, for chaining setter calls
-
getTrackCapSize
public int getTrackCapSize()The height ofverticalslider start and end images, or width of horizontal slider start and end images.- Returns:
- Current trackCapSize value. Default value is 6
-
setTrackImageType
The imageType setting for the slider track.
If this method is called after the component has been drawn/initialized: Sets thetrackImageTypeproperty of the slider- Parameters:
trackImageType- new trackImageType. Default value is "stretch"- Returns:
Sliderinstance, for chaining setter calls- See Also:
-
getTrackImageType
The imageType setting for the slider track.- Returns:
- Current trackImageType value. Default value is "stretch"
- See Also:
-
setTrackSrc
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.
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 thetrackSrcproperty of the slider- Parameters:
trackSrc- new trackSrc. Default value is "track.gif"- Returns:
Sliderinstance, for chaining setter calls- See Also:
-
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}_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.
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:
- Current trackSrc value. Default value is "track.gif"
- See Also:
-
setTrackWidth
The thickness of the track. This is the width, for averticalslider, or the height, for a horizontal slider.
If this method is called after the component has been drawn/initialized: Sets thetrackWidthproperty of the slider- Parameters:
trackWidth- new trackWidth. Default value is 7- Returns:
Sliderinstance, for chaining setter calls
-
getTrackWidth
public int getTrackWidth()The thickness of the track. This is the width, for averticalslider, or the height, for a horizontal slider.- Returns:
- Current trackWidth value. Default value is 7
-
setValue
Deprecated.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 Note:Use Doubles rather Floats when manipulating decimal values. SeeGwtFloatVsDoublefor details. Default value is 1- Returns:
Sliderinstance, for chaining setter calls- See Also:
-
getValue
public float getValue()Deprecated.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. Default value is 1
- See Also:
-
setValue
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 Note:Use Doubles rather Floats when manipulating decimal values. SeeGwtFloatVsDoublefor details. Default value is 1- Returns:
Sliderinstance, for chaining setter calls- See Also:
-
getValueAsDouble
public double getValueAsDouble()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. Default value is 1
- See Also:
-
setValueFormat
FormatStringfor numeric formatting of the value and range labels.- Parameters:
valueFormat- New valueFormat value. Default value is null- Returns:
Sliderinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getValueFormat
FormatStringfor numeric formatting of the value and range labels.- Returns:
- Current valueFormat value. Default value is null
- See Also:
-
getValueLabel
com.smartgwt.client.types.AutoChilddisplaying the current value as a floating label whenshowValueis true.This component is an AutoChild named "valueLabel". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current valueLabel value. Default value is null
- Throws:
IllegalStateException- if this widget has not yet been rendered.
-
setValueStyle
CSS style for the floatingvalueLabel, visible whenshowValueis true.- Parameters:
valueStyle- New valueStyle value. Default value is "sliderValue"- Returns:
Sliderinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getValueStyle
CSS style for the floatingvalueLabel, visible whenshowValueis true.- Returns:
- Current valueStyle value. Default value is "sliderValue"
- See Also:
-
setValueTextStyle
CSS style for the text in the floatingvalueLabel, visible whenshowValueis true.- Parameters:
valueTextStyle- New valueTextStyle value. Default value is "sliderValueText"- Returns:
Sliderinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getValueTextStyle
CSS style for the text in the floatingvalueLabel, visible whenshowValueis true.- Returns:
- Current valueTextStyle value. Default value is "sliderValueText"
- See Also:
-
setVertical
Indicates whether this is a vertical or horizontal slider.
If this method is called after the component has been drawn/initialized: Sets theverticalproperty of the slider- Parameters:
vertical- is the slider vertical. Default value is true- Returns:
Sliderinstance, for chaining setter calls- See Also:
-
getVertical
Indicates whether this is a vertical or horizontal slider.- Returns:
- Current vertical value. Default value is true
- See Also:
-
setVLabelSpacing
The space around the labels used to display theminimum, maximumandcurrentvalues of the slider, whenverticalis true. If unset, defaults tolabelSpacing.- Parameters:
vLabelSpacing- New vLabelSpacing value. Default value is null- Returns:
Sliderinstance, for chaining setter calls
-
getVLabelSpacing
The space around the labels used to display theminimum, maximumandcurrentvalues of the slider, whenverticalis true. If unset, defaults tolabelSpacing.- Returns:
- Current vLabelSpacing value. Default value is null
-
setVThumbStyle
Optional CSS style for the thumb for avertically orientedslider. SeehThumbStylefor state suffixes.- Parameters:
vThumbStyle- New vThumbStyle value. Default value is null- Returns:
Sliderinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getVThumbStyle
Optional CSS style for the thumb for avertically orientedslider. SeehThumbStylefor state suffixes.- Returns:
- Current vThumbStyle value. Default value is null
- See Also:
-
setVTrackStyle
Optional CSS style for the track for avertically orientedslider.Will have the suffix "Disabled" added when the slider is disabled.
- Parameters:
vTrackStyle- New vTrackStyle value. Default value is null- Returns:
Sliderinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getVTrackStyle
Optional CSS style for the track for avertically orientedslider.Will have the suffix "Disabled" added when the slider is disabled.
- Returns:
- Current vTrackStyle value. Default value is null
- See Also:
-
setVValueStyle
Optional CSS style for the floatingvalueLabel, visible whenshowValueis true andverticalis true.- Parameters:
vValueStyle- New vValueStyle value. Default value is null- Returns:
Sliderinstance, for chaining setter calls- Throws:
IllegalStateException- this property cannot be changed after the component has been created- See Also:
-
getVValueStyle
Optional CSS style for the floatingvalueLabel, visible whenshowValueis true andverticalis true.- Returns:
- Current vValueStyle value. Default value is null
- See Also:
-
addValueChangedHandler
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. Add a notification to be fired whenever the slider value changes.- Specified by:
addValueChangedHandlerin interfaceHasValueChangedHandlers- Parameters:
handler- the valueChanged handler- Returns:
HandlerRegistrationused to remove this handler
-
valueIsChanging
Call this method in yourSlider.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
Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties set on the SmartGWT class instance passed to this function before its underlying SmartClient JS object was created. 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 affect 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. Calling this method after instances have been created can result in undefined behavior, since it bypasses any setters and a class instance may have already examined a particular property and not be expecting any changes through this route.
- Parameters:
sliderProperties- properties that should be used as new defaults when instances of this class are created- See Also:
-
setLogicalStructure
Setter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility. -
getLogicalStructure
Getter implementing theLogicalStructureinterface, which supports Eclipse's logical structure debugging facility.- Specified by:
getLogicalStructurein interfaceLogicalStructure- Overrides:
getLogicalStructurein classCanvas
-
GwtFloatVsDouble