6.53.  < rich:inplaceInput >

6.53.1. Description

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

<rich:inplaceInput> component

Figure 6.104.  <rich:inplaceInput> component


6.53.2. Key Features

  • Option to display "save", "cancel" buttons
  • Possibility to assign an JavaScript action on state change
  • Switching between <rich:inplaceInput> components using "Tab" key
  • Resizable input field

Table 6.217. rich : inplaceInput attributes

Attribute NameDescription
bindingThe attribute takes a value-binding expression for a component property of a backing bean
cancelControlIcon 
changedClass 
changedHoverClass 
controlClass 
controlHoverClass 
controlPressedClass 
controlsHorizontalPosition 
controlsVerticalPosition 
converterId of Converter to be used or reference to a Converter
converterMessageconverterMessage
defaultLabel 
editClass 
editEvent 
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
inputWidth 
layoutinline/block
maxInputWidth 
minInputWidth 
onblur 
onchange 
onclickHTML: a script expression; a pointer button is clicked
ondblclickHTML: a script expression; a pointer button is double-clicked
oneditactivated 
oneditactivation 
onfocus 
oninputclickHTML: a script expression; a pointer button is clicked
oninputdblclickHTML: a script expression; a pointer button is double-clicked
oninputkeydownHTML: a script expression; a key is pressed down
oninputkeypressHTML: a script expression; a key is pressed and released
oninputkeyupHTML: a script expression; a key is released
oninputmousedownHTML: script expression; a pointer button is pressed down
oninputmousemoveHTML: a script expression; a pointer is moved within
oninputmouseoutHTML: a script expression; a pointer is moved away
oninputmouseoverHTML: a script expression; a pointer is moved onto
oninputmouseupHTML: script expression; a pointer button is released
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
onselect 
onviewactivated 
onviewactivation 
renderedIf "false", this component is not rendered
requiredIf "true", this component is checked for non-empty input
requiredMessagerequiredMessage
saveControlIcon 
selectOnEdit 
showControls 
styleClass 
tabindex 
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
validatorMessagevalidatorMessage
valueThe initial value to set when rendered for the first time
valueChangeListenerListener for value changes
viewClass 
viewHoverClass 

Table 6.218. Component identification parameters

NameValue
component-typeorg.richfaces.inplaceInput
component-familyorg.richfaces.inplaceInput
renderer-typeorg.richfaces.renderkit.inplaceInputRenderer
tag-classorg.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

As it was mentioned earlier the <rich:inplaceInput> component was designed to facilitate inputting and editing some parts of text.

The component has three logical states:

  • View state displays the text containing in a "value" attribute;

    View state

    Figure 6.105. View state


  • ;Editstate - the text can be edited and saved;

    Edit state

    Figure 6.106. Edit state


  • Changedstate - displays the edited text and indicates that it was edited, changed

    Changed state

    Figure 6.107. Changed state


The main attribute of the component is "value" it displays the text on a page, the text can be edited by clicking (default action, which can be redefined) on it.

However, if "value" attribute is not defined, you can use "defaultLabel" attribute which displays some default text while "value" attribute stays undefined.

Example:


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

In the shown example, "value" attribute is not defined; therefore default text "Click to edit" is displayed since it is placed into the "defaultLabel" attribute.

Input data is saved (submitted) automatically whenever the input field loses focus. Nevertheless, you can use the "showControls" attribute, which makes "save"and "cancel" buttons appear next to the input field.

Example:


...
<rich:inplaceInput value="#{bean.value}" defaultLabel='click to edit' showControls="true"/>
... 
Usage "showControls" attribute

Figure 6.108. Usage "showControls" attribute


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.

Positioning of "save" and "cancel" buttons

Figure 6.109. Positioning of "save" and "cancel" buttons


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:inplaceInput value="#{bean.value}" defaultLabel='click to edit'
    showControls="true"
    controlsHorizontalPosition="left"
    controlsVerticalPosition="top"
    saveControlIcon="/richfaces-demo/richfaces/cancel.gif"
    cancelControlIcon="/richfaces-demo/richfaces/save.gif"/> 
    ... 
Redefining of "save" and "cancel" buttons

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


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

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".

Having multiple <rich:inplaceInput> components on a page you can use "tabindex" attribute that enables switching (tabbing) between the components by pressing the “Tab” key. Switching order is determined by the value of the attribute which is an integer between 0 and 32767.

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 " oneditactivation" , "oneditactivated" , "onviewactivation" and " onviewactivated" 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.

Example:


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

The given code illustrates how onviewactivation attribute works, namely when the state is being changed from edit to view, a confirmation window with a message "Are you sure you want to change value?" comes up.

Table 6.219. Keyboard usage

Keys and combinations Description
ENTERSaves the input data, and changes the state from edit to changed
ESCchanges the state from edit to view or changed, value is not affected
TABswitches between the components

6.53.6. JavaScript API

Table 6.220. 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.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.221. Skin parameters redefinition for "save" and "cancel" controls

Skin parametersCSS properties
tabBackgroundColorbackground-color
panelBorderColorborder-color
panelBorderColorborder-color

Table 6.222. Skin parameters redefinition for view state

Skin parametersCSS properties
editorBackgroundColorbackground-color
generalTextColorborder-bottom-color

Table 6.223. Skin parameters redefinition for "Changed" state

Skin parametersCSS properties
editorBackgroundColorbackground-color
generalTextColoborder-bottom-color

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

Skin parametersCSS properties
editBackgroundColorbackground-color
panelBorderColorborder-color

6.53.9. Definition of Custom Style Classes

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

Classes names

Figure 6.111. Classes names


Table 6.225. Class name for the view state

Class nameDescription
rich-inplace-viewDefines styles for the view state
rich-inplace-input-view-hoverDefines styles for hovered text in the view state

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

Class nameDescription
rich-inplace-fieldDefines styles for input field look and feel in edit state

Table 6.227. Class name for the "Changed" state

Class nameDescription
rich-inplace-changedDefines styles for the "Changed" state
rich-inplace-input-changed-hover Defines styles for the hovered text in the "Changed" state

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

Class nameDescription
rich-inplace-controlDefines styles for the controls
.rich-inplace-control-pressDefines styles for the controls when either of the buttons is pressed
.rich-inplace-shadow-sizeDefines size of the shadow
rich-inplace-shadow-tlDefines styles for the shadow in the top left corner
rich-inplace-shadow-trDefines styles for the shadow in the top right corner
rich-inplace-shadow-blDefines styles for the shadow in the bottom left corner
rich-inplace-shadow-brDefines 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: bold;
}                       
   
...

This is the result:

Redefinition styles with predefined classes

Figure 6.112. 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 "styleClass" attribute for <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:

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

Figure 6.113. 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.