Class SpinnerItem
- All Implemented Interfaces:
HasHandlers,HasBlurHandlers,HasChangedHandlers,HasChangeHandlers,HasClickHandlers,HasDoubleClickHandlers,HasEditorEnterHandlers,HasEditorExitHandlers,HasFocusHandlers,HasIconClickHandlers,HasIconKeyPressHandlers,HasItemHoverHandlers,HasKeyDownHandlers,HasKeyPressHandlers,HasKeyUpHandlers,HasPendingStatusChangedHandlers,HasPickerIconClickHandlers,HasShowContextMenuHandlers,HasTitleClickHandlers,HasTitleDoubleClickHandlers,HasTitleHoverHandlers,HasValueHoverHandlers,HasValueIconClickHandlers
-
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
ConstructorsConstructorDescriptionSpinnerItem(JavaScriptObject jsObj) SpinnerItem(String name) SpinnerItem(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) Instacked mode, the icon to decrease the spinner's value (a down arrow by default).Instacked mode, the icon to increase the spinner's value (an up arrow by default).getMask()Not applicable to a SpinnerItem.Not applicable to a SpinnerItem.Not applicable to a SpinnerItem.Not applicable to a SpinnerItem.Not applicable to a SpinnerItem.getMax()Maximum valid value for this item.getMin()Minimum valid value for this item.static SpinnerItemgetOrCreateRef(JavaScriptObject jsObj) Instacked icons modethis property can be used to specify the height of both the increase and decrease icon.Instacked icons modethis property can be used to specify the width of both the increase and decrease icon.doublegetStep()How much should the value be incremented / decremented when the user hits the icons to increase / decrease the value?Inunstacked mode, the icon to decrease theSpinnerItem's value.Inunstacked mode, the icon to increase theSpinnerItem's value.Inunstacked mode, the base CSS class name for theSpinnerItem's text box element when printed.Inunstacked mode, the base CSS class name for theSpinnerItem's text box element.When set totrue, the increase and decrease icons are stacked on top of each other, also called stacked mode.setDecreaseIconProperties(FormItemIcon decreaseIconProperties) FormItemIcon properties applied to thedecreaseIconAutoChild of this SpinnerItem.static voidsetDefaultProperties(SpinnerItem spinnerItemProperties) Class level method to set the default properties of this class.setIncreaseIconProperties(FormItemIcon increaseIconProperties) FormItemIcon properties applied to theincreaseIconAutoChild of this SpinnerItem.Not applicable to a SpinnerItem.setMaskOverwriteMode(Boolean maskOverwriteMode) Not applicable to a SpinnerItem.setMaskPadChar(String maskPadChar) Not applicable to a SpinnerItem.setMaskPromptChar(String maskPromptChar) Not applicable to a SpinnerItem.setMaskSaveLiterals(Boolean maskSaveLiterals) Not applicable to a SpinnerItem.final SpinnerItemsetMax(double max) Maximum valid value for this item.final SpinnerItemfinal SpinnerItemsetMin(double min) Minimum valid value for this item.final SpinnerItemvoidsetNextValueHandler(NextValueHandler handler) voidsetStackedIconsHeight(Integer stackedIconsHeight) Instacked icons modethis property can be used to specify the height of both the increase and decrease icon.setStackedIconsWidth(Integer stackedIconsWidth) Instacked icons modethis property can be used to specify the width of both the increase and decrease icon.setStep(double step) How much should the value be incremented / decremented when the user hits the icons to increase / decrease the value?final SpinnerItemfinal SpinnerItemsetUnstackedPrintTextBoxStyle(String unstackedPrintTextBoxStyle) Inunstacked mode, the base CSS class name for theSpinnerItem's text box element when printed.setUnstackedReadOnlyTextBoxStyle(String unstackedReadOnlyTextBoxStyle) setUnstackedTextBoxStyle(String unstackedTextBoxStyle) Inunstacked mode, the base CSS class name for theSpinnerItem's text box element.setWriteStackedIcons(Boolean writeStackedIcons) When set totrue, the increase and decrease icons are stacked on top of each other, also called stacked mode.Methods inherited from class com.smartgwt.client.widgets.form.fields.TextItem
deselectValue, deselectValue, getBrowserAutoCapitalize, getBrowserAutoCorrect, getBrowserInputType, getChangeOnKeypress, getCharacterCasing, getEditProxyConstructor, getEnforceLength, getEnteredValue, getEscapeHTML, getFetchMissingValues, getFormatOnBlur, getFormatOnFocusChange, getHint, getKeyPressFilter, getLength, getPrintFullText, getSaveOnEnter, getSelectionRange, getSelectOnClick, getSelectOnFocus, getShowHintInField, getShowInputElement, getSupportsCutPasteEvents, getSuppressBrowserClearIcon, getTextBoxStyle, getUsePlaceholderForHint, getValueAsString, pendingStatusChanged, selectValue, setBrowserAutoCapitalize, setBrowserAutoCorrect, setBrowserInputType, setChangeOnKeypress, setCharacterCasing, setDefaultProperties, setEditProxyConstructor, setEnforceLength, setEscapeHTML, setFetchMissingValues, setFormatOnBlur, setFormatOnFocusChange, setKeyPressFilter, setLength, setPastedValueTransformer, setPrintFullText, setSaveOnEnter, setSelectionRange, setSelectOnClick, setSelectOnFocus, setShowHintInField, setShowInputElement, setSupportsCutPasteEvents, setSuppressBrowserClearIcon, setTextBoxStyle, setUsePlaceholderForHint, shouldFetchMissingValueMethods 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, getBrowserSpellCheck, getCanEdit, getCanEditOpaqueValues, getCanFocus, getCanHover, getCanSelectText, getCanTabToIcons, getCanvasAutoChild, getCellHeight, getCellStyle, getClassName, getClipStaticValue, getClipTitle, getConfig, getContainerWidget, getControlStyle, getCriteriaField, getCriterion, getCriterion, getCursorPosition, getCustomState, getDataPath, getDateFormatter, getDecimalPad, getDecimalPrecision, getDefaultIconSrc, getDefaultOperator, getDefaultValue, getDestroyed, getDisabled, getDisabledHover, getDisableIconsOnReadOnly, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEditPendingCSSText, getEmptyDisplayValue, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconProperties, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getErrors, getExportFormat, getFieldName, getFilterLocally, getForeignDisplayField, getForm, getFormat, getFormItemAutoChild, getFormula, getFullDataPath, getGlobalTabIndex, getGridColNum, getGridRowNum, getHeight, getHeightAsString, getHidden, 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, getMultiple, 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, getPrompt, getReadOnlyCanSelectText, getReadOnlyControlStyle, getReadOnlyDisplay, getReadOnlyHover, getReadOnlyTextBoxStyle, getReadOnlyWhen, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRequiredWhen, getRowSpan, getScClassName, getSelectedRecord, getShouldSaveValue, 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, getSuppressValueIcon, getSynchronousValidation, getTabIndex, getTextAlign, 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, getWidth, getWidthAsString, getWrapHintText, getWrapStaticValue, getWrapTitle, handleWarnOnEditorTypeConversion, hasAdvancedCriteria, hasErrors, hide, hideIcon, invalidateDisplayValueCache, isAssignableFrom, isConfigOnly, isCreated, isCutEvent, isDisabled, isDrawn, isFocused, 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, setBrowserSpellCheck, setCanEdit, setCanEditCriterionPredicate, setCanEditOpaqueValues, setCanFocus, setCanHover, setCanSelectText, setCanTabToIcons, setCellHeight, setCellStyle, setClipStaticValue, setClipTitle, setColSpan, setColSpan, setConfigOnly, setControlStyle, setCriteriaField, setCriterion, setCriterionGetter, setCriterionSetter, 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, setEmptyDisplayValue, setEmptyValueIcon, setEndRow, setErrorFormatter, setErrorIconHeight, setErrorIconProperties, setErrorIconSrc, setErrorIconWidth, setErrorMessageWidth, setErrorOrientation, setErrors, setErrors, setExportFormat, setFilterLocally, setForeignDisplayField, setFormat, setFormula, setGlobalTabIndex, setHeight, setHeight, 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, setMultiple, setMultipleValueSeparator, setName, setNullOriginalValueText, setNullProperty, setOperator, setOptionCriteria, setOptionDataSource, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setOptionTextMatchStyle, setOriginalValueMessage, setPickerIconHeight, setPickerIconName, setPickerIconPrompt, setPickerIconProperties, setPickerIconSrc, setPickerIconStyle, setPickerIconWidth, setPrintReadOnlyTextBoxStyle, setPrintTextBoxStyle, setPrintTitleStyle, setPrompt, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyCanSelectText, setReadOnlyControlStyle, setReadOnlyDisplay, setReadOnlyHover, setReadOnlyTextBoxStyle, setReadOnlyWhen, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRequiredWhen, setRowSpan, setScClassName, setShouldSaveValue, 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, setSuppressValueIcon, setSynchronousValidation, setTabIndex, setTextAlign, 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, setWidth, setWrapHintText, setWrapStaticValue, setWrapTitle, shouldApplyHeightToTextBox, shouldSaveOnEnter, shouldStopKeyPressBubbling, show, showIcon, showPicker, stopHover, storeValue, 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
-
SpinnerItem
public SpinnerItem() -
SpinnerItem
-
SpinnerItem
-
SpinnerItem
-
-
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
-
getDecreaseIcon
Instacked mode, the icon to decrease the spinner's value (a down arrow by default). This icon is generated automatically using thecom.smartgwt.client.types.AutoChildpattern. For skinning purposes,decreaseIconDefaultsmay be modified using changeDefaults().If sizes for the increase and decrease icons are not explicitly specified in their autoChild configuration, they will be derived from the specified
stackedIconsHeightandstackedIconsWidthproperties.See the
skinning overviewfor details on how to provide a sprited image for these icons.This component is an AutoChild named "decreaseIcon". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current decreaseIcon value. Default value is null
-
setDecreaseIconProperties
FormItemIcon properties applied to thedecreaseIconAutoChild of this SpinnerItem.- Parameters:
decreaseIconProperties- New decreaseIconProperties value. Default value is null- Returns:
SpinnerIteminstance, for chaining setter calls
-
getIncreaseIcon
Instacked mode, the icon to increase the spinner's value (an up arrow by default). This icon is generated automatically using thecom.smartgwt.client.types.AutoChildpattern. For skinning purposes,increaseIconDefaultsmay be modified using changeDefaults().If sizes for the increase and decrease icons are not explicitly specified in their autoChild configuration, they will be derived from the specified
stackedIconsHeightandstackedIconsWidthproperties.See the
skinning overviewfor details on how to provide a sprited image for these icons.This component is an AutoChild named "increaseIcon". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current increaseIcon value. Default value is null
-
setIncreaseIconProperties
FormItemIcon properties applied to theincreaseIconAutoChild of this SpinnerItem.- Parameters:
increaseIconProperties- New increaseIconProperties value. Default value is null- Returns:
SpinnerIteminstance, for chaining setter calls
-
setMask
Not applicable to a SpinnerItem.Note : This is an advanced setting
- Overrides:
setMaskin classTextItem- Parameters:
mask- New mask value. Default value is null- Returns:
SpinnerIteminstance, for chaining setter calls- See Also:
-
getMask
Not applicable to a SpinnerItem. -
setMaskOverwriteMode
Not applicable to a SpinnerItem.Note : This is an advanced setting
- Overrides:
setMaskOverwriteModein classTextItem- Parameters:
maskOverwriteMode- New maskOverwriteMode value. Default value is null- Returns:
SpinnerIteminstance, for chaining setter calls
-
getMaskOverwriteMode
Not applicable to a SpinnerItem.- Overrides:
getMaskOverwriteModein classTextItem- Returns:
- Current maskOverwriteMode value. Default value is null
-
setMaskPadChar
Not applicable to a SpinnerItem.Note : This is an advanced setting
- Overrides:
setMaskPadCharin classTextItem- Parameters:
maskPadChar- New maskPadChar value. Default value is " "- Returns:
SpinnerIteminstance, for chaining setter calls
-
getMaskPadChar
Not applicable to a SpinnerItem.- Overrides:
getMaskPadCharin classTextItem- Returns:
- Current maskPadChar value. Default value is " "
-
setMaskPromptChar
Not applicable to a SpinnerItem.Note : This is an advanced setting
- Overrides:
setMaskPromptCharin classTextItem- Parameters:
maskPromptChar- New maskPromptChar value. Default value is "_"- Returns:
SpinnerIteminstance, for chaining setter calls
-
getMaskPromptChar
Not applicable to a SpinnerItem.- Overrides:
getMaskPromptCharin classTextItem- Returns:
- Current maskPromptChar value. Default value is "_"
-
setMaskSaveLiterals
Not applicable to a SpinnerItem.Note : This is an advanced setting
- Overrides:
setMaskSaveLiteralsin classTextItem- Parameters:
maskSaveLiterals- New maskSaveLiterals value. Default value is null- Returns:
SpinnerIteminstance, for chaining setter calls
-
getMaskSaveLiterals
Not applicable to a SpinnerItem.- Overrides:
getMaskSaveLiteralsin classTextItem- Returns:
- Current maskSaveLiterals value. Default value is null
-
setMax
Maximum valid value for this item. If this andminare both null or unspecified, then thenextValueHandlerandpreviousValueHandlerare used to increase or decrease the value and these handlers are also used to determine the maximum value.- Parameters:
max- New max value. Default value is null- Returns:
SpinnerIteminstance, for chaining setter calls- See Also:
-
getMax
Maximum valid value for this item. If this andminare both null or unspecified, then thenextValueHandlerandpreviousValueHandlerare used to increase or decrease the value and these handlers are also used to determine the maximum value.- Returns:
- Current max value. Default value is null
- See Also:
-
setMin
Minimum valid value for this item. If this andmaxare both null or unspecified, then thenextValueHandlerandpreviousValueHandlerare used to increase or decrease the value and these handlers are also used to determine the minimum value.- Parameters:
min- New min value. Default value is null- Returns:
SpinnerIteminstance, for chaining setter calls- See Also:
-
getMin
Minimum valid value for this item. If this andmaxare both null or unspecified, then thenextValueHandlerandpreviousValueHandlerare used to increase or decrease the value and these handlers are also used to determine the minimum value.- Returns:
- Current min value. Default value is null
- See Also:
-
setStackedIconsHeight
Instacked icons modethis property can be used to specify the height of both the increase and decrease icon. Since the icons are stacked vertically, each icon will be sized to half this specified value. If a height property is explicitly set for the icon viaincreaseIconProperties,decreaseIconProperties, or relatedDefaultsproperty blocks, that will take precedence over any specified stackedIconsHeight.See also
stackedIconsWidth.- Parameters:
stackedIconsHeight- New stackedIconsHeight value. Default value is 18- Returns:
SpinnerIteminstance, for chaining setter calls
-
getStackedIconsHeight
Instacked icons modethis property can be used to specify the height of both the increase and decrease icon. Since the icons are stacked vertically, each icon will be sized to half this specified value. If a height property is explicitly set for the icon viaincreaseIconProperties,decreaseIconProperties, or relatedDefaultsproperty blocks, that will take precedence over any specified stackedIconsHeight.See also
stackedIconsWidth.- Returns:
- Current stackedIconsHeight value. Default value is 18
-
setStackedIconsWidth
Instacked icons modethis property can be used to specify the width of both the increase and decrease icon. If a width property is explicitly set for the icon viaincreaseIconProperties,decreaseIconProperties, or relatedDefaultsproperty blocks, that will take precedence over any specified stackedIconsWidth.See also
stackedIconsHeight.- Parameters:
stackedIconsWidth- New stackedIconsWidth value. Default value is 16- Returns:
SpinnerIteminstance, for chaining setter calls
-
getStackedIconsWidth
Instacked icons modethis property can be used to specify the width of both the increase and decrease icon. If a width property is explicitly set for the icon viaincreaseIconProperties,decreaseIconProperties, or relatedDefaultsproperty blocks, that will take precedence over any specified stackedIconsWidth.See also
stackedIconsHeight.- Returns:
- Current stackedIconsWidth value. Default value is 16
-
setStep
How much should the value be incremented / decremented when the user hits the icons to increase / decrease the value?When providing a
nextValueHandlerand/orpreviousValueHandler, the sign of the step value determines whether these handlers are expected to induce monotonically increasing or decreasing functions.- Parameters:
step- New step value. Default value is 1- Returns:
SpinnerIteminstance, for chaining setter calls- See Also:
-
getStep
public double getStep()How much should the value be incremented / decremented when the user hits the icons to increase / decrease the value?When providing a
nextValueHandlerand/orpreviousValueHandler, the sign of the step value determines whether these handlers are expected to induce monotonically increasing or decreasing functions.- Returns:
- Current step value. Default value is 1
- See Also:
-
getUnstackedDecreaseIcon
Inunstacked mode, the icon to decrease theSpinnerItem's value.By default,
"[SKIN]/DynamicForm/Spinner_decrease_icon.png"is stretched to an 18x18 icon.When
spritingis enabled, this property will not be used to locate an image, instead, the image is drawn via CSS based on theFormItemIcon.baseStyleproperty.This component is an AutoChild named "unstackedDecreaseIcon". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current unstackedDecreaseIcon value. Default value is null
-
getUnstackedIncreaseIcon
Inunstacked mode, the icon to increase theSpinnerItem's value.By default,
"[SKIN]/DynamicForm/Spinner_increase_icon.png"is stretched to an 18x18 icon.When
spritingis enabled, this property will not be used to locate an image, instead, the image is drawn via CSS based on theFormItemIcon.baseStyleproperty.This component is an AutoChild named "unstackedIncreaseIcon". For an overview of how to use and configure AutoChildren, see
Using AutoChildren.- Returns:
- Current unstackedIncreaseIcon value. Default value is null
-
setUnstackedPrintTextBoxStyle
Inunstacked mode, the base CSS class name for theSpinnerItem's text box element when printed. If unset, thenunstackedTextBoxStyleis used.- Parameters:
unstackedPrintTextBoxStyle- New unstackedPrintTextBoxStyle value. Default value is null- Returns:
SpinnerIteminstance, for chaining setter calls- See Also:
-
getUnstackedPrintTextBoxStyle
Inunstacked mode, the base CSS class name for theSpinnerItem's text box element when printed. If unset, thenunstackedTextBoxStyleis used.- Returns:
- Current unstackedPrintTextBoxStyle value. Default value is null
- See Also:
-
setUnstackedReadOnlyTextBoxStyle
- Parameters:
unstackedReadOnlyTextBoxStyle- New unstackedReadOnlyTextBoxStyle value. Default value is null- Returns:
SpinnerIteminstance, for chaining setter calls- See Also:
-
getUnstackedReadOnlyTextBoxStyle
- Returns:
- Current unstackedReadOnlyTextBoxStyle value. Default value is null
- See Also:
-
setUnstackedTextBoxStyle
Inunstacked mode, the base CSS class name for theSpinnerItem's text box element.NOTE: See the
CompoundFormItem_skinningdiscussion for special skinning considerations.- Parameters:
unstackedTextBoxStyle- New unstackedTextBoxStyle value. Default value is "textItem"- Returns:
SpinnerIteminstance, for chaining setter calls- See Also:
-
getUnstackedTextBoxStyle
Inunstacked mode, the base CSS class name for theSpinnerItem's text box element.NOTE: See the
CompoundFormItem_skinningdiscussion for special skinning considerations.- Returns:
- Current unstackedTextBoxStyle value. Default value is "textItem"
- See Also:
-
setWriteStackedIcons
When set totrue, the increase and decrease icons are stacked on top of each other, also called stacked mode. Whenfalse, the increase and decrease icons are placed on the same line as theSpinnerItem's text box, also called unstacked mode. Whennull, a default setting depending onisTouchis used (for touch browsers, the default isfalse/unstacked mode).In stacked mode,
increaseIconanddecreaseIconcontrol the appearance of the stacked icons.In unstacked mode,
unstackedIncreaseIconandunstackedDecreaseIconcontrol the appearance of the unstacked icons.- Parameters:
writeStackedIcons- New writeStackedIcons value. Default value is null- Returns:
SpinnerIteminstance, for chaining setter calls- See Also:
-
getWriteStackedIcons
When set totrue, the increase and decrease icons are stacked on top of each other, also called stacked mode. Whenfalse, the increase and decrease icons are placed on the same line as theSpinnerItem's text box, also called unstacked mode. Whennull, a default setting depending onisTouchis used (for touch browsers, the default isfalse/unstacked mode).In stacked mode,
increaseIconanddecreaseIconcontrol the appearance of the stacked icons.In unstacked mode,
unstackedIncreaseIconandunstackedDecreaseIconcontrol the appearance of the unstacked icons.- Returns:
- Current writeStackedIcons value. Default value is null
- See Also:
-
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:
spinnerItemProperties- properties that should be used as new defaults when instances of this class are created- See Also:
-
setMax
-
setMin
-
setStep
-
setStep
-
setMin
-
setMax
-
setNextValueHandler
Whenminandmaxare both null or unspecified, the nextValueHandler is used to get the next higher value from the currentValue. The default implementation returns (currentValue + step).To indicate that the given currentValue is the maximum value, return currentValue again.
Implementations should expect to be passed any value for currentValue. Also, if
stepis non-negative, the nextValueHandler must induce a monotonically increasing (non-decreasing) function; otherwise, the nextValueHandler must induce a monotonically decreasing function. -
setPreviousValueHandler
Whenminandmaxare both null or unspecified, the previousValueHandler is used to get the previous lower value from the currentValue. The default implementation returns (currentValue + step) because the step parameter is based on the opposite ofthis.step.To indicate that the given currentValue is the minimum value, return currentValue again.
Implementations should expect to be passed any value for currentValue. Also, if
stepis non-negative, the previousValueHandler must induce a monotonically decreasing (non-increasing) function; otherwise, the previousValueHandler must induce a monotonically increasing function.
-