Project Documentation

Summary

Tag name: <tr:chooseColor>
UIComponent class: org.apache.myfaces.trinidad.component.core.input.CoreChooseColor
Component type: org.apache.myfaces.trinidad.CoreChooseColor
The chooseColor control creates a palette for picking colors. A chooseColor can display two sets of colors:

  • A set of standard colors, as specified by the colorData attribute.
  • A set of custom colors which extend the set of colors available in the standard palette. Custom colors are specified by the customColorData attribute.

Both the colorData and customColorData attributes accept both List and array objects, each of which contain one java.awt.Color instance for each color to display.

In order to simplify the use of standard palettes, Apache Trinidad makes certain palettes available via the requestContext.colorPalette EL implicit object. The "#{requestContext.colorPalette}" implicit object provides access to four standard color palettes:

  • "default49": 49 colors, including one transparent entry.
  • "opaque49": 49 colors, without a transparent entry.
  • "default80": 80 colors, including one transparent entry.
  • "web216": the 216 "web-safe" colors.

Code Example(s)

A chooseColor which uses the standard "default49" palette

<tr:chooseColor id="cc0" colorData="#{requestContext.colorPalette.default49}"/>

A chooseColor which defines custom colors using inline data

<tr:chooseColor id="cc1" colorData="#{requestContext.colorPalette.default49}"
                customColorData="#{myBean.listOfColors}">

A chooseColor that is associated with a selectInputColor

<tr:inputColor id="sic1" chooseId="cc2"/>
<tr:chooseColor id="cc2" width="18"
                colorData="#{requestContext.colorPalette.web216}"/>

Supported Client Events for Client Behaviors

  • click (default)
  • dblclick
  • keydown
  • keypress
  • keyup
  • mousedown
  • mousemove
  • mouseout
  • mouseover
  • mouseup

Events

Type Phases Description
org.apache.myfaces.trinidad.event.AttributeChangeEventInvoke Application,
Apply Request Values
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing.

Attributes

Name Type Supports EL? Description
attributeChangeListenerjavax.el.MethodExpressionOnly EL a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
bindingorg.apache.myfaces.trinidad.component.core.input.CoreChooseColorOnly EL an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean.
colorDatajava.util.ListYes the list of colors for the component
customColorDatajava.util.ListYes the list of custom colors for the component
idStringNo the identifier for the component. The identifier must follow a subset of the syntax allowed in HTML:
  • Must not be a zero-length String.
  • First character must be an ASCII letter (A-Za-z) or an underscore ('_').
  • Subsequent characters must be an ASCII letter or digit (A-Za-z0-9), an underscore ('_'), or a dash ('-').
inlineStyleStringYes the CSS styles to use for this component.
onclickStringYes an onclick Javascript handler.
ondblclickStringYes an ondblclick Javascript handler.
onkeydownStringYes an onkeydown Javascript handler.
onkeypressStringYes an onkeypress Javascript handler.
onkeyupStringYes an onkeyup Javascript handler.
onmousedownStringYes an onmousedown Javascript handler.
onmousemoveStringYes an onmousemove Javascript handler.
onmouseoutStringYes an onmouseout Javascript handler.
onmouseoverStringYes an onmouseover Javascript handler.
onmouseupStringYes an onmouseup Javascript handler.
partialTriggersString[]Yes the IDs of the components that should trigger a partial update.

This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too.

Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"

Identifiers must account for NamingContainers. You can use a single colon to start the search from the root, or use multiple colons to move up through the NamingContainer. For example, "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), ":::" will pop out of two naming containers, etc. The search for the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the component with id = commandButton1 after popping out of two naming containers relative to this component. To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".

renderedbooleanYes Default Value: true

whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client). If you want to change a component's rendered attribute from false to true using PPR, set the partialTrigger attribute of its parent component so the parent refreshes and in turn will render this component.
shortDescStringYes The short description of the component. This text is commonly used by user agents to display tooltip help text.
styleClassStringYes a CSS style class to use for this component.
widthintYes the width of the standard palette in cells