6.54.  < rich:inplaceSelect >

6.54.1. Description

The <rich:inplaceSelect> is used for creation select based inputs: it shows the value as text in one state and enables editing the value, providing a list of options in another state

Three states of <rich:inplaceSelect> component

Figure 6.116. Three states of <rich:inplaceSelect> component


6.54.2. Key Features

  • Option to display "Save", "Cancel" buttons as icons
  • Option to display "Save", "Cancel" buttons as standard buttons
  • Possibility to assign an JavaScript action on state change
  • Switching between <rich:inplaceSelect> components using "Tab" key
  • Resizable select field
  • Full skinability

Table 6.228. rich : inplaceSelect attributes

Attribute NameDescription
bindingThe attribute takes a value-binding expression for a component property of a backing bean
cancelControlIconDefines custom cancel icon
changedClassCSS style class for changed state
controlClassCSS style class for controls
controlHoverCSS style class for hovered control
controlPressedCSS style class for controls pressed
controlsHorizontalPositionThe attribute postions the controls horizontally
controlsVerticalPositionThe attribute postions the controls vertically
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
defaultLabelThe attribute is used to display text while value is undefined
editClassCSS style class for edit state
editEventThe attribute provides an option to assign an JavaScript action that initiates the change of the state
editOnTabThe attribute activates edit state once Tab key pressed
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
layoutdefines how the component is displayed in the layout, can be block or inline
listHeightThe attribute defines the height of option list
listWidthThe attribute defines the withs of option list
maxSelectWidthmax width of the select element
minSelectWidthmin width of the select element
onclickHTML: a script expression; a pointer button is clicked
ondblclickHTML: a script expression; a pointer button is double-clicked
oneditactivatedThe attributes provide a possibility to assign JavaScript code to be executed when edit state is activated
oneditactivationThe attributes provide a possibility to assign JavaScript code on edit state activation
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
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
onviewactivatedThe attributes provide a possibility to assign JavaScript code to be executed when view state is activated
onviewactivationThe attributes provide a possibility to assign JavaScript code on view state activation
openOnEditThe attribure opens the list once edit activated
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
saveControlIconDefines custom save icon
selectOnEditThe attribute make the input field select when switched to edit state
selectWidthwidth of the select element
showControlsThe attribute serves to display "save" and "cancel" controls
tabindexThe attribute serves to define the tabbing order
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 initial value to set when rendered for the first time
valueChangeListenerListener for value changes
viewClassStyle class for view state
viewHoverCSS style class for hovered text in view state

Table 6.229. Component identification parameters

NameValue
component-typeorg.richfaces.inplaceInput
component-familyorg.richfaces.inplaceInput
renderer-typeorg.richfaces.renderkit.inplaceInputRenderer
tag-classorg.richfaces.taglib.inplaceInputTag

6.54.3. Creating the Component with a Page Tag

Here is a simple example of how the component can be used on a page:

Example:


...
<rich:inplaceSelect value="#{Bean.inputValue}" defaultLabel="Click  to edit">
    <f:selectItems  value="#{bean.selectItems}"/>
    <f:selectItem itemValue="1" itemLabel="factory"/>
    <f:selectItem itemValue="2" itemLabel="newspaper"/>
</rich:inplaceSelect>
...

6.54.4. Creating the Component Dynamically Using Java

Example:


import org.richfaces.component.html.inplaceSelect;
... 
HtmlInpaceSelect myInplaceSelect = new InplaceSelect();
...

6.54.5. Details of Usage

The <rich:inplaceSelect> component has three functional states, which are:

  • View state displays the current value as text;

  • Edit state displays a list with options;

  • Changed state displays the value of the selected option as text

The "value" attribute displays the value as an outputtext. The attribute is defined when some option in the list is selected.

You can form he list of the options: using <f:selectItem> and <f:selectItems>

Please see the example below

Example:


...
<rich:inplaceSelect value="#{inplaceComponentsBean.inputValue}" showControls="true" defaultLabel="click to edit">
    <f:selectItems  value="#{bean.selectItems}"/>
    <f:selectItem itemValue="1" itemLabel="factory"/>
    <f:selectItem itemValue="2" itemLabel="newspaper"/>
</rich:inplaceSelect>
... 

The "value" attribute gets some value when an option in the select-box in clicked on (the default action).

Nowever, if you want the end user to confirm the data saving explicitly you can:

  • Use a "showControls" attribute, which makes "Save" and "Cancel" buttons (displayed as icons) appear next to the input field;

    Please see the example

    Example:

    
    ...
        <rich:inplaceSelect value="#{inplaceComponentsBean.inputValue}"
            defaultLabel="Click here to edit">
        <f:selectItem itemValue="0" itemLabel="oil well"/>
        <f:selectItem itemValue="1" itemLabel="factory"/>
        <f:selectItem itemValue="2" itemLabel="newspaper"/>
        </rich:inplaceSelect>
    ... 
  • Use standard buttons by means of the "controls" facet

    Please see the example

    Example:

    
    ...
    <rich:inplaceSelect value="#{inplaceComponentsBean.inputValue}" defaultLabel="Click to edit" showControls="true">
        <f:facet name="controls">
            <input type="button" value="Save"/>
            <input type="button" value="Cancel"/>
        </f:facet>
        <f:selectItem itemValue="0" itemLabel="oil well"/>
        <f:selectItem itemValue="1" itemLabel="factory"/>
        <f:selectItem itemValue="2" itemLabel="newspaper"/>
    </rich:inplaceSelect>
    ... 

Note:

The "controls" facet also implies using showcontrols attribute and it has to be defined as "true".

Redefinition of the "save" and "cancel" icons can be performed using "saveControlIcon" and "cancelControlIcon" attributes r. You need to define the path to where your images are located.

Example:


...
<rich:inplaceSelect 
   value="#{inplaceComponentsBean.inputValue}" defaultLabel="Click to edit" showControls="true"
    showControls="true"
    controlsHorizontalPosition="left"
    controlsVerticalPosition="top"
    saveControlIcon="/richfaces-demo/richfaces/cancel.gif"
    cancelControlIcon="/richfaces-demo/richfaces/save.gif"> 
    
<f:selectItem itemValue="0" itemLabel="oil well"/>
<f:selectItem itemValue="1" itemLabel="factory"/>
<f:selectItem itemValue="2" itemLabel="newspaper"/>
</rich:inplaceSelect>
    ... 

You can also position the controls relatively to the input field, by means of " controlsHorizontalPosition" " controlsVerticalPosition " attributes. The " controlsHorizontalPosition" attribute has "left", "right" and "center" definitions. The " controlsVerticalPosition " attribute has "bottom", "center" and "top" definitions.

Example:


...
<rich:inplaceSelect value="#{inplaceComponentsBean.inputValue}" defaultLabel="Click to edit"  controlsHorizontalPosition="left" controlsVerticalPosition="top" showControls="true">
    <f:facet name="controls" >
        <input type="button" value="Save"/>
        <input type="button" value="Cancel"/>
    </f:facet>
    <f:selectItem itemValue="0" itemLabel="oil well"/>
    <f:selectItem itemValue="1" itemLabel="factory"/>
    <f:selectItem itemValue="2" itemLabel="newspaper"/>
</rich:inplaceSelect>
... 

Another useful attribute is "openOnEdit" . It allows you to make the drop-down box with options appear once "edit" state activated.

The "editEvent" attribute provides an option to assign an JavaScript action that initiates the change of the state from view to edit. The default value is "click".

Note:

Do not use "on" prefix applying event action. E.g. use "click" instead of "onClick", use "mouseover" instead of "onMouseOver".

The "selectOnEdit" (with possible values "true", "false") gives you an option to make the text in the input area selected right after the change from view state to edit occurs.

The " inputWidth" , " minInputWidth" , and " maxInputWidth" attributes are provided to specify the width, minimal width and maximal width for the input element respectively.

In order to specify the height and width parameters for the list items of the component, you can use "listHeight" and " listWidth" attributes.

The " oneditactivation" , "oneditactivated" , "onviewactivation" and " onviewactivated" attributes provide a possibility to assign JavaScript code on edit state activation, on edit state activated,on view state activation and on view state activated respectively.

6.54.6. JavaScript API

Table 6.230. JavaScript API

FunctionDescription
edit()changes the state to edit
cancel()changes its state to the previous one before editing (changed or view)
save()the component hanges the state to the previous one before editing (changed or view)
save()the component changes its state to changed with a new value
save()the component changes its state to changed with a new value
getValue()gets the current value
setValue(newValue)sets the current value

6.54.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:inplaceSelect> components at once:

  • Redefine the corresponding skin parameters
  • Add to your style sheets style classes used by a <rich:inplaceSelect> component

6.54.8. Skin Parameters Redefinition

Table 6.231. Skin parameters redefinition for view state

Skin parametersCSS properties
editorBackgroundColorbackground-color
generaTextColorborder-bottom-color

Table 6.232. Skin parameters redefinition for input field in edit state

Skin parametersCSS properties
editBackgroundColorbackground-color
panelBorderColorborder-color

Table 6.233. Skin parameters redefinition for control

Skin parametersCSS properties
tabBackgroundColorbackground-color
panelBorderColorborder-color

Table 6.234. Skin parameters redefinition for pressed control

Skin parametersCSS properties
tabBackgroundColorbackground-color
panelBorderColorborder-color

Table 6.235. Skin parameters redefinition for list

Skin parametersCSS properties
editBackgroundColorbackground-color
panelBorderColorborder-color

Table 6.236. Skin parameters redefinition for selected item

Skin parametersCSS properties
headerTextColorcolor
headerBackgroundColorbackground-color
headerBackgroundColorborder-color

6.54.9. Definition of Custom Style Classes

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

Classes names

Figure 6.117. Classes names


Table 6.237. Class name for the view state

Class nameDescription
rich-inplace-select-viewDefines styles for the select view

Table 6.238. Class name for the input field in edit state

Class nameDescription
rich-inplace-select-fieldDefines styles for the select field

Table 6.239. Class name for the control

Class nameDescription
rich-inplace-select-controlDefines styles for the select control
rich-inplace-select-control-pressDefines styles for the pressed select control

Table 6.240. Class name for the list

Class nameDescription
rich-inplace-select-list-decorationDefines styles for a wrapper <table> element of an inplaceSelect

Table 6.241. Classes names for the selected item

Class nameDescription
rich-inplace-select-selected-itemDefines styles for the selected item

Table 6.242. Classes names for the shadow

Class nameDescription
rich-inplace-select-shadow-tlDefines styles for the top-left shadow
rich-inplace-select-shadow-trDefines styles for the top-right shadow
rich-inplace-select-shadow-blDefines styles for the bottom-left shadow
rich-inplace-select-shadow-brDefines styles for the bottom-right shadow

In order to redefine styles for all <rich:inplaceSelect> 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-inplace-select-list-decoration{
    
background-color: #ecf4fe;
}                      
   
...

This is the result:

Redefinition styles with predefined classes

Figure 6.118. Redefinition styles with predefined classes


In the shown example the background color for list is changed.

It's aslo possible to change styles of a particular <rich:inplaceSelect> component. In this case you should create own style classes and use them in corresponding <rich:inplaceSelect> styleClass attributes. An example is placed below:

Example:


...
.myClass {
    
background-color:#bed6f8;
    
font-style:italic;}
...

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

Example:


...<rich:inplaceSelect value="click to edit" viewClass="myClass"/>

This is a result:

Modificaton of a look and feel with own classes and styleClass attributes

Figure 6.119. Modificaton of a look and feel with own classes and styleClass attributes


As it could be seen on the picture above, the font style and background color in view state is changed.

6.54.10. Relevant Resources Links

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