Render a JavaScript function that invokes faces.ajax.request() function.
Render an HTML script element. If the value of the "name" attribute does not contain a
period . indicating a namespaced function name, then render JavaScript var
keyword, followed by a space character. Render the value of the "name" attribute, followed by
JavaScript assignment operator. Render JavaScript function which invokes faces.ajax.request()
with data provided by execute, render, onbegin,
oncomplete, onsuccess and onerror arguments, if any.
If the component being rendered has any UIParameter children, each one of them must be
encoded into params object of the options object of the faces.ajax.request()
function.
If the rendered JavaScript function is invoked with an object argument, each property must be
encoded into params object of the options object of the faces.ajax.request()
function. This will override any property with the same key.
Obtain the Map from the "requestParameterMap" property of the ExternalContext.
If the value in the Map for the value of the "jakarta.faces.source" equals to the "clientId" property of the component,
create a jakarta.faces.event.ActionEvent around the component, and pass it to the queueEvent() method of the component,
which must be an instance of UICommand.
| Info | Value |
|---|---|
| Component Type | jakarta.faces.HtmlCommandScript |
| Handler Class | None |
| Renderer Type | jakarta.faces.Script |
| 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. |
name | true | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
|
Name of JavaScript function to be declared, e.g. name="functionName".
This can be a namespaced function name, e.g. name="ez.functionName".
|
autorun | false | jakarta.el.ValueExpression
(must evaluate to boolean)
|
Whether to execute declared JavaScript function during load event of the window.
Defaults to false.
|
action | false | jakarta.el.MethodExpression
(signature must match java.lang.Object action())
|
MethodExpression representing the application action to invoke when this component is activated by the user.
The expression must evaluate to a public method that takes no parameters,
and returns an Object.
The toString() of the returned Object is called to derive the logical outcome.
This outcome is passed to the NavigationHandler for this application.
|
actionListener | false | jakarta.el.MethodExpression
(signature must match void actionListener(jakarta.faces.event.ActionEvent)
)
|
MethodExpression representing an action listener method that will be notified when this component is activated by the user.
The expression must evaluate to a public method that takes an ActionEvent parameter,
with a return type of void,
or to a public method that takes no arguments with a return type of void.
In the latter case,
the method has no way of easily knowing where the event came from,
but this can be useful in cases where a notification is needed that "some action happened".
|
execute | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
|
This is a space separated list of client identifiers of components
that will participate in the "execute" portion of the Request Processing Lifecycle.
If a literal is specified the identifiers must be space delimited.
Any of the keywords "@this", "@form", "@all", "@none" may be specified in the identifier list.
If not specified, the default value of "@this" is assumed.
For example, @this clientIdOne clientIdTwo.
|
render | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
|
This is a space separated list of client identifiers of components
that will participate in the "render" portion of the Request Processing Lifecycle.
If a literal is specified the identifiers must be space delimited.
Any of the keywords "@this", "@form", "@all", "@none" may be specified in the identifier list.
If not specified, the default value of "@none" is assumed.
For example, @this clientIdOne clientIdTwo.
|
resetValues | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
|
Reset specific input values.
Interpret the value of the render attribute as a space separated list of client identifiers
suitable for passing directly to UIViewRoot.resetValues().
The implementation must cause an ActionListener to be attached to the ActionSource
component in which this tag is nested that calls UIViewRoot.resetValues() passing the value
of the render attribute as the argument.
|
onevent | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The name of the JavaScript function that will handle UI events. |
onerror | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The name of the JavaScript function that will handle errors. |
immediate | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Flag indicating that, if this component is activated by the user, notifications should be delivered to interested listeners and actions immediately (that is, during Apply Request Values phase) rather than waiting until Invoke Application phase. |
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. Defaults to true.
|
binding | false | jakarta.el.ValueExpression
(must evaluate to jakarta.faces.component.UIComponent)
| The ValueExpression linking this component to a property in a backing bean. |