6.25.  < rich:comboBox >

6.25.1. Description

The <rich:comboBox> is a component, that provides editable combo box element on a page.

<rich:comboBox> component

Figure 6.13.  <rich:comboBox> component


6.25.2. Key Features

  • Client side suggestions

  • Browser like selection

  • Smart user-defined positioning

  • Seam entity converter support

  • Highly customizable look and feel

  • Disablement support

Table 6.76. rich : comboBox attributes

Attribute NameDescription
accesskeyThis attribute assigns an access key to an element. An access key is a single character from the document character set. Note: Authors should consider the input method of the expected reader when specifying an accesskey
alignleft|center|right|justify [CI] Deprecated. This attribute specifies the horizontal alignment of its element with respect to the surrounding context. Possible values: * left: text lines are rendered flush left. * center: text lines are centered. * right: text lines are rendered flush right. * justify: text lines are justified to both margins. The default depends on the base text direction. For left to right text, the default is align=left, while for right to left text, the default is align=right
altFor a user agents that cannot display images, forms, or applets, this attribute specifies alternate text. The language of the alternate text is specified by the lang attribute
bindingThe attribute takes a value-binding expression for a component property of a backing bean
buttonClassStyle Class attribute for the button
buttonDisabledClassStyle Class attribute for the disabled button
buttonDisabledStyleCSS style rules to be applied to disabled button
buttonIconDefines icon for the button element
buttonIconDisabledDefines disabled icon for the button element
buttonIconInactiveDefines inactive icon for the button element
buttonInactiveClassStyle Class attribute for the inactive button
buttonInactiveStyleCSS style rules to be applied to inactive button
buttonStyleCSS style rules to be applied to button
converterId of Converter to be used or reference to a Converter
converterMessageA ValueExpression enabled attribute that, if present, will be used as the text of the converter message, replacing any message that comes from the converter
defaultLabelDefines default label for the input field element
directInputSuggestionsDefines the first value from the suggested in input field
disabledWhen set for a form control, this boolean attribute disables the control for your input
enableManualInputenabled for keybord input, if "false" keybord input will be locked
filterNewValuesDefines the appearance of values in the list
hideDelayDelay between losing focus and popup list closing
idEvery component may have a unique id that is automatically created if omitted
immediateA flag indicating that this component value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until a Process Validations phase
inputClassStyle Class attribute for the input field
inputDisabledClassStyle Class attribute for the disabled input
inputDisabledStyleCSS style rules to be applied to disabled input
inputInactiveClassStyle Class attribute for the inactive input
inputInactiveStyleCSS style rules to be applied to inactive input
inputStyleCSS style rules to be applied to input field
itemClassStyle Class attribute for the items
itemSelectedClassStyle Class attribute for the selected item
listClassStyle Class attribute for the popup list
listHeightDefines height of file popup list
listStyleCSS style rules to be applied to popup list
listWidthDefines width of file popup list
maxlengthWhen the type attribute has the value "text" or "password", this attribute specifies the maximum number of characters you may enter. This number may exceed the specified size, in which case the user agent should offer a scrolling mechanism. The default value for this attribute is an unlimited number
onblurHTML: script expression; the element lost the focus
onchangeHTML: script expression; the element value was changed
onclickHTML: a script expression; a pointer button is clicked
ondblclickHTML: a script expression; a pointer button is double-clicked
onfocusHTML: script expression; the element got the focus
onkeydownHTML: a script expression; a key is pressed down
onkeypressHTML: a script expression; a key is pressed and released
onkeyupHTML: a script expression; a key is released
onlistcallA JavaScript event handler called on a list call operation
onmousedownHTML: script expression; a pointer button is pressed down
onmousemoveHTML: a script expression; a pointer is moved within
onmouseoutHTML: a script expression; a pointer is moved away
onmouseoverHTML: a script expression; a pointer is moved onto
onmouseupHTML: script expression; a pointer button is released
onselectHTML: script expression; The onselect event occurs when you select some text in a text field. This attribute may be used with the INPUT and TEXTAREA elements
renderedIf "false", this component is not rendered
requiredIf "true", this component is checked for non-empty input
requiredMessageA ValueExpression enabled attribute that, if present, will be used as the text of the validation message for the "required" facility, if the "required" facility is used
selectFirstOnUpdateDefines if the first value from suggested is selected in popup list
showDelayDelay between event and popup list showing
sizeThis attribute tells the user agent the initial width of the control. The width is given in pixels except when type attribute has the value "text" or "password". In that case, its value refers to the (integer) number of characters
styleCSS style(s) is/are to be applied when this component is rendered
styleClassCorresponds to the HTML class attribute
suggestionValuesDefines the suggestion collection
tabindexThis attribute specifies the position of the current element in the tabbing order for the current document. This value must be a number between 0 and 32767. User agents should ignore leading zeros
validatorMethodBinding pointing at a method that is called during Process Validations phase of the request processing lifecycle, to validate the current value of this component
validatorMessageA ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator
valueThe current value of this component
valueChangeListenerListener for value changes
widthWidth of the component

Table 6.77. Component identification parameters

NameValue
component-typeorg.richfaces.ComboBox
component-classorg.richfaces.component.html.HtmlComboBox
component-familyorg.richfaces.ComboBox
renderer-typeorg.richfaces.renderkit.ComboBoxRenderer
tag-classorg.richfaces.taglib.ComboBoxTag

6.25.3. Creating the Component with a Page Tag

Here is a simple example as it could be used on a page:

Example:


...
<rich:comboBox value="#{bean.state}" suggestionValues="#{bean.suggestions}" />
...

6.25.4. Creating the Component Dynamically Using Java

Example:


import org.richfaces.component.html.HtmlComboBox;
... 
HtmlComboBox myComboBox = new HtmlComboBox();
...

6.25.5. Details of Usage

The <rich:comboBox> is a simplified suggestion box component, that provides input with client side suggestions. The component could be in two states:

  • Default - only input and button is shown

  • Input, button and a popup list of suggestions attached to input is shown

There are two ways to get values for the popup list of suggestions:

  • Using the "suggestionValues" attribute, that defines the suggestion collection

    Example:

    
    ...
    <rich:comboBox value="#{bean.state}" suggestionValues="#{bean.suggestions}" />    
    ...
  • Using the <f:selectItem /> or <f:selectItems /> facets which considers only "value" attribute.

    Example:

    
    ...
    <rich:comboBox value="#{bean.state}" valueChangeListener="#{bean.selectionChanged}">
            <f:selectItems  value="#{bean.selectItems}"/>
            <f:selectItem itemValue="Oregon"/>            
            <f:selectItem itemValue="Pennsylvania"/>
            <f:selectItem itemValue="Rhode Island"/>
            <f:selectItem itemValue="South Carolina"/>
    </rich:comboBox>            
    ...

Popup list content loads at page render time. No additional requests could be performed on the popup calling.

The "value" attribute stores value from input after submit.

The "directInputSuggestions" attribute defines, how the first value from the suggested one appears in an input field. If it's "true" the first value appears with the suggested part highlighted.

Example:


...
<rich:comboBox value="#{bean.state}" suggestionValues="#{bean.suggestions}" directInputSuggestions="true" />            
...

This is a result:

<rich:comboBox> with "directInputSuggestions" attribute.

Figure 6.14.  <rich:comboBox> with "directInputSuggestions" attribute.


The "selectFirstOnUpdate" attribute defines if the first value from suggested is selected in a popup list. If it's "false" nothing is selected in the list before a user hovers some item with the mouse.

Example:


...
<rich:comboBox value="#{bean.state}" suggestionValues="#{bean.suggestions}" selectFirstOnUpdate="false" />           
...

This is a result:

<rich:comboBox> with "selectFirstOnUpdate" attribute.

Figure 6.15.  <rich:comboBox> with "selectFirstOnUpdate" attribute.


The "defaultLabel" attribute defines the default label of the input element. Simple example is placed below.

Example:


...
<rich:comboBox value="#{bean.state}" suggestionValues="#{bean.suggestions}" defaultLabel="Select a city..." />            
...

This is a result:

<rich:comboBox> with "defaultLabel" attribute.

Figure 6.16.  <rich:comboBox> with "defaultLabel" attribute.


With the help of the "disabled" attribute you can disable the whole <rich:comboBox> component. See the following example.

Example:


...
<rich:comboBox value="#{bean.state}" suggestionValues="#{bean.suggestions}" defaultLabel="Select a city..." disabled="true" />            
...

This is a result:

<rich:comboBox> with "disabled" attribute.

Figure 6.17.  <rich:comboBox> with "disabled" attribute.


The <rich:comboBox> component provides to use specific event attributes:

  • "onlistcall" which is fired before the list opening and gives you a possibility to cancel list popup/update

  • "onselect" which gives you a possibility to send AJAX request when item is selected

The <rich:comboBox> component allows to use sizes attributes:

  • "listWidth" and "listHeight" attributes specify popup list sizes with values in pixels

  • "width" attribute customizes the size of input element with values in pixels.

6.25.6. JavaScript API

Table 6.78. JavaScript API

FunctionDescription
showList()Shows the popup list
hideList()Hides the popup list
enable()Enables the control for input
disable()Disables the control for input

6.25.7. Look-and-Feel Customization

For skinnability implementation, the components use a style class redefinition method. Default style classes are mapped on skin parameters.

There are two ways to redefine the appearance of all <rich:comboBox> components at once:

  • Redefine the corresponding skin parameters

  • Add to your style sheets style classes used by a <rich:comboBox> component

6.25.8. Skin Parameters Redefinition

Table 6.79. Skin parameters redefinition for a popup list

Skin parametersCSS properties
tableBackgroundColorbackground
panelBorderColorborder-color

Table 6.80. Skin parameters redefinition for a button background, inactive button background, button background in pressed and disabled state

Skin parametersCSS properties
tabBackgroundColorbackground-color

Table 6.81. Skin parameters redefinition for a button

Skin parametersCSS properties
panelBorderColorborder-top-color
panelBorderColorborder-left-color

Table 6.82. Skin parameters redefinition for an inactive button

Skin parametersCSS properties
panelBorderColorborder-top-color
panelBorderColorborder-left-color

Table 6.83. Skin parameters redefinition for a disabled button

Skin parametersCSS properties
panelBorderColorborder-top-color
panelBorderColorborder-left-color

Table 6.84. Skin parameters redefinition for a hovered button

Skin parametersCSS properties
selectControlColorborder-color

Table 6.85. Skin parameters redefinition for a font

Skin parametersCSS properties
generalSizeFontfont-size
generalFamilyFontfont-family
generalTextColorcolor

Table 6.86. Skin parameters redefinition for a font in inactive state

Skin parametersCSS properties
generalSizeFontfont-size
generalFamilyFontfont-family
generalTextColorcolor

Table 6.87. Skin parameters redefinition for a font in disabled state

Skin parametersCSS properties
headerFamilyFontfont-size
headerFamilyFontfont-family

Table 6.88. Skin parameters redefinition for an input field

Skin parametersCSS properties
controlBackgroundColorbackground-color
panelBorderColorborder-bottom-color
panelBorderColorborder-right-color

Table 6.89. Skin parameters redefinition for an inactive input field

Skin parametersCSS properties
controlBackgroundColorbackground-color
panelBorderColorborder-bottom-color
panelBorderColorborder-right-color

Table 6.90. Skin parameters redefinition for a disabled input field

Skin parametersCSS properties
controlBackgroundColorbackground-color
panelBorderColorborder-bottom-color
panelBorderColorborder-right-color

Table 6.91. Skin parameters redefinition for an item

Skin parametersCSS properties
generalSizeFontfont-size
generalFamilyFontfont-family
generalTextColorcolor

Table 6.92. Skin parameters redefinition for a selected item

Skin parametersCSS properties
headerBackgroundColorbackground-color
headerBackgroundColorborder-color
generalTextColorcolor

6.25.9. Definition of Custom Style Classes

On the screenshot there are classes names that define styles for component elements.

Classes names

Figure 6.18. Classes names


Classes names

Figure 6.19. Classes names


Table 6.93. Classes names that define popup list representation

Class nameDescription
rich-combobox-shellDefines styles for a wrapper <div> element of a list
rich-combobox-list-positionDefines position of a list
rich-combobox-list-decorationDefines styles for a list
rich-combobox-list-scrollDefines styles for a list scrolling

Table 6.94. Classes names that define font representation

Class nameDescription
rich-combobox-fontDefines styles for a font
rich-combobox-font-inactiveDefines styles for an inactive font
rich-combobox-font-disabledDefines styles for a disabled font

Table 6.95. Classes names that define input field representation

Class nameDescription
rich-combobox-inputDefines styles for an input field
rich-combobox-input-disabledDefines styles for an input field in disabled state
rich-combobox-input-inactiveDefines styles for an inactive input field

Table 6.96. Classes names that define item representation

Class nameDescription
rich-combobox-itemDefines styles for an item
rich-combobox-item-selectedDefines styles for a selected item

Table 6.97. Classes names that define button representation

Class nameDescription
rich-combobox-buttonDefines styles for a button
rich-combobox-button-inactiveDefines styles for an inactive button
rich-combobox-button-disabledDefines styles for a button in disabled state
rich-combobox-button-hoveredDefines styles for a hovered button
rich-combobox-button-backgroundDefines styles for a button background
rich-combobox-button-background-disabledDefines styles for a disabled button background
rich-combobox-button-background-inactiveDefines styles for an inactive button background
rich-combobox-button-pressed-backgroundDefines styles for a pressed button background
rich-combobox-button-iconDefines styles for a button icon
rich-combobox-button-icon-inactiveDefines styles for an inactive button icon
rich-combobox-button-icon-disabledDefines styles for a disabled button icon

Table 6.98. Classes names that define shadow representation

Class nameDescription
rich-combobox-shadowDefines styles for a wrapper <div> element of a shadow
rich-combobox-shadow-tlDefines styles for a top-left element of a shadow
rich-combobox-shadow-trDefines styles for a top-right element of a shadow
rich-combobox-shadow-blDefines styles for a bottom-left element of a shadow
rich-combobox-shadow-brDefines styles for a bottom-right element of a shadow

In order to redefine styles for all <rich:comboBox> components on a page using CSS, it's enough to create classes with the same names (possible classes could be found in the tables above) and define necessary properties in them.

Example:


...
.rich-combobox-list-decoration{
        
background-color:#ecf4fe;
}
...

This is a result:

Redefinition styles with predefined classes

Figure 6.20. Redefinition styles with predefined classes


In the example background color for popup list was changed.

Also it’s possible to change styles of particular <rich:comboBox> component. In this case you should create own style classes and use them in corresponding <rich:comboBox> styleClass attributes. An example is placed below:

Example:


...
.myClass{
        
font-weight:bold;
}
...

The "listClass" attribute for <rich:comboBox> is defined as it’s shown in the example below:

Example:


<rich:comboBox ... listClass="myClass"/>

This is a result:

Redefinition styles with own classes and "listClass" attributes

Figure 6.21. Redefinition styles with own classes and "listClass" attributes


As it could be seen on the picture above, the font weight for items was changed.

6.25.10. Relevant Resources Links

Here you can see an example of <rich:comboBox> usage and sources for the given example.