Class SliderItem
- All Implemented Interfaces:
HasHandlers,HasBlurHandlers,HasCanEditChangedHandlers,HasChangedHandlers,HasChangeHandlers,HasClickHandlers,HasDoubleClickHandlers,HasEditorEnterHandlers,HasEditorExitHandlers,HasFocusHandlers,HasIconClickHandlers,HasIconKeyPressHandlers,HasItemHoverHandlers,HasKeyDownHandlers,HasKeyPressHandlers,HasKeyUpHandlers,HasPendingStatusChangedHandlers,HasPickerIconClickHandlers,HasReadOnlyDisplayChangedHandlers,HasShowContextMenuHandlers,HasShowValueHandlers,HasTitleClickHandlers,HasTitleDoubleClickHandlers,HasTitleHoverHandlers,HasValueHoverHandlers,HasValueIconClickHandlers
Slider component to present an interface for picking from
either a continuous range or a range with a small number of discrete values.-
Nested Class Summary
Nested classes/interfaces inherited from class com.smartgwt.client.widgets.form.fields.FormItem
FormItem.CustomStateGetter, FormItem.StateCustomizer -
Field Summary
Fields inherited from class com.smartgwt.client.widgets.form.fields.FormItem
configOnly, scClassName, warnOnEditorTypeConversion, warnOnEditorTypeConversionDefaultFields inherited from class com.smartgwt.client.core.RefDataClass
idFields inherited from class com.smartgwt.client.core.DataClass
factoryCreated, factoryProperties -
Constructor Summary
ConstructorsConstructorDescriptionSliderItem(JavaScriptObject jsObj) SliderItem(String name) SliderItem(String name, String title) -
Method Summary
Modifier and TypeMethodDescriptionstatic voidchangeAutoChildDefaults(String autoChildName, Canvas defaults) Changes the defaults for Canvas AutoChildren namedautoChildName.static voidchangeAutoChildDefaults(String autoChildName, FormItem defaults) Changes the defaults for FormItem AutoChildren namedautoChildName.static voidchangePickerIconDefaults(FormItemIcon defaults) Should this sliderItem update its value and fire change handlers while the user is actively dragging the slider.Default value for this sliderItems is 1.floatDeprecated.doubleThe maximum slider value.floatDeprecated.doubleThe minimum slider value.The number of discrete values represented by slider.static SliderItemgetOrCreateRef(JavaScriptObject jsObj) intIfSlider.roundValuesis false, the slider value will be rounded to this number of decimal places.Specifies whether the slider value should be rounded to the nearest integer.Should this item's value be saved in the form's values and hence returned fromform.getValues()?Indicates whether this is a vertical or horizontal slider.intgetWidth()Default width of this item.booleanpendingStatusChanged(DynamicForm form, FormItem item, boolean pendingStatus, Object newValue, Object value) Notification method called whenshowPendingis enabled and thisSliderItemshould either clear or show its pending visual state.setChangeOnDrag(Boolean changeOnDrag) Should this sliderItem update its value and fire change handlers while the user is actively dragging the slider.static voidsetDefaultProperties(SliderItem sliderItemProperties) Class level method to set the default properties of this class.setMaxValue(double maxValue) The maximum slider value.setMaxValue(float maxValue) Deprecated.setMinValue(double minValue) The minimum slider value.setMinValue(float minValue) Deprecated.setNumValues(Integer numValues) The number of discrete values represented by slider.setRoundPrecision(int roundPrecision) IfSlider.roundValuesis false, the slider value will be rounded to this number of decimal places.setRoundValues(Boolean roundValues) Specifies whether the slider value should be rounded to the nearest integer.setShouldSaveValue(Boolean shouldSaveValue) Should this item's value be saved in the form's values and hence returned fromform.getValues()?setVertical(Boolean vertical) Indicates whether this is a vertical or horizontal slider.setWidth(int width) Default width of this item.Methods inherited from class com.smartgwt.client.widgets.form.fields.CanvasItem
addCanEditChangedHandler, addReadOnlyDisplayChangedHandler, addShowValueHandler, createCanvas, getApplyPromptToCanvas, getAutoDestroy, getCanvas, getEditCriteriaInInnerForm, getHeight, getHeightAsString, getMaxHeight, getMinHeight, getMultiple, getOverflow, getPrompt, hasAdvancedCriteria, isFocused, setApplyPromptToCanvas, setAutoDestroy, setCanEditCriterionPredicate, setCanvas, setCriterionGetter, setCriterionSetter, setDefaultProperties, setEditCriteriaInInnerForm, setHeight, setHeight, setMaxHeight, setMinHeight, setMultiple, setOverflow, setPrompt, setShouldDisableCanvasCustomizer, setupCanvasConstructor, storeValue, storeValue, storeValue, updateCanvasTabPositionMethods inherited from class com.smartgwt.client.widgets.form.fields.FormItem
_getValue, addBlurHandler, addChangedHandler, addChangeHandler, addClickHandler, addDoubleClickHandler, addEditorEnterHandler, addEditorExitHandler, addFocusHandler, addIcon, addIcon, addIconClickHandler, addIconKeyPressHandler, addItemHoverHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addPendingStatusChangedHandler, addPickerIconClickHandler, addShowContextMenuHandler, addTitleClickHandler, addTitleDoubleClickHandler, addTitleHoverHandler, addValueHoverHandler, addValueIconClickHandler, applyFormula, asSGWTComponent, blurItem, canEditCriterion, checkFormItemType, clearErrors, clearValue, disable, disableIcon, enable, enableIcon, error, error, errorIfNotCreated, focusAfterItem, focusInItem, getAccessKey, getAlign, getAllowExpressions, getAlwaysFetchMissingValues, getAlwaysShowControlBox, getApplyAlignToText, getApplyHeightToTextBox, getAriaRole, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsObject, getAttributeAsString, getAutoComplete, getAutoCompleteKeywords, getBrowserInputType, getBrowserSpellCheck, getCanEdit, getCanEditOpaqueValues, getCanFocus, getCanHover, getCanSelectText, getCanTabToIcons, getCanvasAutoChild, getCellHeight, getCellStyle, getChangeOnKeypress, getClassName, getClipStaticValue, getClipTitle, getConfig, getContainerWidget, getControlStyle, getCriteriaField, getCriterion, getCriterion, getCursorPosition, getCustomState, getDataPath, getDateFormatter, getDecimalPad, getDecimalPrecision, getDefaultIconSrc, getDefaultOperator, getDestroyed, getDisabled, getDisabledHover, getDisableIconsOnReadOnly, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEditPendingCSSText, getEditProxyConstructor, getEmptyDisplayValue, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconProperties, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getErrors, getEscapeHTML, getExportFormat, getFetchMissingValues, getFieldName, getFilterLocally, getForeignDisplayField, getForm, getFormat, getFormItemAutoChild, getFormula, getFullDataPath, getGlobalTabIndex, getGridColNum, getGridRowNum, getHidden, getHint, getHintStyle, getHoverAlign, getHoverDelay, getHoverFocusKey, getHoverHeight, getHoverHeightAsString, getHoverOpacity, getHoverPersist, getHoverStyle, getHoverVAlign, getHoverWidth, getHoverWidthAsString, getIcon, getIconBaseStyle, getIconHeight, getIconHSpace, getIconPageRect, getIconPrompt, getIconRect, getIcons, getIconTabPosition, getIconVAlign, getIconWidth, getID, getImageURLPrefix, getImageURLSuffix, getImplicitSave, getImplicitSaveOnBlur, getInputFormat, getLeft, getLinearColSpan, getLinearColSpanAsString, getLinearEndRow, getLinearEndRowAsString, getLinearStartRow, getLinearStartRowAsString, getLinearWidth, getLinearWidthAsString, getListGrid, getLoadingDisplayValue, getLocateItemBy, getMinHintWidth, getMultipleValueSeparator, getName, getNullOriginalValueText, getOperator, getOptionCriteria, getOptionDataSource, getOptionDataSourceAsString, getOptionFilterContext, getOptionOperationId, getOptionTextMatchStyle, getOriginalValueMessage, getPageLeft, getPageRect, getPageTop, getPaletteDefaults, getPicker, getPickerIcon, getPickerIcon, getPickerIconHeight, getPickerIconName, getPickerIconPrompt, getPickerIconProperties, getPickerIconSrc, getPickerIconStyle, getPickerIconTabPosition, getPickerIconWidth, getPixelHeight, getPixelWidth, getPrintReadOnlyTextBoxStyle, getPrintTextBoxStyle, getPrintTitleStyle, getReadOnlyCanSelectText, getReadOnlyControlStyle, getReadOnlyDisplay, getReadOnlyHover, getReadOnlyTextBoxStyle, getReadOnlyWhen, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRequiredWhen, getRowSpan, getSaveOnEnter, getScClassName, getSelectedRecord, getSelectOnClick, getSelectOnFocus, getShowClippedTitleOnHover, getShowClippedValueOnHover, getShowDeletions, getShowDisabled, getShowDisabledIconsOnFocus, getShowDisabledPickerIconOnFocus, getShowErrorIcon, getShowErrorIconInline, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedErrorState, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowIconsOnFocus, getShowImageAsURL, getShowOldValueInHover, getShowOver, getShowOverIcons, getShowPending, getShowPickerIcon, getShowPickerIconOnFocus, getShowRTL, getShowTitle, getShowValueIconOnly, getStartRow, getStaticHeight, getStopOnError, getStoreDisplayValues, getSupportsCutPasteEvents, getSuppressValueIcon, getSynchronousValidation, getTabIndex, getTextAlign, getTextBoxStyle, getTextFormula, getTimeFormatter, getTitle, getTitleAlign, getTitleColSpan, getTitleOrientation, getTitleStyle, getTitleVAlign, getTooltip, getTop, getType, getUpdateControlOnOver, getUpdatePickerIconOnOver, getUpdateTextBoxOnOver, getUseAdvancedCriteria, getUseDisabledHintStyleForReadOnly, getUseLocalDisplayFieldValue, getValidateOnChange, getValidateOnExit, getValidOperators, getVAlign, getValue, getValueAsFloat, getValueAsInteger, getValueAsLong, getValueAsRecordList, getValueDeselectedCSSText, getValueField, getValueFieldName, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getValueMap, getValueMapAsArray, getVisible, getVisibleHeight, getVisibleTitleWidth, getVisibleWhen, getVisibleWidth, getWarnOnEditorTypeConversion, getWarnOnEditorTypeConversionDefault, getWidthAsString, getWrapHintText, getWrapStaticValue, getWrapTitle, handleWarnOnEditorTypeConversion, hasErrors, hide, hideIcon, invalidateDisplayValueCache, isAssignableFrom, isConfigOnly, isCreated, isCutEvent, isDisabled, isDrawn, isInGrid, isPasteEvent, isVisible, linkToInstanceUponCreate, mapDisplayToValue, mapValueToDisplay, mapValueToDisplay, mapValueToDisplay, redraw, redraw, removeIcon, selectedRecordChanged, setAccessKey, setAlign, setAllowExpressions, setAlwaysFetchMissingValues, setAlwaysShowControlBox, setApplyAlignToText, 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, setAutoChildProperties, setAutoChildVisibility, setAutoComplete, setAutoCompleteKeywords, setBrowserInputType, setBrowserSpellCheck, setCanEdit, setCanEditOpaqueValues, setCanFocus, setCanHover, setCanSelectText, setCanTabToIcons, setCellHeight, setCellStyle, setChangeOnKeypress, setClipStaticValue, setClipTitle, setColSpan, setColSpan, setConfigOnly, setControlStyle, setCriteriaField, setCriterion, setCustomStateGetter, setDataPath, setDateFormatter, setDecimalPad, setDecimalPrecision, setDefaultIconSrc, setDefaultOperator, setDefaultProperties, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDefaultValue, setDisabled, setDisabledHover, setDisableIconsOnReadOnly, setDisplayField, setDisplayFormat, setDisplayFormat, setEditorProperties, setEditorType, setEditorType, setEditorType, setEditorValueFormatter, setEditorValueParser, setEditPendingCSSText, setEditProxyConstructor, setEmptyDisplayValue, setEmptyValueIcon, setEndRow, setErrorFormatter, setErrorIconHeight, setErrorIconProperties, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setErrors, setErrors, setEscapeHTML, setExportFormat, setFetchMissingValues, setFilterLocally, setForeignDisplayField, setFormat, setFormula, setGlobalTabIndex, setHidden, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverFocusKey, setHoverHeight, setHoverHeight, setHoverOpacity, setHoverPersist, setHoverStyle, setHoverVAlign, setHoverWidth, setHoverWidth, setIconBaseStyle, setIconDisabled, setIconHeight, setIconHSpace, setIconPrompt, setIcons, setIconShowOnFocus, setIconVAlign, setIconWidth, setID, setImageURLPrefix, setImageURLSuffix, setImplicitSave, setImplicitSaveOnBlur, setInitHandler, setInputFormat, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setItemValueHoverFormatter, setJavaScriptObject, setLeft, setLinearColSpan, setLinearColSpan, setLinearEndRow, setLinearEndRow, setLinearStartRow, setLinearStartRow, setLinearWidth, setLinearWidth, setLoadingDisplayValue, setLocateItemBy, setMinHintWidth, setMultipleValueSeparator, setName, setNullOriginalValueText, setNullProperty, setOperator, setOptionCriteria, setOptionDataSource, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setOptionTextMatchStyle, setOriginalValueMessage, setPickerIconHeight, setPickerIconName, setPickerIconPrompt, setPickerIconProperties, setPickerIconSrc, setPickerIconStyle, setPickerIconWidth, setPrintReadOnlyTextBoxStyle, setPrintTextBoxStyle, setPrintTitleStyle, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyCanSelectText, setReadOnlyControlStyle, setReadOnlyDisplay, setReadOnlyHover, setReadOnlyTextBoxStyle, setReadOnlyWhen, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRequiredWhen, setRowSpan, setSaveOnEnter, setScClassName, setSelectOnClick, setSelectOnFocus, setShowClippedTitleOnHover, setShowClippedValueOnHover, setShowDeletions, setShowDisabled, setShowDisabledIconsOnFocus, setShowDisabledPickerIconOnFocus, setShowErrorIcon, setShowErrorIconInline, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedErrorState, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIconsOnFocus, setShowIfCondition, setShowImageAsURL, setShowOldValueInHover, setShowOver, setShowOverIcons, setShowPending, setShowPickerIcon, setShowPickerIconOnFocus, setShowRTL, setShowTitle, setShowValueIconOnly, setStartRow, setStateCustomizer, setStaticHeight, setStopOnError, setStoreDisplayValues, setSupportsCutPasteEvents, setSuppressValueIcon, setSynchronousValidation, setTabIndex, setTextAlign, setTextBoxStyle, setTextFormula, setTimeFormatter, setTitle, setTitleAlign, setTitleColSpan, setTitleHoverFormatter, setTitleOrientation, setTitleStyle, setTitleVAlign, setTooltip, setTop, setType, setUpdateControlOnOver, setUpdatePickerIconOnOver, setUpdateTextBoxOnOver, setUseAdvancedCriteria, setUseDisabledHintStyleForReadOnly, setUseLocalDisplayFieldValue, setUseObjectFactoryForTypeFallback, setValidateOnChange, setValidateOnExit, setValidators, setValidOperators, setVAlign, setValue, setValue, setValue, setValue, setValue, setValue, setValueDeselectedCSSText, setValueField, setValueFormatter, setValueHoverFormatter, setValueIconHeight, setValueIconLeftPadding, setValueIconMapper, setValueIconRightPadding, setValueIcons, setValueIconSize, setValueIconWidth, setValueMap, setValueMap, setVisible, setVisibleWhen, setWarnOnEditorTypeConversion, setWarnOnEditorTypeConversionDefault, setWidth, setWrapHintText, setWrapStaticValue, setWrapTitle, shouldApplyHeightToTextBox, shouldFetchMissingValue, shouldSaveOnEnter, shouldStopKeyPressBubbling, show, showIcon, showPicker, stopHover, storeValue, updateState, validate, valueClippedMethods inherited from class com.smartgwt.client.data.Field
getCanExport, getExportTitle, getPrimaryKey, getSortByField, setCanExport, setExportTitle, setPrimaryKey, setSortByFieldMethods inherited from class com.smartgwt.client.core.RefDataClass
getRef, getRef, internalSetIDMethods inherited from class com.smartgwt.client.core.DataClass
applyFactoryProperties, doAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreatedMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.google.gwt.event.shared.HasHandlers
fireEvent
-
Constructor Details
-
SliderItem
public SliderItem() -
SliderItem
-
SliderItem
-
SliderItem
-
-
Method Details
-
getOrCreateRef
-
changeAutoChildDefaults
Changes the defaults for Canvas AutoChildren namedautoChildName.- Parameters:
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. For usage tips on this param, seeSGWTProperties.- See Also:
-
changeAutoChildDefaults
Changes the defaults for FormItem AutoChildren namedautoChildName.- Parameters:
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. For usage tips on this param, seeSGWTProperties.- See Also:
-
changePickerIconDefaults
-
setChangeOnDrag
Should this sliderItem update its value and fire change handlers while the user is actively dragging the slider. Setting this attribute value tofalsewill 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- New changeOnDrag value. Default value is true- Returns:
SliderIteminstance, for chaining setter calls
-
getChangeOnDrag
Should this sliderItem update its value and fire change handlers while the user is actively dragging the slider. Setting this attribute value tofalsewill 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:
- Current changeOnDrag value. Default value is true
-
setMaxValue
Deprecated.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 themaximum valueof the slider- Parameters:
maxValue- the new maximum value Note:Use Doubles rather Floats when manipulating decimal values. SeeGwtFloatVsDoublefor details. Default value is 100- Returns:
SliderIteminstance, for chaining setter calls- See Also:
-
getMaxValue
public float getMaxValue()Deprecated.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:
- Current maxValue value. Default value is 100
- See Also:
-
setMaxValue
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 themaximum valueof the slider- Parameters:
maxValue- the new maximum value Note:Use Doubles rather Floats when manipulating decimal values. SeeGwtFloatVsDoublefor details. Default value is 100- Returns:
SliderIteminstance, for chaining setter calls- See Also:
-
getMaxValueAsDouble
public double getMaxValueAsDouble()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:
- Current maxValue value. Default value is 100
- See Also:
-
setMinValue
Deprecated.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 theminimum valueof the slider- Parameters:
minValue- the new minimum value Note:Use Doubles rather Floats when manipulating decimal values. SeeGwtFloatVsDoublefor details. Default value is 1- Returns:
SliderIteminstance, for chaining setter calls- See Also:
-
getMinValue
public float getMinValue()Deprecated.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:
- Current minValue value. Default value is 1
- See Also:
-
setMinValue
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 theminimum valueof the slider- Parameters:
minValue- the new minimum value Note:Use Doubles rather Floats when manipulating decimal values. SeeGwtFloatVsDoublefor details. Default value is 1- Returns:
SliderIteminstance, for chaining setter calls- See Also:
-
getMinValueAsDouble
public double getMinValueAsDouble()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:
- Current minValue value. Default value is 1
- See Also:
-
setNumValues
The number of discrete values represented by slider. If specified, the range of valid values (betweenminValueandmaxValue) 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 thenumber of valuesfor the slider- Parameters:
numValues- the new number of values Note:Use Doubles rather Floats when manipulating decimal values. SeeGwtFloatVsDoublefor details. Default value is null- Returns:
SliderIteminstance, for chaining setter calls- See Also:
-
getNumValues
The number of discrete values represented by slider. If specified, the range of valid values (betweenminValueandmaxValue) 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:
- Current numValues value. Default value is null
- See Also:
-
setRoundPrecision
IfSlider.roundValuesis 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- New roundPrecision value. Default value is 1- Returns:
SliderIteminstance, for chaining setter calls- See Also:
-
getRoundPrecision
public int getRoundPrecision()IfSlider.roundValuesis false, the slider value will be rounded to this number of decimal places. If set to null the value will not be rounded- Returns:
- Current roundPrecision value. Default value is 1
- See Also:
-
setRoundValues
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 byroundPrecision.- Parameters:
roundValues- New roundValues value. Default value is true- Returns:
SliderIteminstance, for chaining setter calls- See Also:
-
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 byroundPrecision.- Returns:
- Current roundValues value. Default value is true
- See Also:
-
setShouldSaveValue
Should this item's value be saved in the form's values and hence returned fromform.getValues()?shouldSaveValue:falseis used to mark formItems which do not correspond to the underlying data model and should not save a value into the form'svalues. Example includes visual separators, password re-type fields, or checkboxes used to show/hide other form items.A
shouldSaveValue:falseitem should be given a value either viaFormItem.defaultValueor by callingform.setValue(item, value)orformItem.setValue(value). Providing a value viaform.valuesorform.setValues()will automatically switch the item toshouldSaveValue:true.Note that
- if an item is shouldSaveValue true, but has no name, a warning is logged, and shouldSaveValue will be set to false.
- Overrides:
setShouldSaveValuein classCanvasItem- Parameters:
shouldSaveValue- New shouldSaveValue value. Default value is true- Returns:
SliderIteminstance, for chaining setter calls
-
getShouldSaveValue
Should this item's value be saved in the form's values and hence returned fromform.getValues()?shouldSaveValue:falseis used to mark formItems which do not correspond to the underlying data model and should not save a value into the form'svalues. Example includes visual separators, password re-type fields, or checkboxes used to show/hide other form items.A
shouldSaveValue:falseitem should be given a value either viaFormItem.defaultValueor by callingform.setValue(item, value)orformItem.setValue(value). Providing a value viaform.valuesorform.setValues()will automatically switch the item toshouldSaveValue:true.Note that
- if an item is shouldSaveValue true, but has no name, a warning is logged, and shouldSaveValue will be set to false.
- Overrides:
getShouldSaveValuein classCanvasItem- Returns:
- Current shouldSaveValue value. Default value is true
-
getSlider
This item is an autoChild generatedCanvasdisplayed by the SliderItem and is an instance ofSliderby default. It is customizable via the standardcom.smartgwt.client.types.AutoChildpattern, by customizingsliderPropertiesandsliderConstructor.This component is an AutoChild named "slider". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current slider value. Default value is null
-
setVertical
Indicates whether this is a vertical or horizontal slider.- Parameters:
vertical- New vertical value. Default value is false- Returns:
SliderIteminstance, for chaining setter calls- See Also:
-
getVertical
Indicates whether this is a vertical or horizontal slider.- Returns:
- Current vertical value. Default value is false
- See Also:
-
setWidth
Default width of this item.- Overrides:
setWidthin classFormItem- Parameters:
width- New width value. Default value is 150- Returns:
SliderIteminstance, for chaining setter calls- See Also:
-
getWidth
public int getWidth()Default width of this item. -
pendingStatusChanged
public boolean pendingStatusChanged(DynamicForm form, FormItem item, boolean pendingStatus, Object newValue, Object value) Notification method called whenshowPendingis enabled and thisSliderItemshould either clear or show its pending visual state.The default behavior is that the
titleStyleandcellStyleare updated to include/exclude the "Pending" suffix. In addition, when displayed in the pending state the value label changes color. Returningfalsewill cancel this default behavior.- Parameters:
form- the managingDynamicForminstance.item- the form item itself (also available as "this").pendingStatus-trueif the item should show its pending visual state;falseotherwise.newValue- the current form item value.value- the value that would be restored by a call toDynamicForm.resetValues().- Returns:
falseto cancel the default behavior.
-
setDefaultProperties
Class level method to set the default properties of this class. If set, then all existing and subsequently created instances of this class will automatically have default properties corresponding to the properties of the class instance passed to this function. This is a powerful feature that eliminates the need for users to create a separate hierarchy of subclasses that only alter the default properties of this class. Can also be used for skinning / styling purposes.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.
- Parameters:
sliderItemProperties- properties that should be used as new defaults when instances of this class are created- See Also:
-
getDefaultValue
Default value for this sliderItems is 1.- Overrides:
getDefaultValuein classFormItem- Returns:
- Current defaultValue value. Default value is 1
- See Also:
-
com.smartgwt.client.widgets.form.fields.FormItem#defaultDynamicValue- Enable & Disable Example
-
GwtFloatVsDouble