All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.sun.faces.metadata.taglib.faces.html.taglib.xml Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jakarta.faces Show documentation

EE4J Compatible Implementation for Jakarta Faces API

There is a newer version: 4.1.1





    Jakarta Faces HTML Tag Library

        This tag library contains Jakarta Faces component tags for all
        UIComponent + HTML RenderKit Renderer combinations as defined in
        section 9.5 "Standard HTML RenderKit Tag Library" of the Jakarta Faces Specification Document.
    ]]>
    jakarta.faces.html
    
        
            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.

]]>

button

jakarta.faces.HtmlOutcomeTargetButton
jakarta.faces.Button



Flag indicating that this element must never
receive focus or be included in a subsequent
submit.]]>


disabled


false


boolean




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.]]>

role
false
java.lang.String






id


false


java.lang.String







includeViewParams


false


java.lang.Boolean







outcome


false


java.lang.String







rendered


false


boolean







value


false


java.lang.Object







accesskey


false


java.lang.String




This attribute is ignored when the image attribute is not specified.]]>


alt


false


java.lang.String







dir


false


java.lang.String







fragment


false


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.
]]>


image


false


java.lang.String







lang


false


java.lang.String







onblur


false


java.lang.String







onclick


false


java.lang.String







ondblclick


false


java.lang.String







onfocus


false


java.lang.String







onkeydown


false


java.lang.String







onkeypress


false


java.lang.String







onkeyup


false


java.lang.String







onmousedown


false


java.lang.String







onmousemove


false


java.lang.String







onmouseout


false


java.lang.String







onmouseover


false


java.lang.String







onmouseup


false


java.lang.String







style


false


java.lang.String







styleClass


false


java.lang.String







tabindex


false


java.lang.String







title


false


java.lang.String




The ValueExpression linking this component to a property in a
backing bean


binding


false


jakarta.faces.component.UIComponent




Disable appending the ClientWindow on the rendering of this element.]]>

disableClientWindow
false
java.lang.Boolean




Render an HTML "a" anchor element. The value of the
component is rendered as the anchor text and the outcome of the component is used
to determine the target URL rendered in the "href" attribute. Any
child UIParameter components are appended to the String to be
output as the value of the "href" attribute as query parameters
before rendering. The entire "href" 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 separated by an ampersand, as dictated in
the URL spec. 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 HTML "a"
anchor element or the "href" element. Instead, render a "span" element.
If the "styleClass" attribute is specified, render its value as the value
of the "class" attribute on the "span". Render any pass-through attributes
on the "span".]]>

link

jakarta.faces.HtmlOutcomeTargetLink
jakarta.faces.Link



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.]]>

role
false
java.lang.String



Disable appending the ClientWindow on the rendering of this element.]]>

disableClientWindow
false
java.lang.Boolean






id


false


java.lang.String







includeViewParams


false


java.lang.Boolean







outcome


false


java.lang.String







rendered


false


boolean







value


false


java.lang.Object







accesskey


false


java.lang.String







charset


false


java.lang.String







coords


false


java.lang.String







dir


false


java.lang.String







disabled


false


boolean







fragment


false


java.lang.String







hreflang


false


java.lang.String







lang


false


java.lang.String







onblur


false


java.lang.String







onclick


false


java.lang.String







ondblclick


false


java.lang.String







onfocus


false


java.lang.String







onkeydown


false


java.lang.String







onkeypress


false


java.lang.String







onkeyup


false


java.lang.String







onmousedown


false


java.lang.String







onmousemove


false


java.lang.String







onmouseout


false


java.lang.String







onmouseover


false


java.lang.String







onmouseup


false


java.lang.String







rel


false


java.lang.String







rev


false


java.lang.String







shape


false


java.lang.String







style


false


java.lang.String







styleClass


false


java.lang.String







tabindex


false


java.lang.String







target


false


java.lang.String







title


false


java.lang.String







type


false


java.lang.String




The ValueExpression linking this component to a property in a
backing bean


binding


false


jakarta.faces.component.UIComponent





Render the markup for a <head> element.
Decode Behavior

No action is required during decode for this renderer.

Encode Behavior


Render the starting <head> element tag. Any attributes declared on the element must be passed through
unmodified to the rendered output.
Just before rendering the
closing </head> element tag, render any resources that have been targeted
for this "head" element:

Obtain a UIViewRoot instance.
Obtain a List of component resources targeted for
this "head" element with a call to UIViewRoot.getComponentResources()
with the String "head" as the argument.
Iterate over the returned List of UIComponent instances
and call encodeAll on each UIComponent instance.
Any attributes declared on the element must be passed through
unmodified to the rendered output.

Render the ending </head> element tag.
]]>

head

jakarta.faces.Output
jakarta.faces.Head






dir


false


java.lang.String







lang


false


java.lang.String




The ValueExpression linking this component to a property in a
backing bean


binding


false


jakarta.faces.component.UIComponent





Render the markup for a <body> element.
Decode Behavior

No action is required during decode for this renderer.

Encode Behavior


Render the starting <body> element tag. Just before rendering the
closing </body> element tag, render any resources that have been targeted
for this "body" element:

Obtain a UIViewRoot instance.
Obtain a List of component resources targeted for
this "body" element with a call to
UIViewRoot.getComponentResources() with the
String "body" as the argument. Render the ending
</body> element tag.
Iterate over the returned List of UIComponent instances
and call encodeAll on each UIComponent instance.

Any attributes declared on the element must be passed through
unmodified to the rendered output.
]]>

body

jakarta.faces.Output
jakarta.faces.Body






dir


false


java.lang.String







lang


false


java.lang.String







onclick


false


java.lang.String







ondblclick


false


java.lang.String







onkeydown


false


java.lang.String







onkeypress


false


java.lang.String







onkeyup


false


java.lang.String







onload


false


java.lang.String







onmousedown


false


java.lang.String







onmousemove


false


java.lang.String







onmouseout


false


java.lang.String







onmouseover


false


java.lang.String







onmouseup


false


java.lang.String







onunload


false


java.lang.String







style


false


java.lang.String







styleClass


false


java.lang.String







title


false


java.lang.String




The ValueExpression linking this component to a property in a
backing bean


binding


false


jakarta.faces.component.UIComponent




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.]]>

role
false
java.lang.String




<p><span
class="changed_modified_2_0">Renders an HTML "input"
element.</p>
<p>Decode Behavior</p>
<ul>
<p>Obtain the <code>Map</code> from the
"requestParameterMap"
property of the <code>ExternalContext</code>. If the
value in the
<code>Map</code> for the value of the "clientId"
property of the
component is <code>null</code>, create a String by
concatenating
the value of the "clientId" property of the component with the
String ".x" (without the quotes). Create another String in the
same manner, but concatenate ".y" (without the quotes). If
<code>null</code> is the value in the <code>Map</code>
for both
Strings, return from <code>decode()</code>. If the value
in the
<code>Map</code> for the value of the "clientId"
property of the
component is not <code>null</code>, get the value of the
"type"
attribute, and convert it to lower case. If the result is equal
to the String "reset" (without the quotes), return from
<code>decode()</code>. Otherwise, create a
<code>jakarta.faces.event.ActionEvent</code> around the
component,
and pass it to the <code>queueEvent()</code> method of
the
component, which must be an instance of
<code>UICommand</code>.</p>
</ul>
<p>Encode Behavior</p>
<ul>
<p>Render the clientId of the component as the value of the
"name"
attribute. Render the current value of the component as the value
of the "value" attribute. If "image" attribute is specified render
it as the value of the "src" attribute after passing it to the
<code>getResourceURL()</code> method of the
<code>ViewHandler</code> for this application, and
passing the
result through the <code>encodeResourceURL()</code>
method of the
<code>ExternalContext</code>. <span
class="changed_added_2_0">Note that calling
<code>getResourceURL()</code> will prefix the
context-root of the
current application if the value of the "src" attribute starts
with "/".</span> When handling the "image" attribute, the
value must not
be escaped. For example, <code>&</code> must not be
turned into
<code>&amp;amp;</code>. If the "styleClass"
attribute is
specified, render its value as the value of the "class" attribute.
If the user has specified an "onclick" attribute, append that
JavaScript to any existing JavaScript before rendering.</p>
<p class="changed_added_2_0">If the component being rendered
by
this renderer has any <code>UIParameter</code> children,
each one
of them must be rendered using the renderer for component-family:
"jakarta.faces.Input" and renderer-type: "jakarta.faces.Hidden". For
discussion, this is called the hiddenRenderer. A component with
component-type "jakarta.faces.Input" must be created for local use
in rendering each <code>UIParameter</code> child. The
"id"
property of the temporary component must be set to the "name" of
the <code>UIParameter</code>. The "value" property of
the
temporary component must be set to the "value" of the
<code>UIParameter</code>. For each <code>UIParameter</code>
child, the hiddenRenderer must have its
<code>encodeBegin()</code>, <code>encodeChildren()</code>,
and
<code>encodeEnd()</code> methods called, in order,
passing the
temporary component as the second argument.</p>
</ul>

commandButton

jakarta.faces.HtmlCommandButton
jakarta.faces.Button



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.]]>

role
false
java.lang.String



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 which is called to derive
the logical outcome) which is passed to the NavigationHandler
for this application.

action
false
java.lang.Object action()



<p>
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, <span
class="changed_added_2_0">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".</span>
</p>

actionListener
false
void actionListener(jakarta.faces.event.ActionEvent)




The component identifier for this component. This value must be
unique within the closest parent component that is a naming
container.

id
false
java.lang.String



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.

immediate
false
java.lang.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.

rendered
false
java.lang.Boolean



The current value of this component.

value
false
java.lang.Object



Access key that, when pressed, transfers focus
to this element.

accesskey
false
java.lang.String


This attribute is ignored when the image attribute is not specified.
]]>
alt
false
java.lang.String



Direction indication for text that does not inherit
directionality.
Valid values are "LTR" (left-to-right) and "RTL"
(right-to-left).

dir
false
java.lang.String



Flag indicating that this element must never receive focus or
be included in a subsequent submit. A value of false causes
no attribute to be rendered, while a value of true causes the
attribute to be rendered as disabled="disabled".

disabled
false
java.lang.Boolean



<p>
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. <span
class="changed_added_2_0">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.</span>
</p>

image
false
java.lang.String



A localized user presentable name for this component.

label
false
java.lang.String



Code describing the language used in the generated markup
for this component.

lang
false
java.lang.String



Javascript code executed when this element loses focus.

onblur
false
java.lang.String



Javascript code executed when this element loses focus
and its value has been modified since gaining focus.

onchange
false
java.lang.String



Javascript code executed when a pointer button is
clicked over this element.

onclick
false
java.lang.String



Javascript code executed when a pointer button is
double clicked over this element.

ondblclick
false
java.lang.String



Javascript code executed when this element receives focus.

onfocus
false
java.lang.String



Javascript code executed when a key is
pressed down over this element.

onkeydown
false
java.lang.String



Javascript code executed when a key is
pressed and released over this element.

onkeypress
false
java.lang.String



Javascript code executed when a key is
released over this element.

onkeyup
false
java.lang.String



Javascript code executed when a pointer button is
pressed down over this element.

onmousedown
false
java.lang.String



Javascript code executed when a pointer button is
moved within this element.

onmousemove
false
java.lang.String



Javascript code executed when a pointer button is
moved away from this element.

onmouseout
false
java.lang.String



Javascript code executed when a pointer button is
moved onto this element.

onmouseover
false
java.lang.String



Javascript code executed when a pointer button is
released over this element.

onmouseup
false
java.lang.String



Javascript code executed when text within this
element is selected by the user.

onselect
false
java.lang.String



Flag indicating that this component will prohibit changes by
the user. The element may receive focus unless it has also
been disabled. A value of false causes
no attribute to be rendered, while a value of true causes the
attribute to be rendered as readonly="readonly".

readonly
false
java.lang.Boolean



CSS style(s) to be applied when this component is rendered.

style
false
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.

styleClass
false
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.

tabindex
false
java.lang.String



Advisory title information about markup elements generated
for this component.

title
false
java.lang.String



Type of button to create. Valid values are "submit", "button",
and "reset". If not specified, or not a valid value, the default
value is "submit".

type
false
java.lang.String



The ValueExpression linking this component to a property in a
backing bean

binding
false
jakarta.faces.component.UIComponent




<p><span
class="changed_modified_2_0">Render</span> an HTML "a"
anchor
element that acts like a form submit button when
clicked.</p>
<p>General Behaviour</p>
<p>Both the encode and decode behavior require the ability to
get
the id/name for a hidden field, <span
class="changed_added_2_0">which may be rendered in markup or
which
may be programmatically added via client DOM manipulation</span>,
whose value is set by the JavaScript form submit. This name must
be constructed as follows:</p>
<ul>
<li><p>Get the clientId for the form of which this
component is a
child.</p></li>
<li><p>Append
<code>NamingContainer.SEPARATOR_CHAR</code>.</p></li>
<li><p>Append a constant string that is the same for all
command
link components in the tree.</p></li>
</ul>
<p>In the following text, this String is called
hiddenFieldName.</p>
<p>Decode Behavior</p>
<ul>
<p>Obtain the "clientId" property of the component. Obtain the
<code>Map</code> from the "requestParameterMap" property
of the
<code>ExternalContext</code>. Derive hiddenFieldName as
above.
Get the entry in the <code>Map</code> under the key that
is the
hiddenFieldName. If the there is no entry, or the entry is the
empty String, or the entry is not equal to the value of the
"clientId" property, return immediately. If there is an entry,
and its value is equal to the value of the "clientId" property,
create a new <code>jakarta.faces.event.ActionEvent</code>
instance
around the component and call <code>queueActionEvent()</code>
on
the component, passing the event.</p>
</ul>
<p>Encode Behavior</p>
<ul>
<p>If the value of the <code>disabled</code>
attribute is
<code>true</code>, render a span element. Render all the
passthru
attributes and the <code>target</code> attribute as
pass-through
attributes on the span, even though the <code>target</code>
attribute will have no effect on a span. Render the current value
of the component as the content of the span. Return.</p>
<p>If the <code>disabled</code> attribute is not
present, or its
value is <code>false</code>, render an HTML <code>a</code>
element. Render "#" as the value of the "href" attribute. Render
the current value of the component as the link text if it is
specified. Render JavaScript that is functionally equivalent to
the following as the value of the "onclick" attribute:</p>
<p><code>document.forms['CLIENT_ID']['hiddenFieldName'].value='CLIENT_ID';
document.forms['CLIENT_ID']['PARAM1_NAME'].value='PARAM1_VALUE';
document.forms['CLIENT_ID']['PARAM2_NAME'].value='PARAM2_VALUE';
return false;</code></p>
<p>document.forms['CLIENT_ID'].submit()" where hiddenFieldName
is
as described above, CLIENT_ID is the clientId of the UICommand
component, PARAM*_NAME and PARAM*_VALUE are the names and values,
respectively, of any nested UIParameter children. The name and
the value must be URLEncoded. If an "onclick" attribute was
specified by the user, render this JavaScript in a function,
and render the user's JavaScript in a function. Render both
functions
in a choice function as follows:</p>
<p><code>var a=function(){#USER_FUNCTION#};
var b=function(){#JSF_FUNCTION#};
return (a()==false) ? false : b();</code></p>
<p>where #USER_FUNCTION# is the user's JavaScript and
#JSF_FUNCTION# is the JavaScript rendered by Faces. The choice
function should operate such that if the user's JavaScript returns
true, then the rendered JavaScript will also execute.</p>
<p>If the "styleClass" attribute is specified, render its
value as
the value of the "class" attribute. Render any non-UIParameter
output children as normal inside of the "a" element. These will
appear as the link text. Allow the form renderer to output a
single "input" element (for the entire page, regardless of how
many command link components are in the page) of "type" "hidden"
whose "name" is the value of hiddenFieldName, and which must not
have a "value" attribute. Multiple occurrences of command link
components in the tree should not cause multiple hiddenFieldName
hidden fields. Allow the form renderer to output an "input"
element of "type" "hidden" for each of the nested UIParameter
children, taking the name property (but not the value) from each
one in turn. If the "disabled" attribute is specified, do not
render the HTML "a" anchor element or its "href" attribute.
Instead, render a "span" element. If the "styleClass" attribute
is specified, render its value as the value of the "class"
attribute on the "span". Render any pass-through attributes on
the "span". The content of the span element comes from the value
of the component or its children as specified above.</p>
<p>If the user specified a <code>target</code>
attribute, its
value must be set using javascript since the <code>onclick</code>
handler will prevent the target attribute from being generated.
This must be accomplished using JavaScript that is equivalent to
the following.</p>
<p><code>document.forms['CLIENT_ID'].target='TARGET';</code></p>
<p>Where TARGET is the value of the target attribute on the
JSP
tag.</p>
</ul>

commandLink

jakarta.faces.HtmlCommandLink
jakarta.faces.Link



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.]]>

role
false
java.lang.String



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 which is called to derive
the logical outcome) which is passed to the NavigationHandler
for this application.

action
false
java.lang.Object action()



<p>
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, <span
class="changed_added_2_0">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".</span>
</p>

actionListener
false
void actionListener(jakarta.faces.event.ActionEvent)




The component identifier for this component. This value must be
unique within the closest parent component that is a naming
container.

id
false
java.lang.String



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.

immediate
false
java.lang.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.

rendered
false
java.lang.Boolean



The current value of this component.

value
false
java.lang.Object



Access key that, when pressed, transfers focus
to this element.

accesskey
false
java.lang.String



The character encoding of the resource designated
by this hyperlink.

charset
false
java.lang.String



The position and shape of the hot spot on the screen
(for use in client-side image maps).

coords
false
java.lang.String



Direction indication for text that does not inherit
directionality.
Valid values are "LTR" (left-to-right) and "RTL"
(right-to-left).

dir
false
java.lang.String



Flag indicating that this element must never
receive focus or be included in a subsequent
submit.

disabled
false
java.lang.Boolean



The language code of the resource designated
by this hyperlink.

hreflang
false
java.lang.String



Code describing the language used in the generated markup
for this component.

lang
false
java.lang.String



Javascript code executed when this element loses focus.

onblur
false
java.lang.String



Javascript code executed when a pointer button is
clicked over this element.

onclick
false
java.lang.String



Javascript code executed when a pointer button is
double clicked over this element.

ondblclick
false
java.lang.String



Javascript code executed when this element receives focus.

onfocus
false
java.lang.String



Javascript code executed when a key is
pressed down over this element.

onkeydown
false
java.lang.String



Javascript code executed when a key is
pressed and released over this element.

onkeypress
false
java.lang.String



Javascript code executed when a key is
released over this element.

onkeyup
false
java.lang.String



Javascript code executed when a pointer button is
pressed down over this element.

onmousedown
false
java.lang.String



Javascript code executed when a pointer button is
moved within this element.

onmousemove
false
java.lang.String



Javascript code executed when a pointer button is
moved away from this element.

onmouseout
false
java.lang.String



Javascript code executed when a pointer button is
moved onto this element.

onmouseover
false
java.lang.String



Javascript code executed when a pointer button is
released over this element.

onmouseup
false
java.lang.String



The relationship from the current document
to the anchor specified by this hyperlink.
The value of this attribute is a space-separated
list of link types.

rel
false
java.lang.String



A reverse link from the anchor specified
by this hyperlink to the current document.
The value of this attribute is a space-separated
list of link types.

rev
false
java.lang.String



The shape of the hot spot on the screen
(for use in client-side image maps). Valid
values are: default (entire region); rect
(rectangular region); circle (circular region);
and poly (polygonal region).

shape
false
java.lang.String



CSS style(s) to be applied when this component is rendered.

style
false
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.

styleClass
false
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.

tabindex
false
java.lang.String



Name of a frame where the resource
retrieved via this hyperlink is to
be displayed.

target
false
java.lang.String



Advisory title information about markup elements generated
for this component.

title
false
java.lang.String



The content type of the resource designated
by this hyperlink.

type
false
java.lang.String



The ValueExpression linking this component to a property in a
backing bean

binding
false
jakarta.faces.component.UIComponent





Render a JavaScript function that invokes faces.ajax.request() function.

Encode Behavior

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.

Decode Behavior

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.

]]>

commandScript

jakarta.faces.HtmlCommandScript
jakarta.faces.Script



The component identifier for this component.
This value must be unique within the closest parent component that is a naming container.

id
false
java.lang.String


name="functionName"

name="ez.functionName"

name

true

java.lang.String

load event of the window. Defaults to false. ]]> autorun false boolean

Object. The toString() of the returned Object is called to derive the logical outcome. This outcome is passed to the NavigationHandler for this application. ]]> action false

java.lang.Object action()

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". ]]> actionListener false

void actionListener(jakarta.faces.event.ActionEvent)

@this clientIdOne clientIdTwo. ]]> execute false java.lang.String

@this clientIdOne clientIdTwo. ]]> render false java.lang.String

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. ]]> resetValues false java.lang.Boolean

The name of the JavaScript function that will handle UI events. onevent false java.lang.String

The name of the JavaScript function that will handle errors. onerror false java.lang.String

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. immediate false java.lang.Boolean

true. ]]> rendered false java.lang.Boolean

The ValueExpression linking this component to a property in a backing bean. binding false jakarta.faces.component.UIComponent

Renders an HTML "table" element compliant with the HTML 401 specification. Render the "caption" facet, if present, inside a "caption" element immediately below the "table" element. If the "captionClass" attribute is specified, render its value as the value of the "class" attribute on the "caption" element. If the "captionStyle" attribute is specified, render its value as the value of the "style" attribute on the "caption" element. Please consult the javadoc for <code>UIData</code> to supplement this specification. If the "styleClass" attribute is specified, render its value as the value of the "class" attribute on the "table" element. Any pass-through attributes are also rendered on the "table" element. Column Groups <ul> If the <code>UIData</code> component has a "colgroups" facet, render its contents. Consistent with the rules of facets in general, this facet must have only one child. In general, this will be a <code>panel group</code> component that will contain <code>colgroup</code> and <code>col</code> elements per the HTML Table specification. Use of column grouping can improve accessibility. This facet must be rendered before the table header and footer. </ul> Rendering the header <ul> If the <code>UIData</code> component has a "header" facet, or any of the child <code>UIColumn</code> components has a "header" facet, render a "thead" element. If the <code>UIData</code> component has a "header" facet, encode its contents inside of "tr" and "th" elements, respectively. Output the value of the "headerClass" attribute of the <code>UIData</code> component, if present, as the value of the "class" attribute on the "th". Output the number of child <code>UIColumn</code> components of the <code>UIData</code> component as the value of the "colspan" attribute on the "th". Output "colgroup" as the value of the "scope" attribute on the "th" element. If any of the child <code>UIColumn</code> components has a "header" facet render a "tr" element. For each <code>UIColumn</code> that actually has a "header" facet, render it inside of a "th" element. Columns that don't have a "header" facet cause an empty "th" element to be rendered. Output the value of the "headerClass" attribute of the <code>UIColumn</code> component, if present, as the value of the "class" attribute on the "th". If the "headerClass" attribute of the <code>UIColumn</code> component is not present, output the value of the "headerClass" attribute of the <code>UIData</code> component, if present, as the value of the "class" attribute on the "th". Output "col" as the value of the "scope" attribute on the "th" element. Close out the "thead" element. </ul> Rendering the footer <ul> Follow the same process as for the header, except replace "header" with "footer", "th" with "td", "thead" with "tfoot", and "headerClass" with "footerClass". Do not render any "scope" attribute for the footer. </ul> Rendering the table body <ul> Look at the value of the "bodyrows" attribute. If present, this must be a comma separated list of integers. Each entry in this list is the row index of the row before which a "tbody" element should be rendered. If there was no "bodyrows" attribute, or it was empty, render a "tbody" element. Keep track of the result of the "rows" property on the <code>UIData</code> component. Keep track of the number of rows we have rendered so far. Iterate through the rows. Set the "rowIndex" property of the <code>UIData</code> component to be correct as we iterate through the rows. Stop rendering children and close out the "tbody" element if the "rowAvailable" property of the <code>UIData</code> returned false. If the current row index is contained in the "bodyrows" attribute, check if a "tbody" start element was rendered that needs to be closed, and if so, close the "tbody" element. Then render a "tbody" element start. Otherwise, do not render a "tbody" element. Output a "tr" element. Output the value of the "rowClasses" per the attribute description below. For each <code>UIColumn</code> child, if the column component has a "rowHeader" attribute with a value of "true", output a "th" element with a "scope" attribute with the value of "row". Otherwise, if the column component has no "rowHeader" attribute, or its value is false, output a "td" element. In either case attach the value of the "columnClasses" attribute of the <code>UIData</code> component per the attribute description below. Recursively encode each child of each <code>UIColumn</code> child. Close out the "td" or "th" element. When done with the row, close out the "tr" element. When done with all the rows, close out the "tbody" element. </ul> When done rendering all the rows, set the "rowIndex" property of the <code>UIData</code> to -1, and close out the "table" element.

dataTable

jakarta.faces.HtmlDataTable

jakarta.faces.Table

Zero-relative row number of the first row to be displayed. If this property is set to zero, rendering will begin with the first row of the underlying data. first false int The component identifier for this component. This value must be unique within the closest parent component that is a naming container. id false java.lang.String 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. rendered false java.lang.Boolean The number of rows to display, starting with the one identified by the "first" property. If this value is set to zero, all available rows in the underlying data model will be displayed. rows false int The current value of this component. value false java.lang.Object Name of a request-scope attribute under which the model data for the row selected by the current value of the "rowIndex" property (i.e. also the current value of the "rowData" property) will be exposed. var false java.lang.String Name or code of the background color for this table. bgcolor false java.lang.String Comma separated list of row indices for which a new "tbody" element should be started (and any previously opened one should be ended). bodyrows false java.lang.String Width (in pixels) of the border to be drawn around this table. border false int Space-separated list of CSS style class(es) that will be applied to any caption generated for this table. captionClass false java.lang.String CSS style(s) to be applied when this caption is rendered. captionStyle false java.lang.String Definition of how much space the user agent should leave between the border of each cell and its contents. cellpadding false java.lang.String Definition of how much space the user agent should leave between the left side of the table and the leftmost column, the top of the table and the top of the top side of the topmost row, and so on for the right and bottom of the table. It also specifies the amount of space to leave between cells. cellspacing false java.lang.String Comma-delimited list of CSS style classes that will be applied to the columns of this table. A space separated list of classes may also be specified for any individual column. If the number of elements in this list is less than the number of actual column children of the UIData, no "class" attribute is output for each column greater than the number of elements in the list. If the number of elements in the list is greater than the number of actual column children of the UIData, the elements at the posisiton in the list after the last column are ignored. columnClasses false java.lang.String Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). dir false java.lang.String Space-separated list of CSS style class(es) that will be applied to any footer generated for this table. footerClass false java.lang.String Code specifying which sides of the frame surrounding this table will be visible. Valid values are: none (no sides, default value); above (top side only); below (bottom side only); hsides (top and bottom sides only); vsides (right and left sides only); lhs (left hand side only); rhs (right hand side only); box (all four sides); and border (all four sides). frame false java.lang.String Space-separated list of CSS style class(es) that will be applied to any header generated for this table. headerClass false java.lang.String Code describing the language used in the generated markup for this component. lang false java.lang.String Javascript code executed when a pointer button is clicked over this element. onclick false java.lang.String Javascript code executed when a pointer button is double clicked over this element. ondblclick false java.lang.String Javascript code executed when a key is pressed down over this element. onkeydown false java.lang.String Javascript code executed when a key is pressed and released over this element. onkeypress false java.lang.String Javascript code executed when a key is released over this element. onkeyup false java.lang.String Javascript code executed when a pointer button is pressed down over this element. onmousedown false java.lang.String Javascript code executed when a pointer button is moved within this element. onmousemove false java.lang.String Javascript code executed when a pointer button is moved away from this element. onmouseout false java.lang.String Javascript code executed when a pointer button is moved onto this element. onmouseover false java.lang.String Javascript code executed when a pointer button is released over this element. onmouseup false java.lang.String Comma-delimited list of CSS style classes that will be applied to the rows of this table. A space separated list of classes may also be specified for any individual row. Thes styles are applied, in turn, to each row in the table. For example, if the list has two elements, the first style class in the list is applied to the first row, the second to the second row, the first to the third row, the second to the fourth row, etc. In other words, we keep iterating through the list until we reach the end, and then we start at the beginning again. rowClasses false java.lang.String Code specifying which rules will appear between cells within this table. Valid values are: none (no rules, default value); groups (between row groups); rows (between rows only); cols (between columns only); and all (between all rows and columns). rules false java.lang.String CSS style(s) to be applied when this component is rendered. style false 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. styleClass false java.lang.String Summary of this table's purpose and structure, for user agents rendering to non-visual media such as speech and Braille. summary false java.lang.String Advisory title information about markup elements generated for this component. title false java.lang.String Width of the entire table, for visual user agents. width false java.lang.String The ValueExpression linking this component to a property in a backing bean binding false jakarta.faces.component.UIComponent 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.

]]> role false java.lang.String

Renders an HTML "form" element. Decode Behavior <ul> Obtain the <code>Map</code> from the "requestParameterMap" property of the <code>ExternalContext</code>. If the map contains an entry for the "clientId" of this <code>UIForm</code> component, call <code>setSubmitted(true)</code> on the form, otherwise call <code>setSubmitted(false)</code> on the form. </ul> Encode Behavior <ul> The value of the "method" attribute must be "post". The value of the "action" attribute must be the result of passing the view identifier of the current view to the <code>getActionURL()</code> method of the <code>ViewHandler</code> for this application, then passing that String to the <code>encodeActionURL()</code> method on the <code>ExternalContext</code>. The value of the acceptcharset attribute must be rendered as the value of "accept-charset". If the "styleClass" attribute is specified, render its value as the value of the "class" attribute. Render a "name" attribute with a value the same as the "id" attribute as described in "<a href="../../../renderkitdocs/HTML_BASIC/renderkit-summary.html#general_encoding">General Notes on Encoding</a>" regarding the "id" attribute for UIInput components. Obtain the <code>UIViewRoot view identifier</code> and use it to obtain an <code>action URL</code> by calling <code>ViewHandler.getActionURL</code>. Use the <code>action URL</code> to obtain an <code>encoded action URL</code> by calling <code>ExternalContext.encodeActionURL</code>. Obtain an <code>encoded partial action URL</code> by calling <code>ExternalContext.encodePartialActionURL</code> using <code>action URL</code> as the argument. Compare the result from <code>ExternalContext.encodePartialActionURL</code> with the value from <code>ExternalContext.encodeActionURL()</code>. If they are different, render a hidden field with the name <code>jakarta.faces.encodedURL</code> and the value of this hidden field as the value from <code>ExternalContext.encodePartialActionURL</code>. Call <code>ViewHandler.writeState()</code> before the the close of the "form" element. Render all the necessary hidden fields for all commandLink instances in the page just before the close of the "form" element. <div class="changed_modified_2_0"> Just before rendering the closing <code></form></code> element tag, render any resources that have been targeted for this form: <ul> <li>Obtain a <code>UIViewRoot</code> instance.</li> <li>Obtain a <code>List</code> of component resources targeted for this form with a call to <code>UIViewRoot.getComponentResources()</code> with the <code>String "form"</code> as the argument.</li> <li>Iterate over the returned <code>List</code> of <code>UIComponent</code> instances and call <code>encodeAll</code> on each <code>UIComponent</code> instance. </ul> </div> </ul> </div>

form

jakarta.faces.HtmlForm

jakarta.faces.Form

The component identifier for this component. This value must be unique within the closest parent component that is a naming container. id false java.lang.String Flag indicating whether or not this form should prepend its id to its descendent's id during the clientId generation process. If this flag is not set, the default value is true. prependId false java.lang.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. rendered false java.lang.Boolean List of content types that a server processing this form will handle correctly accept false java.lang.String List of character encodings for input data that are accepted by the server processing this form. acceptcharset false java.lang.String Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). dir false 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". enctype false java.lang.String Code describing the language used in the generated markup for this component. lang false java.lang.String Javascript code executed when a pointer button is clicked over this element. onclick false java.lang.String Javascript code executed when a pointer button is double clicked over this element. ondblclick false java.lang.String Javascript code executed when a key is pressed down over this element. onkeydown false java.lang.String Javascript code executed when a key is pressed and released over this element. onkeypress false java.lang.String Javascript code executed when a key is released over this element. onkeyup false java.lang.String Javascript code executed when a pointer button is pressed down over this element. onmousedown false java.lang.String Javascript code executed when a pointer button is moved within this element. onmousemove false java.lang.String Javascript code executed when a pointer button is moved away from this element. onmouseout false java.lang.String Javascript code executed when a pointer button is moved onto this element. onmouseover false java.lang.String Javascript code executed when a pointer button is released over this element. onmouseup false java.lang.String Javascript code executed when this form is reset. onreset false java.lang.String Javascript code executed when this form is submitted. onsubmit false java.lang.String CSS style(s) to be applied when this component is rendered. style false 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. styleClass false java.lang.String Name of a frame where the response retrieved after this form submit is to be displayed. target false java.lang.String Advisory title information about markup elements generated for this component. title false java.lang.String The ValueExpression linking this component to a property in a backing bean binding false jakarta.faces.component.UIComponent 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.

]]> role false java.lang.String

Renders an HTML "img" element. Render the clientId as the value of the "id" attribute. <div class="changed_modified_2_0"> Handling the Value <ul> If the "name" attribute is present, execute algorithm <a href="../../../renderkitdocs/HTML_BASIC/jakarta.faces.Outputjakarta.faces.resource.Script.html#ResourceCommonGetResource">Common Algorithm for Obtaining A Resource to Render</a> to obtain a <code>Resource</code> instance. Call <code>Resource.getRequestPath()</code> and output the result as the value of the "src" attribute on the rendered markup. Otherwise, if the "url" attribute is present, treat its value as if it was the value of the "value" attribute. Otherwise, if the "value" attribute is present, render the value of the component as the value of the "src" attribute, after passing it to the <code>getResourceURL()</code> method of the <code>ViewHandler</code> for this application, and passing the result through the <code>encodeResourceURL()</code> method of the <code>ExternalContext</code>. When handling the "src" attribute, the value must not be escaped. For example, <code>&</code> must not be turned into <code>&amp;</code>. If the "styleClass" attribute is specified, render its value as the value of the "class" attribute. </ul> </div>

graphicImage

jakarta.faces.HtmlGraphicImage

jakarta.faces.Image

It is the page author's responsibility to ensure that the user agent is capable of correctly interpreting the value of this attribute.

]]> role false java.lang.String

Renders an HTML "input" element of type "hidden". Decode Behavior <ul> See the decode description for the <a href="jakarta.faces.Inputjakarta.faces.Text.html#encode">Input Text</a> renderer. </ul> Encode Behavior <ul> Render the clientId of the component as the value of the "name" attribute. Render the current value of the component as the value of the "value" attribute. </ul>

inputHidden

jakarta.faces.HtmlInputHidden

jakarta.faces.Hidden

Converter instance registered with this component. converter false jakarta.faces.convert.Converter A ValueExpression enabled attribute that, if present, will be used as the text of the converter message, replacing any message that comes from the converter. converterMessage false java.lang.String The component identifier for this component. This value must be unique within the closest parent component that is a naming container. id false java.lang.String Flag indicating that this component's value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until Process Validations phase. immediate false java.lang.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. rendered false java.lang.Boolean Flag indicating that the user is required to provide a submitted value for this input component. required false java.lang.Boolean A ValueExpression enabled attribute that, if present, will be used as the text of the validation message for the "required" facility, if the "required" facility is used. requiredMessage false java.lang.String MethodExpression representing a validator method that will be called during Process Validations to perform correctness checks on the value of this component. The expression must evaluate to a public method that takes FacesContext, UIComponent, and Object parameters, with a return type of void. validator false

void validate(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, java.lang.Object)

A ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator. validatorMessage false java.lang.String The current value of this component. value false java.lang.Object MethodExpression representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a <code>ValueChangeEvent</code> 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 what the new value is, but this can be useful in cases where a notification is needed that "this value changed". valueChangeListener false

void valueChange(jakarta.faces.event.ValueChangeEvent)

The ValueExpression linking this component to a property in a backing bean binding false jakarta.faces.component.UIComponent

Renders an HTML "input" element of "type" "password". Decode Behavior <ul> See the decode description for the <a href="jakarta.faces.Inputjakarta.faces.Text.html#encode">Input Text</a> renderer. </ul> Encode Behavior <ul> Render the clientId of the component as the value of the "name" attribute. Render the current value of the component as the value of the "value" attribute, if and only if the "redisplay" component attribute is the string "true". If the "styleClass" attribute is specified, render its value as the value of the "class" attribute. </ul>

inputSecret

jakarta.faces.HtmlInputSecret

jakarta.faces.Secret

void validate(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, java.lang.Object)

A ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator. validatorMessage false java.lang.String The current value of this component. value false java.lang.Object MethodExpression representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a <code>ValueChangeEvent</code> 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 what the new value is, but this can be useful in cases where a notification is needed that "this value changed". valueChangeListener false

void valueChange(jakarta.faces.event.ValueChangeEvent)

Access key that, when pressed, transfers focus to this element. accesskey false java.lang.String If the value of this attribute is "off", render "off" as the value of the attribute. This indicates that the browser should disable its autocomplete feature for this component. This is useful for components that perform autocompletion and do not want the browser interfering. If this attribute is not set or the value is "on", render nothing. autocomplete false java.lang.String Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). dir false java.lang.String Flag indicating that this element must never receive focus or be included in a subsequent submit. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as disabled="disabled". disabled false java.lang.Boolean A localized user presentable name for this component. label false java.lang.String Code describing the language used in the generated markup for this component. lang false java.lang.String The maximum number of characters that may be entered in this field. maxlength false int Javascript code executed when this element loses focus. onblur false java.lang.String Javascript code executed when this element loses focus and its value has been modified since gaining focus. onchange false java.lang.String Javascript code executed when a pointer button is clicked over this element. onclick false java.lang.String Javascript code executed when a pointer button is double clicked over this element. ondblclick false java.lang.String Javascript code executed when this element receives focus. onfocus false java.lang.String Javascript code executed when a key is pressed down over this element. onkeydown false java.lang.String Javascript code executed when a key is pressed and released over this element. onkeypress false java.lang.String Javascript code executed when a key is released over this element. onkeyup false java.lang.String Javascript code executed when a pointer button is pressed down over this element. onmousedown false java.lang.String Javascript code executed when a pointer button is moved within this element. onmousemove false java.lang.String Javascript code executed when a pointer button is moved away from this element. onmouseout false java.lang.String Javascript code executed when a pointer button is moved onto this element. onmouseover false java.lang.String Javascript code executed when a pointer button is released over this element. onmouseup false java.lang.String Javascript code executed when text within this element is selected by the user. onselect false java.lang.String Flag indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as readonly="readonly". readonly false java.lang.Boolean Flag indicating that any existing value in this field should be rendered when the form is created. Because this is a potential security risk, password values are not displayed by default. redisplay false java.lang.Boolean The number of characters used to determine the width of this field. size false int CSS style(s) to be applied when this component is rendered. style false 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. styleClass false 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. tabindex false java.lang.String Advisory title information about markup elements generated for this component. title false java.lang.String The ValueExpression linking this component to a property in a backing bean binding false jakarta.faces.component.UIComponent 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.

]]> role false java.lang.String

Renders an HTML "input" element of "type" "text". <a name="decode">Decode Behavior</a> <ul> Obtain the <code>Map</code> from the "requestParameterMap" property of the <code>ExternalContext</code>. If the <code>Map</code> contains an entry for the "clientId" of the component, pass the value of the entry to the <code>setSubmittedValue()</code> method of the component, which must be an instance of <code>EditableValueHolder</code>. </ul> Encode Behavior <ul> Render the clientId of the component as the value of the "name" attribute. Render the current value of the component as the value of the "value" attribute. If the "styleClass" attribute is specified, render its value as the value of the "class" attribute. </ul>

inputText

jakarta.faces.HtmlInputText

jakarta.faces.Text

void validate(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, java.lang.Object)

A ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator. validatorMessage false java.lang.String Controls the data type and associated control of the element. Default value is text. If a value is specified for which already a more specific component exist, such as hidden, password, checkbox, radio, file, submit, image, reset and button, and the ProjectStage is set to Development, then the renderer must add a warning message stating that the more specific component should be preferred. ]]> type false java.lang.String The current value of this component. value false java.lang.Object MethodExpression representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a <code>ValueChangeEvent</code> 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 what the new value is, but this can be useful in cases where a notification is needed that "this value changed". valueChangeListener false

void valueChange(jakarta.faces.event.ValueChangeEvent)

Access key that, when pressed, transfers focus to this element. accesskey false java.lang.String Alternate textual description of the element rendered by this component. alt false java.lang.String If the value of this attribute is "off", render "off" as the value of the attribute. This indicates that the browser should disable its autocomplete feature for this component. This is useful for components that perform autocompletion and do not want the browser interfering. If this attribute is not set or the value is "on", render nothing. autocomplete false java.lang.String Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). dir false java.lang.String Flag indicating that this element must never receive focus or be included in a subsequent submit. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as disabled="disabled". disabled false java.lang.Boolean A localized user presentable name for this component. label false java.lang.String Code describing the language used in the generated markup for this component. lang false java.lang.String The maximum number of characters that may be entered in this field. maxlength false int Javascript code executed when this element loses focus. onblur false java.lang.String Javascript code executed when this element loses focus and its value has been modified since gaining focus. onchange false java.lang.String Javascript code executed when a pointer button is clicked over this element. onclick false java.lang.String Javascript code executed when a pointer button is double clicked over this element. ondblclick false java.lang.String Javascript code executed when this element receives focus. onfocus false java.lang.String Javascript code executed when a key is pressed down over this element. onkeydown false java.lang.String Javascript code executed when a key is pressed and released over this element. onkeypress false java.lang.String Javascript code executed when a key is released over this element. onkeyup false java.lang.String Javascript code executed when a pointer button is pressed down over this element. onmousedown false java.lang.String Javascript code executed when a pointer button is moved within this element. onmousemove false java.lang.String Javascript code executed when a pointer button is moved away from this element. onmouseout false java.lang.String Javascript code executed when a pointer button is moved onto this element. onmouseover false java.lang.String Javascript code executed when a pointer button is released over this element. onmouseup false java.lang.String Javascript code executed when text within this element is selected by the user. onselect false java.lang.String Flag indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as readonly="readonly". readonly false java.lang.Boolean The number of characters used to determine the width of this field. size false int CSS style(s) to be applied when this component is rendered. style false 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. styleClass false 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. tabindex false java.lang.String Advisory title information about markup elements generated for this component. title false java.lang.String The ValueExpression linking this component to a property in a backing bean binding false jakarta.faces.component.UIComponent 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.

]]> role false java.lang.String

Renders an HTML "textarea" element. Decode Behavior <ul> See the encode description for the <a href="jakarta.faces.Inputjakarta.faces.Text.html#encode">Input Text</a> renderer. </ul> Encode Behavior <ul> Render the clientId as the value of the "name" attribute. Render the current valu eof the component inside the "textarea" element. </ul>

inputTextarea

jakarta.faces.HtmlInputTextarea

jakarta.faces.Textarea

void validate(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, java.lang.Object)

A ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator. validatorMessage false java.lang.String The current value of this component. value false java.lang.Object MethodExpression representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a <code>ValueChangeEvent</code> 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 what the new value is, but this can be useful in cases where a notification is needed that "this value changed". valueChangeListener false

void valueChange(jakarta.faces.event.ValueChangeEvent)

Access key that, when pressed, transfers focus to this element. accesskey false java.lang.String The number of columns to be displayed. cols false int Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). dir false java.lang.String Flag indicating that this element must never receive focus or be included in a subsequent submit. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as disabled="disabled". disabled false java.lang.Boolean A localized user presentable name for this component. label false java.lang.String Code describing the language used in the generated markup for this component. lang false java.lang.String Javascript code executed when this element loses focus. onblur false java.lang.String Javascript code executed when this element loses focus and its value has been modified since gaining focus. onchange false java.lang.String Javascript code executed when a pointer button is clicked over this element. onclick false java.lang.String Javascript code executed when a pointer button is double clicked over this element. ondblclick false java.lang.String Javascript code executed when this element receives focus. onfocus false java.lang.String Javascript code executed when a key is pressed down over this element. onkeydown false java.lang.String Javascript code executed when a key is pressed and released over this element. onkeypress false java.lang.String Javascript code executed when a key is released over this element. onkeyup false java.lang.String Javascript code executed when a pointer button is pressed down over this element. onmousedown false java.lang.String Javascript code executed when a pointer button is moved within this element. onmousemove false java.lang.String Javascript code executed when a pointer button is moved away from this element. onmouseout false java.lang.String Javascript code executed when a pointer button is moved onto this element. onmouseover false java.lang.String Javascript code executed when a pointer button is released over this element. onmouseup false java.lang.String Javascript code executed when text within this element is selected by the user. onselect false java.lang.String Flag indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as readonly="readonly". readonly false java.lang.Boolean The number of rows to be displayed. rows false int CSS style(s) to be applied when this component is rendered. style false 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. styleClass false 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. tabindex false java.lang.String Advisory title information about markup elements generated for this component. title false java.lang.String The ValueExpression linking this component to a property in a backing bean binding false jakarta.faces.component.UIComponent 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.

]]> role false java.lang.String

Render a single message for a specific component. Set-up for Rendering <ul> Obtain the "summary" and "detail" properties from <code>UIMessage</code> component. If not present, keep the empty string as the value, respectively. Obtain the first <code>FacesMessage</code> to render from the component, using the "for" property of the <code>UIMessage</code>. This will be the only message we render. Obtain the severity style for this message. If the severity of the message is <code>FacesMessage.SEVERITY_INFO</code>, the severity style comes from the value of the "infoStyle" attribute. If the severity of the message is <code>FacesMessage.SEVERITY_WARN</code>, the severity style comes from the value of the "warnStyle" attribute, and so on for each of the severities, <code>INFO, WARN, ERROR</code> and <code>FATAL</code>. The same rules apply for obtaining the severity style class, but instead of "infoStyle, warnStyle", etc use "infoClass, warnClass", etc. Obtain the "style", "styleClass" and "layout" attributes from the <code>UIMessage</code> component. If we have a "style" attribute and a severity style attribute, use the severity style attribute as the value of the "style" attribute. If we have no "style" attribute, but do have a severity style, use the severity style as the value of the "style" attribute. The same precedence rules apply for the style class. Obtain the value of the <code>dir</code> and <code>lang</code> attributes. </ul> Rendering <ul> For the message renderer, we only render one row, for the first message. For the messages renderer, we render as many rows as we have messages. If any of the "dir", "lang", "style" or "styleClass" attributes has a non-null value (as determined above), render a "span" element, outputting the value of the "style" attribute as the the value of the "style" attribute, and outputting the value of the "styleClass" attribute as the value of the "class" attribute on the "span" element. Output the "dir" and "lang" attributes as well, if they are present. If the <code>UIMessage</code> has a "tooltip" attribute with the value of "true", and the <code>UIMessage</code> has "showSummary" and "showDetail" properties with the value "true", if we haven't already written out the "span", output the "summary" as the value of the "title" attribute on the "span". If we haven't already written out a "title" attribute, and "showSummary" is true, output the summary. If "showDetail" is true, output the detail. Close out the span if necessary. </ul>

message

jakarta.faces.HtmlMessage

jakarta.faces.Message

Client identifier of the component for which to display messages. for true java.lang.String The component identifier for this component. This value must be unique within the closest parent component that is a naming container. id false java.lang.String 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. rendered false java.lang.Boolean Flag indicating whether the detail portion of displayed messages should be included. Default value is "true". showDetail false java.lang.Boolean Flag indicating whether the summary portion of displayed messages should be included. Default value is "false". showSummary false java.lang.Boolean Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). dir false java.lang.String CSS style class to apply to any message with a severity class of "ERROR". errorClass false java.lang.String CSS style(s) to apply to any message with a severity class of "ERROR". errorStyle false java.lang.String CSS style class to apply to any message with a severity class of "FATAL". fatalClass false java.lang.String CSS style(s) to apply to any message with a severity class of "FATAL". fatalStyle false java.lang.String CSS style class to apply to any message with a severity class of "INFO". infoClass false java.lang.String CSS style(s) to apply to any message with a severity class of "INFO". infoStyle false java.lang.String Code describing the language used in the generated markup for this component. lang false java.lang.String CSS style(s) to be applied when this component is rendered. style false 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. styleClass false java.lang.String Advisory title information about markup elements generated for this component. title false java.lang.String Flag indicating whether the detail portion of the message should be displayed as a tooltip. tooltip false java.lang.Boolean CSS style class to apply to any message with a severity class of "WARN". warnClass false java.lang.String CSS style(s) to apply to any message with a severity class of "WARN". warnStyle false java.lang.String The ValueExpression linking this component to a property in a backing bean binding false jakarta.faces.component.UIComponent 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.

]]> role false java.lang.String

The same as for the Message renderer, but output all the messages. If an "id" attribute has been specified, it must be rendered on the outermost markup corresponding to this component. If the value of the "layout" attribute is "table", render nested "table", "tr", and "td" elements, in that order. If the value of the "layout" attribute is "list", or the "layout" attribute is not specified, render nested "ul", "li" elements, in that order. Output the value of the "style" attribute as the value of the "style" attribute, output the value of the "styleClass" attribute as the value of the "class" attribute, and output the dir and lang attributes. Output these values on the "table" element or the "ul" element. Output the values of the "errorStyle", "fatalStyle", "infoStyle", "warnStyle" attributes as the value of the "style" attribute on either the "tr" element or the "li" element. Output the values of the "errorClass", "fatalClass", "infoClass", "warnClass" attributes as the value of the "class" attribute on either the "tr" element or the "li" element. The component is a <code>UIMessages</code>, and there is no "for" attribute. Therefore, use either <code>null</code> to obtain the messages from the <code>FacesContext</code> or the empty string if the components "globalOnly" property is <code>true</code>. If the layout was "table" close out the table elements, otherwise, close out the list elements. If an h:form does not contain a h:messages tag and the ProjectStage is set to Development the runtime will automatically add h:messages for debugging purposes.

messages

jakarta.faces.HtmlMessages

jakarta.faces.Messages

Client identifier of the component for which to display messages. This attribute is mutually exclusive with globalOnly and take precedence if used. for false java.lang.String Flag indicating that only global messages (that is, messages not associated with any client identifier) are to be displayed. Default value is "false". globalOnly false java.lang.Boolean The component identifier for this component. This value must be unique within the closest parent component that is a naming container. id false java.lang.String 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. rendered false java.lang.Boolean Flag indicating whether the detail portion of displayed messages should be included. Default value is "false". showDetail false java.lang.Boolean Flag indicating whether the summary portion of displayed messages should be included. Default value is "true". showSummary false java.lang.Boolean Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). dir false java.lang.String CSS style class to apply to any message with a severity class of "ERROR". errorClass false java.lang.String CSS style(s) to apply to any message with a severity class of "ERROR". errorStyle false java.lang.String CSS style class to apply to any message with a severity class of "FATAL". fatalClass false java.lang.String CSS style(s) to apply to any message with a severity class of "FATAL". fatalStyle false java.lang.String CSS style class to apply to any message with a severity class of "INFO". infoClass false java.lang.String CSS style(s) to apply to any message with a severity class of "INFO". infoStyle false java.lang.String Code describing the language used in the generated markup for this component. lang false java.lang.String The type of layout markup to use when rendering error messages. Valid values are "table" (an HTML table) and "list" (an HTML list). If not specified, the default value is "list". layout false java.lang.String CSS style(s) to be applied when this component is rendered. style false 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. styleClass false java.lang.String Advisory title information about markup elements generated for this component. title false java.lang.String Flag indicating whether the detail portion of the message should be displayed as a tooltip. tooltip false java.lang.Boolean CSS style class to apply to any message with a severity class of "WARN". warnClass false java.lang.String CSS style(s) to apply to any message with a severity class of "WARN". warnStyle false java.lang.String The ValueExpression linking this component to a property in a backing bean binding false jakarta.faces.component.UIComponent

Render parameterized text. Obtain the <code>style</code>, <code>styleClass</code>, <code>dir</code>, and <code>lang</code> attributees from this component. If any are present, render a "span" element. Output the <code>styleClass</code> attribute (if present) as the value of the <code>class</code> attribute. Output the <code>style</code> attribute as the value of the <code>style</code> attribute. Output the <code>dir</code> and <code>lang</code> attributes as pass through attributes. Accrue a list of the values of all child <code>UIParameter</code> components of this component. If there are one or more accumulated parameter values, convert the list of parameter values to an <code>Object</code> array, call <code>MessageFormat.format()</code>, passing the <code>value</code> of this component as the first argument, and the array of parameter values as the second argument, and render the result. Otherwise, render the <code>value</code> of this component unmodified.

outputFormat

jakarta.faces.HtmlOutputFormat

jakarta.faces.Format

It is the page author's responsibility to ensure that the user agent is capable of correctly interpreting the value of this attribute.

]]> role false java.lang.String

Renders an HTML "label" element. Render the current value of the component as label text if it is specified. If a "for" attribute is specified, find the component specified by the value of the "for" attribute, and render its client id as the value of the "for" attribute. If "styleClass" attribute is specified, render its value as the value of the "class" attribute.

outputLabel

jakarta.faces.HtmlOutputLabel

jakarta.faces.Label

Converter instance registered with this component. converter false jakarta.faces.convert.Converter The component identifier for this component. This value must be unique within the closest parent component that is a naming container. id false java.lang.String 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. rendered false java.lang.Boolean The current value of this component. value false java.lang.Object Access key that, when pressed, transfers focus to this element. accesskey false java.lang.String Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). dir false java.lang.String Flag indicating that characters that are sensitive in HTML and XML markup must be escaped. If omitted, this flag is assumed to be "true". escape false java.lang.Boolean Client identifier of the component for which this element is a label. for false java.lang.String Code describing the language used in the generated markup for this component. lang false java.lang.String Javascript code executed when this element loses focus. onblur false java.lang.String Javascript code executed when a pointer button is clicked over this element. onclick false java.lang.String Javascript code executed when a pointer button is double clicked over this element. ondblclick false java.lang.String Javascript code executed when this element receives focus. onfocus false java.lang.String Javascript code executed when a key is pressed down over this element. onkeydown false java.lang.String Javascript code executed when a key is pressed and released over this element. onkeypress false java.lang.String Javascript code executed when a key is released over this element. onkeyup false java.lang.String Javascript code executed when a pointer button is pressed down over this element. onmousedown false java.lang.String Javascript code executed when a pointer button is moved within this element. onmousemove false java.lang.String Javascript code executed when a pointer button is moved away from this element. onmouseout false java.lang.String Javascript code executed when a pointer button is moved onto this element. onmouseover false java.lang.String Javascript code executed when a pointer button is released over this element. onmouseup false java.lang.String CSS style(s) to be applied when this component is rendered. style false 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. styleClass false 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. tabindex false java.lang.String Advisory title information about markup elements generated for this component. title false java.lang.String The ValueExpression linking this component to a property in a backing bean binding false jakarta.faces.component.UIComponent 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.

]]> role false java.lang.String

Render an HTML "a" anchor element. The value of the component is rendered as the value of the "href" attribute. Any child UIParameter components are appended to the String to be output as the value of the "href" attribute as query parameters before rendering. The entire "href" string must be passed through a call to the <code>encodeResourceURL()</code> method of the <code>ExternalContext</code>. 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. 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 "<a href="../../../renderkitdocs/HTML_BASIC/renderkit-summary.html#general_encoding">General Notes on Encoding</a>" regarding the "id" attribute for UIInput components. If the "disabled" attribute is specified, do not render the HTML "a" anchor element or the "href" element. Instead, render a "span" element. If the "styleClass" attribute is specified, render its value as the value of the "class" attribute on the "span". Render any pass-through attributes on the "span".

outputLink

jakarta.faces.HtmlOutputLink

jakarta.faces.Link

Converter instance registered with this component. converter false jakarta.faces.convert.Converter The component identifier for this component. This value must be unique within the closest parent component that is a naming container. id false java.lang.String 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. rendered false java.lang.Boolean The current value of this component. value false java.lang.Object Access key that, when pressed, transfers focus to this element. accesskey false java.lang.String The character encoding of the resource designated by this hyperlink. charset false java.lang.String The position and shape of the hot spot on the screen (for use in client-side image maps). coords false java.lang.String Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). dir false java.lang.String Flag indicating that this element must never receive focus or be included in a subsequent submit. disabled false java.lang.Boolean The language code of the resource designated by this hyperlink. hreflang false java.lang.String Code describing the language used in the generated markup for this component. lang false java.lang.String Javascript code executed when this element loses focus. onblur false java.lang.String Javascript code executed when a pointer button is clicked over this element. onclick false java.lang.String Javascript code executed when a pointer button is double clicked over this element. ondblclick false java.lang.String Javascript code executed when this element receives focus. onfocus false java.lang.String Javascript code executed when a key is pressed down over this element. onkeydown false java.lang.String Javascript code executed when a key is pressed and released over this element. onkeypress false java.lang.String Javascript code executed when a key is released over this element. onkeyup false java.lang.String Javascript code executed when a pointer button is pressed down over this element. onmousedown false java.lang.String Javascript code executed when a pointer button is moved within this element. onmousemove false java.lang.String Javascript code executed when a pointer button is moved away from this element. onmouseout false java.lang.String Javascript code executed when a pointer button is moved onto this element. onmouseover false java.lang.String Javascript code executed when a pointer button is released over this element. onmouseup false java.lang.String The relationship from the current document to the anchor specified by this hyperlink. The value of this attribute is a space-separated list of link types. rel false java.lang.String A reverse link from the anchor specified by this hyperlink to the current document. The value of this attribute is a space-separated list of link types. rev false java.lang.String The shape of the hot spot on the screen (for use in client-side image maps). Valid values are: default (entire region); rect (rectangular region); circle (circular region); and poly (polygonal region). shape false java.lang.String CSS style(s) to be applied when this component is rendered. style false 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. styleClass false 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. tabindex false java.lang.String Name of a frame where the resource retrieved via this hyperlink is to be displayed. target false java.lang.String Advisory title information about markup elements generated for this component. title false java.lang.String The content type of the resource designated by this hyperlink. type false java.lang.String The ValueExpression linking this component to a property in a backing bean binding false jakarta.faces.component.UIComponent 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.

]]> role false java.lang.String

Render the markup for a <link> element that renders the style Resource specified by the optional name and library attributes.

Decode Behavior

No action is required during decode for this renderer.

Encode Behavior

Use the algorithm Common Encode Behavior for encodeBegin(), encodeChildren() and getRendersChildren().

For encodeEnd(), use the algorithm Common Algorithm for Obtaining A Resource to Render to obtain a reference to the Resource to be encoded.

Output a <link> element. Use the result from calling resource.getRequestPath() as the value of the "href" attribute. Use the result from calling resource.getContentType() as the value of the "type" attribute, unless the value equals text/css and the current doctype is a HTML5 doctype.. Use the literal string "stylesheet" as the value of the "rel" attribute, and the literal string "screen" as the value of the "media" attribute.

The implementation of this renderer must have a @ListenerFor annotation attached to it, at the class level, declaring PostAddToViewEvent.class as the value of the systemEventClass attribute. The presence of this annotation on a renderer implies the renderer implements ComponentSystemEventListener, which this renderer must do. The implementation of processEvent() must extract the UIComponent from the argument event pass it to UIViewRoot.addComponentResource(), specifying the literal string "head" as the last argument.

The stylsheet renderer must ensure that any stylesheets are included in the <head> of the document.

outputStylesheet

jakarta.faces.Output

jakarta.faces.resource.Stylesheet

converter false jakarta.faces.convert.Converter

id false java.lang.String

rendered false boolean

value false java.lang.Object

The libraryName for this resource.

]]> library false java.lang.String

The resourceName for this resource.

This attribute is required if the stylesheet is NOT inline.

]]> name false java.lang.String

The ValueExpression linking this component to a property in a backing bean binding false jakarta.faces.component.UIComponent

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.

]]> role false java.lang.String

If the "styleClass", "style", "dir" or "lang" attributes are present, render a "span" element. If the "styleClass" attribute is present, render its value as the value of the "class" attribute. If the "style" attribute is present, pass it thru. If the "escape" attribute is not present, or it is present and its value is "true" all angle brackets should be converted to the ampersand xx semicolon syntax when rendering the value of the "value" attribute as the value of the component. If the "escape" attribute is present and is "false" the value of the component should be rendered as text without escaping.

outputText

jakarta.faces.HtmlOutputText

jakarta.faces.Text

It is the page author's responsibility to ensure that the user agent is capable of correctly interpreting the value of this attribute.

]]> role false java.lang.String

Render the markup for a <script> element that renders the script Resource specified by the optional name attribute and library attributes.

The implementation of this renderer must have a @ListenerFor annotation attached to it, at the class level, declaring PostAddToViewEvent.class as the value of the systemEventClass attribute. The presence of this annotation on a renderer implies the renderer implements ComponentSystemEventListener, which this renderer must do. The implementation of processEvent() must extract the UIComponent from the argument event and look for the presence of the key "target" in the component's attribute Map. If and only if such a key is present, the implementation of processEvent() must pass the component to UIViewRoot.addComponentResource().

Decode Behavior

No action is required during decode for this renderer.

Encode Behavior

Common Algorithm for Obtaining A Resource to Render

This algorithm is used by all resource renderers to obtain a Resource instance which is then rendered in a specific way depending on what kind of renderer is doing the encoding.

Look in the component attribute Map for a value under the key name.
Look in the component attribute Map for a value under the key library. This attribute is optional, therefore, library may be null.
Create the resource by calling Application.getResourceHandler.createResource(name, library);.

Common Encode Behavior

This algorithm is used by all resource renderers to render the resource.

encodeBegin() must take no action.

Because this renderer returns true from getRendersChildren(), the encodeChildren() method must take the following action.

If there is no name attribute, and the argument component has no children, and ProjectStage is not ProjectStage.Production, add a FacesMessage for this component's clientId to the FacesContext stating that if no name attribute is present, and no body content is present either, then the user should take action to correct this problem. In this case, encodeChildren() must take no further action.
If there is no name attribute and the argument component does have children, the renderer must ensure that those children are encoded as usual.
If there is a name attribute and the argument component does have children, the renderer must log a descriptive localized message stating that the child content will be ignored. The resource referenced by the name attribute will be rendered in encodeEnd().
If there is a name attribute and the argument component does not have children, encodeChildren() must take no action.

encodeEnd() must take specific action based on the specific kind of resource being rendered.

Use the algorithm Common Encode Behavior for encodeBegin(), encodeChildren() and getRendersChildren().

For encodeEnd(), use the algorithm Common Algorithm for Obtaining A Resource to Render above to obtain a reference to the Resource to be encoded.

If this is NOT the first time this Resource has been referenced on this request take no action and return.

Render a script element. Use the result from calling resource.getRequestPath() as the value of the "src" attribue. Use the result from calling resource.getContentType() as the value of the "type" attribute, unless the value equals text/javascript and the current doctype is a HTML5 doctype.

]]>

outputScript

jakarta.faces.Output

jakarta.faces.resource.Script

converter false jakarta.faces.convert.Converter id false java.lang.String rendered false boolean value false java.lang.Object

The libraryName for this resource.

]]> library false java.lang.String

The resourceName for this resource.

This attribute is required if the script is NOT inline.

]]> name false java.lang.String

The target area for which this resource will be rendered. For example, target="head" would cause the resource to be rendered within the head element.

]]> target false java.lang.String The ValueExpression linking this component to a property in a backing bean binding false jakarta.faces.component.UIComponent 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.

]]> role false java.lang.String

Renders an HTML "table" element, conforming to the rules in the HTML 401 specification. Render the "caption" facet, if present, inside a "caption" element immediately below the "table" element. If the "captionClass" attribute is specified, render its value as the value of the "class" attribute on the "caption" element. If the "captionStyle" attribute is specified, render its value as the value of the "style" attribute on the "caption" element. If the "styleClass" attribute is specified, render its value as the value of the "class" attribute. Render the pass-through attributes in the table below. Render the "header" facet, if present, inside of "thead", "tr", and "th" elements, nested in that order. If the "headerClass" attribute is specifed, render its value as the value of the "class" attribute on the "th" element. Render "colgroup" as the value of the "scope" attribute. Render the value of the "columns" attribute as the value of the "colspan" attribute on the "th" element. Render the "footer" facet if present, using similar logic to the rendering of the "header", but replacing "thead" with "tfoot", "th" with "td", and "headerClass" with "footerClass". Render the children of the <code>UIPanel</code> component inside of a "tbody" element. Render the children based on the value of the "columns" attribute, creating a new row each time a "columns" worth of children have been rendered. For the start of each row, render a "tr" element. Output the value of the "rowClasses" per the attribute description below. For each child, output a "td" element, attaching the value of the "columnClasses" attribute per the attribute description below. Recursively encode each child. Close out the "td" element. When done with the row, close out the "tr" element. If a child has "rendered==false" it is not rendered, and the column counter must not be incremented.

panelGrid

jakarta.faces.HtmlPanelGrid

jakarta.faces.Grid

The component identifier for this component. This value must be unique within the closest parent component that is a naming container. id false java.lang.String 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. rendered false java.lang.Boolean Name or code of the background color for this table. bgcolor false java.lang.String Comma separated list of row indices for which a new "tbody" element should be started (and any previously opened one should be ended). bodyrows false java.lang.String Width (in pixels) of the border to be drawn around this table. border false int Space-separated list of CSS style class(es) that will be applied to any caption generated for this table. captionClass false java.lang.String CSS style(s) to be applied when this caption is rendered. captionStyle false java.lang.String Definition of how much space the user agent should leave between the border of each cell and its contents. cellpadding false java.lang.String Definition of how much space the user agent should leave between the left side of the table and the leftmost column, the top of the table and the top of the top side of the topmost row, and so on for the right and bottom of the table. It also specifies the amount of space to leave between cells. cellspacing false java.lang.String Comma-delimited list of CSS style classes that will be applied to the columns of this table. A space separated list of classes may also be specified for any individual column. If the number of elements in this list is less than the number of actual column children of the UIData, no "class" attribute is output for each column greater than the number of elements in the list. If the number of elements in the list is greater than the number of actual column children of the UIData, the elements at the posisiton in the list after the last column are ignored. columnClasses false java.lang.String The number of columns to render before starting a new row. columns false int Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). dir false java.lang.String Space-separated list of CSS style class(es) that will be applied to any footer generated for this table. footerClass false java.lang.String Code specifying which sides of the frame surrounding this table will be visible. Valid values are: none (no sides, default value); above (top side only); below (bottom side only); hsides (top and bottom sides only); vsides (right and left sides only); lhs (left hand side only); rhs (right hand side only); box (all four sides); and border (all four sides). frame false java.lang.String Space-separated list of CSS style class(es) that will be applied to any header generated for this table. headerClass false java.lang.String Code describing the language used in the generated markup for this component. lang false java.lang.String Javascript code executed when a pointer button is clicked over this element. onclick false java.lang.String Javascript code executed when a pointer button is double clicked over this element. ondblclick false java.lang.String Javascript code executed when a key is pressed down over this element. onkeydown false java.lang.String Javascript code executed when a key is pressed and released over this element. onkeypress false java.lang.String Javascript code executed when a key is released over this element. onkeyup false java.lang.String Javascript code executed when a pointer button is pressed down over this element. onmousedown false java.lang.String Javascript code executed when a pointer button is moved within this element. onmousemove false java.lang.String Javascript code executed when a pointer button is moved away from this element. onmouseout false java.lang.String Javascript code executed when a pointer button is moved onto this element. onmouseover false java.lang.String Javascript code executed when a pointer button is released over this element. onmouseup false java.lang.String Comma-delimited list of CSS style classes that will be applied to the rows of this table. A space separated list of classes may also be specified for any individual row. Thes styles are applied, in turn, to each row in the table. For example, if the list has two elements, the first style class in the list is applied to the first row, the second to the second row, the first to the third row, the second to the fourth row, etc. In other words, we keep iterating through the list until we reach the end, and then we start at the beginning again. rowClasses false java.lang.String Code specifying which rules will appear between cells within this table. Valid values are: none (no rules, default value); groups (between row groups); rows (between rows only); cols (between columns only); and all (between all rows and columns). rules false java.lang.String CSS style(s) to be applied when this component is rendered. style false 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. styleClass false java.lang.String Summary of this table's purpose and structure, for user agents rendering to non-visual media such as speech and Braille. summary false java.lang.String Advisory title information about markup elements generated for this component. title false java.lang.String Width of the entire table, for visual user agents. width false java.lang.String The ValueExpression linking this component to a property in a backing bean binding false jakarta.faces.component.UIComponent 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.

]]> role false java.lang.String

Intended for use in situations when only one UIComponent child can be nested, such as in the case of facets. If the "style" or "styleClass" attributes are present, and the "layout" attribute is present with a value of "block", render a "div" element, outputting the value of the "style" attribute as the value of the "style" attribute and the value of the "styleClass" attribute as the value of the "class" attribute. Otherwise, if the "layout" attribute is not present, or the "layout" attribute contains a value other than "block", render a "span" element, outputting the value of the "style" attribute as the value of the "style" attribute, and the value of the "styleClass" attribute as the value of the "class" attribute.

panelGroup

jakarta.faces.HtmlPanelGroup

jakarta.faces.Group

Renders an HTML "input" element of type "checkbox". Decode Behavior <ul> Obtain the <code>Map</code> from the "requestParameterMap" property of the <code>ExternalContext</code>. If there is no entry in the <code>Map</code> for the "clientId" of this component, pass "false" to the <code>setSubmittedValue()</code> method of the component, which must be an instance of <code>EditableValueHolder</code>. If there is an entry, and its value is equal, ignoring case and without quotes, to any of the Strings: "on", "yes" or "true" pass true to the <code>setSubmittedValue()</code> method of the component. </ul> Encode Behavior <ul> Render the clientId of the component as the value of the "name" attribute. If the current value of the component is "true", output the "checked" attribute (must be rendered as checked="checked"). If the "styleClass" attribute is specified, render its value as the value of the "class" attribute. </ul>

selectBooleanCheckbox

jakarta.faces.HtmlSelectBooleanCheckbox

jakarta.faces.Checkbox

void validate(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, java.lang.Object)

A ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator. validatorMessage false java.lang.String The current value of this component. value false java.lang.Boolean MethodExpression representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a <code>ValueChangeEvent</code> 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 what the new value is, but this can be useful in cases where a notification is needed that "this value changed". valueChangeListener false

void valueChange(jakarta.faces.event.ValueChangeEvent)

Access key that, when pressed, transfers focus to this element. accesskey false java.lang.String Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). dir false java.lang.String Flag indicating that this element must never receive focus or be included in a subsequent submit. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as disabled="disabled". disabled false java.lang.Boolean A localized user presentable name for this component. label false java.lang.String Code describing the language used in the generated markup for this component. lang false java.lang.String Javascript code executed when this element loses focus. onblur false java.lang.String Javascript code executed when this element loses focus and its value has been modified since gaining focus. onchange false java.lang.String Javascript code executed when a pointer button is clicked over this element. onclick false java.lang.String Javascript code executed when a pointer button is double clicked over this element. ondblclick false java.lang.String Javascript code executed when this element receives focus. onfocus false java.lang.String Javascript code executed when a key is pressed down over this element. onkeydown false java.lang.String Javascript code executed when a key is pressed and released over this element. onkeypress false java.lang.String Javascript code executed when a key is released over this element. onkeyup false java.lang.String Javascript code executed when a pointer button is pressed down over this element. onmousedown false java.lang.String Javascript code executed when a pointer button is moved within this element. onmousemove false java.lang.String Javascript code executed when a pointer button is moved away from this element. onmouseout false java.lang.String Javascript code executed when a pointer button is moved onto this element. onmouseover false java.lang.String Javascript code executed when a pointer button is released over this element. onmouseup false java.lang.String Javascript code executed when text within this element is selected by the user. onselect false java.lang.String Flag indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as readonly="readonly". readonly false java.lang.Boolean CSS style(s) to be applied when this component is rendered. style false 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. styleClass false 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. tabindex false java.lang.String Advisory title information about markup elements generated for this component. title false java.lang.String The ValueExpression linking this component to a property in a backing bean binding false jakarta.faces.component.UIComponent 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.

]]> role false java.lang.String

Render an HTML checkbox list. <a name="decode">Decode Behavior</a> <ul> See the <a href="SelectManyListbox.html">"Decode Behavior for UISelectMany Components"</a> section. </ul> Encode Behavior <ul> If the "layout" attribute is specified, and its value is "list", render a "ul" element as root element, otherwise render a "table" element. If the "styleClass" is specified, render the value of the "styleClass" attribute as the value of the "class" attribute on the root element. If the "style", or "border" attributes are specified, pass them thru and render their values as the "style" and "border" attributes on the root element, respectively. If the "layout" attribute is specified, and its value is "pageDirection", render the children elements vertically, otherwise horizontally, in the root element. If any of the children are an instance of SelectItemGroup, render them as a nested root element. Each of the children are ultimately rendererd as follows. Render an "input" element of "type" "checkbox" for each child component. Render the "name" attribute on the "input" element with the value of the <code>clientId</code> of the component. Render an "id" attribute on the "input" element. Each "id" value must be unique. If the current SelectItem.isDisabled() returns true, render "disabled" as the value of the "disabled" attribute. Close out the "input" element. Render a "label" element. Render the "for" attribute of the "label" element whose value is the corresponding "input" element's "id" value. Render any "style" as the "class" attribute on the "label" element. If the current checkbox would be rendered as being checked, and there is a "selectedClass" attribute, append a space, followed by the value of the "selectedClass" attribute to any existing "class" attribute value on the label element. Otherwise, render the value of the "selectedClass" attribute as the value of the "class" attribute on the label element. If the current checkbox would be rendered as being not checked, and there is a "unselectedClass" attribute, append a space, followed by the value of the "unselectedClass" attribute to any existing "class" attribute value on the label element. Otherwise, render the value of the "unselectedClass" attribute as the value of the "class" attribute on the label element. Close out the starting "label" element and render the label value from SelectItem.getLabel(). Close out the "label" element. As an exception to the general rules about how to handle the "id" attribute, render it as an attribute on the outer "table" element, the value of which is the <code>clientId</code> of the component per the rules at the beginning of this specification. The value of the current SelectItem is rendered as the value of the "value" attribute. Coerce the value of the currently rendered child to the type of the parent UISelectMany value following the Expression Language coercion rules, before comparing the values. If the value of the enclosing UISelectMany matches the current value, render "checked" as the value of the "checked" attribute. See the <a href="SelectManyListbox.html">"Rendering the option elements" </a> specification for <code>ListboxRenderer</code> for more detail on how to render the "option" elements in this renderer. </ul>

selectManyCheckbox

jakarta.faces.HtmlSelectManyCheckbox

jakarta.faces.Checkbox

void validate(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, java.lang.Object)

A ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator. validatorMessage false java.lang.String The current value of this component. value false java.lang.Object MethodExpression representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a <code>ValueChangeEvent</code> 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 what the new value is, but this can be useful in cases where a notification is needed that "this value changed". valueChangeListener false

void valueChange(jakarta.faces.event.ValueChangeEvent)

Access key that, when pressed, transfers focus to this element. accesskey false java.lang.String Width (in pixels) of the border to be drawn around the table containing the options list. This attribute is ignored when the "layout" attribute equals to "list". border false int Optional attribute that is a literal string that is the fully qualified class name of a concrete class that implements <code>java.util.Collection</code>, or an EL expression that evaluates to either 1. such a String, or 2. the <code>Class</code> object itself. collectionType false java.lang.String Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). dir false java.lang.String Flag indicating that this element must never receive focus or be included in a subsequent submit. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as disabled="disabled". disabled false java.lang.Boolean CSS style class to apply to the rendered label on disabled options. disabledClass false java.lang.String CSS style class to apply to the rendered label on enabled options. enabledClass false java.lang.String Flag indicating that, if this component is activated by the user, The "no selection option", if any, must be hidden. hideNoSelectionOption false java.lang.Boolean A localized user presentable name for this component. label false java.lang.String Code describing the language used in the generated markup for this component. lang false java.lang.String Orientation of the options list to be created. Valid values are "pageDirection" (list is laid out vertically), or "lineDirection" (list is laid out horizontally). If not specified, the default value is "lineDirection". layout false java.lang.String Javascript code executed when this element loses focus. onblur false java.lang.String Javascript code executed when this element loses focus and its value has been modified since gaining focus. onchange false java.lang.String Javascript code executed when a pointer button is clicked over this element. onclick false java.lang.String Javascript code executed when a pointer button is double clicked over this element. ondblclick false java.lang.String Javascript code executed when this element receives focus. onfocus false java.lang.String Javascript code executed when a key is pressed down over this element. onkeydown false java.lang.String Javascript code executed when a key is pressed and released over this element. onkeypress false java.lang.String Javascript code executed when a key is released over this element. onkeyup false java.lang.String Javascript code executed when a pointer button is pressed down over this element. onmousedown false java.lang.String Javascript code executed when a pointer button is moved within this element. onmousemove false java.lang.String Javascript code executed when a pointer button is moved away from this element. onmouseout false java.lang.String Javascript code executed when a pointer button is moved onto this element. onmouseover false java.lang.String Javascript code executed when a pointer button is released over this element. onmouseup false java.lang.String Javascript code executed when text within this element is selected by the user. onselect false java.lang.String Flag indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as readonly="readonly". readonly false java.lang.Boolean CSS style class to apply to the rendered label on selected options. selectedClass false java.lang.String CSS style(s) to be applied when this component is rendered. style false 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. styleClass false 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. tabindex false java.lang.String Advisory title information about markup elements generated for this component. title false java.lang.String CSS style class to apply to the rendered label on unselected options. unselectedClass false java.lang.String The ValueExpression linking this component to a property in a backing bean binding false jakarta.faces.component.UIComponent 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.

]]> role false java.lang.String

Render an HTML option list. Decode Behavior This section documents the decode behavior for all renderers that handle <code>UISelectMany</code> or <code>UISelectOne</code> components. <ul> <a name="decodeMany">Decode Behavior for <code>UISelectMany</code> components</a> <ul> Obtain the <code>Map</code> from the "requestParameterValuesMap" property of the <code>ExternalContext</code>. If the <code>Map</code> contains an entry for the "clientId" of the component, pass the value of the entry, cast to a <code>String []</code>, to the <code>setSubmittedValue()</code> method of the component, which must be an <code>EditableValueHolder</code>. If the <code>Map</code> does not contain an entry, create an empty <code>String</code> array and call <code>setSubmittedValue()</code> with it. Please check the javadoc for <a href="../../javadocs/jakarta/faces/component/UISelectMany.html#getConvertedvalue">UISelectMany.getConvertedValue()</a> for additional requirements for renderers that render this kind of component. </ul> <a name="decodeOne">Decode Behavior for <code>UISelectOne</code> components</a> <ul> Obtain the <code>Map</code> from the "requestParameterMap" property of the <code>ExternalContext</code>. If there is a <code>Map</code> entry for the "clientId" property of the component, pass it to the <code>setSubmittedValue()</code> method of the component. If the <code>Map</code> does not contain an entry, call <code>setSubmittedValue()</code> passing an empty <code>String</code> as the argument. </ul> Encode Behavior <ul> Render an HTML "select" element. Render the clientId of the component as the value of the "name" attribute. If the "styleClass" attribute is specified, render its value as the value of the "class" attribute on the "select" element. If the component is a <code>UISelectMany</code> instance, render "multiple" as the value of the "multiple" attribute. If the "size" attribute is specified, render its value as the value of the "size" attribute. Otherwise use the number of items as the value of the "size" attribute. </ul> <a name="option">Rendering the "option" elements</a> <ul> The only valid children of this component are <code>UISelectItem</code> or <code>UISelectItems</code> instances. Iterate over the children of this component, and accrue a list of <code>jakarta.faces.model.SelectItem</code> instances. If the current child is a <code>SelectItem</code> whose <code>noSelctionProperty</code> is <code>true</code>, and the <code>UISelectOne</code> or <code>UISelectMany</code> parent of this option has one or more selected values that are not the "no selection" <code>SelectItem</code>, and the component has a "hideNoSelectionLabel" attribute whose value is <code>true</code>, then the current option, which is the "no selection" option, must not be rendered. If the current child is a <code>UISelectItem</code> create a <code>SelectItem</code>instance from its <code>itemValue, itemLabel</code>, <code class="changed_added_2_0">itemEscaped</code>, and <code>itemDescription</code> properties, add it to the list. If the current child is a <code>UISelectItems</code> instance, call its <code>getValue()</code> method. If the result is a <code>SelectItem</code> bean, add it to the list. If the result is an array of <code>SelectItem</code> beans, add each one to the list. If the result is a <code>Collection</code> of <code>SelectItem</code> beans, add each one to the list. If the result is a <code>Map</code>, create a <code>SelectItem</code> bean for each entry in the <code>Map</code> using the key as the label, the value as the value, and <code>null</code> as the description. Iterate over the list of <code>SelectItem</code> beans. If the current element is a <code>SelectItemGroup</code>, render an "optgroup" element with a "label" attribute, the value of which is the "label" property from the current element, then call <code>getSelectItems()</code> and render each element as below. If the current element is not a <code>SelectItemGroup</code>, render an "option" element. Follow the conversion rules in the spec to obtain a renderable <code>String</code> from the "value" property of the current element, render that as the value of the "value" atribute. Now it is time to see if the current element is the selected value. Call its <code>getSubmittedValue()</code> method, casting the result to an <code>Object []</code>, otherwise the component must be a <code>UISelectOne</code> instance, call its <code>getSubmittedValue()</code> method and create an <code>Object []</code> around the result. Determine the type of the resultant array, if the resultant array is non-null, otherwise the type is <code>String</code>. Coerce the current item value to this type following the Expression Language coercion rules. If the resultant array is non-null, we look in the array for a value that, when we pass the renderable value to its <code>equals()</code> method, it returns <code>true</code>, meaning the current element is selected. If the resultant array is <code>null</code>, if the component is a <code>UISelectMany</code>, call its <code>getValue()</code> method. If the result is a <code>List</code> obtain the values in the list as an array. Otherwise, the component must be a <code>UISelectOne</code> instance. Call its <code>getValue()</code> method, which must be an Object array. Look for an element in the resultant array that, 1. when we pass the renderable value to its <code>equals()</code> method, it returns <code>true</code> , or 2. if the renderable value is null, and there is a null element in the array, also conclude that the current element is selected. Otherwise the current element is not selected. Now, if the current value is selected, write out an HTML boolean property "selected". If the current SelectItem.isDisabled() returns true, render "disabled" as the value of the "disabled" attribute. If the value of the <code>escape</code> property is true, use the <code>writeText()</code> method of <code>ResponseWriter</code> to write out the value of the <code>label</code> property. Otherwise, use the <code>write()</code> method of the <code>ResponseWriter</code> to do so. </ul> </ul>

selectManyListbox

jakarta.faces.HtmlSelectManyListbox

jakarta.faces.Listbox

void validate(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, java.lang.Object)

A ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator. validatorMessage false java.lang.String The current value of this component. value false java.lang.Object MethodExpression representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a <code>ValueChangeEvent</code> 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 what the new value is, but this can be useful in cases where a notification is needed that "this value changed". valueChangeListener false

void valueChange(jakarta.faces.event.ValueChangeEvent)

Access key that, when pressed, transfers focus to this element. accesskey false java.lang.String Optional attribute that is a literal string that is the fully qualified class name of a concrete class that implements <code>java.util.Collection</code>, or an EL expression that evaluates to either 1. such a String, or 2. the <code>Class</code> object itself. collectionType false java.lang.String Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). dir false java.lang.String Flag indicating that this element must never receive focus or be included in a subsequent submit. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as disabled="disabled". disabled false java.lang.Boolean CSS style class to apply to the rendered label on disabled options. disabledClass false java.lang.String CSS style class to apply to the rendered label on enabled options. enabledClass false java.lang.String Flag indicating that, if this component is activated by the user, The "no selection option", if any, must be hidden. hideNoSelectionOption false java.lang.Boolean A localized user presentable name for this component. label false java.lang.String Code describing the language used in the generated markup for this component. lang false java.lang.String Javascript code executed when this element loses focus. onblur false java.lang.String Javascript code executed when this element loses focus and its value has been modified since gaining focus. onchange false java.lang.String Javascript code executed when a pointer button is clicked over this element. onclick false java.lang.String Javascript code executed when a pointer button is double clicked over this element. ondblclick false java.lang.String Javascript code executed when this element receives focus. onfocus false java.lang.String Javascript code executed when a key is pressed down over this element. onkeydown false java.lang.String Javascript code executed when a key is pressed and released over this element. onkeypress false java.lang.String Javascript code executed when a key is released over this element. onkeyup false java.lang.String Javascript code executed when a pointer button is pressed down over this element. onmousedown false java.lang.String Javascript code executed when a pointer button is moved within this element. onmousemove false java.lang.String Javascript code executed when a pointer button is moved away from this element. onmouseout false java.lang.String Javascript code executed when a pointer button is moved onto this element. onmouseover false java.lang.String Javascript code executed when a pointer button is released over this element. onmouseup false java.lang.String Flag indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as readonly="readonly". readonly false java.lang.Boolean Number of available options to be shown at all times. If not specified, all available options are shown. size false int CSS style(s) to be applied when this component is rendered. style false 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. styleClass false 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. tabindex false java.lang.String Advisory title information about markup elements generated for this component. title false java.lang.String The ValueExpression linking this component to a property in a backing bean binding false jakarta.faces.component.UIComponent 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.

]]> role false java.lang.String

Render an HTML option list. <a name="decode">Decode Behavior</a> <ul> See the <a href="SelectManyListbox.html">"Decode Behavior for UISelectMany Components"</a> section. </ul> Encode Behavior <ul> Render an HTML "select" element. Render the clientId of the component as the value of the "name" attribute. If the "styleClass" attribute is specified, render its value as the value of the "class" attribute on the "select" element. If the component to be rendered is a UISelectMany, render "multiple" as the value of the "multiple" attribute. Render "1" as the value of the "size" attribute. See the <a href="SelectManyListbox.html">"Rendering the option elements" </a> specification for <code>ListboxRenderer</code> for more detail on how to render the "option" elements in this renderer. </ul>

selectManyMenu

jakarta.faces.HtmlSelectManyMenu

jakarta.faces.Menu

void validate(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, java.lang.Object)

A ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator. validatorMessage false java.lang.String The current value of this component. value false java.lang.Object MethodExpression representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a <code>ValueChangeEvent</code> 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 what the new value is, but this can be useful in cases where a notification is needed that "this value changed". valueChangeListener false

void valueChange(jakarta.faces.event.ValueChangeEvent)

Access key that, when pressed, transfers focus to this element. accesskey false java.lang.String Optional attribute that is a literal string that is the fully qualified class name of a concrete class that implements <code>java.util.Collection</code>, or an EL expression that evaluates to either 1. such a String, or 2. the <code>Class</code> object itself. collectionType false java.lang.String Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). dir false java.lang.String Flag indicating that this element must never receive focus or be included in a subsequent submit. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as disabled="disabled". disabled false java.lang.Boolean CSS style class to apply to the rendered label on disabled options. disabledClass false java.lang.String CSS style class to apply to the rendered label on enabled options. enabledClass false java.lang.String Flag indicating that, if this component is activated by the user, The "no selection option", if any, must be hidden. hideNoSelectionOption false java.lang.Boolean A localized user presentable name for this component. label false java.lang.String Code describing the language used in the generated markup for this component. lang false java.lang.String Javascript code executed when this element loses focus. onblur false java.lang.String Javascript code executed when this element loses focus and its value has been modified since gaining focus. onchange false java.lang.String Javascript code executed when a pointer button is clicked over this element. onclick false java.lang.String Javascript code executed when a pointer button is double clicked over this element. ondblclick false java.lang.String Javascript code executed when this element receives focus. onfocus false java.lang.String Javascript code executed when a key is pressed down over this element. onkeydown false java.lang.String Javascript code executed when a key is pressed and released over this element. onkeypress false java.lang.String Javascript code executed when a key is released over this element. onkeyup false java.lang.String Javascript code executed when a pointer button is pressed down over this element. onmousedown false java.lang.String Javascript code executed when a pointer button is moved within this element. onmousemove false java.lang.String Javascript code executed when a pointer button is moved away from this element. onmouseout false java.lang.String Javascript code executed when a pointer button is moved onto this element. onmouseover false java.lang.String Javascript code executed when a pointer button is released over this element. onmouseup false java.lang.String Flag indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as readonly="readonly". readonly false java.lang.Boolean CSS style(s) to be applied when this component is rendered. style false 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. styleClass false 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. tabindex false java.lang.String Advisory title information about markup elements generated for this component. title false java.lang.String The ValueExpression linking this component to a property in a backing bean binding false jakarta.faces.component.UIComponent 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.

]]> role false java.lang.String

Render an HTML option list. <a name="decode">Decode Behavior</a> <ul> See the <a href="SelectManyListbox.html">"Decode Behavior for UISelectOne Components"</a> section. </ul> Encode Behavior <ul> Render an HTML "select" element. Render the clientId of the component as the value of the "name" attribute. If the "styleClass" attribute is specified, render its value as the value of the "class" attribute on the "select" element. If the component to be rendered is a UISelectMany, render "multiple" as the value of the "multiple" attribute. If the "size" attribute is specified, render its value as the value of the "size" attribute. Otherwise use the number of items as the value of the "size" attribute. See the <a href="SelectManyListbox.html">"Rendering the option elements" </a> specification for <code>ListboxRenderer</code> for more detail on how to render the "option" elements in this renderer. </ul>

selectOneListbox

jakarta.faces.HtmlSelectOneListbox

jakarta.faces.Listbox

void validate(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, java.lang.Object)

A ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator. validatorMessage false java.lang.String The current value of this component. value false java.lang.Object MethodExpression representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a <code>ValueChangeEvent</code> 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 what the new value is, but this can be useful in cases where a notification is needed that "this value changed". valueChangeListener false

void valueChange(jakarta.faces.event.ValueChangeEvent)

Access key that, when pressed, transfers focus to this element. accesskey false java.lang.String Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). dir false java.lang.String Flag indicating that this element must never receive focus or be included in a subsequent submit. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as disabled="disabled". disabled false java.lang.Boolean CSS style class to apply to the rendered label on disabled options. disabledClass false java.lang.String CSS style class to apply to the rendered label on enabled options. enabledClass false java.lang.String Flag indicating that, if this component is activated by the user, The "no selection option", if any, must be hidden. hideNoSelectionOption false java.lang.Boolean A localized user presentable name for this component. label false java.lang.String Code describing the language used in the generated markup for this component. lang false java.lang.String Javascript code executed when this element loses focus. onblur false java.lang.String Javascript code executed when this element loses focus and its value has been modified since gaining focus. onchange false java.lang.String Javascript code executed when a pointer button is clicked over this element. onclick false java.lang.String Javascript code executed when a pointer button is double clicked over this element. ondblclick false java.lang.String Javascript code executed when this element receives focus. onfocus false java.lang.String Javascript code executed when a key is pressed down over this element. onkeydown false java.lang.String Javascript code executed when a key is pressed and released over this element. onkeypress false java.lang.String Javascript code executed when a key is released over this element. onkeyup false java.lang.String Javascript code executed when a pointer button is pressed down over this element. onmousedown false java.lang.String Javascript code executed when a pointer button is moved within this element. onmousemove false java.lang.String Javascript code executed when a pointer button is moved away from this element. onmouseout false java.lang.String Javascript code executed when a pointer button is moved onto this element. onmouseover false java.lang.String Javascript code executed when a pointer button is released over this element. onmouseup false java.lang.String Flag indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as readonly="readonly". readonly false java.lang.Boolean Number of available options to be shown at all times. If not specified, all available options are shown. size false int CSS style(s) to be applied when this component is rendered. style false 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. styleClass false 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. tabindex false java.lang.String Advisory title information about markup elements generated for this component. title false java.lang.String The ValueExpression linking this component to a property in a backing bean binding false jakarta.faces.component.UIComponent 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.

]]> role false java.lang.String

Render an HTML option list. <a name="decode">Decode Behavior</a> <ul> See the <a href="SelectManyListbox.html">"Decode Behavior for UISelectOne Components"</a> section. </ul> Encode Behavior <ul> Render an HTML "select" element. Render the clientId of the component as the value of the "name" attribute. If the "styleClass" attribute is specified, render its value as the value of the "class" attribute on the "select" element. If the component to be rendered is a UISelectMany, render "true" as the value of the "multiple" attribute. Use the number of items as the value of the "size" attribute. See the <a href="SelectManyListbox.html">"Rendering the option elements" </a> specification for <code>ListboxRenderer</code> for more detail on how to render the "option" elements in this renderer. </ul>

selectOneMenu

jakarta.faces.HtmlSelectOneMenu

jakarta.faces.Menu

void validate(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, java.lang.Object)

A ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator. validatorMessage false java.lang.String The current value of this component. value false java.lang.Object MethodExpression representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a <code>ValueChangeEvent</code> 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 what the new value is, but this can be useful in cases where a notification is needed that "this value changed". valueChangeListener false

void valueChange(jakarta.faces.event.ValueChangeEvent)

Access key that, when pressed, transfers focus to this element. accesskey false java.lang.String Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). dir false java.lang.String Flag indicating that this element must never receive focus or be included in a subsequent submit. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as disabled="disabled". disabled false java.lang.Boolean CSS style class to apply to the rendered label on disabled options. disabledClass false java.lang.String CSS style class to apply to the rendered label on enabled options. enabledClass false java.lang.String Flag indicating that, if this component is activated by the user, The "no selection option", if any, must be hidden. hideNoSelectionOption false java.lang.Boolean A localized user presentable name for this component. label false java.lang.String Code describing the language used in the generated markup for this component. lang false java.lang.String Javascript code executed when this element loses focus. onblur false java.lang.String Javascript code executed when this element loses focus and its value has been modified since gaining focus. onchange false java.lang.String Javascript code executed when a pointer button is clicked over this element. onclick false java.lang.String Javascript code executed when a pointer button is double clicked over this element. ondblclick false java.lang.String Javascript code executed when this element receives focus. onfocus false java.lang.String Javascript code executed when a key is pressed down over this element. onkeydown false java.lang.String Javascript code executed when a key is pressed and released over this element. onkeypress false java.lang.String Javascript code executed when a key is released over this element. onkeyup false java.lang.String Javascript code executed when a pointer button is pressed down over this element. onmousedown false java.lang.String Javascript code executed when a pointer button is moved within this element. onmousemove false java.lang.String Javascript code executed when a pointer button is moved away from this element. onmouseout false java.lang.String Javascript code executed when a pointer button is moved onto this element. onmouseover false java.lang.String Javascript code executed when a pointer button is released over this element. onmouseup false java.lang.String Flag indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as readonly="readonly". readonly false java.lang.Boolean CSS style(s) to be applied when this component is rendered. style false 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. styleClass false 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. tabindex false java.lang.String Advisory title information about markup elements generated for this component. title false java.lang.String The ValueExpression linking this component to a property in a backing bean binding false jakarta.faces.component.UIComponent 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.

]]> role false java.lang.String

Render a set of html "input" elements of type "radio".

Decode Behavior

See the "Decode Behavior for UISelectOne Components" section.

Encode Behavior

If the "group" attribute is not specified, render as follows.
- If the "layout" attribute is specified, and its value is "list", render a "ul" element as root element, otherwise render a "table" element.
- As an exception to the general rules about how to handle the "id" attribute, render it as an attribute on the outer root element, the value of which is the clientId of the component per the rules at the beginning of this specification.
- If the "styleClass" attribute is specified, render the value of the "styleClass" attribute as the value of the "class" attribute on the root element.
- If the "style", "border" attributes are specified, pass them thru and render their values as the "style" and "border" attributes on the root element, respectively..
- If the "layout" attribute is specified, and its value is "pageDirection", render the children elements vertically, otherwise horizontally, in the root element.
- If any of the children are an instance of SelectItemGroup, render them as a nested root element.
Each of the SelectItem children are ultimately rendered as follows.
- If the SelectItem.getLabel() is specified, and the group attribute is specified, render as follows.
  - Render a "label" element.
  - Render the "for" attribute of the "label" element whose value is the corresponding "input" element's "id" value.
  - Render any "class" attribute as the "class" attribute on the "label" element.
  - Render the label value from SelectItem.getLabel().
  - Close out the "label" element.
- Render an "input" element of "type" "radio" for each child component.
- Render an "id" attribute on the "input" element. Each "id" value must be unique.
- If the "group" attribute is not specified, render the "name" attribute on the "input" element with the value of the clientId of the component.
- If the "group" attribute is specified, render as follows.
  - Render the "name" attribute on the "input" element with the value of the "group" attribute.
  - If the "styleClass" attribute is specified, render the value of the "styleClass" attribute as the value of the "class" attribute on the "input" element.
  - If the "style" attribute is specified, pass it thru and render its value as the "style" attribute on the "input" element.
- Render the input value from SelectItem.getValue().
- Coerce the select item value to the type of the parent UISelectOne value using the Expression Language coercion rules before comparing the values. If the select item value is equal to the value of the parent UISelectOne, render an appropriate HTML boolean value indicating "checked" for the enclosing "input".
- If the current SelectItem.isDisabled() returns true, render "disabled" as the value of the "disabled" attribute.
- Close out the "input" element.
- If the SelectItem.getLabel() is specified, and the group attribute is not specified, render as follows.
  - Render a "label" element.
  - Render the "for" attribute of the "label" element whose value is the corresponding "input" element's "id" value.
  - Render any "class" attribute as the "class" attribute on the "label" element.
  - Render the label value from SelectItem.getLabel().
  - Close out the "label" element.
See the "Rendering the option elements" specification for ListboxRenderer for more detail on how to render the "option" elements in this renderer.

]]>

selectOneRadio

jakarta.faces.HtmlSelectOneRadio

jakarta.faces.Radio

void validate(jakarta.faces.context.FacesContext, jakarta.faces.component.UIComponent, java.lang.Object)

A ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator. validatorMessage false java.lang.String The current value of this component. value false java.lang.Object MethodExpression representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a <code>ValueChangeEvent</code> 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 what the new value is, but this can be useful in cases where a notification is needed that "this value changed". valueChangeListener false

void valueChange(jakarta.faces.event.ValueChangeEvent)

Access key that, when pressed, transfers focus to this element. accesskey false java.lang.String Width (in pixels) of the border to be drawn around the table containing the options list. This attribute is ignored when the "layout" attribute equals to "list". border false int Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). dir false java.lang.String Flag indicating that this element must never receive focus or be included in a subsequent submit. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as disabled="disabled". disabled false java.lang.Boolean CSS style class to apply to the rendered label on disabled options. disabledClass false java.lang.String CSS style class to apply to the rendered label on enabled options. enabledClass false java.lang.String Flag indicating that, if this component is activated by the user, The "no selection option", if any, must be hidden. hideNoSelectionOption false java.lang.Boolean A localized user presentable name for this component. label false java.lang.String Code describing the language used in the generated markup for this component. lang false java.lang.String Orientation of the options list to be created. Valid values are "pageDirection" (list is laid out vertically), or "lineDirection" (list is laid out horizontally). If not specified, the default value is "lineDirection". layout false java.lang.String Javascript code executed when this element loses focus. onblur false java.lang.String Javascript code executed when this element loses focus and its value has been modified since gaining focus. onchange false java.lang.String Javascript code executed when a pointer button is clicked over this element. onclick false java.lang.String Javascript code executed when a pointer button is double clicked over this element. ondblclick false java.lang.String Javascript code executed when this element receives focus. onfocus false java.lang.String Javascript code executed when a key is pressed down over this element. onkeydown false java.lang.String Javascript code executed when a key is pressed and released over this element. onkeypress false java.lang.String Javascript code executed when a key is released over this element. onkeyup false java.lang.String Javascript code executed when a pointer button is pressed down over this element. onmousedown false java.lang.String Javascript code executed when a pointer button is moved within this element. onmousemove false java.lang.String Javascript code executed when a pointer button is moved away from this element. onmouseout false java.lang.String Javascript code executed when a pointer button is moved onto this element. onmouseover false java.lang.String Javascript code executed when a pointer button is released over this element. onmouseup false java.lang.String Javascript code executed when text within this element is selected by the user. onselect false java.lang.String Flag indicating that this component will prohibit changes by the user. The element may receive focus unless it has also been disabled. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as readonly="readonly". readonly false java.lang.Boolean CSS style(s) to be applied when this component is rendered. style false 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. styleClass false 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. tabindex false java.lang.String Advisory title information about markup elements generated for this component. title false java.lang.String The ValueExpression linking this component to a property in a backing bean binding false jakarta.faces.component.UIComponent 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.

]]> role false java.lang.String

Renders a UIComponent that represents a single column of data within a parent <code>UIData</code> component.

column

jakarta.faces.Column

Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. rendered false java.lang.Boolean The value binding expression linking this component to a property in a backing bean binding false jakarta.faces.component.UIComponent The component identifier for the associated component id false java.lang.String Space-separated list of CSS style class(es) that will be applied to any column footer generated for this table. footerClass false java.lang.String Space-separated list of CSS style class(es) that will be applied to any column header generated for this table. headerClass false java.lang.String Flag indicating that this column is a row header column and therefore cells in this column should be rendered with "th" instead of "td" and must have the 'scope="row"' attribute. rowHeader false java.lang.Boolean

Renders an HTML "input" element of "type" "file". The standard HTML_BASIC RenderKit specifies behavior that assumes Servlet 3.0 or later. Portlet implementations must override this implementation with a semantically equivalent one that functions under the constraints of the Portlet specification.

Decode Behavior

Obtain the Map from the "requestParameterMap" property of the ExternalContext. If the Map contains an entry for the "clientId" of the component, pass the value of the entry to the setSubmittedValue() method of the component, which must be an instance of EditableValueHolder, and return. Otherwise, obtain the "request" property from the ExternalContext and cast it to jakarta.servlet.http.HttpServletRequest. Call getParts() on the httpServletRequest. Iterate over the parts. If the "name" property of the current part is equal to the "clientId", then collect the part. After the iteration, if the multiple attribute is set to true, then pass java.util.Collection<jakarta.servlet.http.Part> to the setSubmittedValue() method of the component, else pass the first item, if any, as jakarta.servlet.http.Part to the setSubmittedValue() method of the component. If an exception is thrown during the iteration, log the exception and continue.

The standard implementation must override the getConvertedValue() so that it filters out from the submittedValue any parts which return null or an empty string on getSubmittedFileName(), or return 0 or less on getSize().

Any exception thrown when interacting with the underlying multi-part API must be wrapped in a FacesException and allowed to reach the ExceptionHandler.

Encode Behavior

Render the clientId of the component as the value of the "name" attribute. Do not render the "value" attribute. If the "styleClass" attribute is specified, render its value as the value of the "class" attribute.

If ProjectStage is not ProjectStage.Production, verify that the enclosing form has an enctype attribute whose value is multipart/form-data. If not, add a FacesMessage for this component's clientId to the FacesContext stating that file upload requires a form with enctype equal to multipart/form-data. If ProjectStage is ProjectStage.Production, do not do this verification.

]]>

inputFile

jakarta.faces.HtmlInputFile

jakarta.faces.File

converter false jakarta.faces.convert.Converter converterMessage false java.lang.String id false java.lang.String immediate false java.lang.Boolean rendered false java.lang.Boolean required false java.lang.Boolean requiredMessage false java.lang.String validator false java.lang.String If the multiple attribute is set to true, then this must be assignable to java.util.Collection<jakarta.servlet.http.Part>, else this must be assignable to jakarta.servlet.http.Part.]]> value false java.lang.Object MethodExpression representing a value change listener method that will be notified when a new value has been set for this input component. The expression must evaluate to a public method that takes a ValueChangeEvent 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 what the new value is, but this can be useful in cases where a notification is needed that "this value changed".

]]> valueChangeListener false java.lang.String Comma separated string of mime types of files to filter in client side file browse dialog. Note: this is not validated in server side. ]]> accept false java.lang.String dir false java.lang.String disabled false java.lang.Boolean label false java.lang.String lang false java.lang.String Flag indicating that this element must allow multiple file selection. A value of false causes no attribute to be rendered, while a value of true causes the attribute to be rendered as multiple="multiple".]]> multiple false boolean onblur false java.lang.String onchange false java.lang.String onclick false java.lang.String ondblclick false java.lang.String onfocus false java.lang.String onkeydown false java.lang.String onkeypress false java.lang.String onkeyup false java.lang.String onmousedown false java.lang.String onmousemove false java.lang.String onmouseout false java.lang.String onmouseover false java.lang.String onmouseup false java.lang.String onselect false java.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.

]]> role false java.lang.String style false java.lang.String styleClass false java.lang.String tabindex false java.lang.String title false java.lang.String The ValueExpression linking this component to a property in a backing bean binding false jakarta.faces.component.UIComponent

Render the markup for a <!DOCTYPE> declaration.

Decode Behavior

No action is required during decode for this renderer.

Encode Behavior

Output an XML Doctype using the provided attributes. Output the literal text <!DOCTYPE. The "rootElement" attribute is required and must be rendered next. If the "public" attribute is defined, render the literal text PUBLIC then render the value of the attribute inside double quotes. If the "system" attribute is defined, render it next, inside double quotes. Close the doctype declaration with the literal text >.

No relocation occurs with the output of this component. It is rendered at whatever position in the view hierarchy it happens to be encountered when traversing the view to render. Therefore, this component must be located in the view hierarchy at the correct location so that the final rendered markup has it in the proper place with respect to the user agent that consumes the rendered markup. In practice this means in front of the <html> or <h:html> element. Furthermore, if multiple <h:doctype> components exist, all of them will be rendered.

If this component is present in a view, any DOCTYPE that would otherwise have been rendered by virtue of being present in the VDL page must be ignored.

]]>

doctype

jakarta.faces.HtmlDoctype

jakarta.faces.Doctype

converter false jakarta.faces.convert.Converter id false java.lang.Boolean value false java.lang.Object Will be output as the public part of the DOCTYPE ]]> public false java.lang.String The root XML element ]]> rootElement false java.lang.String Will be output as the system part of the DOCTYPE ]]> system false java.lang.String The ValueExpression linking this component to a property in a backing bean binding false jakarta.faces.component.UIComponent