HTML_BASIC RenderKit

The standard HTML RenderKit. Please see the spec for additional details for the standard render-kit.

General notes on decoding

Only Renderers for components which cause data to sent to the server on a page submit need to implement decode behavior. In practical terms, this means Renderers for components that implement from jakarta.faces.component.EditableValueHolder or jakarta.faces.component.ActionSource or Renderers for jakarta.faces.component.UIForm components. Renderers for components that do not send data to the server on page submit may choose to accept the no-op decode behavior of the jakarta.faces.render.Renderer abstract class. In the Renderer descriptions that follow, the omission of a Decode Behavior section indicates that this Renderer does no decoding.

If a Renderer chooses to implement decode behavior, it must consult the "disabled" and "readonly" attributes of the component to be rendered, if the value of either attribute is equal to, ignoring case, the string "true" (without the quotes) the decode method must take no action and return immediately.

If the component associated with the Renderer implements the jakarta.faces.component.behavior.ClientBehaviorHolder interface, process jakarta.faces.component.behavior.ClientBehaviors as follows:

• Determine if there are jakarta.faces.component.behavior.ClientBehaviors associated with this component by calling the implementation of jakarta.faces.component.behavior.ClientBehaviorHolder.getClientBehaviors.
• If there are client behaviors, determine the client behavior event name from the request parameter given by the value of the constant jakarta.faces.component.behavior.ClientBehaviorContext.BEHAVIOR_EVENT_PARAM_NAME.
• If that request parameter exists, get the List of jakarta.faces.component.behavior.ClientBehaviors for the behavior event name from the Map returned from jakarta.faces.component.behavior.ClientBehaviorHolder.getClientBehaviors.
• If there are client behaviors for the behavior event name, determine the behavior source name from the request parameter given by the value of the constant jakarta.faces.component.behavior.ClientBehaviorContext.BEHAVIOR_SOURCE_PARAM_NAME.
• If the request parameter exists, and its value is the same as this component's clientId, iterate over the List of jakarta.faces.component.behavior.ClientBehaviors and call the decode() method for each one.

Behavior decoding is applicable to components that are "readonly", but it is not applicable to components that are "disabled".

General notes on encoding

If the value of the component's "rendered" property is false, the component, and its children must not be rendered.

For all renderers that are responsible for rendering their own children, the renderer will decide if the end tag is required or not based on the presence or absence of children for the component.

General notes regarding the id attribute

All components, and therefore all tags for those components support the id attribute. This attribute is optional. If not present its value is autogenerated by the implementation and used for internal purposes only. If present, an id attribute must not start with the String listed as the value of the constant UIViewRoot.UNIQUE_ID_PREFIX, and it must be unique within the scope of the nearest component that is a NamingContainer.

All renderers must take the following action regarding the id attribute: If the value returned from component.getId() is non-null and does not start with UIViewRoot.UNIQUE_ID_PREFIX, call component.getClientId() and render the result as the value of the id attribute in the markup for the component. See the javadoc for component.getClientId() for details, particularly note that the Renderer has a chance to modify the client id before it is rendered. If the component doesn't generate any markup elements, include the id attribte on a "span" element that encloses the content for the component.

In addition to any action already specified in the renderers, all renderers for UIInput components must take the following action regarding the id attribute: Call component.getClientId() and render the result as the value of the name attribute. This may cause some renderers to have "id" and "name" attributes that have exactly the same value.

General notes regarding the rendering of JavaScript in the standard components.

The intent of the standard renderkit is to specify the minimal Renderers a JSF implementation must provide. As such, it is the baseline for building JSF applications that are maximally portable across JSF implementations and user agents. Therefore, the use of JavaScript must be minimized as not all browsers support JavaScript, nor do all users enable JavaScript support in their user agents.

Compliant implementations must only generate JavaScript in the jakarta.faces.Link and jakarta.faces.Button Renderers for the jakarta.faces.Command component. The generation of JavaScript in any other Renderer in the HTML_BASIC renderkit is not permitted. However, any JavaScript code provided by the user as the value of an ignored-by-renderer attribute, such as "onmouseover", is excluded from this restriction.

General notes regarding the rendering of component Client Behaviors.

Components that implement the jakarta.faces.component.behavior.ClientBehaviorHolder interface are eligable to have ClientBehavior instances attached to them. The standard renderers are responsible for inserting the scripts produced by client behaviors into the component's rendered content. Components may obtain script from multiple sources. Event handler scripts may be specified by page authors, scripts may be produced by client behaviors and renderers may produce ther own scripts. When multiple scripts are present, the scripts must be chained together in this order:

• User specified event handler scripts
• client behavior scripts
• renderer specific scripts
If any of the scripts in the chain returns false, subsequent script must not be executed. The specification provides a utility function faces.util.chain to handle this capability. If there are UIParameter children the parameter names and values must be passed into the client behavior getScript method via the ClientBehaviorContext.

Rendering Pass Through Attributes.

The set of attributes written for a component is determined by its Renderer and collectively are known as renderer specific attributes. In addition to renderer specific attributes, pass through attributes are also possible. Pass through attributes are declared as markup attributes on components in the VDL view and are stored in the Map returned by UIComponent.getPassThroughAttributes(). When rendering a UIComponent instance, Renderers call ResponseWriter.startElement(), passing in the UIComponent instance. The ResponseWriter must ensure that any pass through attributes are rendered on the outer-most markup element for the component. If there is a pass through attribute with the same name as a renderer specific attribute, the pass through attribute takes precedence. Pass through attributes are rendered as if they were passed to ResponseWriter.writeURIAttribute().

Renderer Summary
component-family	renderer-type	description
jakarta.faces.Command	jakarta.faces.Button	Renders an HTML "input" element.
	jakarta.faces.Link	Render an HTML "a" anchor element that acts like a form submit button when clicked.
	jakarta.faces.Script	Render a JavaScript function that invokes faces.
jakarta.faces.Data	jakarta.faces.Table	Renders an HTML "table" element compliant with the HTML 401 specification.
jakarta.faces.Form	jakarta.faces.Form	Renders an HTML "form" element.
jakarta.faces.Graphic	jakarta.faces.Image	Renders an HTML "img" element.
jakarta.faces.Input	jakarta.faces.File	Renders an HTML "input" element of "type" "file".
	jakarta.faces.Hidden	Renders an HTML "input" element of type "hidden".
	jakarta.faces.Secret	Renders an HTML "input" element of "type" "password".
	jakarta.faces.Text	Renders an HTML "input" element of "type" "text".
	jakarta.faces.Textarea	Renders an HTML "textarea" element.
jakarta.faces.Message	jakarta.faces.Message	Render a single message for a specific component.
jakarta.faces.Messages	jakarta.faces.Messages	The same as for the Message renderer, but output all the messages.
jakarta.faces.NamingContainer	jakarta.faces.Composite	Renders a composite component.
jakarta.faces.OutcomeTarget	jakarta.faces.Button	Render a button that does not cause an HTTP POST.
	jakarta.faces.Link	Render an HTML "a" anchor element.
jakarta.faces.Output	jakarta.faces.Body	Render the markup for a <body> element.
	jakarta.faces.CompositeFacet	Renders a facet at this particular point in the composite component VDL page.
	jakarta.faces.Doctype	Render the markup for a <!DOCTYPE> declaration.
	jakarta.faces.Format	Render parameterized text.
	jakarta.faces.Head	Render the markup for a <head> element.
	jakarta.faces.Label	Renders an HTML "label" element.
	jakarta.faces.Link	Render an HTML "a" anchor element.
	jakarta.faces.Text	If the "styleClass", "style", "dir" or "lang" attributes are present, render a "span" element.
	jakarta.faces.resource.Script	Render the markup for a <script> element that renders the script Resource specified by the optional name attribute and library attributes.
	jakarta.faces.resource.Stylesheet	Render the markup for a <link> element that renders the style Resource specified by the optional name and library attributes.
jakarta.faces.Panel	jakarta.faces.Grid	Renders an HTML "table" element, conforming to the rules in the HTML 401 specification.
	jakarta.faces.Group	Intended for use in situations when only one UIComponent child can be nested, such as in the case of facets.
	jakarta.faces.passthrough.Element	This renderer is intended to be used with an arbitrary markup element whose decoding needs can be entirely described by the section "General notes on decoding" in the RenderKit overview.
jakarta.faces.Script	jakarta.faces.Websocket	Render a JavaScript function that invokes faces.
jakarta.faces.SelectBoolean	jakarta.faces.Checkbox	Renders an HTML "input" element of type "checkbox".
jakarta.faces.SelectMany	jakarta.faces.Checkbox	Render an HTML checkbox list.
	jakarta.faces.Listbox	Render an HTML option list.
	jakarta.faces.Menu	Render an HTML option list.
jakarta.faces.SelectOne	jakarta.faces.Listbox	Render an HTML option list.
	jakarta.faces.Menu	Render an HTML option list.
	jakarta.faces.Radio	Render a set of html "input" elements of type "radio".