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, 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(String name)
           
SliderItem(String name, String title)
           
 
Method Summary
 int getDefaultValue()
          Default value for this sliderItems is 1.
 float getMaxValue()
          The maximum slider value.
 float getMinValue()
          The minimum slider value.
 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.
 Boolean getRoundValues()
          Specifies whether the slider value should be rounded to the nearest integer.
 Boolean getVertical()
          Indicates whether this is a vertical or horizontal 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(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 setVertical(Boolean vertical)
          Indicates whether this is a vertical or horizontal slider.
 
Methods inherited from class com.smartgwt.client.widgets.form.fields.CanvasItem
getCanvas, setCanvas
 
Methods inherited from class com.smartgwt.client.widgets.form.fields.FormItem
addBlurHandler, addChangedHandler, addChangeHandler, addClickHandler, addDoubleClickHandler, addFocusHandler, addIconClickHandler, addIconKeyPressHandler, addItemHoverHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addTitleHoverHandler, blurItem, clearValue, disable, enable, focusInItem, getAccessKey, getAlign, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsString, getCellStyle, getConfig, getCriteriaField, getCriterion, getDataPath, getDateFormatter, getDefaultIconSrc, getDisabled, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEmptyDisplayValue, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getFetchMissingValues, getFieldName, getFilterLocally, getForm, getGlobalTabIndex, getHeight, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverHeight, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getIconHeight, getIconPageRect, getIconPrompt, getIconRect, getIconVAlign, getIconWidth, getImageURLPrefix, getImageURLSuffix, getLeft, getName, getOperator, getOptionCriteria, getOptionFilterContext, getOptionOperationId, getPickerIconHeight, getPickerIconSrc, getPickerIconWidth, getPrompt, getRejectInvalidValueOnChange, getRequired, getRowSpan, getSelectOnFocus, getShouldSaveValue, getShowDisabled, getShowErrorIcon, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowOverIcons, getShowPickerIcon, getShowTitle, getShowValueIconOnly, getStartRow, getSuppressValueIcon, getTabIndex, getTextAlign, getTextBoxStyle, getTimeFormatter, getTitle, getTitleAlign, getTitleOrientation, getTitleStyle, getTooltip, getTop, getType, getValidateOnChange, getValue, getValueField, getValueFieldName, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getVisible, getWidth, getWrapTitle, hide, isCreated, isDisabled, isDrawn, redraw, setAccessKey, setAlign, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setCellStyle, setColSpan, setColSpan, setCriteriaField, setDataPath, setDateFormatter, setDefaultIconSrc, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setDisplayField, 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, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setLeft, setName, setOperator, setOptionCriteria, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setPickerIconHeight, setPickerIconSrc, setPickerIconWidth, setPrompt, setProperty, setProperty, setProperty, setProperty, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRowSpan, setSelectOnFocus, setShouldSaveValue, setShowDisabled, setShowErrorIcon, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIfCondition, setShowOverIcons, setShowPickerIcon, setShowTitle, setShowValueIconOnly, setStartRow, setSuppressValueIcon, setTabIndex, setTextAlign, setTextBoxStyle, setTimeFormatter, setTitle, setTitleAlign, setTitleOrientation, setTitleStyle, setTooltip, setTop, setType, setValidateOnChange, setValidators, setValue, setValue, setValue, setValue, setValue, setValue, setValueField, setValueFormatter, setValueIconHeight, setValueIconLeftPadding, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setVisible, setWidth, setWidth, setWrapTitle, show, stopHover, updateState
 
Methods inherited from class com.smartgwt.client.core.RefDataClass
getRef, getRef
 
Methods inherited from class com.smartgwt.client.core.DataClass
doAddHandler, fireEvent, getAttributeAsIntArray, getAttributeAsMap, getAttributeAsObject, getAttributeAsStringArray, getAttributes, getHandlerCount, getJsObj, 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(String name)

SliderItem

public SliderItem(String name,
                  String title)
Method Detail

getOrCreateRef

public static SliderItem getOrCreateRef(JavaScriptObject jsObj)

setVertical

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

Parameters:
vertical - vertical Default value is false

getVertical

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

Returns:
Boolean

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

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

setNumValues

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

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

getNumValues

public 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

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

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

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

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