button (Jakarta Server Faces 3.0.0 VDL Documentation)

Description:

Render an HTML "input" element of type "button". The value of the component is rendered as the button text and the outcome of the component is used to determine the target URL which is activated by onclick. If "image" attribute is specified, render it as the value of the "src" attribute after passing it to the getResourceURL() method of the ViewHandler for this application, and passing the result through the encodeResourceURL() method of the ExternalContext. Any child UIParameter components are appended to the String to be used as the target URL as query parameters before rendering. The entire target URL string must be passed through a call to the encodeResourceURL() method of the ExternalContext. The name of the UIParameter goes on the left hand side, and the value of the UIParameter on the right hand side. The name and the value must be URLEncoded. Each UIParameter instance is separeted by an ampersand, as dictated in the URL spec. The final encoded result will be written out to the onclick attribute of the button as "window.location.href = ''". If the developer has specified a custom onlclick the window.location.href name/value pair will be appended at the end of the developer specified script. If the "fragment" attribute is specified, the value will be included at the end of the resulting URL preceded by a hash mark. If the "styleClass" attribute is specified, render its value as the value of the "class" attribute. If the "id" attribute is specified, follow the same steps as mentioned in the "General Notes on Encoding" regarding the "id" attribute for UIInput components. If the "disabled" attribute is specified, do not render the "onclick" element and assign the "disabled" attribute a value of true.

Component Information
Info	Value
Component Type	`jakarta.faces.HtmlOutcomeTargetButton`
Handler Class	None
Renderer Type	`jakarta.faces.Button`
Description	None

Attributes
Name	Required	Type	Description
`disabled`	`false`	`jakarta.el.ValueExpression` (must evaluate to `boolean`)	Flag indicating that this element must never receive focus or be included in a subsequent submit.
`role`	`false`	`jakarta.el.ValueExpression` (must evaluate to `javal.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.
`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.
`includeViewParams`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Whether to include page parameters in the target URI.
`outcome`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	The logical outcome used to resolve a navigation case.
`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.
`value`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Object`)	The current value of this component.
`accesskey`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Access key that, when pressed, transfers focus to this element.
`alt`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Alternate textual description of the element rendered by this component.
`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).
`fragment`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	The identifier of the page fragment which should be brought into focus when the target page is rendered. The value of this attribute is appended to the end of target URL following a hash (#) mark. This notation is part of the standard URL syntax.
`image`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Absolute or relative URL of the image to be displayed for this button. If specified, this "input" element will be of type "image". Otherwise, it will be of the type specified by the "type" property with a label specified by the "value" property. Note that if the value of this attribute starts with "/", the rendered value for this attribute will be prefixed with the context-root for this application.
`lang`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Code describing the language used in the generated markup for this component.
`onblur`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript code executed when this element loses focus.
`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.
`onfocus`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Javascript code executed when this element receives focus.
`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.
`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.
`tabindex`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.String`)	Position of this element in the tabbing order for the current document. This value must be an integer between 0 and 32767.
`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
`disableClientWindow`	`false`	`jakarta.el.ValueExpression` (must evaluate to `java.lang.Boolean`)	Disable appending the `ClientWindow` on the rendering of this element.

html_basic

Tag button