Create new RichFaces Documentation Jira issue
This will launch the RichFaces Jira page - to complete your feedback please login if needed, and submit the Jira.
JBoss.orgCommunity Documentation
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
View/changed/edit states highly customizable representations
Optional "inline" or "block" element rendering on a page
Changing state event customization
Possibility to call custom JavaScript function on state changes
Edit mode activation when the component got focus with the "Tab"
Sizes synchronizations between modes
Highly customizable look and feel
Table 6.440. rich : inplaceSelect attributes
| Attribute Name |
Description
|
|---|---|
| binding | JSF: The attribute takes a value-binding expression for a component property of a backing bean |
| cancelControlIcon | Defines custom cancel icon |
| changedClass | Assigns one or more space-separated CSS class names to the component in the changed state |
| controlClass | Assigns one or more space-separated CSS class names to the component controls |
| controlHoverClass | Assigns one or more space-separated CSS class names to the component control hovered |
| controlPressClass | Assigns one or more space-separated CSS class names to the component control pressed |
| controlsHorizontalPosition | The attribute positions the controls horizontally. Possible values are "right","center","left". Default value is "right". |
| controlsVerticalPosition | The attribute positions the controls vertically. Possible values are "bottom","center" and "top". Default value is "center" |
| converter | JSF: Id of Converter to be used or reference to a Converter |
| converterMessage | A ValueExpression enabled attribute that, if present, will be used as the text of the converter message, replacing any message that comes from the converter |
| defaultLabel | The attribute is used to display text while value is undefined |
| editClass | Assigns one or more space-separated CSS class names to the component in the edit state |
| editEvent | The attribute provides an option to assign an JavaScript action that initiates the change of the state. Default value is "onclick". |
| id | JSF: Every component may have a unique id that is automatically created if omitted |
| immediate | A 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 |
| label | A localized user presentable name for this component. |
| layout | Defines how the component is displayed in the layout. Possible values are "block", "inline". Default value is "inline". |
| listHeight | The attribute defines the height of option list. Default value is "200px". |
| listWidth | The attribute defines the width of option list. Default value is "200px". |
| maxSelectWidth | Sets the maximum width of the select element. Default value is "200px". |
| minSelectWidth | Sets the minimum width of the select element. Default value is "100px". |
| onblur | DHTML: The client-side script method to be called when the component loses the focus |
| onchange | DHTML: The client-side script method to be called when the component value is changed |
| onclick | DHTML: The client-side script method to be called when the element is clicked |
| ondblclick | DHTML: The client-side script method to be called when the element is double-clicked |
| oneditactivated | The client-side script method to be called when the component edit state is activated |
| oneditactivation | The client-side script method to be called before the component edit state is activated |
| onfocus | DHTML: The client-side script method to be called when the component gets the focus |
| oninputblur | The client-side script method to be called when the component input field loses the focus |
| oninputclick | The client-side script method to be called when the input field is clicked |
| oninputdblclick | The client-side script method to be called when the input field is double-clicked |
| oninputfocus | The client-side script method to be called when the component input field gets the focus |
| oninputkeydown | The client-side script method to be called when a key is pressed down in the input field |
| oninputkeypress | The client-side script method to be called when a key is pressed and released in the input field |
| oninputkeyup | The client-side script method to be called when a key is released in the input field |
| oninputmousedown | The client-side script method to be called when a mouse button is pressed down in the input field |
| oninputmousemove | The client-side script method to be called when a pointer is moved within the input field |
| oninputmouseout | The client-side script method to be called when a pointer is moved away from the input field |
| oninputmouseover | The client-side script method to be called when a pointer is moved onto the input field |
| oninputmouseup | The client-side script method to be called when a mouse button is released in the input field |
| onkeydown | DHTML: The client-side script method to be called when a key is pressed down over the element |
| onkeypress | DHTML: The client-side script method to be called when a key is pressed over the element and released |
| onkeyup | DHTML: The client-side script method to be called when a key is released |
| onmousedown | DHTML: The client-side script method to be called when a mouse button is pressed down over the element |
| onmousemove | DHTML: The client-side script method to be called when a pointer is moved within the element |
| onmouseout | DHTML: The client-side script method to be called when a pointer is moved away from the element |
| onmouseover | DHTML: The client-side script method to be called when a pointer is moved onto the element |
| onmouseup | DHTML: The client-side script method to be called when a mouse button is released |
| onselect | DHTML: The client-side script method to be called when some text is selected in the input field |
| onviewactivated | The client-side script method to be called when the component view state is activated |
| onviewactivation | The client-side script method to be called before the component view state is activated |
| openOnEdit | The attribute opens the list once edit activated. Default value is "true". |
| rendered | JSF: If "false", this component is not rendered |
| required | JSF: If "true", this component is checked for non-empty input |
| requiredMessage | A ValueExpression enabled attribute which defines text of validation message to show, if a required field is missing |
| saveControlIcon | Defines custom save icon |
| selectWidth | Sets width of the select element |
| showControls | The attribute serves to display "save" and "cancel" controls. Default value is "false". |
| showValueInView | If "true", shows the SelectItem labels in the InplaceSelect pull-down list, but displays the value in the field in view mode once an item is selected. Default value is "false" |
| styleClass | JSF: Assigns one or more space-separated CSS class names to the component. Corresponds to the HTML "class" attribute. |
| tabindex | HTML: The attribute serves to define the tabbing order |
| validator | JSF: MethodBinding pointing at a method that is called during Process Validations phase of the request processing lifecycle, to validate the current value of this component |
| validatorMessage | A ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator |
| value | JSF: The current value of this component |
| valueChangeListener | JSF: Listener for value changes |
| viewClass | Assigns one or more space-separated CSS class names to the component in the view state |
| viewHoverClass | Assigns one or more space-separated CSS class names to the component hovered in the view state |
Table 6.441. Component identification parameters
| Name | Value |
|---|---|
| component-type | org.richfaces.InplaceSelect |
| component-class | org.richfaces.component.html.HtmlInplaceSelect |
| component-family | org.richfaces.InplaceSelect |
| renderer-type | org.richfaces.renderkit.InplaceSelectRenderer |
| tag-class | org.richfaces.taglib.InplaceSelectTag |
Here is a simple example of how the component can be used on a page:
Example:
...
<rich:inplaceSelect value="#{bean.inputValue}">
<f:selectItem itemValue="1" itemLabel="factory"/>
</rich:inplaceSelect>
...
Example:
import org.richfaces.component.html.inplaceSelect;
...
HtmlInpaceSelect myInplaceSelect = new InplaceSelect();
...
The "value" attribute is a value-binding expression for the current value of the component.
The <rich:inplaceSelect> component has three functional states:
View state displays default label with the value taken from "value" or "defaultLabel" attributes.
If the initial value of the "value" attribute is "null" or empty string the "defaultLabel" attribute is used to define default label.
Example:
...
<rich:inplaceSelect value="#{bean.value}" defaultLabel="click to edit">
<f:selectItems value="#{bean.selectItems}" />
</rich:inplaceSelect>
...
In the example above the
"value"
attribute is not initialized
therefore "click to edit" text, that
"defaultLabel"
, contains is displayed.
This is the result:
Edit state - select representation to allow value edit
Changed state - value representation after it was changed
You can form the list of the options using <f:selectItem/> and <f:selectItems/> JSF components.
Please, see the example below.
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>
...
In the example above the value of the selected item is available via "value" attribute.
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 "onclick".
Example:
...
<rich:inplaceSelect value="#{bean.inputValue}" defaultLabel="Double Click to edit" editEvent="ondblclick">
<f:selectItems value="#{demo.selectItems}" />
</rich:inplaceSelect>
...
The <rich:inplaceSelect> component provides specific event attributes:
"oneditactivation" fired on edit state activation
"oneditactivated" fired when edit state is activated
"onviewactivation" fired on view state activation
"onviewactivated" fired after the component is changed to representation state
Example:
...
<rich:inplaceSelect value="#{bean.inputValue}" oneditactivation="if (!confirm('Are you sure you want to change the value?')){return false;}">
<f:selectItems value="#{demo.selectItems}" />
</rich:inplaceSelect>
...
The given code illustrates how
"oneditactivation"
attribute works,
namely when the state is being changed from view to edit,
a confirmation window with a message "Are you sure you want to change value?" comes up.
To prevent opening the drop-down list by default, once edit state is activated, set the "openOnEdit" attribute to "false". The default value is "true".
Example:
...
<rich:inplaceSelect value="#{bean.inputValue}" showControls="true" openOnEdit="false">
<f:selectItems value="#{bean.selectItems}"/>
</rich:inplaceSelect>
...
This is the result:
Nowever, if you want to confirm the data saving explicitly you can use the "showControls" attribute, which makes "Save" and "Cancel" buttons (displayed as icons) appear next to the input field. Edit state can be deactivated by pressing "Esc" key. An option in the drop-drown list can be also selected by pressing "Enter".
Example:
...
<rich:inplaceSelect value="#{bean.inputValue}" showControls="true">
<f:selectItems value="#{bean.selectItems}"/>
</rich:inplaceSelect>
...
This is the result:
You can also position the controls relatively to the input field, by means of
The "controlsHorizontalPosition" attribute with "left", "right" and "center" definitions
The "controlsVerticalPosition " attribute with "bottom" and "top" definitions
Example:
...
<rich:inplaceSelect value="#{bean.inputValue}" controlsHorizontalPosition="left" controlsVerticalPosition="center" showControls="true">
<f:selectItems value="#{bean.selectItems}"/>
</rich:inplaceSelect>
...
This is the result:
It is also possible to use "controls" facet in order to replace the default controls with facets content. See the example below.
Please, see the example.
Example:
...
<rich:inplaceSelect value="#{bean.inputValue}" showControls="true">
<f:facet name="controls">
<button onclick="#{rich:component('inplaceSelect')}.save();" type="button">Save</button>
<button onclick="#{rich:component('inplaceSelect')}.cancel();" type="button">Cancel</button>
</f:facet>
<f:selectItems value="#{bean.selectItems}"/>
</rich:inplaceSelect>
...
This is the result:
The "controls" facet also implies using "showControls" attribute and it has to be defined as "true".
The <rich:inplaceSelect> component could be rendered with <span> or <div> elements to display its value. In order to change default <span> output, use the "layout" attribute with "block" value.
The <rich:inplaceSelect> component supports standard "tabindex" attribute. When the component gets focus the edit mode is activated and drop-down list is opened.
The "selectWidth" , "minSelectWidth" and "maxSelectWidth" 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.
Table 6.442. JavaScript API
| Function | Description |
|---|---|
| edit() | Changes the state to edit |
| cancel() | Changes its state to the previous one before editing (changed or view) |
| save() | Changes its state to changed with a new value |
| getValue() | Gets the current value |
| setValue(newValue) | Sets the current value and name |
Table 6.443. Facets
| Facet name | Description |
|---|---|
| controls | Defines the contols contents. Related attributes are "saveControlIcon" and "cancelControlIcon" |
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
Table 6.444. Skin parameters redefinition for view state
| Skin parameters | CSS properties |
|---|---|
| editorBackgroundColor | background-color |
| generaTextColor | border-bottom-color |
Table 6.445. Skin parameters redefinition for input field in edit state
| Skin parameters | CSS properties |
|---|---|
| editBackgroundColor | background-color |
| panelBorderColor | border-color |
Table 6.446. Skin parameters redefinition for control
| Skin parameters | CSS properties |
|---|---|
| tabBackgroundColor | background-color |
| panelBorderColor | border-color |
Table 6.447. Skin parameters redefinition for pressed control
| Skin parameters | CSS properties |
|---|---|
| tabBackgroundColor | background-color |
| panelBorderColor | border-color |
Table 6.448. Skin parameters redefinition for list
| Skin parameters | CSS properties |
|---|---|
| editBackgroundColor | background-color |
| panelBorderColor | border-color |
Table 6.449. Skin parameters redefinition for selected item
| Skin parameters | CSS properties |
|---|---|
| headerTextColor | color |
| headerBackgroundColor | background-color |
| headerBackgroundColor | border-color |
On the screenshot there are classes names that define styles for component elements.
Table 6.450. Class name for the view state
| Class name | Description |
|---|---|
| rich-inplace-select-view | Defines styles for the select view |
Table 6.451. Class name for the input field in edit state
| Class name | Description |
|---|---|
| rich-inplace-select-field | Defines styles for the select field |
Table 6.452. Class name for the control
| Class name | Description |
|---|---|
| rich-inplace-select-control | Defines styles for the select control |
| rich-inplace-select-control-press | Defines styles for the pressed select control |
Table 6.453. Class name for the list
| Class name | Description |
|---|---|
| rich-inplace-select-list-decoration | Defines styles for a wrapper <table> element of an inplaceSelect |
Table 6.454. Classes names for the selected item
| Class name | Description |
|---|---|
| rich-inplace-select-selected-item | Defines styles for the selected item |
Table 6.455. Classes names for the shadow
| Class name | Description |
|---|---|
| rich-inplace-select-shadow-tl | Defines styles for the top-left shadow |
| rich-inplace-select-shadow-tr | Defines styles for the top-right shadow |
| rich-inplace-select-shadow-bl | Defines styles for the bottom-left shadow |
| rich-inplace-select-shadow-br | Defines 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:
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:
As it could be seen on the picture above, the font style and background color in view state is changed.
On the component Live Demo page you can see the example of <rich:inplaceSelect> usage and sources for the given example.
