Decode Behavior
Obtain the Map from the
"requestParameterMap"
property of the ExternalContext. If the map
contains
an entry for the "clientId" of this UIForm
component,
call setSubmitted(true) on the form,
otherwise call
setSubmitted(false) on the form.
Encode Behavior
The value of the "method" attribute must be "post". The
value
of the "action" attribute must be the result of passing the view
identifier of the current view to the getActionURL()
method of the ViewHandler for this
application, then
passing that String to the encodeActionURL()
method
on the ExternalContext. The value of the
acceptcharset
attribute must be rendered as the value of "accept-charset".
If the "styleClass" attribute is specified, render its value as the
value of the "class" attribute. Render a "name"
attribute with a value the same as the "id" attribute as described
in "General
Notes on
Encoding" regarding the "id" attribute for UIInput
components.
Obtain the UIViewRoot
view identifier and
use it to obtain an action URL by calling
ViewHandler.getActionURL.
Use the action URL to obtain an encoded
action URL by calling
ExternalContext.encodeActionURL. Obtain an
encoded partial action URL by calling
ExternalContext.encodePartialActionURL
using action URL as the argument.
Compare the result from ExternalContext.encodePartialActionURL
with the
value from ExternalContext.encodeActionURL().
If they are different,
render a hidden field with the name jakarta.faces.encodedURL
and the value
of this hidden field as the value from ExternalContext.encodePartialActionURL.
ViewHandler.writeState()
before the the close of the "form" element. Render all the
necessary hidden fields for all commandLink instances in the page
just before the close of the "form" element.
</form>
element tag, render
any resources that have been targeted for this form:
UIViewRoot instance.List of component
resources targeted for
this form with a call to UIViewRoot.getComponentResources()
with the String "form" as the argument.List of
UIComponent instances
and call encodeAll on each UIComponent
instance.
| Info | Value |
|---|---|
| Component Type | jakarta.faces.HtmlForm |
| Handler Class | None |
| Renderer Type | jakarta.faces.Form |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
id | false | jakarta.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. |
prependId | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Flag indicating whether or not this form should prepend its id to its descendent's id during the clientId generation process. If this flag is not set, the default value is true. |
rendered | false | jakarta.el.ValueExpression
(must evaluate to java.lang.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. |
accept | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| List of content types that a server processing this form will handle correctly |
acceptcharset | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| List of character encodings for input data that are accepted by the server processing this form. |
dir | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). |
enctype | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Content type used to submit the form to the server. If not specified, the default value is "application/x-www-form-urlencoded". |
lang | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Code describing the language used in the generated markup for this component. |
onclick | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is clicked over this element. |
ondblclick | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is double clicked over this element. |
onkeydown | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a key is pressed down over this element. |
onkeypress | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a key is pressed and released over this element. |
onkeyup | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a key is released over this element. |
onmousedown | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is pressed down over this element. |
onmousemove | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is moved within this element. |
onmouseout | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is moved away from this element. |
onmouseover | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is moved onto this element. |
onmouseup | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when a pointer button is released over this element. |
onreset | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when this form is reset. |
onsubmit | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Javascript code executed when this form is submitted. |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| CSS style(s) to be applied when this component is rendered. |
styleClass | false | jakarta.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. |
target | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Name of a frame where the response retrieved after this form submit is to be displayed. |
title | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Advisory title information about markup elements generated for this component. |
binding | false | jakarta.el.ValueExpression
(must evaluate to jakarta.faces.component.UIComponent)
| The ValueExpression linking this component to a property in a backing bean |
role | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
|
Per the WAI-ARIA spec and its relationship to HTML5 (Section title ARIA Role Attriubute), every HTML element may have a "role" attribute whose value must be passed through unmodified on the element on which it is declared in the final rendered markup. The attribute, if specified, must have a value that is a string literal that is, or an EL Expression that evaluates to, a set of space-separated tokens representing the various WAI-ARIA roles that the element belongs to. It is the page author's responsibility to ensure that the user agent is capable of correctly interpreting the value of this attribute. |