Summary
Tag name: <s:form>
UIComponent class: org.apache.myfaces.custom.form.HtmlForm
Tag class: org.apache.myfaces.custom.form.HtmlFormTag
Component type: org.apache.myfaces.HtmlForm
Component family: javax.faces.Form
Renderer type: org.apache.myfaces.Form
Renderer class: org.apache.myfaces.custom.form.HtmlFormRenderer
Renders a HTML form element which allow defining a different scheme,
servername or port for the action url to which the form is submited
Instructions
The tag allows control for the action attribute of the form.
Every JSF request goes to the same url which renders the response. The s:form component allows to use a different scheme, servername or port when a form is submitted. This is normally needed to change from http to https to submit security related data.
Even more, by setting an entirely different 'action' and 'method' attribute the standard behaviour of the JSF-Form can be overwritten completely. This might be useful for special cases of forms, e.g. for form based authentication.
Attributes
| Name | Type | Supports EL? | Description |
|---|---|---|---|
| accept | String | Yes | HTML: Provides a comma-separated list of content types that the server processing this form can handle. |
| acceptcharset | String | Yes | HTML: The list of character encodings accepted by the server for this form. |
| action | String | Yes | This attribute can be used to set an entirely different action (might be something JSF-unspecific) to the form. |
| binding | String | 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. |
| dir | String | Yes | HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left). |
| enctype | String | Yes | HTML: The content type used to submit this form to the server. |
| forceId | boolean | No | If true, this component will force the use of the specified id when rendering. |
| forceIdIndex | boolean | No | If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.) |
| id | String | Yes | An identifier for this particular component instance within
a component view.
The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted. |
| lang | String | Yes | HTML: The base language of this document. |
| method | String | Yes | This attribute can be used to set a method to the form which is different to the regular POST method used. |
| onclick | String | Yes | HTML: Script to be invoked when the element is clicked. |
| ondblclick | String | Yes | HTML: Script to be invoked when the element is double-clicked. |
| onkeydown | String | Yes | HTML: Script to be invoked when a key is pressed down over this element. |
| onkeypress | String | Yes | HTML: Script to be invoked when a key is pressed over this element. |
| onkeyup | String | Yes | HTML: Script to be invoked when a key is released over this element. |
| onmousedown | String | Yes | HTML: Script to be invoked when the pointing device is pressed over this element. |
| onmousemove | String | Yes | HTML: Script to be invoked when the pointing device is moved while it is in this element. |
| onmouseout | String | Yes | HTML: Script to be invoked when the pointing device is moves out of this element. |
| onmouseover | String | Yes | HTML: Script to be invoked when the pointing device is moved into this element. |
| onmouseup | String | Yes | HTML: Script to be invoked when the pointing device is released over this element. |
| onreset | String | Yes | HTML: Script to be invoked when this form is reset. |
| onsubmit | String | Yes | HTML: Script to be invoked when this form is submitted. |
| port | Integer | Yes | This attribute can be used to set the port for the action attribute |
| rendered | boolean | Yes | A boolean value that indicates whether this component should be rendered. Default value: true. |
| scheme | String | Yes | This attribute can be used to set the url scheme for the action attribute |
| serverName | String | Yes | This attribute can be used to set the url server name or ip address for the action attribute |
| style | String | Yes | HTML: CSS styling instructions. |
| styleClass | String | Yes | The CSS class for this element. Corresponds to the HTML 'class' attribute. |
| target | String | Yes | HTML: Names the frame that should display content generated by invoking this action. |
| title | String | Yes | HTML: An advisory title for this element. Often used by the user agent as a tooltip. |