public class ColorItem extends TextItem implements HasPickerColorSelectedHandlers
ColorPicker.FormItem.CustomStateGetter, FormItem.StateCustomizerscClassName, warnOnEditorTypeConversion, warnOnEditorTypeConversionDefaultidfactoryCreated, factoryProperties, readOnly| Constructor and Description |
|---|
ColorItem() |
ColorItem(com.google.gwt.core.client.JavaScriptObject jsObj) |
ColorItem(java.lang.String name) |
ColorItem(java.lang.String name,
java.lang.String title) |
| Modifier and Type | Method and Description |
|---|---|
com.google.gwt.event.shared.HandlerRegistration |
addPickerColorSelectedHandler(PickerColorSelectedHandler handler)
Add a pickerColorSelected handler.
|
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 |
getAllowComplexMode()
Should "complex" mode be allowed for the
ColorPicker window associated with
this ColorItem? |
ColorPickerMode |
getDefaultPickerMode()
|
static ColorItem |
getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj) |
java.lang.Integer |
getPickerIconHeight()
If
showPickerIcon is true for this item,
this property governs the size of the picker icon. |
java.lang.String |
getPickerIconPrompt()
Prompt to show when the user hovers the mouse over the picker icon.
|
java.lang.String |
getPickerIconSrc()
If
showPickerIcon is true for this item,
this property governs the src of the picker icon
image to be displayed. |
java.lang.Integer |
getPickerIconWidth()
If
showPickerIcon is true for this item,
this property governs the size of the picker icon. |
java.lang.Boolean |
getShowPickerIcon()
Should the pick button icon be shown for choosing colors from a ColorPicker
|
java.lang.Boolean |
getSupportsTransparency()
Determines whether the
ColorPicker associated with this ColorItem allows the
user to set transparency/opacity information whilst selecting a color. |
void |
setAllowComplexMode(java.lang.Boolean allowComplexMode)
Should "complex" mode be allowed for the
ColorPicker window associated with
this ColorItem? |
void |
setDefaultPickerMode(ColorPickerMode defaultPickerMode)
|
static void |
setDefaultProperties(ColorItem colorItemProperties)
Class level method to set the default properties of this class.
|
void |
setPickerIconHeight(java.lang.Integer pickerIconHeight)
If
showPickerIcon is true for this item,
this property governs the size of the picker icon. |
void |
setPickerIconPrompt(java.lang.String pickerIconPrompt)
Prompt to show when the user hovers the mouse over the picker icon.
|
void |
setPickerIconSrc(java.lang.String pickerIconSrc)
If
showPickerIcon is true for this item,
this property governs the src of the picker icon
image to be displayed. |
void |
setPickerIconWidth(java.lang.Integer pickerIconWidth)
If
showPickerIcon is true for this item,
this property governs the size of the picker icon. |
void |
setShowPickerIcon(java.lang.Boolean showPickerIcon)
Should the pick button icon be shown for choosing colors from a ColorPicker
|
void |
setSupportsTransparency(java.lang.Boolean supportsTransparency)
Determines whether the
ColorPicker associated with this ColorItem allows the
user to set transparency/opacity information whilst selecting a color. |
deselectValue, deselectValue, getBrowserAutoCapitalize, getBrowserAutoCorrect, getBrowserInputType, getChangeOnKeypress, getCharacterCasing, getEditProxyConstructor, getEnforceLength, getEnteredValue, getEscapeHTML, getFetchMissingValues, getFormatOnBlur, getFormatOnFocusChange, getHint, getKeyPressFilter, getLength, getMask, getMaskOverwriteMode, getMaskPadChar, getMaskPromptChar, getMaskSaveLiterals, getPrintFullText, getSaveOnEnter, getSelectionRange, getSelectOnClick, getSelectOnFocus, getShowHintInField, getSupportsCutPasteEvents, getTextBoxStyle, getUsePlaceholderForHint, getValueAsString, pendingStatusChanged, selectValue, setBrowserAutoCapitalize, setBrowserAutoCorrect, setBrowserInputType, setChangeOnKeypress, setCharacterCasing, setDefaultProperties, setEditProxyConstructor, setEnforceLength, setEscapeHTML, setFetchMissingValues, setFormatOnBlur, setFormatOnFocusChange, setKeyPressFilter, setLength, setMask, setMaskOverwriteMode, setMaskPadChar, setMaskPromptChar, setMaskSaveLiterals, setPastedValueTransformer, setPrintFullText, setSaveOnEnter, setSelectionRange, setSelectOnClick, setSelectOnFocus, setShowHintInField, setSupportsCutPasteEvents, setTextBoxStyle, setUsePlaceholderForHint, shouldFetchMissingValue_getValue, addBlurHandler, addChangedHandler, addChangeHandler, addClickHandler, addDoubleClickHandler, addEditorEnterHandler, addEditorExitHandler, addFocusHandler, addIconClickHandler, addIconKeyPressHandler, addItemHoverHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addPendingStatusChangedHandler, addPickerIconClickHandler, addShowContextMenuHandler, addTitleClickHandler, addTitleDoubleClickHandler, addTitleHoverHandler, addValueHoverHandler, addValueIconClickHandler, applyFormula, asSGWTComponent, blurItem, canEditCriterion, clearErrors, clearValue, disable, disableIcon, enable, enableIcon, error, error, errorIfNotCreated, focusInItem, getAccessKey, getAlign, getAllowExpressions, getAlwaysFetchMissingValues, getApplyAlignToText, getApplyHeightToTextBox, getAriaRole, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsObject, getAttributeAsString, getAutoComplete, getBrowserSpellCheck, getCanEdit, getCanEditOpaqueValues, getCanFocus, getCanSelectText, getCanTabToIcons, getCanvasAutoChild, getCellHeight, getCellStyle, getClassName, getClipStaticValue, getClipTitle, getConfig, getContainerWidget, getControlStyle, getCriteriaField, getCriterion, getCriterion, getCursorPosition, getCustomState, getDataPath, getDateFormatter, getDecimalPad, getDecimalPrecision, getDefaultIconSrc, getDisabled, getDisableIconsOnReadOnly, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEditPendingCSSText, getEmptyDisplayValue, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getErrors, getExportFormat, getFieldName, getFilterLocally, getForeignDisplayField, getForm, getFormat, getFormItemAutoChild, getFormula, getFullDataPath, getGlobalTabIndex, getGridColNum, getGridRowNum, getHeight, getHeightAsString, getHidden, getHintStyle, getHoverAlign, getHoverDelay, getHoverHeight, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getIcon, getIconHeight, getIconHSpace, getIconPageRect, getIconPrompt, getIconRect, getIconVAlign, getIconWidth, getImageURLPrefix, getImageURLSuffix, getImplicitSave, getImplicitSaveOnBlur, getInputFormat, getLeft, getLoadingDisplayValue, getLocateItemBy, getMinHintWidth, getMultipleValueSeparator, getName, getOperator, getOptionCriteria, getOptionDataSource, getOptionDataSourceAsString, getOptionFilterContext, getOptionOperationId, getOriginalValueMessage, getPageLeft, getPageRect, getPageTop, getPicker, getPickerIconName, getPickerIconProperties, getPickerIconStyle, getPixelHeight, getPixelWidth, getPrintTextBoxStyle, getPrintTitleStyle, getPrompt, getReadOnlyDisplay, getReadOnlyHover, getReadOnlyTextBoxStyle, getReadOnlyWhen, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRequiredWhen, getRowSpan, getScClassName, getSelectedRecord, getShouldSaveValue, getShowClippedTitleOnHover, getShowClippedValueOnHover, getShowDeletions, getShowDisabled, getShowErrorIcon, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedErrorState, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowOldValueInHover, getShowOver, getShowOverIcons, getShowPending, getShowRTL, getShowTitle, getShowValueIconOnly, getStartRow, getStaticHeight, getStopOnError, getSuppressValueIcon, getSynchronousValidation, getTabIndex, getTextAlign, getTextFormula, getTimeFormatter, getTitle, getTitleAlign, getTitleColSpan, getTitleOrientation, getTitleStyle, getTitleVAlign, getTooltip, getTop, getType, getUpdateControlOnOver, getUpdatePickerIconOnOver, getUpdateTextBoxOnOver, getUseDisabledHintStyleForReadOnly, getValidateOnChange, getValidateOnExit, getValidOperators, getVAlign, getValue, getValueAsRecordList, getValueDeselectedCSSText, getValueField, getValueFieldName, getValueIconHeight, getValueIconLeftPadding, getValueIconRightPadding, getValueIconSize, getValueIconWidth, getVisible, getVisibleHeight, getVisibleTitleWidth, getVisibleWhen, getVisibleWidth, getWarnOnEditorTypeConversion, getWarnOnEditorTypeConversionDefault, getWidth, getWidthAsString, getWrapHintText, getWrapTitle, handleWarnOnEditorTypeConversion, hasAdvancedCriteria, hasErrors, hide, hideIcon, invalidateDisplayValueCache, isCreated, isCutEvent, isDisabled, isDrawn, isFocused, isInGrid, isPasteEvent, isVisible, linkToInstanceUponCreate, mapDisplayToValue, mapValueToDisplay, mapValueToDisplay, mapValueToDisplay, redraw, redraw, setAccessKey, setAlign, setAllowExpressions, setAlwaysFetchMissingValues, 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, setBrowserSpellCheck, setCanEdit, setCanEditCriterionPredicate, setCanEditOpaqueValues, setCanFocus, setCanSelectText, setCanTabToIcons, setCellHeight, setCellStyle, setClipStaticValue, setClipTitle, setColSpan, setColSpan, setControlStyle, setCriteriaField, setCriterion, setCriterionGetter, setCriterionSetter, setCustomStateGetter, 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, setErrors, setErrors, setExportFormat, setFilterLocally, setForeignDisplayField, setFormat, setFormula, setGlobalTabIndex, setHeight, setHeight, setHidden, setHint, setHintStyle, setHoverAlign, setHoverDelay, setHoverHeight, setHoverOpacity, setHoverStyle, setHoverVAlign, setHoverWidth, setIconDisabled, setIconHeight, setIconHSpace, setIconPrompt, setIcons, setIconVAlign, setIconWidth, setImageURLPrefix, setImageURLSuffix, setImplicitSave, setImplicitSaveOnBlur, setInitHandler, setInputFormat, setInputTransformer, setItemHoverFormatter, setItemTitleHoverFormatter, setItemValueHoverFormatter, setJavaScriptObject, setLeft, setLoadingDisplayValue, setLocateItemBy, setMinHintWidth, setMultipleValueSeparator, setName, setNullProperty, setOperator, setOptionCriteria, setOptionDataSource, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setOriginalValueMessage, setPickerIconName, setPickerIconProperties, setPickerIconStyle, setPrintTextBoxStyle, setPrintTitleStyle, setPrompt, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyDisplay, setReadOnlyHover, setReadOnlyTextBoxStyle, setReadOnlyWhen, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRequiredWhen, setRowSpan, setScClassName, setShouldSaveValue, setShowClippedTitleOnHover, setShowClippedValueOnHover, setShowDeletions, setShowDisabled, setShowErrorIcon, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedErrorState, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIfCondition, setShowOldValueInHover, setShowOver, setShowOverIcons, setShowPending, setShowRTL, setShowTitle, setShowValueIconOnly, setStartRow, setStateCustomizer, setStaticHeight, setStopOnError, setSuppressValueIcon, setSynchronousValidation, setTabIndex, setTextAlign, setTextFormula, setTimeFormatter, setTitle, setTitleAlign, setTitleColSpan, setTitleHoverFormatter, setTitleOrientation, setTitleStyle, setTitleVAlign, setTooltip, setTop, setType, setUpdateControlOnOver, setUpdatePickerIconOnOver, setUpdateTextBoxOnOver, setUseDisabledHintStyleForReadOnly, 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, setWrapTitle, shouldApplyHeightToTextBox, shouldSaveOnEnter, shouldStopKeyPressBubbling, show, showIcon, showPicker, stopHover, storeValue, storeValue, updateState, validate, valueClippedgetRef, getRef, internalSetIDapplyFactoryProperties, doAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, getReadOnly, isFactoryCreated, logConfiguration, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated, setReadOnlypublic ColorItem()
public ColorItem(com.google.gwt.core.client.JavaScriptObject jsObj)
public ColorItem(java.lang.String name)
public ColorItem(java.lang.String name,
java.lang.String title)
public static ColorItem 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. For usage tips on this
param, see SGWTProperties.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. For usage tips on this
param, see SGWTProperties.AutoChildUsagepublic static void changePickerIconDefaults(FormItemIcon defaults)
public void setAllowComplexMode(java.lang.Boolean allowComplexMode)
ColorPicker window associated with
this ColorItem?If false, no "More" button is shown on the simple picker
allowComplexMode - Default value is truepublic java.lang.Boolean getAllowComplexMode()
ColorPicker window associated with
this ColorItem?If false, no "More" button is shown on the simple picker
public void setDefaultPickerMode(ColorPickerMode defaultPickerMode)
defaultPickerMode - Default value is "simple"ColorPicker.setDefaultPickMode(com.smartgwt.client.types.ColorPickerMode)public ColorPickerMode getDefaultPickerMode()
ColorPicker.getDefaultPickMode()public void setPickerIconHeight(java.lang.Integer pickerIconHeight)
showPickerIcon is true for this item,
this property governs the size of the picker icon. If unset, the picker icon will be sized as a square to fit in the
available height for the icon. It is not recommended to change the pickerIconHeight from the default value if spriting is enabled because the image sprites are set up assuming specific, fixed
dimensions of the picker icon. If the pickerIconHeight must be changed, then the pickerIconStyle should be changed to a custom CSS
style name.
setPickerIconHeight in class FormItempickerIconHeight - Default value is 18public java.lang.Integer getPickerIconHeight()
showPickerIcon is true for this item,
this property governs the size of the picker icon. If unset, the picker icon will be sized as a square to fit in the
available height for the icon. It is not recommended to change the pickerIconHeight from the default value if spriting is enabled because the image sprites are set up assuming specific, fixed
dimensions of the picker icon. If the pickerIconHeight must be changed, then the pickerIconStyle should be changed to a custom CSS
style name.
getPickerIconHeight in class FormItempublic void setPickerIconPrompt(java.lang.String pickerIconPrompt)
setPickerIconPrompt in class FormItempickerIconPrompt - HTMLString . Default value is "Click to select a new color"public java.lang.String getPickerIconPrompt()
getPickerIconPrompt in class FormItemHTMLStringpublic void setPickerIconSrc(java.lang.String pickerIconSrc)
showPickerIcon is true for this item,
this property governs the src of the picker icon
image to be displayed.setPickerIconSrc in class FormItempickerIconSrc - SCImgURL . Default value is "[SKIN]/DynamicForm/ColorPicker_icon.png"public java.lang.String getPickerIconSrc()
showPickerIcon is true for this item,
this property governs the src of the picker icon
image to be displayed.getPickerIconSrc in class FormItemSCImgURLpublic void setPickerIconWidth(java.lang.Integer pickerIconWidth)
showPickerIcon is true for this item,
this property governs the size of the picker icon. If unset, the picker icon will be sized as a square to fit in the
available height for the icon. It is not recommended to change the pickerIconWidth from the default value if spriting is enabled because the image sprites are set up assuming specific, fixed
dimensions of the picker icon. If the pickerIconWidth must be changed, then the pickerIconStyle should be changed to a custom CSS
style name.
setPickerIconWidth in class FormItempickerIconWidth - Default value is 18public java.lang.Integer getPickerIconWidth()
showPickerIcon is true for this item,
this property governs the size of the picker icon. If unset, the picker icon will be sized as a square to fit in the
available height for the icon. It is not recommended to change the pickerIconWidth from the default value if spriting is enabled because the image sprites are set up assuming specific, fixed
dimensions of the picker icon. If the pickerIconWidth must be changed, then the pickerIconStyle should be changed to a custom CSS
style name.
getPickerIconWidth in class FormItempublic void setShowPickerIcon(java.lang.Boolean showPickerIcon)
setShowPickerIcon in class FormItemshowPickerIcon - Default value is truepublic java.lang.Boolean getShowPickerIcon()
getShowPickerIcon in class FormItempublic void setSupportsTransparency(java.lang.Boolean supportsTransparency)
ColorPicker associated with this ColorItem allows the
user to set transparency/opacity information whilst selecting a color. If false, no opacity slider is shown and all
colors are 100% opaque. Note ColorItems are representations of HTML color strings, they do not implicitly
support transparency. Setting supportsTransparency to true just allows the user to set opacity with the picker; if you
actually want to capture that information, you will also need to override ColorItem.pickerColorSelected().
supportsTransparency - Default value is falsepublic java.lang.Boolean getSupportsTransparency()
ColorPicker associated with this ColorItem allows the
user to set transparency/opacity information whilst selecting a color. If false, no opacity slider is shown and all
colors are 100% opaque. Note ColorItems are representations of HTML color strings, they do not implicitly
support transparency. Setting supportsTransparency to true just allows the user to set opacity with the picker; if you
actually want to capture that information, you will also need to override ColorItem.pickerColorSelected().
public com.google.gwt.event.shared.HandlerRegistration addPickerColorSelectedHandler(PickerColorSelectedHandler handler)
Store the color value selected by the user from the color picker. You will need to override this method if you wish
to capture opacity information from the ColorPicker
addPickerColorSelectedHandler in interface HasPickerColorSelectedHandlershandler - the pickerColorSelected handlerHandlerRegistration used to remove this handlerpublic static void setDefaultProperties(ColorItem colorItemProperties)
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.
colorItemProperties - properties that should be used as new defaults when instances of this class are createdSGWTProperties