Keywords: inplaceInput, rich:inplaceInput

JBoss.org Community Documentation

- Prev
- Next

## 6.53. < rich:inplaceInput >

### 6.53.1. Description

The <rich:inplaceInput> is an input component used for displaying and editing data inputted.

Figure 6.124. <rich:inplaceInput> component

### 6.53.2. Key Features

- View/changed/edit states highly customizable representations

- Changing state event customization

- Possibility to call custom JavaScript function on state changes

- Optional "inline" or "block" element rendering on a page

- Edit mode activation when the component gets focus with the "Tab"

- Sizes synchronizations between modes

- Controls customization

Table 6.216. rich : inplaceInput attributes

Attribute Name | Description
--- | ---
binding | The attribute takes a value-binding expression for a component property of a backing bean
cancelControlIcon | Defines custom cancel icon
changedClass | CSS style class for changed state
changedHoverClass | CSS style class for hovered text in changed state
controlClass | CSS style class for controls
controlHoverClass | CSS style class for hovered control
controlPressedClass | CSS style class for pressed press controls
controlsHorizontalPosition | Positions the controls horizontally. Possible values are "left", "center", "right". Default value is "right".
controlsVerticalPosition | Positions the controls vertically. Possible values are "bottom", "top"
converter | 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 | CSS style class for edit state
editEvent | Provides an option to assign an JavaScript action that initiates the change of the state. Default value is "onclick".
id | 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
inputWidth | Sets width of the input field
layout | Defines how the component is displayed in the layout. Possible values are "block", "inline". . Default value is "inline".
maxInputWidth | Sets the maximum width of the input field. Default value is "500px".
minInputWidth | Sets the minimum width of the input field. Default value is "40px".
onblur | HTML: script expression; the element lost the focus
onchange | HTML: script expression; the element value was changed
onclick | HTML: a script expression; a pointer button is clicked
ondblclick | HTML: a script expression; a pointer button is double-clicked
oneditactivated | Provides a possibility to assign JavaScript to be executed when edit state is activated
oneditactivation | Provides a possibility to assign JavaScript on edit state activation
onfocus | HTML: script expression; the element got the focus
oninputclick | HTML: a script expression; a pointer button is clicked
oninputdblclick | HTML: a script expression; a pointer button is double-clicked
oninputkeydown | HTML: a script expression; a key is pressed down
oninputkeypress | HTML: a script expression; a key is pressed and released
oninputkeyup | HTML: a script expression; a key is released
oninputmousedown | HTML: script expression; a pointer button is pressed down
oninputmousemove | HTML: a script expression; a pointer is moved within
oninputmouseout | HTML: a script expression; a pointer is moved away
oninputmouseover | HTML: a script expression; a pointer is moved onto
oninputmouseup | HTML: script expression; a pointer button is released
onkeydown | HTML: a script expression; a key is pressed down
onkeypress | HTML: a script expression; a key is pressed and released
onkeyup | HTML: a script expression; a key is released
onmousedown | HTML: script expression; a pointer button is pressed down
onmousemove | HTML: a script expression; a pointer is moved within
onmouseout | HTML: a script expression; a pointer is moved away
onmouseover | HTML: a script expression; a pointer is moved onto
onmouseup | HTML: script expression; a pointer button is released
onselect | HTML: script expression; the onselect event occurs when you select some menu item
onviewactivated | Provides a possibility to assign JavaScript to be executed when view state is activated
onviewactivation | Provides a possibility to assign JavaScript on view state activation
rendered | If "false", this component is not rendered
required | If "true", this component is checked for non-empty input
requiredMessage | A 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
saveControlIcon | Defines custom save icon
selectOnEdit | Makes the input field select when switched to edit state. Default value is "false"
showControls | Serves to display "save" and "cancel" controls. Default value is "false".
styleClass | Corresponds to the HTML class attribute
tabindex | Serves to define the tabbing order
validator | 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 | The current value of this component
valueChangeListener | Listener for value changes
viewClass | CSS style class for view state
viewHoverClass | CSS style class for hovered text in view state

Table 6.217. Component identification parameters

Name | Value
--- | ---
component-type | org.richfaces.inplaceInput
component-class | org.richfaces.component.html.HtmlInplaceInput
component-family | org.richfaces.inplaceInput
renderer-type | org.richfaces.renderkit.inplaceInputRenderer
tag-class | org.richfaces.taglib.inplaceInputTag

### 6.53.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:inplaceInput value="#{bean.value}"/>

    ...

### 6.53.4. Creating the Component Dynamically Using Java

Example:

    import org.richfaces.component.html.inplaceInput;

    ...

    HtmlInpaceInput myInplaceInput = new InplaceInput();

    ...

### 6.53.5. Details of Usage

The <rich:inplaceInput> component was designed to facilitate displaying and inputting(editing) some data.

The "value" attribute is a value-binding expression for the current value of the component.

The 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:inplaceInput value="#{bean.value}" defaultLabel="click to edit"/>

      ...

  In the example above the "value" attribute is not initialized therefore "click to edit" text, that "defaultLabel" , contains is displayed.

  This is the result:

  Figure 6.125. View state

- Edit state - input representation to allow value edit

  Figure 6.126. Edit state

- Changed state - value representation after it was changed

  Figure 6.127. Changed state

The "editEvent" attribute provides an option to assign a JavaScript action to initiate the change of the state from view/changed to edit. The default value is "onclick".

Example:

    ...

    <rich:inplaceInput value="#{bean.value}" editEvent="ondblclick"/>

    ...

The <rich:inplaceInput> component provides specific event attributes:

- "oneditactivation" which is fired on edit state activation

- "oneditactivated" which is fired when edit state is activated

- "onviewactivation" which is fired on view state activation

- "onviewactivated" which is fired after the component is changed to representation state

Example:

    ...

    <rich:inplaceInput value="#{bean.value}" oneditactivation="if (confirm('Are you sure you want to change value?')){return false;}" />

    ...

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.

Using the boolean "selectOnEdit" attribute set to true, the text in the input field will be selected when the change from view/changed state to edit occurs.

This is the result:

Figure 6.128. Usage of the "selectOnEdit" attribute

If the <rich:inplaceInput> loses focus, input data is saved automatically and the component displays a new value. Additionally, the data is saved when "Enter" is pressed. Nevertheless, you can use the "showControls" attribute, which makes "Save" and "Cancel" buttons appear next to the input field. If the controls are used, data is not saved automatically when the form loses focus: user has to confirm that he/she wants to save/discard the data explicitly. In both cases(with controls or without them) the input data can be discarded by pressing "Esc" key.

Example:

    ...

    <rich:inplaceInput value="#{bean.value}" showControls="true"/>

    ...

Figure 6.129. Usage "showControls" attribute

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", "center" and "top" definitions

Example:

    ...

    <rich:inplaceInput value="#{bean.value}" showControls="true" controlsVerticalPosition="bottom" controlsHorizontalPosition="left"/>

    ...

This is the result:

Figure 6.130. Positioning of "Save" and "Cancel" buttons

It is also possible to use "controls" facet in order to replace the default controls with facets content. See the example below.

Example:

    ...

    <rich:inplaceInput defaultLabel="Click here to edit" showControls="true" controlsHorizontalPosition="left" controlsVerticalPosition="bottom" id="inplaceInput">

        <f:facet name="controls">

            <button onclick="#{rich:component('inplaceInput')}.save();" type="button">Save</button>

            <button onclick="#{rich:component('inplaceInput')}.cancel();" type="button">Cancel</button>

        </f:facet>

    </rich:inplaceInput>

    ...

This is the result:

Figure 6.131. "controls" facet usage

## 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. You need to define the path to where your images are located.

Example:

    ...

    <rich:inplaceInput value="#{bean.value}" defaultLabel='click to edit'

        showControls="true"

        controlsHorizontalPosition="left"

        controlsVerticalPosition="top"

        saveControlIcon="/images/cancel.gif"

        cancelControlIcon="/images/save.gif"/>

        ...

Figure 6.132. Redefining of "save" and "cancel" buttons

The <rich:inplaceInput> component could be rendered with <span> or <div> elements to display its value. In order to change default <span> output, use "layout" attribute with "block" value.

The <rich:inplaceInput> component supports standard "tabindex" attribute. When the component gets focus the edit mode is activated.

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

Table 6.218. Keyboard usage

Keys and combinations | Description
--- | ---
ENTER | Saves the input data, and changes the state from edit to changed
ESC | Changes the state from edit to view or changed, value is not affected
TAB | Switches between the components

### 6.53.6. JavaScript API

Table 6.219. 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

### 6.53.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:inplaceInput> components at once:

- Redefine the corresponding skin parameters

- Add to your style sheets style classes used by a <rich:inplaceInput> component

### 6.53.8. Skin Parameters Redefinition

Table 6.220. Skin parameters redefinition for "save" and "cancel" controls

Skin parameters | CSS properties
--- | ---
tabBackgroundColor | background-color
panelBorderColor | border-color
panelBorderColor | border-color

Table 6.221. Skin parameters redefinition for view state

Skin parameters | CSS properties
--- | ---
editorBackgroundColor | background-color
generalTextColor | border-bottom-color

Table 6.222. Skin parameters redefinition for "Changed" state

Skin parameters | CSS properties
--- | ---
editorBackgroundColor | background-color
generalTextColo | border-bottom-color

Table 6.223. Classes names that define input field look and feel in edit state

Skin parameters | CSS properties
--- | ---
editBackgroundColor | background-color
panelBorderColor | border-color

### 6.53.9. Definition of Custom Style Classes

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

Figure 6.133. Classes names

Table 6.224. Class name for the view state

Class name | Description
--- | ---
rich-inplace-view | Defines styles for the view state
rich-inplace-input-view-hover | Defines styles for hovered text in the view state

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

Class name | Description
--- | ---
rich-inplace-field | Defines styles for input field look and feel in edit state

Table 6.226. Class name for the "Changed" state

Class name | Description
--- | ---
rich-inplace-changed | Defines styles for the "Changed" state
rich-inplace-input-changed-hover | Defines styles for the hovered text in the "Changed" state

Table 6.227. Classes names "save" and "cancel" controls in Edit state

Class name | Description
--- | ---
rich-inplace-control | Defines styles for the controls
rich-inplace-control-press | Defines styles for the controls when either of the buttons is pressed
rich-inplace-shadow-size | Defines size of the shadow
rich-inplace-shadow-tl | Defines styles for the shadow in the top left corner
rich-inplace-shadow-tr | Defines styles for the shadow in the top right corner
rich-inplace-shadow-bl | Defines styles for the shadow in the bottom left corner
rich-inplace-shadow-br | Defines styles for the shadow in the bottom right corner

In order to redefine styles for all <rich:inplaceInput> 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-field {

        font-style: italic;

    }

    ...

This is the result:

Figure 6.134. Redefinition styles with predefined classes

In the shown example the font in edit state is changed to bold.

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

Example:

    ...

    .myClass {

        color:  #008cca;

    }

    ...

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

Example:

    ...<rich:inplaceInput value="click to edit" styleClass="myClass"/>

This is a result:

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

As it could be seen on the picture above, the font color of the text on the component was changed.

### 6.53.10. Relevant Resources Links

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

- Prev6.52. < rich:virtualEarth >
- Top of page
- Front page
- Next6.54. < rich:inplaceSelect >