com.sencha.gxt.widget.core.client

Class Slider

java.lang.Object

Widget

com.sencha.gxt.widget.core.client.Component

com.sencha.gxt.widget.core.client.cell.CellComponent<T>

com.sencha.gxt.widget.core.client.form.Field<Integer>

com.sencha.gxt.widget.core.client.Slider

All Implemented Interfaces:

HasGestureRecognizers, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, InvalidEvent.HasInvalidHandlers, MoveEvent.HasMoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, ValidEvent.HasValidHandlers, HasErrorHandler, IsField<Integer>, HasFocusSupport, HasItemId

public class Slider
extends Field<Integer>

Lets the user select a value by sliding an indicator within a bounded range.

Nested Class Summary

Nested classes/interfaces inherited from class com.sencha.gxt.widget.core.client.form.Field

Field.FieldStyles

Field Summary

Fields inherited from class com.sencha.gxt.widget.core.client.form.Field

forceInvalidText, hasFocus, name, originalValue, parseError, preventMark, validationTask

Fields inherited from class com.sencha.gxt.widget.core.client.cell.CellComponent

valueUpdater

Fields inherited from class com.sencha.gxt.widget.core.client.Component

adjustSize, allowTextSelection, cacheSizes, disableContextMenu, disabled, disabledStyle, ensureVisibilityOnSizing, height, hidden, lastSize, layer, left, mask, maskMessage, monitorWindowResize, pageX, pageY, resizeHandler, shim, tabIndex, toolTip, toolTipConfig, top, width, windowResizeDelay, windowResizeTask

Constructor Summary

Constructors

Constructor and Description
Slider() Creates a slider with the default slider cell.
Slider(boolean vertical) Creates a slider with the specified orientation.
Slider(SliderCell cell) Creates a slider with the specified slider cell.

Method Summary

Modifier and Type	Method and Description
SliderCell	getCell() Get the Cell wrapped by this widget.
int	getIncrement() Returns the increment.
int	getMaxValue() Returns the max value (defaults to 100).
String	getMessage() Returns the tool tip message.
int	getMinValue() Returns the minimum value (defaults to 0).
boolean	isShowMessage() Returns true if the tool tip message is shown
void	setIncrement(int increment) How many units to change the slider when adjusting by drag and drop.
void	setMaxValue(int maxValue) Sets the max value (defaults to 100).
void	setMessage(String message) Sets the tool tip message (defaults to '{0}').
void	setMinValue(int minValue) Sets the minimum value (defaults to 0).
void	setShowMessage(boolean showMessage) Sets if the tool tip message should be displayed (defaults to true, pre-render).
void	setToolTipConfig(ToolTipConfig toolTipConfig) Set the tooltip config.

Methods inherited from class com.sencha.gxt.widget.core.client.form.Field

addInvalidHandler, addValidator, addValidHandler, addValueChangeHandler, clear, clearInvalid, doAutoValidate, finishEditing, flush, forceInvalid, getErrors, getErrorSupport, getName, getOriginalValue, getValidateOnBlur, getValidationDelay, getValidators, isAutoValidate, isEditing, isValid, isValid, markInvalid, markInvalid, onBlur, onBrowserEvent, onDetach, onDisable, onEnable, onFocus, onKeyDown, onKeyPress, onKeyUp, onLogicalBlur, onLogicalFocus, onNavigationKey, onPropertyChange, onRedraw, removeValidator, reset, setAutoValidate, setDelegate, setErrors, setErrorSupport, setName, setOriginalValue, setReadOnly, setValidateOnBlur, setValidationDelay, setValue, showErrors, validate, validate, validateValue

Methods inherited from class com.sencha.gxt.widget.core.client.cell.CellComponent

createContext, getElement, getFocusEl, getKey, getKeyProvider, getValue, onResize, redraw, redraw, setKeyProvider, setValue, setValue

Methods inherited from class com.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addGestureRecognizer, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleDependentName, addStyleOnOver, adjustPosition, adjustSize, applyState, assertAfterRender, assertPreRender, blur, clearSizeCache, disable, disableContextMenu, disableEvents, enable, enableEvents, fireCancellableEvent, fireEvent, focus, getData, getFocusSupport, getGestureRecognizer, getGestureRecognizerCount, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getPositionEl, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideShadow, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, notifyHide, notifyShow, onAfterFirstAttach, onAttach, onHide, onHideContextMenu, onLoad, onPosition, onRightClick, onShow, onShowContextMenu, onTouch, onUnload, onWindowResize, removeStyleDependentName, removeStyleOnOver, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setMonitorWindowResize, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setStyleDependentName, setTabIndex, setToolTip, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sencha.gxt.widget.core.client.event.BlurEvent.HasBlurHandlers

addBlurHandler

Constructor Detail

Slider

public Slider()

Creates a slider with the default slider cell.

Slider

public Slider(boolean vertical)

Creates a slider with the specified orientation.

Parameters:

vertical - true to create a vertical slider

Slider

public Slider(SliderCell cell)

Creates a slider with the specified slider cell.

Parameters:

cell - the cell for this slider

Method Detail

getCell

public SliderCell getCell()

Description copied from class: CellComponent

Get the Cell wrapped by this widget.

Overrides:

getCell in class Field<Integer>

Returns:

the Cell being wrapped

getIncrement

public int getIncrement()

Returns the increment.

Returns:

the increment

getMaxValue

public int getMaxValue()

Returns the max value (defaults to 100).

Returns:

the max value

getMessage

public String getMessage()

Returns the tool tip message.

Returns:

the tool tip message

getMinValue

public int getMinValue()

Returns the minimum value (defaults to 0).

Returns:

the minimum value

isShowMessage

public boolean isShowMessage()

Returns true if the tool tip message is shown

Returns:

the showMessage state

setIncrement

public void setIncrement(int increment)

How many units to change the slider when adjusting by drag and drop. Use this option to enable 'snapping' (default to 10).

Parameters:

increment - the increment

setMaxValue

public void setMaxValue(int maxValue)

Sets the max value (defaults to 100).

Parameters:

maxValue - the max value

setMessage

public void setMessage(String message)

Sets the tool tip message (defaults to '{0}'). "{0} will be substituted with the current slider value.

Parameters:

message - the tool tip message

setMinValue

public void setMinValue(int minValue)

Sets the minimum value (defaults to 0).

Parameters:

minValue - the minimum value

setShowMessage

public void setShowMessage(boolean showMessage)

Sets if the tool tip message should be displayed (defaults to true, pre-render).

Parameters:

showMessage - true to show tool tip message

setToolTipConfig

public void setToolTipConfig(ToolTipConfig toolTipConfig)

Set the tooltip config. This is the tooltip for the message configuration. SliderCell.setShowMessage(boolean) has to be on to use this.

Overrides:

setToolTipConfig in class Component

Parameters:

toolTipConfig - is the tooltip configuration.