public class ColorItem extends TextItem
id
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 |
---|---|
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? |
java.lang.String |
getDefaultPickerMode()
The
ColorPicker associated with this ColorItem can operate in either a "simple"
mode (where it displays just the 40 basic colors and allows the user to click one), or a "complex" mode (where the
user can specify a color from anywhere in the spectrum, with an optional alpha element). |
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 |
pickerColorSelected(java.lang.String color,
int opacity)
Store the color value selected by the user from the color picker.
|
void |
setAllowComplexMode(java.lang.Boolean allowComplexMode)
Should "complex" mode be allowed for the
ColorPicker window associated with
this ColorItem? |
void |
setDefaultPickerMode(java.lang.String defaultPickerMode)
The
ColorPicker associated with this ColorItem can operate in either a "simple"
mode (where it displays just the 40 basic colors and allows the user to click one), or a "complex" mode (where the
user can specify a color from anywhere in the spectrum, with an optional alpha element). |
static void |
setDefaultProperties(ColorItem colorItemProperties)
Class level method to set the default properties of this class.
|
void |
setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj) |
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, getEnteredValue, getFormatOnBlur, getFormatOnFocusChange, getHeight, getHint, getKeyPressFilter, getLength, getMask, getMaskOverwriteMode, getMaskPadChar, getMaskPromptChar, getMaskSaveLiterals, getPrintFullText, getSaveOnEnter, getSelectionRange, getSelectOnClick, getSelectOnFocus, getShowHintInField, getTextBoxStyle, getValueAsString, getWidth, selectValue, setBrowserAutoCapitalize, setBrowserAutoCorrect, setBrowserInputType, setChangeOnKeypress, setCharacterCasing, setDefaultProperties, setFormatOnBlur, setFormatOnFocusChange, setHeight, setKeyPressFilter, setLength, setMask, setMaskOverwriteMode, setMaskPadChar, setMaskPromptChar, setMaskSaveLiterals, setPrintFullText, setSaveOnEnter, setSelectionRange, setSelectOnClick, setSelectOnFocus, setShowHintInField, setTextBoxStyle, setWidth
_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, focusInItem, getAccessKey, getAlign, getAllowExpressions, getAlwaysFetchMissingValues, getApplyHeightToTextBox, getAriaRole, getAttribute, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsFloat, getAttributeAsInt, getAttributeAsJavaScriptObject, getAttributeAsString, getBrowserSpellCheck, getCanEdit, getCanFocus, getCanvasAutoChild, getCellHeight, getCellStyle, getClassName, getClipStaticValue, getClipTitle, getConfig, getContainerWidget, getCriteriaField, getCriterion, getCriterion, getDataPath, getDateFormatter, getDecimalPad, getDecimalPrecision, getDefaultIconSrc, getDisabled, getDisableIconsOnReadOnly, getDisplayField, getDisplayFieldName, getDisplayValue, getDisplayValue, getEditorTypeConfig, getEditPendingCSSText, getEmptyDisplayValue, getEmptyValueIcon, getEndRow, getErrorIconHeight, getErrorIconSrc, getErrorIconWidth, getErrorMessageWidth, getFetchMissingValues, getFieldName, getFilterLocally, getForm, getFormItemAutoChild, getFullDataPath, getGlobalTabIndex, getHintStyle, getHoverAlign, getHoverDelay, getHoverHeight, getHoverOpacity, getHoverStyle, getHoverVAlign, getHoverWidth, getIcon, getIconHeight, getIconHSpace, getIconPageRect, getIconPrompt, getIconRect, getIconVAlign, getIconWidth, getImageURLPrefix, getImageURLSuffix, getImplicitSave, getImplicitSaveOnBlur, getInputFormat, getLeft, getLocateItemBy, getMultipleValueSeparator, getName, getOperator, getOptionCriteria, getOptionFilterContext, getOptionOperationId, getPageLeft, getPageRect, getPageTop, getPicker, getPickerIconName, getPickerIconProperties, getPickerIconStyle, getPrintTextBoxStyle, getPrintTitleStyle, getPrompt, getReadOnlyDisplay, getReadOnlyTextBoxStyle, getRect, getRedrawOnChange, getRejectInvalidValueOnChange, getRequired, getRequiredMessage, getRowSpan, getSelectedRecord, getShouldSaveValue, getShowClippedTitleOnHover, getShowClippedValueOnHover, getShowDisabled, getShowErrorIcon, getShowErrorStyle, getShowErrorText, getShowFocused, getShowFocusedErrorState, getShowFocusedIcons, getShowFocusedPickerIcon, getShowHint, getShowIcons, getShowOverIcons, 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, 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, setAutoChildConstructor, setAutoChildProperties, setAutoChildProperties, setAutoChildVisibility, setBrowserSpellCheck, setCanEdit, setCanEditCriterionPredicate, setCanFocus, setCellHeight, setCellStyle, setClipStaticValue, setClipTitle, setColSpan, setColSpan, setCriteriaField, setCriterion, setCriterionGetter, setCriterionSetter, 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, setFetchMissingValues, setFilterLocally, setGlobalTabIndex, 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, setLocateItemBy, setMultipleValueSeparator, setName, setOperator, setOptionCriteria, setOptionDataSource, setOptionFilterContext, setOptionOperationId, setPickerIconName, setPickerIconProperties, setPickerIconStyle, setPrintTextBoxStyle, setPrintTitleStyle, setPrompt, setProperty, setProperty, setProperty, setProperty, setProperty, setReadOnlyDisplay, setReadOnlyTextBoxStyle, setRedrawOnChange, setRejectInvalidValueOnChange, setRequired, setRequiredMessage, setRowSpan, setShouldSaveValue, setShowClippedTitleOnHover, setShowClippedValueOnHover, setShowDisabled, setShowErrorIcon, setShowErrorStyle, setShowErrorText, setShowFocused, setShowFocusedErrorState, setShowFocusedIcons, setShowFocusedPickerIcon, setShowHint, setShowIcons, setShowIfCondition, setShowOverIcons, 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, setWrapTitle, shouldApplyHeightToTextBox, shouldFetchMissingValue, shouldSaveOnEnter, show, showIcon, showPicker, stopHover, updateState, validate, valueClipped
getRef, getRef, internalSetID
doAddHandler, fireEvent, getAttributeAsDoubleArray, getAttributeAsIntArray, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsStringArray, getAttributes, getHandlerCount, getJsObj, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject
public 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 void setJavaScriptObject(com.google.gwt.core.client.JavaScriptObject jsObj)
setJavaScriptObject
in class TextItem
public static void changeAutoChildDefaults(java.lang.String autoChildName, Canvas defaults)
autoChildName
.autoChildName
- name of an AutoChild to customize the defaults for.defaults
- Canvas defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties.AutoChildUsage
public static void changeAutoChildDefaults(java.lang.String autoChildName, FormItem defaults)
autoChildName
.autoChildName
- name of an AutoChild to customize the defaults for.defaults
- FormItem defaults to apply. These defaults override any existing properties
without destroying or wiping out non-overridden properties.AutoChildUsage
public static void changePickerIconDefaults(FormItemIcon defaults)
public void setAllowComplexMode(java.lang.Boolean allowComplexMode)
ColorPicker
window associated with
this ColorItem?If false, no "More" button is shown on the simple picker
allowComplexMode
- 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(java.lang.String defaultPickerMode)
ColorPicker
associated with this ColorItem can operate in either a "simple"
mode (where it displays just the 40 basic colors and allows the user to click one), or a "complex" mode (where the
user can specify a color from anywhere in the spectrum, with an optional alpha element). The defaultPickMode attribute
specifies which of these two modes is in force when the picker first loads.defaultPickerMode
- . See String
. Default value is "simple"public java.lang.String getDefaultPickerMode()
ColorPicker
associated with this ColorItem can operate in either a "simple"
mode (where it displays just the 40 basic colors and allows the user to click one), or a "complex" mode (where the
user can specify a color from anywhere in the spectrum, with an optional alpha element). The defaultPickMode attribute
specifies which of these two modes is in force when the picker first loads.String
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 FormItem
pickerIconHeight
- pickerIconHeight 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 FormItem
public void setPickerIconPrompt(java.lang.String pickerIconPrompt)
setPickerIconPrompt
in class FormItem
pickerIconPrompt
- . See String
. Default value is "Click to select a new color"public java.lang.String getPickerIconPrompt()
getPickerIconPrompt
in class FormItem
String
public 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 FormItem
pickerIconSrc
- . See 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 FormItem
SCImgURL
public 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 FormItem
pickerIconWidth
- pickerIconWidth 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 FormItem
public void setShowPickerIcon(java.lang.Boolean showPickerIcon)
setShowPickerIcon
in class FormItem
showPickerIcon
- showPickerIcon Default value is truepublic java.lang.Boolean getShowPickerIcon()
getShowPickerIcon
in class FormItem
public 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
- 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 void pickerColorSelected(java.lang.String color, int opacity)
ColorPicker
color
- the selected color as a stringopacity
- the selected opacity, from 0 (transparent) to 100 (opaque). Only applicable if supportsTransparency
is true.public static void setDefaultProperties(ColorItem colorItemProperties)
Note: This method is intended for setting default attributes only and will effect 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.
colorItemProperties
- properties that should be used as new defaults when instances of this class are created