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

java.lang.Object
  extended by com.smartgwt.client.core.JsObject
      extended by com.smartgwt.client.core.DataClass
          extended by com.smartgwt.client.core.RefDataClass
              extended by com.smartgwt.client.widgets.form.fields.FormItem
                  extended by com.smartgwt.client.widgets.form.fields.CanvasItem
                      extended by com.smartgwt.client.widgets.form.fields.SliderItem
All Implemented Interfaces:
HasHandlers, HasBlurHandlers, HasChangedHandlers, HasChangeHandlers, HasClickHandlers, HasDoubleClickHandlers, HasFocusHandlers, HasIconClickHandlers, HasIconKeyPressHandlers, HasItemHoverHandlers, HasKeyDownHandlers, HasKeyPressHandlers, HasKeyUpHandlers, HasShowValueHandlers, HasTitleClickHandlers, HasTitleDoubleClickHandlers, HasTitleHoverHandlers

public class SliderItem
extends CanvasItem

FormItem that uses a Slider component to present an interface for picking from either a continuous range or a range with a small number of discrete values.


Field Summary
 
Fields inherited from class com.smartgwt.client.core.JsObject
jsObj
 
Constructor Summary
SliderItem()
           
SliderItem(JavaScriptObject jsObj)
           
SliderItem(java.lang.String name)
           
SliderItem(java.lang.String name, java.lang.String title)
           
 
Method Summary
 java.lang.Boolean getChangeOnDrag()
          Should this sliderItem update its value and fire change handlers while the user is actively dragging the slider.
 int getDefaultValue()
          Default value for this sliderItems is 1.
 float getMaxValue()
          The maximum slider value.
 float getMinValue()
          The minimum slider value.
 java.lang.Integer getNumValues()
          The number of discrete values represented by slider.
static SliderItem getOrCreateRef(JavaScriptObject jsObj)
           
 int getRoundPrecision()
          If roundValues is false, the slider value will be rounded to this number of decimal places.
 java.lang.Boolean getRoundValues()
          Specifies whether the slider value should be rounded to the nearest integer.
 java.lang.Float getValueAsFloat()
          Return the value tracked by this form item.
 java.lang.Boolean getVertical()
          Indicates whether this is a vertical or horizontal slider.
 void setChangeOnDrag(java.lang.Boolean changeOnDrag)
          Should this sliderItem update its value and fire change handlers while the user is actively dragging the slider.
 void setDefaultValue(int defaultValue)
          Default value for this sliderItems is 1.
 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(java.lang.Boolean roundValues)
          Specifies whether the slider value should be rounded to the nearest integer.
 void setVertical(java.lang.Boolean vertical)
          Indicates whether this is a vertical or horizontal slider.
 
Methods inherited from class com.smartgwt.client.widgets.form.fields.CanvasItem
addShowValueHandler, canEditCriterion, createCanvas, getCanvas, getCriterion, getEditCriteriaInInnerForm, getOverflow, getShouldSaveValue, hasAdvancedCriteria, setCanvas, setCriterion, setEditCriteriaInInnerForm, setOverflow, setShouldSaveValue, setupCanvasConstructor, storeValue, storeValue, storeValue
 
Methods inherited from class com.smartgwt.client.widgets.form.fields.FormItem
addBlurHandler, addChangedHandler, addChangeHandler, addClickHandler, addDoubleClickHandler, addFocusHandler, addIconClickHandler, addIconKeyPressHandler, addItemHoverHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addTitleClickHandler, addTitleDoubleClickHandler, addTitleHoverHandler, blurItem, clearValue, disable, enable, focusInItem, getAccessKey, getAlign, getAllowExpressions, getAlwaysFetchMissingValues, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsString, getBrowserSpellCheck, getCanFocus, getCellHeight, getCellStyle, getConfig, getContainerWidget, getCriteriaField, getCriterion, getDataPath, getDateFormatter, getDefaultIconSrc, getDisabled, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEmptyDisplayValue, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getFetchMissingValues, getFieldName, getFilterLocally, getForm, getFullDataPath, getGlobalTabIndex, getHeight, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverHeight, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getIcon, getIconHeight, getIconPageRect, getIconPrompt, getIconRect, getIconVAlign, getIconWidth, getImageURLPrefix, getImageURLSuffix, getImplicitSave, getImplicitSaveOnBlur, getInputFormat, getLeft, getLocateItemBy, getMultipleValueSeparator, getName, getOperator, getOptionCriteria, getOptionFilterContext, getOptionOperationId, getPageLeft, getPageRect, getPageTop, getPickerIconHeight, getPickerIconName, getPickerIconSrc, getPickerIconWidth, getPrintTextBoxStyle, getPrintTitleStyle, getPrompt, getRect, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRowSpan, getSelectedRecord, getSelectOnFocus, getShowDisabled, getShowErrorIcon, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowOverIcons, getShowPickerIcon, getShowTitle, getShowValueIconOnly, getStartRow, getStopOnError, getSuppressValueIcon, getSynchronousValidation, getTabIndex, getTextAlign, getTextBoxStyle, getTimeFormatter, getTitle, getTitleAlign, getTitleColSpan, getTitleOrientation, getTitleStyle, getTitleVAlign, getTooltip, getTop, getType, getValidateOnChange, getValidateOnExit, getValidOperators, getValue, getValueField, getValueFieldName, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getVisible, getVisibleHeight, getVisibleWidth, getWidth, getWrapTitle, hide, invalidateDisplayValueCache, isCreated, isDisabled, isDrawn, redraw, setAccessKey, setAlign, setAllowExpressions, setAlwaysFetchMissingValues, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setBrowserSpellCheck, setCanFocus, setCellHeight, setCellStyle, setColSpan, setColSpan, setCriteriaField, setDataPath, setDateFormatter, setDefaultIconSrc, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setDisplayField, setDisplayFormat, setDisplayFormat, setEditorType, setEditorValueFormatter, setEditorValueParser, setEmptyDisplayValue, setEmptyValueIcon, setEndRow, setErrorFormatter, setErrorIconHeight, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setFetchMissingValues, setFilterLocally, setGlobalTabIndex, setHeight, setHeight, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverHeight, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setIconHeight, setIconPrompt, setIcons, setIconVAlign, setIconWidth, setImageURLPrefix, setImageURLSuffix, setImplicitSave, setImplicitSaveOnBlur, setInitHandler, setInputFormat, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setLeft, setLocateItemBy, setMultipleValueSeparator, setName, setOperator, setOptionCriteria, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setPickerIconHeight, setPickerIconName, setPickerIconSrc, setPickerIconWidth, setPrintTextBoxStyle, setPrintTitleStyle, setPrompt, setProperty, setProperty, setProperty, setProperty, setProperty, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRowSpan, setSelectOnFocus, setShowDisabled, setShowErrorIcon, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIfCondition, setShowOverIcons, setShowPickerIcon, setShowTitle, setShowValueIconOnly, setStartRow, setStopOnError, setSuppressValueIcon, setSynchronousValidation, setTabIndex, setTextAlign, setTextBoxStyle, setTimeFormatter, setTitle, setTitleAlign, setTitleColSpan, setTitleOrientation, setTitleStyle, setTitleVAlign, setTooltip, setTop, setType, setValidateOnChange, setValidateOnExit, setValidators, setValidOperators, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueField, setValueFormatter, setValueIconHeight, setValueIconLeftPadding, setValueIconMapper, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setVisible, setWidth, setWidth, setWrapTitle, shouldFetchMissingValue, show, showPicker, stopHover, updateState, validate
 
Methods inherited from class com.smartgwt.client.core.RefDataClass
getRef, getRef
 
Methods inherited from class com.smartgwt.client.core.DataClass
doAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, getJsObj, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute
 
Methods inherited from class com.smartgwt.client.core.JsObject
setJsObj
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
 

Constructor Detail

SliderItem

public SliderItem()

SliderItem

public SliderItem(JavaScriptObject jsObj)

SliderItem

public SliderItem(java.lang.String name)

SliderItem

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

getOrCreateRef

public static SliderItem getOrCreateRef(JavaScriptObject jsObj)

setChangeOnDrag

public void setChangeOnDrag(java.lang.Boolean changeOnDrag)
Should this sliderItem update its value and fire change handlers while the user is actively dragging the slider. Setting this attribute value to false will suppress any change notifications from the user dragging the slider thumb until the user releases the mouse at the final position. This can be useful to avoid repeatedly firing expensive operations such as server fetches while the user drags through a range of values.

Parameters:
changeOnDrag - changeOnDrag Default value is true

getChangeOnDrag

public java.lang.Boolean getChangeOnDrag()
Should this sliderItem update its value and fire change handlers while the user is actively dragging the slider. Setting this attribute value to false will suppress any change notifications from the user dragging the slider thumb until the user releases the mouse at the final position. This can be useful to avoid repeatedly firing expensive operations such as server fetches while the user drags through a range of values.

Returns:
Boolean

setDefaultValue

public void setDefaultValue(int defaultValue)
Default value for this sliderItems is 1.

Parameters:
defaultValue - defaultValue Default value is 1

getDefaultValue

public int getDefaultValue()
Default value for this sliderItems is 1.

Returns:
int

setMaxValue

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

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

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

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
See Also:
Slider.getFlipValues(), Number - Slider Example

setMinValue

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

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

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

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
See Also:
Slider.getFlipValues(), Number - Slider Example

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.

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

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

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
See Also:
Number - Slider Example

setRoundPrecision

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

Parameters:
roundPrecision - roundPrecision Default value is 1
See Also:
Number - Slider Example

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
See Also:
Number - Slider Example

setRoundValues

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

Parameters:
roundValues - roundValues Default value is true
See Also:
Number - Slider Example

getRoundValues

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

Returns:
Boolean
See Also:
Number - Slider Example

setVertical

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

Parameters:
vertical - vertical Default value is false
See Also:
Slider Example

getVertical

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

Returns:
Boolean
See Also:
Slider Example

getValueAsFloat

public java.lang.Float getValueAsFloat()
Return the value tracked by this form item.

Returns:
value of this element