com.sun.rave.web.ui.component
Class TextFieldBase

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.UIInput
                  com.sun.rave.web.ui.component.HiddenFieldBase
                      com.sun.rave.web.ui.component.HiddenField
                          com.sun.rave.web.ui.component.FieldBase
                              com.sun.rave.web.ui.component.Field
                                  com.sun.rave.web.ui.component.TextFieldBase

All Implemented Interfaces:

ComplexComponent, javax.faces.component.EditableValueHolder, javax.faces.component.StateHolder, javax.faces.component.ValueHolder

Direct Known Subclasses:

TextField

public abstract class TextFieldBase

extends Field

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

HTML Elements and Layout

The textField component renders an XHTML <input type="text">element.

Configuring the ui:textField Tag

Use the text attribute to associate the component with a model object that represents the current value, by setting the attribute's value to an EL expression that corresponds to a property of a backing bean.

To optionally specify a label for the component, use the label attribute, or specify a label facet.

Facets

• label: use this facet to specify a custom component for the label.
• readOnly: use this facet to specify a custom component for displaying the value of this component when it is marked as readonly. The default is a ui:staticText.

Client-side JavaScript functions

In all the functions below, <id> should be the generated id of the TextField component.

field_setDisabled(<id>, <disabled>)	Enable/disable the field. Set <disabled> to true to disable the component, or false to enable it.
field_setValue(<id>, <newValue>)	Set the value of the field to <newValue>.
field_getValue(<id>)	Get the value of the field.
field_getInputElement(<id>)	Get hold of a reference to the input element rendered by this component.
component_setVisible(<id>)	Hide or show this component.

Examples

Example 1: Text field with label and required icon

This example uses a backing bean FieldTest with a property string. The tag generates a label followed by text input field. The required attribute is set to true, which causes an icon to be rendered next to the label to indicate that the application user must enter a value in the text field. The icon, label and input elements are enclosed by a span.

      <ui:textField id="textfield" label="Enter a value:" 
                text="#{FieldTest.string}" 
                required="true"/>
 

Example 2: Text field using a validator

This example uses a backing bean FieldTest with a property number. The number property is an int, which means that the value must be converted to be displayed. It is not necessary to specify a Converter instance, however, since standard JSF conversion deals with this case. A Validator has been set to verify that any value entered by the user is within a certain range. The HTML elements are rendered as in example 1.

      <ui:textField id="test2" label="Enter a number:" 
                text="#{FieldTest.number}" 
                validator="#{FieldTest.checkNumberRange}"/>
 

Auto-generated component class. Do NOT modify; all changes will be lost!

Field Summary

Fields inherited from class com.sun.rave.web.ui.component.Field

INPUT_ID, LABEL_FACET, LABEL_ID, READONLY_FACET, READONLY_ID

Fields inherited from class javax.faces.component.UIInput

COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID

Constructor Summary

TextFieldBase()
Construct a new TextFieldBase.

Method Summary

java.lang.String	getFamily() Return the family for this component.
void	restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state) Restore the state of this component.
java.lang.Object	saveState(javax.faces.context.FacesContext _context) Save the state of this component.

Methods inherited from class com.sun.rave.web.ui.component.Field

getColumns, getLabelComponent, getPrimaryElementID, getReadOnlyComponent, log, setText

Methods inherited from class com.sun.rave.web.ui.component.FieldBase

getLabel, getLabelLevel, getMaxLength, getOnBlur, getOnChange, getOnClick, getOnDblClick, getOnFocus, getOnKeyDown, getOnKeyPress, getOnKeyUp, getOnMouseDown, getOnMouseMove, getOnMouseOut, getOnMouseOver, getOnMouseUp, getOnSelect, getStyle, getStyleClass, getTabIndex, getText, getToolTip, getValueBinding, isDisabled, isReadOnly, isTrim, isVisible, setColumns, setDisabled, setLabel, setLabelLevel, setMaxLength, setOnBlur, setOnChange, setOnClick, setOnDblClick, setOnFocus, setOnKeyDown, setOnKeyPress, setOnKeyUp, setOnMouseDown, setOnMouseMove, setOnMouseOut, setOnMouseOver, setOnMouseUp, setOnSelect, setReadOnly, setStyle, setStyleClass, setTabIndex, setToolTip, setTrim, setValueBinding, setVisible

Methods inherited from class com.sun.rave.web.ui.component.HiddenField

getConvertedValue, getReadOnlyValueString, getValueAsString

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, broadcast, compareValues, decode, getSubmittedValue, getValidator, getValidators, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, setImmediate, setLocalValueSet, setRequired, setSubmittedValue, setValid, setValidator, setValue, setValueChangeListener, updateModel, validate, validateValue

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, getValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, getValue, setConverter

Constructor Detail

TextFieldBase

public TextFieldBase()

Construct a new TextFieldBase.

Method Detail

getFamily

public java.lang.String getFamily()

Return the family for this component.

Overrides:

getFamily in class FieldBase

restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)

Restore the state of this component.

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class FieldBase

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)

Save the state of this component.

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class FieldBase