webuijsf
Tag editableField


Use the webuijsf:editableField tag to create an input field for a single line of text.

HTML Elements and Layout

The editableField component renders a borderless readonly XHTML <input type="text">element that can be edited inline. An initial ( read-only ) state resembles regular static text, and it can be edited by using the onDblClick event or when the <SPACE> key is pressed. Once the field looses the focus ( as a result of onBlur event), it enters a read-only state again.

If the editable field is modified and if autoSave is set to its default value, which is true, the updated data will be automatically submitted to the server by an Ajax request.

The EditableField component inherits most of the functionality and attributes from TextField. See the webuijsf:textField component description for details and examples.

Configuring the webuijsf:editableField Tag

See the webuijsf:editableField component description for details and examples. With the exception of the autoValidate, all of the usage and attribute examples for textField can be used with editableField by replacing tag into webuijsf:editableField .

Client Side Javascript Functions

When the editableField component is rendered, a DOM object is created. To manipulate the editableField component on the client side, you may invoke functions on this DOM object. For example, ir ordet to disable the component, invoke document.getElementById(id).setProps({disabled: true}).
The following table offers description of additional functions available on the editableField DOM node.
JavaScript Function Description
getInputElement() Accesses the HTML <input> element that is rendered by the component.
getProps() Gets widget properties. Please see setProps() function for a list of supported properties.
refresh(execute)
Asynchronously refreshes the component.
  • [optional] execute: Comma separated string containing a list of client ids against which the execute portion of the request processing lifecycle must be run. If omitted, no other components are executed.
setProps(props) Changes any of the following supported properties:
  • accesskey
  • autoSave
  • className
  • dir
  • disabled
  • id
  • label
  • lang
  • onClick
  • onDblClick
  • onFocus
  • onKeyDown
  • onKeyPress
  • onKeyUp
  • onMouseDown
  • onMouseMove
  • onMouseOut
  • onMouseOver
  • onMouseUp
  • readOnly
  • required
  • size
  • style
  • tabIndex
  • title
  • valid
  • value
  • visible
submit(execute)
Asynchronously submits the component.
  • [optional] execute: Comma separated string containing a list of client ids against which the execute portion of the request processing lifecycle must be run. If omitted, the component on which the function has been invoked, is submitted.

Client Side JavaScript Events

When the component is manipulated client side, some functions may publish event topics for custom AJAX implementations to listen for. Using the Dojo event system, subscribe to any of these events in order to add custom logic to the editableField behavior. For example:

<webuijsf:script>
    var processEvents = {                       
        update: function(props) {
            // Do something...
        }
    }

    // Subscribe to refresh event.
    dojo.subscribe(webui.suntheme.widget.editableField.event.<eventname>.endTopic, processEvents, "update");


</webuijsf:script>

The following events are supported.

Event Description
webui.suntheme.widget.editableField.event.refresh.beginTopic Event topic published before asynchronously refreshing the component. Supported properties include:
  • [optional] execute - list of the components to be executed along with this component
  • id - The client id to process the event for
webui.suntheme.widget.editableField.event.refresh.endTopic

Event topic published after asynchronously refreshing the component. Supported properties include:

  • props - JSON object containing properties of the component. See setProps() function for details on properties and their usage
webui.suntheme.widget.editableField.event.submit.beginTopic Event topic published before asynchronously submitting the component. Supported properties include:
  • [optional] execute - list of the components to be executed along with this component
  • id - The client id to process the event for
webui.suntheme.widget.editableField.event.submit.endTopic

Event topic published after asynchronously submitting the component. Supported properties include:

  • props - JSON object containing messages (if any) raised by the server.In particular, valdiation messages will be present here if validation failed.

Examples

Example 1: Update the Client-Side EditableField Properties Using the GetProps and SetProps Functions

This example shows how to toggle the disabled state of a editable field client side using the getProps and setProps functions. When the user clicks the radio button, the text field is either disabled or enabled.
<webuijsf:radioButton id="rb1" name="rb1" label="Toggle Field Disabled" onClick="toggleDisabled()"/>
<webuijsf:editableField id="field1" text="My Text Field" />

<webuijsf:script>
function toggleDisabled() {
var domNode = document.getElementById("form1:field1"); // Get field
return domNode.setProps({disabled: !domNode.getProps().disabled}); // Toggle disabled state
}
</webuijsf:script>

Example 2: Asynchronously Update the EditableField Using Refresh Function

This example shows how to asynchronously update a editable field using the refresh function. When the user clicks on the radio button, the text field is asynchronously updated with new data.
<webuijsf:radioButton id="rb1" name="rb1" label="Refresh Text Field" onClick="refreshField()"/>
<webuijsf:editableField id="field1" text="#{MyBean.text}" />
<webuijsf:script>
    function refreshField() {
        var domNode = document.getElementById("form1:field1"); // Get field
        return domNode.refresh(); // Asynchronously refresh field
    }
</webuijsf:script>

Note that the refresh function can optionally take a list of elements to execute. Thus, a comma-separated list of ids can be provided to update components server-side: refresh("form1:id1,form2:id2,..."). When no parameter is given, the refresh function acts as a reset. That is, the component will be redrawn using values set server-side, but not updated.

Example 3: Asynchronously Update EditableField Using Refresh Function

This example shows how to asynchronously update a editable field using the refresh function. The execute property of the refresh function is used to define the client id which is to be submitted and updated server-side. When the user clicks on the radio button, the input value is updated server-side and the text field is updated client-side -- all without a page refresh.
<webuijsf:radioButton id="rb1" name="rb1" label="Refresh Text Field" onClick="refreshField()"/>
<webuijsf:editableField id="field1" text="#{MyBean.text}" /> // Field used to asynchronously update text.
<webuijsf:script>
    function
refreshField() {
        var domNode = document.getElementById("form1:field1"); // Get field
        return domNode.refresh("form1:rb1"); // Asynchronously refresh while submitting radio button value
    }
</webuijsf:script>

Note that the refresh function can optionally take a list of elements to execute. Thus, a comma-separated list of ids can be provided to update components server-side: refresh("form1:id1,form2:id2,...")



Tag Information
Tag Classcom.sun.webui.jsf.component.EditableFieldTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
bindingfalsefalsejava.lang.String A ValueExpression that resolves to the UIComponent that corresponds to this tag. This binding allows the Java bean that contains the UIComponent to manipulate the UIComponent, its properties, and its children.
autoSavefalsefalsejava.lang.String Attribute indicating to turn on/off the autoSave functionality of the EditableField. When on, an Ajax submit event will be generated every time component looses focus with modified data. If data is not modified, no Ajax request will be submitted.
AutoSave will submit the content of the text field for server side processing that will be processed using JSFX partial lifecycle cycle. Component on the client will not be updated as per results of the submit. If validation fails, for example, the server state of the component will not be updated ( UPDATE_MODEL phase is not invoked), while client side component will still reflect the user modified invalid data.
By default autoSave is on.
submitFormfalsefalsejava.lang.String

Flag indicating whether pressing enter in this text field would allow browser to submit the enclosing form ( for all input fields with the exception of TextArea which uses enter key to open a new line)
If set to false, the browser will be prevented from submitting the form on enter in all circumstances. If set to true, the form will be submitted on enter in all circumstances. The default value for this attribute is "false", i.e. default browser auto submit feature will be disabled.

onDblClickfalsefalsejava.lang.String

Scripting code executed when a mouse double click occurs over this component.

trimfalsefalsejava.lang.String

Flag indicating that any leading and trailing blanks will be trimmed prior to conversion to the destination data type. Default value is true.

onKeyPressfalsefalsejava.lang.String

Scripting code executed when the user presses and releases a key while the component has focus.

onSelectfalsefalsejava.lang.String

Scripting code executed when some text in this component value is selected.

onFocusfalsefalsejava.lang.String

Scripting code executed when this component receives focus. An element receives focus when the user selects the element by pressing the tab key or clicking the mouse.

renderedfalsefalsejava.lang.String Indicates whether the HTML code for the component should be included in the rendered HTML page. If set to false, the rendered HTML page does not include the HTML for the component. If the component is not rendered, it is also not processed on any subsequent form submission.
columnsfalsefalsejava.lang.String

Number of character columns used to render this field. The default is 20.

idfalsetruejava.lang.StringNo Description
onKeyUpfalsefalsejava.lang.String

Scripting code executed when the user releases a key while the component has focus.

onMouseUpfalsefalsejava.lang.String

Scripting code executed when the user releases a mouse button while the mouse pointer is on the component.

styleClassfalsefalsejava.lang.String

CSS style class(es) to be applied to the outermost HTML element when this component is rendered.

stylefalsefalsejava.lang.String

CSS style(s) to be applied to the outermost HTML element when this component is rendered.

onClickfalsefalsejava.lang.String

Scripting code executed when a mouse click occurs over this component.

onBlurfalsefalsejava.lang.String

Scripting code executed when this element loses focus.

onMouseDownfalsefalsejava.lang.String

Scripting code executed when the user presses a mouse button while the mouse pointer is on the component.

toolTipfalsefalsejava.lang.String

Sets the value of the title attribute for the HTML element. The specified text will display as a tooltip if the mouse cursor hovers over the HTML element.

maxLengthfalsefalsejava.lang.String

The maximum number of characters that can be entered for this field.

converterfalsefalsejava.lang.String Specifies a method to translate native property values to String and back for this component. The converter attribute value must be one of the following:
  • A JavaServer Faces EL expression that resolves to a backing bean or bean property that implements the javax.faces.converter.Converter interface; or
  • the ID of a registered converter (a String).
requiredfalsefalsejava.lang.String Flag indicating that an input value for this field is mandatory, and failure to provide one will trigger a validation error.
disabledfalsefalsejava.lang.String

Flag indicating that the user is not permitted to activate this component, and that the component's value will not be submitted with the form.

validatorExpressionfalsefalsejava.lang.String Used to specify a method in a backing bean to validate input to the component. The value must be a JavaServer Faces EL expression that resolves to a public method with return type void. The method must take three parameters:
  • a javax.faces.context.FacesContext
  • a javax.faces.component.UIComponent (the component whose data is to be validated)
  • a java.lang.Object containing the data to be validated.

The backing bean where the method is defined must implement java.io.Serializable or javax.faces.component.StateHolder.

The method is invoked during the Process Validations Phase.

onMouseOutfalsefalsejava.lang.String

Scripting code executed when a mouse out movement occurs over this component.

onMouseOverfalsefalsejava.lang.String

Scripting code executed when the user moves the mouse pointer into the boundary of this component.

htmlTemplatefalsefalsejava.lang.String Alternative HTML template to be used by this component.
onMouseMovefalsefalsejava.lang.String

Scripting code executed when the user moves the mouse pointer while over the component.

textfalsefalsejava.lang.String

Literal value to be rendered in this input field. If this property is specified by a value binding expression, the corresponding value will be updated if validation succeeds.

immediatefalsefalsejava.lang.String Flag indicating that event handling for this component should be handled immediately (in Apply Request Values phase) rather than waiting until Invoke Application phase.
labelfalsefalsejava.lang.String

If set, a label is rendered adjacent to the component with the value of this attribute as the label text.

onChangefalsefalsejava.lang.String

Scripting code executed when the element value of this component is changed.

visiblefalsefalsejava.lang.String

Use the visible attribute to indicate whether the component should be viewable by the user in the rendered HTML page.

onKeyDownfalsefalsejava.lang.String

Scripting code executed when the user presses down on a key while the component has focus.

readOnlyfalsefalsejava.lang.String

Flag indicating that modification of this component by the user is not currently permitted, but that it will be included when the form is submitted.

labelLevelfalsefalsejava.lang.String

Sets the style level for the generated label, provided the label attribute has been set. Valid values are 1 (largest), 2 and 3 (smallest). The default value is 2.

valueChangeListenerExpressionfalsefalsejava.lang.String Specifies a method to handle a value-change event that is triggered when the user enters data in the input component. The attribute value must be a JavaServer Faces EL expression that resolves to a backing bean method. The method must take a single parameter of type javax.faces.event.ValueChangeEvent, and its return type must be void. The backing bean where the method is defined must implement java.io.Serializable or javax.faces.component.StateHolder.
tabIndexfalsefalsejava.lang.String

Position of this element in the tabbing order of the current document. Tabbing order determines the sequence in which elements receive focus when the tab key is pressed. The value must be an integer between 0 and 32767.

notifyfalsefalsejava.lang.String The comma separated list of absolute client IDs to notify during text field events.

Currently, this feature is only supported by label and alert components. For example, when the label attribute of the textField tag is not used. Or, when an alert is used in the page to display validation messages.

During auto-validation, the text field will notify the label and alert associated with the given client IDs. If the user's input is found to be invalid, the label will change text color and display an error indicator. Likewise, if there are any messages associated with the event, the alert will display the assocaited summary, detail, and error indicator.


Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.