ICEfaces ACE Components
Tag colorEntry


ColorEntry is a widget that allows a user to enter or choose a color which can be saved as a String. Two default configurations show an inline and popup version, but it is configurable for a more custom look. Themeroller styling and required & custom styling with labelling are also included. There are various formats this color string may be saved as, including but not limited to HEX, RGB or by NAME.

For more information, see the ColorEntry Wiki Documentation.


Client Events
NameDescriptionSupported Classes for ArgumentDefault Event Scopes
valueChangeFired when the original input changes. Only happens when the input is closed or the choose button is clickedjavax.faces.event.AjaxBehaviorEventexecute=@this render=@all
Client events can be used with Client Behaviors and the ace:ajax tag.


Tag Information
Tag Classorg.icefaces.ace.component.colorentry.ColorEntryTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
accesskeynotruejava.lang.StringAccess key that, when pressed, transfers focus to this component.
bindingnotruejavax.el.ValueExpressionUsing an EL expression, bind the component reference to a bean property, so that the component may be accessed in the bean.
buttonColorizenotruebooleanIf a popupIcon is specified, change the background color of the image when the color is changed Default = 'true'.
buttonTextnotruejava.lang.StringThe text to display on the trigger button. Use in conjunction with the showOn option set to "button" or "all". Default = "".
closeOnEscapenotruebooleanClose the window when pressing the Escape key on the keyboard.
colorFormatnotrueorg.icefaces.ace.component.colorentry.ColorFormatThis 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'.
converternotruejavax.faces.convert.ConverterConverter is an interface describing a Java class that can perform Object-to-String and String-to-Object conversions between model data objects and a String representation of those objects that is suitable for rendering.
converterMessagenotruejava.lang.StringIf present, will be used as the text of the converter message, replacing any message that comes from the converter.
customLayoutnotruejava.util.ListWhen 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.
customPartsnotruejava.util.ListAn array of values which can include 'header', 'preview','hex','rgb','alpha', 'hsv','rbgslider', and 'footer'.
disablednotruebooleanIf true then this colorEntry will be disabled and can not be entered. Default = 'false'.
effectnotruejava.lang.StringName 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'.
effectDurationnotruejava.lang.StringControl 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'.
idnotruejava.lang.StringThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.
immediatenotruebooleanA flag indicating that conversion and validation of this component's value should occur during Apply Request Values phase instead of Process Validations phase. Default = 'false'.
indicatorPositionnotruejava.lang.StringPosition 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.
labelnotruejava.lang.StringA localized user presentable name for this component.
labelPositionnotruejava.lang.StringPosition of label relative to input field. Supported values are "left/right/top/bottom/none". Default is "none".
limitSelectionnotruejava.lang.StringLimit 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.
localenotruejava.lang.ObjectLocale 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.
optionalIndicatornotruejava.lang.StringIndicator indicating that the user is NOT required to provide a submitted value for this input component.
popupIconnotruejava.lang.StringThe URL for the popup button image. The showOn attribute must be set to "button" or "both".
popupIconOnlynotruebooleanWhen enabled, popup icon is rendered without it appearing on a button. Default: "false".
readonlynotruebooleanIf true then this colorEntry will be read-only and can not be entered.
renderAsPopupnotruebooleanIf false, the dialog opens automatically upon page load as an inline component. Default = 'false'.
renderednotruebooleanReturn true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. Default = 'true'.
requirednotruebooleanA flag indicating whether the user required to provide a non-empty submitted value for this component. Default = 'false'.
requiredIndicatornotruejava.lang.StringIndicator indicating that the user is required to provide a submitted value for this input component.
requiredMessagenotruejava.lang.StringIf present, will be used as the text of the validation message for the "required" facility, if the "required" facility is used.
showAlphanotruebooleanWhether or not to show the inputs for alpha Default = 'false'.
showCancelButtonnotruebooleanShow the Cancel button if buttonpane on popup is visible. Default = 'true'.
showCloseButtonnotruebooleanShow the Close button if buttonpane on popup is visible Default = 'true'.
showNoneButtonnotruebooleanShow the None/Revert button if buttonpane on popup is visible. Default = 'false'.
showOnnotruejava.lang.StringHave 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'.
stylenotruejava.lang.StringCustom 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.
styleClassnotruejava.lang.StringCustom CSS style class(es) to use for this component. These style classes can be defined in your page or in a theme CSS file.
swatchesnotruejava.util.ListA list of available palettes may be used for the user to select from. This must be a list of String arrays at this time
swatchesNamenotruejava.lang.StringThe 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'
swatchesWidthnotrueintif using swatches attribute, this attribute will set the width of the swatches area in px
tabindexnotruejava.lang.StringPosition of the text field in the tabbing order for the current page. This value must be an integer between 0 and 32767.
titlenotruejava.lang.StringThe 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
validatornotruejavax.el.MethodExpressionMethodExpression representing a validator method that will be called during Process Validations to perform correctness checks on the value of this component. The expression must evaluate to a public method that takes FacesContext, UIComponent, and Object parameters, with a return type of void.
validatorMessagenotruejava.lang.StringIf present, will be used as the text of the validator message, replacing any message that comes from the validator.
valuenotruejava.lang.ObjectThe current value of the simple component. The value to be rendered.
valueChangeListenernotruejavax.el.MethodExpressionMethodExpression representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEvent parameter, with a return type of void, or to a public method that takes no arguments with a return type of void. In the latter case, the method has no way of easily knowing what the new value is, but this can be useful in cases where a notification is needed that "this value changed".

Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.