The <r:inplaceInput> component allows information to be entered in-line in blocks of text, improving readability of the text. Multiple input regions can be navigated with keyboard navigation. The component has three functional states: the view state, where the component displays its initial setting, such as "click to edit"; the edit state, where the user can input text; and the "changed" state, where the new value for the component has been confirmed but can be edited again if required.
@author Anton Belevich| Info | Value |
|---|---|
| Component Type | org.richfaces.ui.InplaceInput |
| Display Name | None |
| Handler Class | None |
| Renderer Type | org.richfaces.ui.InplaceInputRenderer |
| Description | The <r:inplaceInput> component allows information to be entered in-line in blocks of text, improving readability of the text. Multiple input regions can be navigated with keyboard navigation. The component has three functional states: the view state, where the component displays its initial setting, such as "click to edit"; the edit state, where the user can input text; and the "changed" state, where the new value for the component has been confirmed but can be edited again if required. @author Anton Belevich |
| Name | Required | Type | Description |
|---|---|---|---|
activeClass |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Space-separated list of CSS style class(es) to be applied when this element is active. This value must be passed through as the "class" attribute on generated markup. |
binding |
false
| javax.el.ValueExpression
(must evaluate to javax.faces.component.UIComponent)
| The value binding expression used to wire up this component to a component property of a JavaBean class |
changedClass |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Space-separated list of CSS style class(es) to be applied when the value of this element is changed. This value must be passed through as the "class" attribute on generated markup. |
converter |
false
| javax.el.ValueExpression
(must evaluate to javax.faces.convert.Converter)
| Converter instance registered with this component. |
converterMessage |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| 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 |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Used to set the display text when value is undefined |
disabled |
false
| javax.el.ValueExpression
(must evaluate to boolean)
| If "true", this component is disabled |
disabledClass |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup. |
editEvent |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Used to specify the event that switches the component to the edit state Default is "click" |
id |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The component identifier for this component. This value must be unique within the closest parent component that is a naming container. |
immediate |
false
| javax.el.ValueExpression
(must evaluate to boolean)
| Flag indicating that this component's value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until Process Validations phase. |
inputWidth |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The width of the input element |
onblur |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when this element loses focus. |
onchange |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when this element loses focus and its value has been modified since gaining focus. |
onclick |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is clicked over this element. |
ondblclick |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is double clicked over this element. |
onfocus |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when this element receives focus. |
oninputclick |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The client-side script method to be called when |
oninputdblclick |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The client-side script method to be called when |
oninputkeydown |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The client-side script method to be called when |
oninputkeypress |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The client-side script method to be called when |
oninputkeyup |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The client-side script method to be called when |
oninputmousedown |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The client-side script method to be called when |
oninputmousemove |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The client-side script method to be called when |
oninputmouseout |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The client-side script method to be called when |
oninputmouseover |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The client-side script method to be called when |
oninputmouseup |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The client-side script method to be called when |
oninputselect |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| The client-side script method to be called when |
onkeydown |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a key is pressed down over this element. |
onkeypress |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a key is pressed and released over this element. |
onkeyup |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a key is released over this element. |
onmousedown |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is pressed down over this element. |
onmousemove |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is moved within this element. |
onmouseout |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is moved away from this element. |
onmouseover |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is moved onto this element. |
onmouseup |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is released over this element. |
rendered |
false
| javax.el.ValueExpression
(must evaluate to boolean)
| Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true. |
required |
false
| javax.el.ValueExpression
(must evaluate to boolean)
| Flag indicating that the user is required to provide a submitted value for this input component. |
requiredMessage |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| 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. |
saveOnBlur |
false
| javax.el.ValueExpression
(must evaluate to boolean)
| If "true", apply the changes when the focus is lost |
showControls |
false
| javax.el.ValueExpression
(must evaluate to boolean)
| If "true" is set, buttons for confirming or canceling are added to the component |
style |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| CSS style(s) to be applied when this component is rendered. |
styleClass |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup. |
tabindex |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Position of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767. |
title |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| Advisory title information about markup elements generated for this component. |
validator |
false
| javax.el.ValueExpression
(must evaluate to javax.faces.el.MethodBinding)
| MethodExpression representing a validator method that will be called during Process Validations to perform correctness checks on the value of this component. The expression must evaluate to a public method that takes FacesContext, UIComponent, and Object parameters, with a return type of void. |
validatorMessage |
false
| javax.el.ValueExpression
(must evaluate to java.lang.String)
| 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 |
false
| javax.el.ValueExpression
(must evaluate to java.lang.Object)
| The current value of this component. |
valueChangeListener |
false
| javax.el.ValueExpression
(must evaluate to javax.faces.el.MethodBinding)
| MethodExpression representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a |
Output generated by Vdldoc View Declaration Language Documentation Generator.