public class SpinnerItem extends TextItem
scClassNameid| Constructor and Description |
|---|
SpinnerItem() |
SpinnerItem(com.google.gwt.core.client.JavaScriptObject jsObj) |
SpinnerItem(java.lang.String name) |
SpinnerItem(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) |
FormItemIcon |
getDecreaseIcon()
Icon to decrease the spinner's value (a down arrow by default).
|
FormItemIcon |
getIncreaseIcon()
Icon to increase the spinner's value (an up arrow by default).
|
java.lang.String |
getMask()
Not applicable to a SpinnerItem.
|
java.lang.Boolean |
getMaskOverwriteMode()
Not applicable to a SpinnerItem.
|
java.lang.String |
getMaskPadChar()
Not applicable to a SpinnerItem.
|
java.lang.String |
getMaskPromptChar()
Not applicable to a SpinnerItem.
|
java.lang.Boolean |
getMaskSaveLiterals()
Not applicable to a SpinnerItem.
|
java.lang.Double |
getMax()
Maximum valid value for this item.
|
java.lang.Double |
getMin()
Minimum valid value for this item.
|
static SpinnerItem |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
double |
getStep()
How much should the value be incremented / decremented when the user hits the icons to increase / decrease the value?
|
void |
setDecreaseIconProperties(FormItemIcon decreaseIconProperties)
FormItemIcon properties applied to the
decreaseIcon AutoChild of this SpinnerItem. |
static void |
setDefaultProperties(SpinnerItem spinnerItemProperties)
Class level method to set the default properties of this class.
|
void |
setDefaultValue(java.lang.Double defaultValue)
Value used when no value is provided for this item.
|
void |
setDefaultValue(java.lang.Integer defaultValue)
Value used when no value is provided for this item.
|
void |
setIncreaseIconProperties(FormItemIcon increaseIconProperties)
FormItemIcon properties applied to the
increaseIcon AutoChild of this SpinnerItem. |
void |
setMask(java.lang.String mask)
Not applicable to a SpinnerItem.
|
void |
setMaskOverwriteMode(java.lang.Boolean maskOverwriteMode)
Not applicable to a SpinnerItem.
|
void |
setMaskPadChar(java.lang.String maskPadChar)
Not applicable to a SpinnerItem.
|
void |
setMaskPromptChar(java.lang.String maskPromptChar)
Not applicable to a SpinnerItem.
|
void |
setMaskSaveLiterals(java.lang.Boolean maskSaveLiterals)
Not applicable to a SpinnerItem.
|
void |
setMax(java.lang.Double max)
Maximum valid value for this item.
|
void |
setMax(java.lang.Integer max) |
void |
setMin(java.lang.Double min)
Minimum valid value for this item.
|
void |
setMin(java.lang.Integer min) |
void |
setNextValueHandler(NextValueHandler handler)
|
void |
setPreviousValueHandler(PreviousValueHandler handler)
|
void |
setStep(double step)
How much should the value be incremented / decremented when the user hits the icons to increase / decrease the value?
|
deselectValue, deselectValue, getBrowserAutoCapitalize, getBrowserAutoCorrect, getBrowserInputType, getChangeOnKeypress, getCharacterCasing, getEnteredValue, getFormatOnBlur, getFormatOnFocusChange, getHint, getKeyPressFilter, getLength, getPrintFullText, getSaveOnEnter, getSelectionRange, getSelectOnClick, getSelectOnFocus, getShowHintInField, getTextBoxStyle, getValueAsString, selectValue, setBrowserAutoCapitalize, setBrowserAutoCorrect, setBrowserInputType, setChangeOnKeypress, setCharacterCasing, setDefaultProperties, setFormatOnBlur, setFormatOnFocusChange, setKeyPressFilter, setLength, setPrintFullText, setSaveOnEnter, setSelectionRange, setSelectOnClick, setSelectOnFocus, setShowHintInField, setTextBoxStyle_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, 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, getHeight, getHeightAsString, 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, getPrompt, getReadOnlyDisplay, getReadOnlyTextBoxStyle, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRowSpan, getScClassName, getSelectedRecord, getShouldSaveValue, getShowClippedTitleOnHover, getShowClippedValueOnHover, getShowDisabled, getShowErrorIcon, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedErrorState, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowOverIcons, getShowPickerIcon, getShowRTL, getShowTitle, getShowValueIconOnly, getStartRow, getStopOnError, getSuppressValueIcon, getSynchronousValidation, getTabIndex, getTextAlign, 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, hasAdvancedCriteria, 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, setCanEditCriterionPredicate, setCanEditOpaqueValues, setCanFocus, setCanSelectText, setCellHeight, setCellStyle, setClipStaticValue, setClipTitle, setColSpan, setColSpan, setControlStyle, setCriteriaField, setCriterion, setCriterionGetter, setCriterionSetter, setDataPath, setDateFormatter, setDecimalPad, setDecimalPrecision, setDefaultIconSrc, setDefaultProperties, 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, setHeight, setHeight, 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, setPrompt, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyDisplay, setReadOnlyTextBoxStyle, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRowSpan, setScClassName, setShouldSaveValue, setShowClippedTitleOnHover, setShowClippedValueOnHover, setShowDisabled, setShowErrorIcon, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedErrorState, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIfCondition, setShowOverIcons, setShowPickerIcon, setShowRTL, setShowTitle, setShowValueIconOnly, setStartRow, setStopOnError, setSuppressValueIcon, setSynchronousValidation, setTabIndex, setTextAlign, 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, storeValue, updateState, validate, valueClippedgetRef, getRef, internalSetIDdoAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObjectequals, getJsObj, hashCode, setJavaScriptObject, setJsObjpublic SpinnerItem()
public SpinnerItem(com.google.gwt.core.client.JavaScriptObject jsObj)
public SpinnerItem(java.lang.String name)
public SpinnerItem(java.lang.String name,
java.lang.String title)
public static SpinnerItem 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.AutoChildUsagepublic 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.AutoChildUsagepublic static void changePickerIconDefaults(FormItemIcon defaults)
public FormItemIcon getDecreaseIcon()
For an overview of how to use and configure AutoChildren, see Using AutoChildren.
public void setDecreaseIconProperties(FormItemIcon decreaseIconProperties)
decreaseIcon AutoChild of this SpinnerItem.decreaseIconProperties - Default value is nullpublic FormItemIcon getIncreaseIcon()
For an overview of how to use and configure AutoChildren, see Using AutoChildren.
public void setIncreaseIconProperties(FormItemIcon increaseIconProperties)
increaseIcon AutoChild of this SpinnerItem.increaseIconProperties - Default value is nullpublic void setMask(java.lang.String mask)
Note : This is an advanced setting
setMask in class TextItemmask - Default value is nullTextItem.setKeyPressFilter(java.lang.String),
Text - Masked Examplepublic java.lang.String getMask()
getMask in class TextItemTextItem.getKeyPressFilter(),
Text - Masked Examplepublic void setMaskOverwriteMode(java.lang.Boolean maskOverwriteMode)
Note : This is an advanced setting
setMaskOverwriteMode in class TextItemmaskOverwriteMode - Default value is nullpublic java.lang.Boolean getMaskOverwriteMode()
getMaskOverwriteMode in class TextItempublic void setMaskPadChar(java.lang.String maskPadChar)
Note : This is an advanced setting
setMaskPadChar in class TextItemmaskPadChar - Default value is " "public java.lang.String getMaskPadChar()
getMaskPadChar in class TextItempublic void setMaskPromptChar(java.lang.String maskPromptChar)
Note : This is an advanced setting
setMaskPromptChar in class TextItemmaskPromptChar - Default value is "_"public java.lang.String getMaskPromptChar()
getMaskPromptChar in class TextItempublic void setMaskSaveLiterals(java.lang.Boolean maskSaveLiterals)
Note : This is an advanced setting
setMaskSaveLiterals in class TextItemmaskSaveLiterals - Default value is nullpublic java.lang.Boolean getMaskSaveLiterals()
getMaskSaveLiterals in class TextItempublic void setMax(java.lang.Double max)
min
are both null or unspecified, then the nextValueHandler and previousValueHandler
are used to increase or decrease the value and these handlers are also used to determine the maximum value.max - Default value is nullpublic java.lang.Double getMax()
min
are both null or unspecified, then the nextValueHandler and previousValueHandler
are used to increase or decrease the value and these handlers are also used to determine the maximum value.public void setMin(java.lang.Double min)
max
are both null or unspecified, then the nextValueHandler and previousValueHandler
are used to increase or decrease the value and these handlers are also used to determine the minimum value.min - Default value is nullpublic java.lang.Double getMin()
max
are both null or unspecified, then the nextValueHandler and previousValueHandler
are used to increase or decrease the value and these handlers are also used to determine the minimum value.public void setStep(double step)
When providing a nextValueHandler and/or previousValueHandler,
the sign of the step value determines whether these handlers are expected to induce monotonically increasing or
decreasing functions.
step - Default value is 1public double getStep()
When providing a nextValueHandler and/or previousValueHandler,
the sign of the step value determines whether these handlers are expected to induce monotonically increasing or
decreasing functions.
public static void setDefaultProperties(SpinnerItem spinnerItemProperties)
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.
spinnerItemProperties - properties that should be used as new defaults when instances of this class are createdpublic final void setMax(java.lang.Integer max)
public final void setMin(java.lang.Integer min)
public void setDefaultValue(java.lang.Double defaultValue)
FormItemnull programmatically, it will be reverted to the defaultValue. Developers
should use the values object if their intention
is to provide an initial value for a field in a form rather than a value to use in place of null.setDefaultValue in class FormItemdefaultValue - defaultValue Default value is nullpublic void setDefaultValue(java.lang.Integer defaultValue)
FormItemnull programmatically, it will be reverted to the defaultValue. Developers
should use the values object if their intention
is to provide an initial value for a field in a form rather than a value to use in place of null.setDefaultValue in class FormItemdefaultValue - defaultValue Default value is nullpublic void setNextValueHandler(NextValueHandler handler)
min and
max are 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
step is non-negative,
the nextValueHandler must induce a monotonically increasing (non-decreasing) function;
otherwise, the nextValueHandler must induce a monotonically decreasing function.
public void setPreviousValueHandler(PreviousValueHandler handler)
min and
max are 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 of
this.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
step is non-negative,
the previousValueHandler must induce a monotonically decreasing (non-increasing) function;
otherwise, the previousValueHandler must induce a monotonically increasing function.