public class SliderItem extends CanvasItem
Slider
component to present an interface for picking from
either a continuous range or a range with a small number of discrete values.scClassName
id
Constructor and Description |
---|
SliderItem() |
SliderItem(com.google.gwt.core.client.JavaScriptObject jsObj) |
SliderItem(java.lang.String name) |
SliderItem(java.lang.String name,
java.lang.String title) |
Modifier and Type | Method and Description |
---|---|
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
Canvas defaults)
Changes the defaults for Canvas AutoChildren named
autoChildName . |
static void |
changeAutoChildDefaults(java.lang.String autoChildName,
FormItem defaults)
Changes the defaults for FormItem AutoChildren named
autoChildName . |
static void |
changePickerIconDefaults(FormItemIcon defaults) |
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()
Deprecated.
|
double |
getMaxValueAsDouble()
The maximum slider value.
|
float |
getMinValue()
Deprecated.
|
double |
getMinValueAsDouble()
The minimum slider value.
|
java.lang.Integer |
getNumValues()
The number of discrete values represented by slider.
|
static SliderItem |
getOrCreateRef(com.google.gwt.core.client.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.Boolean |
getShouldSaveValue()
Should this item's value be saved in the form's values and hence returned from
form.getValues() ? |
Canvas |
getSlider()
|
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.
|
static void |
setDefaultProperties(SliderItem sliderItemProperties)
Class level method to set the default properties of this class.
|
void |
setDefaultValue(int defaultValue)
Default value for this sliderItems is 1.
|
void |
setMaxValue(double maxValue)
The maximum slider value.
|
void |
setMaxValue(float maxValue)
Deprecated.
|
void |
setMinValue(double minValue)
The minimum slider value.
|
void |
setMinValue(float minValue)
Deprecated.
|
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 |
setShouldSaveValue(java.lang.Boolean shouldSaveValue)
Should this item's value be saved in the form's values and hence returned from
form.getValues() ? |
void |
setVertical(java.lang.Boolean vertical)
Indicates whether this is a vertical or horizontal slider.
|
addCanEditChangedHandler, addReadOnlyDisplayChangedHandler, addShowValueHandler, createCanvas, getApplyPromptToCanvas, getAutoDestroy, getCanvas, getEditCriteriaInInnerForm, getHeight, getHeightAsString, getMultiple, getOverflow, getPrompt, hasAdvancedCriteria, setApplyPromptToCanvas, setAutoDestroy, setCanEditCriterionPredicate, setCanvas, setCriterionGetter, setCriterionSetter, setDefaultProperties, setEditCriteriaInInnerForm, setHeight, setHeight, setMultiple, setOverflow, setPrompt, setShouldDisableCanvasCustomizer, setupCanvasConstructor, storeValue, storeValue, storeValue
_getValue, addBlurHandler, addChangedHandler, addChangeHandler, addClickHandler, addDoubleClickHandler, addEditorEnterHandler, addEditorExitHandler, addFocusHandler, addIconClickHandler, addIconKeyPressHandler, addItemHoverHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addPickerIconClickHandler, addTitleClickHandler, addTitleDoubleClickHandler, addTitleHoverHandler, addValueHoverHandler, asSGWTComponent, blurItem, canEditCriterion, clearValue, disable, enable, error, error, errorIfNotCreated, focusInItem, getAccessKey, getAlign, getAllowExpressions, getAlwaysFetchMissingValues, getApplyHeightToTextBox, getAriaRole, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsObject, getAttributeAsString, getBrowserSpellCheck, getCanEdit, getCanEditOpaqueValues, getCanFocus, getCanSelectText, getCanvasAutoChild, getCellHeight, getCellStyle, getChangeOnKeypress, getClassName, getClipStaticValue, getClipTitle, getConfig, getContainerWidget, getControlStyle, getCriteriaField, getCriterion, getCriterion, getDataPath, getDateFormatter, getDecimalPad, getDecimalPrecision, getDefaultIconSrc, getDisabled, getDisableIconsOnReadOnly, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEditPendingCSSText, getEmptyDisplayValue, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getExportFormat, getFetchMissingValues, getFieldName, getFilterLocally, getForm, getFormat, getFormItemAutoChild, getFullDataPath, getGlobalTabIndex, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverHeight, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getIcon, getIconHeight, getIconHSpace, getIconPageRect, getIconPrompt, getIconRect, getIconVAlign, getIconWidth, getImageURLPrefix, getImageURLSuffix, getImplicitSave, getImplicitSaveOnBlur, getInputFormat, getLeft, getLoadingDisplayValue, getLocateItemBy, getMultipleValueSeparator, getName, getOperator, getOptionCriteria, getOptionFilterContext, getOptionOperationId, getPageLeft, getPageRect, getPageTop, getPicker, getPickerIconHeight, getPickerIconName, getPickerIconPrompt, getPickerIconProperties, getPickerIconSrc, getPickerIconStyle, getPickerIconWidth, getPixelHeight, getPixelWidth, getPrintTextBoxStyle, getPrintTitleStyle, getReadOnlyDisplay, getReadOnlyTextBoxStyle, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRowSpan, getSaveOnEnter, getScClassName, getSelectedRecord, getSelectOnClick, getSelectOnFocus, getShowClippedTitleOnHover, getShowClippedValueOnHover, getShowDisabled, getShowErrorIcon, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedErrorState, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowOverIcons, getShowPickerIcon, getShowRTL, getShowTitle, getShowValueIconOnly, getStartRow, getStopOnError, getSuppressValueIcon, getSynchronousValidation, getTabIndex, getTextAlign, getTextBoxStyle, getTimeFormatter, getTitle, getTitleAlign, getTitleColSpan, getTitleOrientation, getTitleStyle, getTitleVAlign, getTooltip, getTop, getType, getValidateOnChange, getValidateOnExit, getValidOperators, getVAlign, getValue, getValueAsRecordList, getValueField, getValueFieldName, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getVisible, getVisibleHeight, getVisibleWidth, getWidth, getWidthAsString, getWrapTitle, hide, hideIcon, invalidateDisplayValueCache, isCreated, isDisabled, isDrawn, isVisible, redraw, setAccessKey, setAlign, setAllowExpressions, setAlwaysFetchMissingValues, setApplyHeightToTextBox, setAriaRole, setAriaState, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setBrowserSpellCheck, setCanEdit, setCanEditOpaqueValues, setCanFocus, setCanSelectText, setCellHeight, setCellStyle, setChangeOnKeypress, setClipStaticValue, setClipTitle, setColSpan, setColSpan, setControlStyle, setCriteriaField, setCriterion, setDataPath, setDateFormatter, setDecimalPad, setDecimalPrecision, setDefaultIconSrc, setDefaultProperties, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setDisableIconsOnReadOnly, setDisplayField, setDisplayFormat, setDisplayFormat, setEditorProperties, setEditorType, setEditorType, setEditorType, setEditorValueFormatter, setEditorValueParser, setEditPendingCSSText, setEmptyDisplayValue, setEmptyValueIcon, setEndRow, setErrorFormatter, setErrorIconHeight, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setExportFormat, setFetchMissingValues, setFilterLocally, setFormat, setGlobalTabIndex, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverHeight, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setIconHeight, setIconHSpace, setIconPrompt, setIcons, setIconVAlign, setIconWidth, setImageURLPrefix, setImageURLSuffix, setImplicitSave, setImplicitSaveOnBlur, setInitHandler, setInputFormat, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setItemValueHoverFormatter, setLeft, setLoadingDisplayValue, setLocateItemBy, setMultipleValueSeparator, setName, setNullProperty, setOperator, setOptionCriteria, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setPickerIconHeight, setPickerIconName, setPickerIconPrompt, setPickerIconProperties, setPickerIconSrc, setPickerIconStyle, setPickerIconWidth, setPrintTextBoxStyle, setPrintTitleStyle, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyDisplay, setReadOnlyTextBoxStyle, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRowSpan, setSaveOnEnter, setScClassName, setSelectOnClick, setSelectOnFocus, setShowClippedTitleOnHover, setShowClippedValueOnHover, setShowDisabled, setShowErrorIcon, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedErrorState, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIfCondition, setShowOverIcons, setShowPickerIcon, setShowRTL, setShowTitle, setShowValueIconOnly, setStartRow, setStopOnError, setSuppressValueIcon, setSynchronousValidation, setTabIndex, setTextAlign, setTextBoxStyle, setTimeFormatter, setTitle, setTitleAlign, setTitleColSpan, setTitleHoverFormatter, setTitleOrientation, setTitleStyle, setTitleVAlign, setTooltip, setTop, setType, setValidateOnChange, setValidateOnExit, setValidators, setValidOperators, setVAlign, setValue, setValue, setValue, setValue, setValue, setValue, setValueField, setValueFormatter, setValueHoverFormatter, setValueIconHeight, setValueIconLeftPadding, setValueIconMapper, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setVisible, setWidth, setWidth, setWrapTitle, shouldApplyHeightToTextBox, shouldFetchMissingValue, shouldSaveOnEnter, shouldStopKeyPressBubbling, show, showIcon, showPicker, stopHover, storeValue, updateState, validate, valueClipped
getRef, getRef, internalSetID
doAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject
equals, getJsObj, hashCode, setJavaScriptObject, setJsObj
public SliderItem()
public SliderItem(com.google.gwt.core.client.JavaScriptObject jsObj)
public SliderItem(java.lang.String name)
public SliderItem(java.lang.String name, java.lang.String title)
public static SliderItem getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public static void changeAutoChildDefaults(java.lang.String autoChildName, Canvas defaults)
autoChildName
.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.AutoChildUsage
public static void changeAutoChildDefaults(java.lang.String autoChildName, FormItem defaults)
autoChildName
.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.AutoChildUsage
public static void changePickerIconDefaults(FormItemIcon defaults)
public void setChangeOnDrag(java.lang.Boolean changeOnDrag)
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.changeOnDrag
- Default value is truepublic java.lang.Boolean getChangeOnDrag()
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.public void setDefaultValue(int defaultValue)
defaultValue
- Default value is 1public int getDefaultValue()
public void setMaxValue(float maxValue)
GwtFloatVsDouble
maximum value
of the slidermaxValue
- the new maximum value Note:Use Doubles rather Floats when manipulating decimal values. See GwtFloatVsDouble
for details. Default value is 100Slider.setFlipValues(java.lang.Boolean)
,
Number - Slider Examplepublic float getMaxValue()
GwtFloatVsDouble
Slider.getFlipValues()
,
Number - Slider Examplepublic void setMaxValue(double maxValue)
maximum value
of the slidermaxValue
- the new maximum value Note:Use Doubles rather Floats when manipulating decimal values. See GwtFloatVsDouble
for details. Default value is 100Slider.setFlipValues(java.lang.Boolean)
,
Number - Slider Examplepublic double getMaxValueAsDouble()
Slider.getFlipValues()
,
Number - Slider Examplepublic void setMinValue(float minValue)
GwtFloatVsDouble
minimum value
of the sliderminValue
- the new minimum value Note:Use Doubles rather Floats when manipulating decimal values. See GwtFloatVsDouble
for details. Default value is 1Slider.setFlipValues(java.lang.Boolean)
,
Number - Slider Examplepublic float getMinValue()
GwtFloatVsDouble
Slider.getFlipValues()
,
Number - Slider Examplepublic void setMinValue(double minValue)
minimum value
of the sliderminValue
- the new minimum value Note:Use Doubles rather Floats when manipulating decimal values. See GwtFloatVsDouble
for details. Default value is 1Slider.setFlipValues(java.lang.Boolean)
,
Number - Slider Examplepublic double getMinValueAsDouble()
Slider.getFlipValues()
,
Number - Slider Examplepublic void setNumValues(java.lang.Integer numValues)
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.
number of values
for the slidernumValues
- the new number of values Note:Use Doubles rather Floats when manipulating decimal values. See GwtFloatVsDouble
for details. Default value is nullpublic java.lang.Integer getNumValues()
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.public void setRoundPrecision(int roundPrecision)
roundValues
is false, the slider value will be rounded to
this number of decimal places. If set to null the value will not be roundedroundPrecision
- Default value is 1public int getRoundPrecision()
roundValues
is false, the slider value will be rounded to
this number of decimal places. If set to null the value will not be roundedpublic void setRoundValues(java.lang.Boolean roundValues)
roundPrecision
.roundValues
- Default value is truepublic java.lang.Boolean getRoundValues()
roundPrecision
.public void setShouldSaveValue(java.lang.Boolean shouldSaveValue)
form.getValues()
? shouldSaveValue:false
is used
to mark formItems which do not correspond to the underlying data model and should not save a value into the form's
values
. Example includes visual separators, password
re-type fields, or checkboxes used to show/hide other form items.
A shouldSaveValue:false
item should
be given a value either via defaultValue
or by
calling form.setValue(item, value)
or formItem.setValue(value)
. Providing a value via form.values
or form.setValues()
will automatically switch the item to
shouldSaveValue:true
.
Note that
setShouldSaveValue
in class CanvasItem
shouldSaveValue
- Default value is truepublic java.lang.Boolean getShouldSaveValue()
form.getValues()
? shouldSaveValue:false
is used
to mark formItems which do not correspond to the underlying data model and should not save a value into the form's
values
. Example includes visual separators, password
re-type fields, or checkboxes used to show/hide other form items.
A shouldSaveValue:false
item should
be given a value either via defaultValue
or by
calling form.setValue(item, value)
or formItem.setValue(value)
. Providing a value via form.values
or form.setValues()
will automatically switch the item to
shouldSaveValue:true
.
Note that
getShouldSaveValue
in class CanvasItem
public Canvas getSlider()
Canvas
displayed by the SliderItem and is an
instance of Slider
by default. It is customizable via the standard com.smartgwt.client.types.AutoChild
pattern, by customizing sliderProperties
and sliderConstructor
.
For an overview of how to use and configure AutoChildren, see Using AutoChildren
.
public void setVertical(java.lang.Boolean vertical)
vertical
- Default value is falsepublic java.lang.Boolean getVertical()
public static void setDefaultProperties(SliderItem sliderItemProperties)
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.
sliderItemProperties
- properties that should be used as new defaults when instances of this class are createdpublic java.lang.Float getValueAsFloat()