form (OmniFaces VDL Documentation - Generated Documentation)

Description:

Form is a component that extends the standard UIForm and submits by default to current request URI with query string and offers in combination with the <o:ignoreValidationFailed> tag on an UICommand component the possibility to ignore validation failures so that the invoke action phase will be executed anyway. It also supports adding custom query string parameters via a nested <o|h:param>.

Component Information
Info	Value
Component Type	`org.omnifaces.component.input.Form`
Handler Class	None
Renderer Type	None
Description	None

Attributes
Name	Required	Type	Description
`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.
`binding`	`false`	`jakarta.el.ValueExpression` (must evaluate to `jakarta.faces.component.UIComponent`)	The ValueExpression linking this component to a property in a backing bean
`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".
`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.
`includeRequestParams`	`false`	`jakarta.el.ValueExpression` (must evaluate to `boolean`)	Whether to include request query string parameters in the URL. Defaults to false. When this setting is set to `true`, `useRequestURI` is ignored.
`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.
`partialSubmit`	`false`	`jakarta.el.ValueExpression` (must evaluate to `boolean`)	Whether to send only the form data which actually need to be processed as opposed to the entire form. Defaults to true.
`rendered`	`false`	`jakarta.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.
`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.
`useRequestURI`	`false`	`jakarta.el.ValueExpression` (must evaluate to `boolean`)	Whether to use current request URI with query string as action URI. Defaults to true. This setting is ignored when `includeRequestParams` is set to `true`.

o

Tag form