The <rich:inplaceInput> is used to make some parts of a text editable
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 | |
changedClass | |
changedHoverClass | |
controlClass | |
controlHoverClass | |
controlPressedClass | |
controlsHorizontalPosition | |
controlsVerticalPosition | |
converter | Id of Converter to be used or reference to a Converter |
converterMessage | converterMessage |
defaultLabel | |
editClass | |
editEvent | |
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 | |
layout | inline/block |
maxInputWidth | |
minInputWidth | |
onblur | |
onchange | |
onclick | HTML: a script expression; a pointer button is clicked |
ondblclick | HTML: a script expression; a pointer button is double-clicked |
oneditactivated | |
oneditactivation | |
onfocus | |
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 | |
onviewactivated | |
onviewactivation | |
rendered | If "false", this component is not rendered |
required | If "true", this component is checked for non-empty input |
requiredMessage | requiredMessage |
saveControlIcon | |
selectOnEdit | |
showControls | |
styleClass | |
tabindex | |
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 | validatorMessage |
value | The initial value to set when rendered for the first time |
valueChangeListener | Listener for value changes |
viewClass | |
viewHoverClass |
Table 6.217. Component identification parameters
Name | Value |
---|---|
component-type | org.richfaces.inplaceInput |
component-family | org.richfaces.inplaceInput |
renderer-type | org.richfaces.renderkit.inplaceInputRenderer |
tag-class | org.richfaces.taglib.inplaceInputTag |
Here is a simple example of how the component can be used on a page:
Example:
...
<rich:inplaceInput value="#{bean.value}"/>
...
Example:
import org.richfaces.component.html.inplaceInput;
...
HtmlInpaceInput myInplaceInput = new InplaceInput();
...
As it was mentioned earlier the <rich:inplaceInput> component was designed to facilitate inputting and editing some parts of a text.
The component has three logical states:
"View" state displays the text containing in a "value" attribute;
"Editable"state - the text can be edited and saved;
"Changed"state - displays the edited text and indicates that it was edited, changed
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 will display 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 when the input field loses focus. Nevertheless, you can use a "showControls" attribute, which make "save"and "cancel" buttons appear next to the input field.
Example:
...
<rich:inplaceInput value="#{bean.value}" defaultLabel='click to edit' showControls="true"/>
...
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.
Redefinition of the "save" and "cancel" icons can be performed using "saveControlIcon" and "cancelControlIcon" attributes relatively. You need to define the path to where your images are located.
Example:
...
<rich:inplaceInput value="#{bean.incValue}" minValue="50" maxValue="400"/>
...
Table 6.218. JavaScript API
Function | Description |
---|---|
enable() | Begins polling for ajax mode |
disable() | Stops polling for ajax mode |
setValue(value) | Updates the progress of the process |
setLabel(label) | Update the label for the process |
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:progressBar> components at once:
Table 6.219. Skin parameters redefinition for the "completed" part of the bar with no label
Skin parameters | CSS properties |
---|---|
selectControlColor | background-color |
Table 6.220. Skin parameters redefinition for the "completed" part of the bar with a label used
Skin parameters | CSS properties |
---|---|
panelBorderColor | border-color |
Table 6.221. Skin parameters redefinition for the “completed” part of the bar with a label used
Skin parameters | CSS properties |
---|---|
selectControlColor | background-color |
controlBackgroundColor | color |
Table 6.222. Skin parameters redefinition for the "remained" part of the bar
Skin parameters | CSS properties |
---|---|
controlBackgroundColor | background-color |
controlTextColor | color |
Table 6.223. Skin parameters redefinition for the bar itself with a label used
Skin parameters | CSS properties |
---|---|
panelBorderColor | border-color |
generalFamilyFont | font-family |
headerFamilyFont | font-family |
generalSizeFont | font-size |
controlTextColor | color |
Table 6.224. Skin parameters redefinition for the bar itself with no label used
Skin parameters | CSS properties |
---|---|
controlBackgroundColor | background-color |
panelBorderColor | border-color |
On the screenshot there are classes names that define styles for component elements.
Table 6.225. Classes names for the bar
Class name | Description |
---|---|
rich-progress-bar-shell | Defines styles for the background and the borders of the bar when label is not used |
rich-progress-bar-shell-dig | Defines styles for background, font and border settings when label is used |
Table 6.226. Classes names that define "completed" part of the bar
Class name | Description |
---|---|
rich-progress-bar-uploaded | Defines styles for of "completed" progress area with no labels used |
rich-progress-bar-uploaded-dig | Defines styles for that "completed" progress area with labels used |
rich-progress-bar-completed | Defines styles for the "completed" progress area with a label used |
Table 6.227. Classes names that define "remained" part of the progress area
Class name | Description |
---|---|
rich-progress-bar-remained | Defines styles for the "remained" part of the bar |
In order to redefine styles for all <rich:progressBar> 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-progress-bar-remained{
background-color: #ebf3fd;
}
...
This is the result:
In the example the "remained" part of progress area is modified with a background-color CSS property.
It's aslo possible to change styles of a particular <rich:progressBar> component. In this case you should create own style classes and use them in corresponding <rich:progressBar> styleClass attributes. An example is placed below:
Example:
...
.RremainClass{ background-color: #ebf3fd;}
...
The "styleClass" attribute for <rich:progressBar> is defined as it’s shown in the example below:
Example:
<rich:progressBar value="#{bean.incValue1}" styleClass="remainClass" />
This is a result:
As it could be seen on the picture above, the font style for output text was changed.
Here you can see the example of <rich:progressBar> usage and sources for the given example.