org.icefaces.ace.component.colorentry

Class ColorEntryBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIOutput

javax.faces.component.UIInput

org.icefaces.ace.component.colorentry.ColorEntryBase

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, IceClientBehaviorHolder, IColorEntry

Direct Known Subclasses:

ColorEntry

public abstract class ColorEntryBase
extends javax.faces.component.UIInput
implements IColorEntry, IceClientBehaviorHolder

ColorEntry is a widget that creates a string for input component that can display some string information which corresponds to a color It also has custom styling for invalid state and required status.

For more information, see the ColorEntry Wiki Documentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ColorEntryBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_TYPE
static java.lang.String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIInput

COMPONENT_FAMILY, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
ColorEntryBase()

Method Summary

Methods

Modifier and Type	Method and Description
void	addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
java.lang.String	getAccesskey() Return the value of the accesskey property.
java.lang.String	getButtonText() Return the value of the buttonText property.
ColorFormat	getColorFormat() Return the value of the colorFormat property.
java.util.List	getCustomLayout() Return the value of the customLayout property.
java.util.List	getCustomParts() Return the value of the customParts property.
java.lang.String	getDefaultEventName()
java.lang.String	getDefaultExecute(java.lang.String event)
java.lang.String	getDefaultRender(java.lang.String event)
java.lang.String	getEffect() Return the value of the effect property.
java.lang.String	getEffectDuration() Return the value of the effectDuration property.
java.util.Collection<java.lang.String>	getEventNames()
java.lang.String	getFamily()
java.lang.String	getHexVal() Return the value of the hexVal property.
java.lang.String	getIndicatorPosition() Return the value of the indicatorPosition property.
java.lang.String	getLabel() Return the value of the label property.
java.lang.String	getLabelPosition() Return the value of the labelPosition property.
java.lang.String	getLimitSelection() Return the value of the limitSelection property.
java.lang.String	getListenerArgument(java.lang.String event)
java.lang.Object	getLocale() Return the value of the locale property.
java.lang.String	getOptionalIndicator() Return the value of the optionalIndicator property.
java.lang.String	getPopupIcon() Return the value of the popupIcon property.
java.lang.String	getRequiredIndicator() Return the value of the requiredIndicator property.
java.lang.String	getShowOn() Return the value of the showOn property.
java.lang.String	getStyle() Return the value of the style property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
java.util.List	getSwatches() Return the value of the swatches property.
java.lang.String	getSwatchesName() Return the value of the swatchesName property.
int	getSwatchesWidth() Return the value of the swatchesWidth property.
java.lang.String	getTabindex() Return the value of the tabindex property.
java.lang.String	getTitle() Return the value of the title property.
boolean	isButtonColorize() Return the value of the buttonColorize property.
boolean	isCloseOnEscape() Return the value of the closeOnEscape property.
boolean	isDisabled() Return the value of the disabled property.
boolean	isPopupIconOnly() Return the value of the popupIconOnly property.
protected boolean	isPropertySet(java.lang.String finder)
boolean	isReadonly() Return the value of the readonly property.
boolean	isRenderAsPopup() Return the value of the renderAsPopup property.
boolean	isShowAlpha() Return the value of the showAlpha property.
boolean	isShowCancelButton() Return the value of the showCancelButton property.
boolean	isShowCloseButton() Return the value of the showCloseButton property.
boolean	isShowNoneButton() Return the value of the showNoneButton property.
void	setAccesskey(java.lang.String accesskey) Set the value of the accesskey property.
void	setButtonColorize(boolean buttonColorize) Set the value of the buttonColorize property.
void	setButtonText(java.lang.String buttonText) Set the value of the buttonText property.
void	setCloseOnEscape(boolean closeOnEscape) Set the value of the closeOnEscape property.
void	setColorFormat(ColorFormat colorFormat) Set the value of the colorFormat property.
void	setCustomLayout(java.util.List customLayout) Set the value of the customLayout property.
void	setCustomParts(java.util.List customParts) Set the value of the customParts property.
void	setDisabled(boolean disabled) Set the value of the disabled property.
void	setEffect(java.lang.String effect) Set the value of the effect property.
void	setEffectDuration(java.lang.String effectDuration) Set the value of the effectDuration property.
void	setHexVal(java.lang.String hexVal) Set the value of the hexVal property.
void	setIndicatorPosition(java.lang.String indicatorPosition) Set the value of the indicatorPosition property.
void	setLabel(java.lang.String label) Set the value of the label property.
void	setLabelPosition(java.lang.String labelPosition) Set the value of the labelPosition property.
void	setLimitSelection(java.lang.String limitSelection) Set the value of the limitSelection property.
void	setLocale(java.lang.Object locale) Set the value of the locale property.
void	setOptionalIndicator(java.lang.String optionalIndicator) Set the value of the optionalIndicator property.
void	setPopupIcon(java.lang.String popupIcon) Set the value of the popupIcon property.
void	setPopupIconOnly(boolean popupIconOnly) Set the value of the popupIconOnly property.
void	setReadonly(boolean readonly) Set the value of the readonly property.
void	setRenderAsPopup(boolean renderAsPopup) Set the value of the renderAsPopup property.
void	setRequiredIndicator(java.lang.String requiredIndicator) Set the value of the requiredIndicator property.
void	setShowAlpha(boolean showAlpha) Set the value of the showAlpha property.
void	setShowCancelButton(boolean showCancelButton) Set the value of the showCancelButton property.
void	setShowCloseButton(boolean showCloseButton) Set the value of the showCloseButton property.
void	setShowNoneButton(boolean showNoneButton) Set the value of the showNoneButton property.
void	setShowOn(java.lang.String showOn) Set the value of the showOn property.
void	setStyle(java.lang.String style) Set the value of the style property.
void	setStyleClass(java.lang.String styleClass) Set the value of the styleClass property.
void	setSwatches(java.util.List swatches) Set the value of the swatches property.
void	setSwatchesName(java.lang.String swatchesName) Set the value of the swatchesName property.
void	setSwatchesWidth(int swatchesWidth) Set the value of the swatchesWidth property.
void	setTabindex(java.lang.String tabindex) Set the value of the tabindex property.
void	setTitle(java.lang.String title) Set the value of the title property.
void	setValueExpression(java.lang.String name, javax.el.ValueExpression binding)

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, restoreState, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate, validateValue

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTree

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

getClientBehaviors

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, setConverter

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

ColorEntryBase

public ColorEntryBase()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIInput

setAccesskey

public void setAccesskey(java.lang.String accesskey)

Set the value of the accesskey property.

Contents: Access key that, when pressed, transfers focus to this component.

Specified by:

setAccesskey in interface IColorEntry

getAccesskey

public java.lang.String getAccesskey()

Return the value of the accesskey property.

Contents: Access key that, when pressed, transfers focus to this component.

Specified by:

getAccesskey in interface IColorEntry

setButtonColorize

public void setButtonColorize(boolean buttonColorize)

Set the value of the buttonColorize property.

Contents: If a popupIcon is specified, change the background color of the image when the color is changed

Specified by:

setButtonColorize in interface IColorEntry

isButtonColorize

public boolean isButtonColorize()

Return the value of the buttonColorize property.

Contents: If a popupIcon is specified, change the background color of the image when the color is changed Default = 'true'.

Specified by:

isButtonColorize in interface IColorEntry

setButtonText

public void setButtonText(java.lang.String buttonText)

Set the value of the buttonText property.

Contents: The text to display on the trigger button. Use in conjunction with the showOn option set to "button" or "all". Default = "".

Specified by:

setButtonText in interface IColorEntry

getButtonText

public java.lang.String getButtonText()

Return the value of the buttonText property.

Contents: The text to display on the trigger button. Use in conjunction with the showOn option set to "button" or "all". Default = "".

Specified by:

getButtonText in interface IColorEntry

setCloseOnEscape

public void setCloseOnEscape(boolean closeOnEscape)

Set the value of the closeOnEscape property.

Contents: Close the window when pressing the Escape key on the keyboard.

Specified by:

setCloseOnEscape in interface IColorEntry

isCloseOnEscape

public boolean isCloseOnEscape()

Return the value of the closeOnEscape property.

Contents: Close the window when pressing the Escape key on the keyboard.

Specified by:

isCloseOnEscape in interface IColorEntry

setColorFormat

public void setColorFormat(ColorFormat colorFormat)

Set the value of the colorFormat property.

Contents: This is the preferred format to display the chosen color under the input field. Valid values are listed in the ColorFormat enumeration HEX("HEX"), HEX3("HEX3"), HEXA("HEXA"), RGB("RGB"), RGBA("RGBA"), RGBPERCENT("RGB%"), HSL("HSL"), HSLA("HSLA"), HSLPERCENT("HSL%"), HSLAPERCENT("HSLA%"),NAME("NAME"), EXACT("EXACT").

Specified by:

setColorFormat in interface IColorEntry

getColorFormat

public ColorFormat getColorFormat()

Return the value of the colorFormat property.

Contents: This is the preferred format to display the chosen color under the input field. Valid values are listed in the ColorFormat enumeration HEX("HEX"), HEX3("HEX3"), HEXA("HEXA"), RGB("RGB"), RGBA("RGBA"), RGBPERCENT("RGB%"), HSL("HSL"), HSLA("HSLA"), HSLPERCENT("HSL%"), HSLAPERCENT("HSLA%"),NAME("NAME"), EXACT("EXACT"). Default = 'ColorFormat.HEX'.

Specified by:

getColorFormat in interface IColorEntry

setCustomLayout

public void setCustomLayout(java.util.List customLayout)

Set the value of the customLayout property.

Contents: When selectedParts is used for custom configuration, this attribute defines the position of elements in a table layout. Any layout is possible with HTML tables by specifying cell position and size of each part. The value is an array with four coordinates on order [left, top, width, height]. The coordinates correspond to cells in a table, if you want to have a part at top-left and spanning two rows, and three columns, the value would be preview, [0, 0, 3, 2] -- to show preview at that location. 'header' and 'footer' do not require a position so should only be listed in the selectedParts attribute.

Specified by:

setCustomLayout in interface IColorEntry

getCustomLayout

public java.util.List getCustomLayout()

Return the value of the customLayout property.

Contents: When selectedParts is used for custom configuration, this attribute defines the position of elements in a table layout. Any layout is possible with HTML tables by specifying cell position and size of each part. The value is an array with four coordinates on order [left, top, width, height]. The coordinates correspond to cells in a table, if you want to have a part at top-left and spanning two rows, and three columns, the value would be preview, [0, 0, 3, 2] -- to show preview at that location. 'header' and 'footer' do not require a position so should only be listed in the selectedParts attribute.

Specified by:

getCustomLayout in interface IColorEntry

setCustomParts

public void setCustomParts(java.util.List customParts)

Set the value of the customParts property.

Contents: An array of values which can include 'header', 'preview','hex','rgb','alpha', 'hsv','rbgslider', and 'footer'.

Specified by:

setCustomParts in interface IColorEntry

getCustomParts

public java.util.List getCustomParts()

Return the value of the customParts property.

Contents: An array of values which can include 'header', 'preview','hex','rgb','alpha', 'hsv','rbgslider', and 'footer'.

Specified by:

getCustomParts in interface IColorEntry

setDisabled

public void setDisabled(boolean disabled)

Set the value of the disabled property.

Contents: If true then this colorEntry will be disabled and can not be entered.

Specified by:

setDisabled in interface IColorEntry

isDisabled

public boolean isDisabled()

Return the value of the disabled property.

Contents: If true then this colorEntry will be disabled and can not be entered. Default = 'false'.

Specified by:

isDisabled in interface IColorEntry

setEffect

public void setEffect(java.lang.String effect)

Set the value of the effect property.

Contents: Name of the animation used to show/hide the colorEntry. Use "slideDown", "fadeIn", any of the show/hide jQuery UI effects, or "" for no animation.

Specified by:

setEffect in interface IColorEntry

getEffect

public java.lang.String getEffect()

Return the value of the effect property.

Contents: Name of the animation used to show/hide the colorEntry. Use "slideDown", "fadeIn", any of the show/hide jQuery UI effects, or "" for no animation. Default = 'show'.

Specified by:

getEffect in interface IColorEntry

setEffectDuration

public void setEffectDuration(java.lang.String effectDuration)

Set the value of the effectDuration property.

Contents: Control the speed at which colorEntry appears, it may be a time in milliseconds or a string representing one of the three predefined speeds ("slow", "normal", "fast").

Specified by:

setEffectDuration in interface IColorEntry

getEffectDuration

public java.lang.String getEffectDuration()

Return the value of the effectDuration property.

Contents: Control the speed at which colorEntry appears, it may be a time in milliseconds or a string representing one of the three predefined speeds ("slow", "normal", "fast"). Default = 'normal'.

Specified by:

getEffectDuration in interface IColorEntry

setIndicatorPosition

public void setIndicatorPosition(java.lang.String indicatorPosition)

Set the value of the indicatorPosition property.

Contents: Position of input-required or input-optional indicator relative to input field or label. Supported values are "left/right/top/bottom/labelLeft/labelRight/none". Default is "labelRight" if labelPosition is "right" otherwise.

Specified by:

setIndicatorPosition in interface IColorEntry

getIndicatorPosition

public java.lang.String getIndicatorPosition()

Return the value of the indicatorPosition property.

Contents: Position of input-required or input-optional indicator relative to input field or label. Supported values are "left/right/top/bottom/labelLeft/labelRight/none". Default is "labelRight" if labelPosition is "right" otherwise.

Specified by:

getIndicatorPosition in interface IColorEntry

setLabel

public void setLabel(java.lang.String label)

Set the value of the label property.

Contents: A localized user presentable name for this component.

Specified by:

setLabel in interface IColorEntry

getLabel

public java.lang.String getLabel()

Return the value of the label property.

Contents: A localized user presentable name for this component.

Specified by:

getLabel in interface IColorEntry

setLabelPosition

public void setLabelPosition(java.lang.String labelPosition)

Set the value of the labelPosition property.

Contents: Position of label relative to input field. Supported values are "left/right/top/bottom/none". Default is "none".

Specified by:

setLabelPosition in interface IColorEntry

getLabelPosition

public java.lang.String getLabelPosition()

Return the value of the labelPosition property.

Contents: Position of label relative to input field. Supported values are "left/right/top/bottom/none". Default is "none".

Specified by:

getLabelPosition in interface IColorEntry

setLimitSelection

public void setLimitSelection(java.lang.String limitSelection)

Set the value of the limitSelection property.

Contents: Limit the selectable colors to any of the predefined limits. Default is empty string. 'websafe'=Set of 216 colors composed of 00, 33, 66, 99, cc and ff color channel values in #rrggbb. 'nibble'= 4 bits per color, can be easily converted to #rgb format. The palette is limited to 4096 colors. 'binary'=Allow only #00 or #ff as color channel values for primary colors; only 8 colors are available with this limit, or 'name'=limits to closes color name.

Specified by:

setLimitSelection in interface IColorEntry

getLimitSelection

public java.lang.String getLimitSelection()

Return the value of the limitSelection property.

Contents: Limit the selectable colors to any of the predefined limits. Default is empty string. 'websafe'=Set of 216 colors composed of 00, 33, 66, 99, cc and ff color channel values in #rrggbb. 'nibble'= 4 bits per color, can be easily converted to #rgb format. The palette is limited to 4096 colors. 'binary'=Allow only #00 or #ff as color channel values for primary colors; only 8 colors are available with this limit, or 'name'=limits to closes color name.

Specified by:

getLimitSelection in interface IColorEntry

setLocale

public void setLocale(java.lang.Object locale)

Set the value of the locale property.

Contents: Locale to be used for labels on this component. May be Locale string or java.util.Locale object Some locales are already defined by String ('fr',''el','en','en-GB','en-US','nl','pt-br','ru','sr'. Any locale not listed must be created, see messages.properties for ace jar and define the appropriate keys then list the message-bundle in the faces-config of your application. Note that locale is something that must be changed in the view root before expectingthe message bundle to be used--as per standard JSF behavior. An ajax update of this attribute will not change anything. The locale that is changed must be set into the ViewRoot first. Default is en.

Specified by:

setLocale in interface IColorEntry

getLocale

public java.lang.Object getLocale()

Return the value of the locale property.

Contents: Locale to be used for labels on this component. May be Locale string or java.util.Locale object Some locales are already defined by String ('fr',''el','en','en-GB','en-US','nl','pt-br','ru','sr'. Any locale not listed must be created, see messages.properties for ace jar and define the appropriate keys then list the message-bundle in the faces-config of your application. Note that locale is something that must be changed in the view root before expectingthe message bundle to be used--as per standard JSF behavior. An ajax update of this attribute will not change anything. The locale that is changed must be set into the ViewRoot first. Default is en.

Specified by:

getLocale in interface IColorEntry

setOptionalIndicator

public void setOptionalIndicator(java.lang.String optionalIndicator)

Set the value of the optionalIndicator property.

Contents: Indicator indicating that the user is NOT required to provide a submitted value for this input component.

Specified by:

setOptionalIndicator in interface IColorEntry

getOptionalIndicator

public java.lang.String getOptionalIndicator()

Return the value of the optionalIndicator property.

Contents: Indicator indicating that the user is NOT required to provide a submitted value for this input component.

Specified by:

getOptionalIndicator in interface IColorEntry

setPopupIcon

public void setPopupIcon(java.lang.String popupIcon)

Set the value of the popupIcon property.

Contents: The URL for the popup button image. The showOn attribute must be set to "button" or "both".

Specified by:

setPopupIcon in interface IColorEntry

getPopupIcon

public java.lang.String getPopupIcon()

Return the value of the popupIcon property.

Contents: The URL for the popup button image. The showOn attribute must be set to "button" or "both".

Specified by:

getPopupIcon in interface IColorEntry

setPopupIconOnly

public void setPopupIconOnly(boolean popupIconOnly)

Set the value of the popupIconOnly property.

Contents: When enabled, popup icon is rendered without it appearing on a button. Default: "false".

Specified by:

setPopupIconOnly in interface IColorEntry

isPopupIconOnly

public boolean isPopupIconOnly()

Return the value of the popupIconOnly property.

Contents: When enabled, popup icon is rendered without it appearing on a button. Default: "false".

Specified by:

isPopupIconOnly in interface IColorEntry

setReadonly

public void setReadonly(boolean readonly)

Set the value of the readonly property.

Contents: If true then this colorEntry will be read-only and can not be entered.

Specified by:

setReadonly in interface IColorEntry

isReadonly

public boolean isReadonly()

Return the value of the readonly property.

Contents: If true then this colorEntry will be read-only and can not be entered.

Specified by:

isReadonly in interface IColorEntry

setRenderAsPopup

public void setRenderAsPopup(boolean renderAsPopup)

Set the value of the renderAsPopup property.

Contents: If false, the dialog opens automatically upon page load as an inline component.

Specified by:

setRenderAsPopup in interface IColorEntry

isRenderAsPopup

public boolean isRenderAsPopup()

Return the value of the renderAsPopup property.

Contents: If false, the dialog opens automatically upon page load as an inline component. Default = 'false'.

Specified by:

isRenderAsPopup in interface IColorEntry

setRequiredIndicator

public void setRequiredIndicator(java.lang.String requiredIndicator)

Set the value of the requiredIndicator property.

Contents: Indicator indicating that the user is required to provide a submitted value for this input component.

Specified by:

setRequiredIndicator in interface IColorEntry

getRequiredIndicator

public java.lang.String getRequiredIndicator()

Return the value of the requiredIndicator property.

Contents: Indicator indicating that the user is required to provide a submitted value for this input component.

Specified by:

getRequiredIndicator in interface IColorEntry

setShowAlpha

public void setShowAlpha(boolean showAlpha)

Set the value of the showAlpha property.

Contents: Whether or not to show the inputs for alpha

Specified by:

setShowAlpha in interface IColorEntry

isShowAlpha

public boolean isShowAlpha()

Return the value of the showAlpha property.

Contents: Whether or not to show the inputs for alpha Default = 'false'.

Specified by:

isShowAlpha in interface IColorEntry

setShowCancelButton

public void setShowCancelButton(boolean showCancelButton)

Set the value of the showCancelButton property.

Contents: Show the Cancel button if buttonpane on popup is visible.

Specified by:

setShowCancelButton in interface IColorEntry

isShowCancelButton

public boolean isShowCancelButton()

Return the value of the showCancelButton property.

Contents: Show the Cancel button if buttonpane on popup is visible. Default = 'true'.

Specified by:

isShowCancelButton in interface IColorEntry

setShowCloseButton

public void setShowCloseButton(boolean showCloseButton)

Set the value of the showCloseButton property.

Contents: Show the Close button if buttonpane on popup is visible

Specified by:

setShowCloseButton in interface IColorEntry

isShowCloseButton

public boolean isShowCloseButton()

Return the value of the showCloseButton property.

Contents: Show the Close button if buttonpane on popup is visible Default = 'true'.

Specified by:

isShowCloseButton in interface IColorEntry

setShowNoneButton

public void setShowNoneButton(boolean showNoneButton)

Set the value of the showNoneButton property.

Contents: Show the None/Revert button if buttonpane on popup is visible.

Specified by:

setShowNoneButton in interface IColorEntry

isShowNoneButton

public boolean isShowNoneButton()

Return the value of the showNoneButton property.

Contents: Show the None/Revert button if buttonpane on popup is visible. Default = 'false'.

Specified by:

isShowNoneButton in interface IColorEntry

setShowOn

public void setShowOn(java.lang.String showOn)

Set the value of the showOn property.

Contents: Have the colorEntry appear automatically when the field receives focus ("focus"), appear only when a button (specified by popupIcon attribute) is clicked ("button"), or appear when either event takes place ("all").

Specified by:

setShowOn in interface IColorEntry

getShowOn

public java.lang.String getShowOn()

Return the value of the showOn property.

Contents: Have the colorEntry appear automatically when the field receives focus ("focus"), appear only when a button (specified by popupIcon attribute) is clicked ("button"), or appear when either event takes place ("all"). Default = 'focus'.

Specified by:

getShowOn in interface IColorEntry

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

Contents: Custom inline CSS styles to use for this component. These styles are generally applied to the root DOM element of the component. This is intended for per-component basic style customizations. Note that due to browser CSS precedence rules, CSS rendered on a DOM element will take precedence over the external stylesheets used to provide the ThemeRoller theme on this component. If the CSS properties applied with this attribute do not affect the DOM element you want to style, you may need to create a custom theme styleClass for the theme CSS class that targets the particular DOM elements you wish to customize.

Specified by:

setStyle in interface IColorEntry

getStyle

public java.lang.String getStyle()

Return the value of the style property.

Contents: Custom inline CSS styles to use for this component. These styles are generally applied to the root DOM element of the component. This is intended for per-component basic style customizations. Note that due to browser CSS precedence rules, CSS rendered on a DOM element will take precedence over the external stylesheets used to provide the ThemeRoller theme on this component. If the CSS properties applied with this attribute do not affect the DOM element you want to style, you may need to create a custom theme styleClass for the theme CSS class that targets the particular DOM elements you wish to customize.

Specified by:

getStyle in interface IColorEntry

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

Contents: Custom CSS style class(es) to use for this component. These style classes can be defined in your page or in a theme CSS file.

Specified by:

setStyleClass in interface IColorEntry

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property.

Contents: Custom CSS style class(es) to use for this component. These style classes can be defined in your page or in a theme CSS file.

Specified by:

getStyleClass in interface IColorEntry

setSwatches

public void setSwatches(java.util.List swatches)

Set the value of the swatches property.

Contents: A list of available palettes may be used for the user to select from. This must be a list of String arrays at this time

Specified by:

setSwatches in interface IColorEntry

getSwatches

public java.util.List getSwatches()

Return the value of the swatches property.

Contents: A list of available palettes may be used for the user to select from. This must be a list of String arrays at this time

Specified by:

getSwatches in interface IColorEntry

setSwatchesName

public void setSwatchesName(java.lang.String swatchesName)

Set the value of the swatchesName property.

Contents: The name of a predefined swatch defined in a js file. default value is the 'html' named swatch from the component itself. A user defined swatch can be used by defining a new 'swatchesname' and defining the swatch with the 'swatches' attribute. Currently included values are 'html', 'pantone', 'crayola'

Specified by:

setSwatchesName in interface IColorEntry

getSwatchesName

public java.lang.String getSwatchesName()

Return the value of the swatchesName property.

Contents: The name of a predefined swatch defined in a js file. default value is the 'html' named swatch from the component itself. A user defined swatch can be used by defining a new 'swatchesname' and defining the swatch with the 'swatches' attribute. Currently included values are 'html', 'pantone', 'crayola'

Specified by:

getSwatchesName in interface IColorEntry

setSwatchesWidth

public void setSwatchesWidth(int swatchesWidth)

Set the value of the swatchesWidth property.

Contents: if using swatches attribute, this attribute will set the width of the swatches area in px

Specified by:

setSwatchesWidth in interface IColorEntry

getSwatchesWidth

public int getSwatchesWidth()

Return the value of the swatchesWidth property.

Contents: if using swatches attribute, this attribute will set the width of the swatches area in px

Specified by:

getSwatchesWidth in interface IColorEntry

setTabindex

public void setTabindex(java.lang.String tabindex)

Set the value of the tabindex property.

Contents: Position of the text field in the tabbing order for the current page. This value must be an integer between 0 and 32767.

Specified by:

setTabindex in interface IColorEntry

getTabindex

public java.lang.String getTabindex()

Return the value of the tabindex property.

Contents: Position of the text field in the tabbing order for the current page. This value must be an integer between 0 and 32767.

Specified by:

getTabindex in interface IColorEntry

setTitle

public void setTitle(java.lang.String title)

Set the value of the title property.

Contents: The title to display in the header. The title is not included in the renderAsPopup is true version of this component. It is applicable if used within a custom version which does list 'header'; as one of its parts

Specified by:

setTitle in interface IColorEntry

getTitle

public java.lang.String getTitle()

Return the value of the title property.

Contents: The title to display in the header. The title is not included in the renderAsPopup is true version of this component. It is applicable if used within a custom version which does list 'header'; as one of its parts

Specified by:

getTitle in interface IColorEntry

setHexVal

public void setHexVal(java.lang.String hexVal)

Set the value of the hexVal property.

Specified by:

setHexVal in interface IColorEntry

getHexVal

public java.lang.String getHexVal()

Return the value of the hexVal property.

Specified by:

getHexVal in interface IColorEntry

isPropertySet

protected boolean isPropertySet(java.lang.String finder)

setValueExpression

public void setValueExpression(java.lang.String name,
                      javax.el.ValueExpression binding)

Overrides:

setValueExpression in class javax.faces.component.UIComponent

getEventNames

public java.util.Collection<java.lang.String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

getDefaultEventName

public java.lang.String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class javax.faces.component.UIComponentBase

getDefaultRender

public java.lang.String getDefaultRender(java.lang.String event)

Specified by:

getDefaultRender in interface IceClientBehaviorHolder

getDefaultExecute

public java.lang.String getDefaultExecute(java.lang.String event)

Specified by:

getDefaultExecute in interface IceClientBehaviorHolder

getListenerArgument

public java.lang.String getListenerArgument(java.lang.String event)

Specified by:

getListenerArgument in interface IceClientBehaviorHolder

addClientBehavior

public void addClientBehavior(java.lang.String eventName,
                     javax.faces.component.behavior.ClientBehavior behavior)

Specified by:

addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

addClientBehavior in class javax.faces.component.UIComponentBase