h
Tag form

Renders an HTML "form" element.

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. Call 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. 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.

Tag Information

Tag Class

com.sun.faces.taglib.html_basic.FormTag

TagExtraInfo Class

com.sun.faces.taglib.FacesTagExtraInfo

Body Content

JSP

Display Name

None

Attributes

Name

Required

Request-time

Type

Description

id

false

true

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

false

javax.el.ValueExpression(must evaluate to 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

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.

accept

false

false

javax.el.ValueExpression(must evaluate to java.lang.String)

List of content types that a server processing this form will handle correctly

acceptcharset

false

false

javax.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

false

javax.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

false

javax.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

false

javax.el.ValueExpression(must evaluate to java.lang.String)

Code describing the language used in the generated markup for this component.

onclick

false

false

javax.el.ValueExpression(must evaluate to java.lang.String)

Javascript code executed when a pointer button is clicked over this element.

ondblclick

false

false

javax.el.ValueExpression(must evaluate to java.lang.String)

Javascript code executed when a pointer button is double clicked over this element.

onkeydown

false

false

javax.el.ValueExpression(must evaluate to java.lang.String)

Javascript code executed when a key is pressed down over this element.

onkeypress

false

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

false

javax.el.ValueExpression(must evaluate to java.lang.String)

Javascript code executed when a key is released over this element.

onmousedown

false

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

false

javax.el.ValueExpression(must evaluate to java.lang.String)

Javascript code executed when a pointer button is moved within this element.

onmouseout

false

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

false

javax.el.ValueExpression(must evaluate to java.lang.String)

Javascript code executed when a pointer button is moved onto this element.

onmouseup

false

false

javax.el.ValueExpression(must evaluate to java.lang.String)

Javascript code executed when a pointer button is released over this element.

onreset

false

false

javax.el.ValueExpression(must evaluate to java.lang.String)

Javascript code executed when this form is reset.

onsubmit

false

false

javax.el.ValueExpression(must evaluate to java.lang.String)

Javascript code executed when this form is submitted.

style

false

false

javax.el.ValueExpression(must evaluate to java.lang.String)

CSS style(s) to be applied when this component is rendered.

styleClass

false

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.

target

false

false

javax.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

false

javax.el.ValueExpression(must evaluate to java.lang.String)

Advisory title information about markup elements generated for this component.