Project Documentation
Foundation

Summary

Tag name: <s:focus2>
UIComponent class: org.apache.myfaces.custom.focus2.HtmlFocus
Tag class: org.apache.myfaces.custom.focus2.HtmlFocusTag
Component type: org.apache.myfaces.Focus2
Component family: javax.faces.Output
Renderer type: org.apache.myfaces.Focus2
Renderer class: org.apache.myfaces.custom.focus2.HtmlFocusRenderer

Supported Listeners

Name Listener Event Phases Required Description
$listener.isRequired()

Attributes

Name Type Supports EL? Description
binding org.apache.myfaces.custom.focus2.HtmlFocus Only EL Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.
converter javax.faces.convert.Converter Yes An expression that specifies the Converter for this component.

The value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface.

converterMessage String Yes Text to be displayed to the user as an error message when conversion of a submitted value to the target type fails.

focusAndSubmitOnEnter String Yes Defines an id of a command-button or command-link that will be focussed and submitted when the enter-key is pressed.
focusOnError boolean Yes Defines that the first element of the form with an associated error should receive the focus by default (if the override focus-id attribute wasn't set).
focusOnFirst boolean Yes Defines that the first element of the form should receive the focus by default (if the overrideFocusId-attribute is not specified, no error has been queued and the focus has not already been set).
id String Yes Get a string which uniquely identifies this UIComponent within the scope of the nearest ancestor NamingContainer component. The id is not necessarily unique across all components in the current view.
immediate boolean Yes A boolean value that identifies the phase during which action events should fire.

During normal event processing, action methods and action listener methods are fired during the "invoke application" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.

overrideFocusId String Yes The id (locally in this naming container) of the component which should receive the focus. Overrides all other behaviour if set.
rendered boolean Yes A boolean value that indicates whether this component should be rendered. Default value: true.
required boolean Yes A boolean value that indicates whether an input value is required.

If this value is true and no input value is provided by a postback operation, then the "requiredMessage" text is registered as a FacesMessage for the request, and validation fails.

Default value: false.

requiredMessage String Yes Text to be displayed to the user as an error message when this component is marked as "required" but no input data is present during a postback (ie the user left the required field blank).
validator javax.faces.el.MethodBinding Only EL A method-binding EL expression which is invoked during the validation phase for this component.

The invoked method is expected to check the submitted value for this component, and if not acceptable then report a validation error for the component.

The method is expected to have the prototype

public void aMethod(FacesContext, UIComponent,Object)
validatorMessage String Yes Text which will be shown if validation fails.
value Object Yes The client-id (fully specified as a concatenation of the id of this component and all naming container parent ids) of the component which receives the focus (works only if overrideFocusId hasn't been set and no error has been queued). The value will automatically be updated when the focus is changed.
valueChangeListener javax.faces.el.MethodBinding Only EL A method which is invoked during postback processing for the current view if the submitted value for this component is not equal to the value which the "value" expression for this component returns.

The phase in which this method is invoked can be controlled via the immediate attribute.