com.smartgwt.mobile.client.widgets.form.fields

Class SliderItem

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.ComplexPanel

com.smartgwt.mobile.client.widgets.Canvas

com.smartgwt.mobile.client.widgets.form.fields.AbstractHasDataValue

com.smartgwt.mobile.client.widgets.form.fields.FormItem

com.smartgwt.mobile.client.widgets.form.fields.SliderItem

All Implemented Interfaces:

com.google.gwt.event.dom.client.HasKeyPressHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.EventHandler, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, com.smartgwt.mobile.client.internal.test.AutoTestLocatable, com.smartgwt.mobile.client.internal.widgets.events.HasValuesSelectedHandlers, com.smartgwt.mobile.client.internal.widgets.events.ValuesSelectedHandler, com.smartgwt.mobile.client.internal.widgets.form.fields.CanCopyFieldConfiguration, HasClickHandlers, HasShowContextMenuHandlers, HasValueChangedHandlers, HasBlurHandlers, HasChangedHandlers, HasDataValue, java.lang.Iterable<com.google.gwt.user.client.ui.Widget>

public class SliderItem
extends FormItem
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.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel

com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

Fields

Modifier and Type	Field and Description
static com.smartgwt.mobile.client.internal.theme.ios.SliderCssResourceIOS	_CSS

Fields inherited from class com.smartgwt.mobile.client.widgets.Canvas

_CONTENT_CHANGED_EVENT_TYPE, _HISTORY_ENABLED, _REQUEST_SCROLL_TO_EVENT_TYPE, id, touched

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
SliderItem(java.lang.String name)
SliderItem(java.lang.String name, java.lang.String title)

Method Summary

Modifier and Type	Method and Description
protected void	_onEnd(com.google.gwt.user.client.Event event)
void	_onStart(com.google.gwt.user.client.Event event, com.google.gwt.dom.client.Touch touch)
void	_setElementValue(java.lang.Object displayValue, java.lang.Object newValue)
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).
com.google.gwt.event.shared.HandlerRegistration	addValueChangedHandler(ValueChangedHandler handler) Add a valueChanged handler.
int	getLength() Used to set slider height if vertical, slider width if horizontal.
float	getMaxValue() The maximum slider value.
float	getMinValue() The minimum slider value.
java.lang.Integer	getNumValues() The number of discrete values represented by slider.
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.
float	getStepPercent() The percentage of the total slider that constitutes one discrete step.
boolean	getVertical() Indicates whether this is a vertical or horizontal slider.
void	onBrowserEvent(com.google.gwt.user.client.Event event)
protected void	onMove(com.google.gwt.user.client.Event event)
void	setLength(int length) Used to set slider height if vertical, slider width if horizontal.
void	setMaxValue(float maxValue) The maximum slider value.
void	setMinValue(float minValue) The minimum slider value.
void	setNumValues(java.lang.Integer numValues) The number of discrete values represented by slider.
void	setRoundPrecision(int roundPrecision) If roundValues is false, the slider value will be rounded to this number of decimal places.
void	setRoundValues(boolean roundValues) Specifies whether the slider value should be rounded to the nearest integer.
void	setStepPercent(float stepPercent) The percentage of the total slider that constitutes one discrete step.
void	setVertical(boolean vertical) Indicates whether this is a vertical or horizontal slider.
boolean	validate()

Methods inherited from class com.smartgwt.mobile.client.widgets.form.fields.FormItem

_addValuesSelectedHandler, _checkForEditorExit, _copyFieldConfiguration, _createPicker, _elementBlur, _formatDataType, _getChildFromLocatorSubstring, _getDateFormatter, _getDatetimeFormatter, _getDefaultValue, _getDisplayValue, _getEmptyDisplayValue, _getInnerAttributeFromSplitLocator, _getInputElement, _getMultipleValueSeparator, _getPicker, _getRequired, _getShowHint, _getShowHintInField, _getTimeFormatter, _getValueMap, _handleEditorExit, _handleInput, _isPickerEnabled, _isReadOnly, _isSetToDefaultValue, _mapDisplayToValue, _mapKey, _mapValueToDisplay, _nativeElementBlur, _onValuesSelected, _parseDisplayValue, _refreshDisplayValue, _setElementReadOnly, _shouldApplyStaticTypeFormat, _storeValue, _unmapKey, _updateDateFormatter, _updateValue, _updateValue, addBlurHandler, addChangedHandler, addKeyPressHandler, getCriterion, getDateFormatter, getDatetimeFormatter, getDisplayField, getDisplayFieldName, getEditorValueFormatter, getEditorValueParser, getEmptyDisplayValue, getForm, getHint, getName, getOptionDataSource, getRequired, getShowHint, getTextAlign, getTimeFormatter, getValue, getValueField, getValueFieldName, getValueFormatter, onChanged, onUnload, setDataManager, setDateFormatter, setDatetimeFormatter, setDefaultValue, setDisplayField, setEditorValueFormatter, setEditorValueParser, setElement, setEmptyDisplayValue, setFieldName, setHint, setName, setOptionDataSource, setRequired, setShowHint, setTextAlign, setTimeFormatter, setValue, setValue, setValueField, setValueFormatter, setValueMap, setValueMap, showPicker, showValue, updateCanEdit

Methods inherited from class com.smartgwt.mobile.client.widgets.form.fields.AbstractHasDataValue

compareValues, getCanEdit, getDataManager, getFieldName, getRealShowTitle, getShowTitle, getStopOnError, getTitle, getValidators, setCanEdit, setShowTitle, setStopOnError, setTitle, setValidators

Methods inherited from class com.smartgwt.mobile.client.widgets.Canvas

_add, _booleanValue, _fireContentChangedEvent, _fireContentChangedEvent, _fireRequestScrollToEvent, _getAndroidWindowSoftInputMode, _getAttributeFromSplitLocator, _getFixNavigationBarPositionDuringKeyboardFocus, _getHideTabBarDuringKeyboardFocus, _getInnerElement, _hideAddressBar, _hideAddressBarNow, _insert, _isDifferent, _isHDPIDisplay, _isIOS4OrOlder, _isIOS5, _isIOSMin6_0, _isStandaloneMode, _nativeParseFloat, _removeClassName, _setClassName, _setHandleDisabled, _sinkAnimationEndEvent, _sinkContentChangedEvent, _sinkFocusInEvent, _sinkFocusOutEvent, _sinkInputEvent, _sinkRequestScrollToEvent, _sinkTransitionEndEvent, _triggerDebugger, addChild, addChild, addChild, addClickHandler, addShowContextMenuHandler, destroy, disable, enable, getContextMenu, getID, getInnerHTML, getMargin, hasChild, hasChild, isAndroid, isDisabled, isEnabled, isIPad, isIPhone, isSafari, isStandAlone, isUIWebView, parseDimension, removeChild, removeChild, setContents, setContextMenu, setDisabled, setID, setMargin, setStyleName, split, useIOSNativeScrolling

Methods inherited from class com.google.gwt.user.client.ui.ComplexPanel

add, add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, insert, iterator, remove, remove

Methods inherited from class com.google.gwt.user.client.ui.Panel

add, add, adopt, clear, doAttachChildren, doDetachChildren, orphan, remove

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onDetach, onLoad, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

_CSS

public static final com.smartgwt.mobile.client.internal.theme.ios.SliderCssResourceIOS _CSS

Constructor Detail

SliderItem

public SliderItem(java.lang.String name)

SliderItem

public SliderItem(java.lang.String name,
                  java.lang.String title)

Method Detail

onBrowserEvent

public void onBrowserEvent(com.google.gwt.user.client.Event event)

Specified by:

onBrowserEvent in interface com.google.gwt.user.client.EventListener

Overrides:

onBrowserEvent in class FormItem

_onStart

public void _onStart(com.google.gwt.user.client.Event event,
                     com.google.gwt.dom.client.Touch touch)

Overrides:

_onStart in class FormItem

onMove

protected void onMove(com.google.gwt.user.client.Event event)

_onEnd

protected void _onEnd(com.google.gwt.user.client.Event event)

Overrides:

_onEnd in class FormItem

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 50

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) Sets the maximum value of the slider

Parameters:

maxValue - the new maximum value. Default value is 100

getMaxValue

public float getMaxValue()

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

Returns:

float

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) Sets the minimum value of the slider

Parameters:

minValue - the new minimum value. Default value is 1

getMinValue

public float getMinValue()

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

Returns:

float

setNumValues

public void setNumValues(java.lang.Integer numValues)

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

Parameters:

numValues - the new number of values. Default value is null

getNumValues

public java.lang.Integer getNumValues()

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

Returns:

Integer

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 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.

Parameters:

roundValues - roundValues Default value is true

getRoundValues

public final 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

_setElementValue

public void _setElementValue(java.lang.Object displayValue,
                             java.lang.Object newValue)

Overrides:

_setElementValue in class FormItem

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. 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

setVertical

public void setVertical(boolean vertical)

Indicates whether this is a vertical or horizontal slider. 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

addValueChangedHandler

public com.google.gwt.event.shared.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

@SGWTInternal
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

validate

public boolean validate()

Overrides:

validate in class FormItem