| Info | Value |
|---|---|
| Component Type | org.primefaces.component.ColorPicker |
| Handler Class | None |
| Renderer Type | org.primefaces.component.ColorPickerRenderer |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
accesskey | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Access key to transfer focus to the input element. |
alpha | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| Enable or disable alpha support. When disabled, it will strip the alpha value from the existing color value in all formats. Default true. |
alt | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Alternate textual description of the input element. |
autocomplete | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Controls browser autocomplete behavior. |
binding | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| An el expression referring to a server side UIComponent instance in a backing bean. |
clearButton | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| Show an optional clear button. Default false. |
closeButton | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| Show an optional close button. Default false. |
converter | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.convert.Converter)
| An el expression or a literal text that defines a converter for the component. When it's an EL expression, it's resolved to a converter instance. In case it's a static text, it must refer to a converter id. |
converterMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when conversion fails. |
dir | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Direction indication for text that does not inherit directionality. |
disabled | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| Disables the input element, default is false. |
focusInput | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| Focus the color value input when the color picker dialog is opened. Default true. |
forceAlpha | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| Set to true to always include the alpha value in the color value even if the opacity is 100%. Default false. |
format | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Set the preferred color string format: hex, rgb, hsl, auto, mixed. |
formatToggle | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| Set to true to enable format toggle buttons in the color picker dialog. This will also force the "format" to auto. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Unique identifier of the component in a namingContainer. |
immediate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| When set true, process validations logic is executed at apply request values phase for this component. Default is false. |
label | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| A localized user presentable name. |
lang | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Code describing the language used in the generated markup. |
maxlength | false | jakarta.el.ValueExpression
(must evaluate to int)
| DO NOT USE! To limit the number of digits...set maximumValue, minimumValue and/or decimalPlaces accordingly. |
mode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Display mode, valid values are'popup' and 'inline'. Default is 'popup'. |
onblur | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when input element loses focus. |
onchange | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when input element loses focus and its value has been modified since gaining focus. |
onclick | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when input element is clicked. |
oncontextmenu | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a context menu is triggered. |
oncopy | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the user cuts the content of an element. |
oncut | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the user copies the content of an element. |
ondblclick | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when input element is double clicked. |
ondrag | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element is dragged. |
ondragend | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute at the end of a drag operation. |
ondragenter | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element has been dragged to a valid drop target. |
ondragleave | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element leaves a valid drop target. |
ondragover | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element is being dragged over a valid drop target. |
ondragstart | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute at the start of a drag operation. |
ondrop | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when dragged element is being dropped. |
onfocus | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when input element receives focus. |
oninput | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element gets user input. |
oninvalid | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element is invalid. |
onkeydown | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a key is pressed down over input element. |
onkeypress | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a key is pressed and released over input element. |
onkeyup | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a key is released over input element. |
onmousedown | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer input element is pressed down over input element. |
onmousemove | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer input element is moved within input element. |
onmouseout | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer input element is moved away from input element. |
onmouseover | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer input element is moved onto input element. |
onmouseup | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when a pointer input element is released over input element. |
onpaste | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the user pastes some content in an element. |
onreset | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the Reset button in a form is clicked. |
onscroll | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when an element's scrollbar is being scrolled. |
onsearch | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the user writes something in a search field. |
onselect | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when text within input element is selected by user. |
onwheel | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Client side callback to execute when the mouse wheel rolls up or down over an element. |
placeholder | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The placeholder attribute specifies a short hint that describes the expected value of an input field. |
readonly | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| Flag indicating that this input element will prevent changes by the user. |
rendered | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Boolean value to specify the rendering of the component, when set to false component will not be rendered. |
required | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Marks component as required. |
requiredMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when required field validation fails. |
selectInput | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| Select and focus the color value input when the color picker dialog is opened. Default false. |
size | false | jakarta.el.ValueExpression
(must evaluate to int)
| Number of characters used to determine the width of the input element. |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Inline style of the component. |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Style class of the component. |
swatches | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| A comma separated list of the desired color swatches to display. If omitted or the array is empty, the color swatches will be disabled. |
swatchesOnly | false | jakarta.el.ValueExpression
(must evaluate to boolean)
| Set to true to hide all the color picker widgets (spectrum, hue, ...) except the swatches. Default false. |
tabindex | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Position of the element in the tabbing order. |
theme | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Available themes: default, large, polaroid, pill (horizontal). |
themeMode | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Set the theme to light, dark, or auto mode. Default to auto to detect your OS setting. |
title | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Advisory tooltip information. |
validator | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.validator.Validator)
| A method expression referring to a method validating the input. |
validatorMessage | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Message to display when validation fails. |
value | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| Value of the component. |
valueChangeListener | false | jakarta.el.ValueExpression
(must evaluate to javax.faces.event.ValueChangeListener)
| A method binding expression referring to a method for handling a valuchangeevent. |
widgetVar | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of the client side widget. |
Output generated by Vdldoc View Declaration Language Documentation Generator.