This tag library implements the standard JSF core tags.
Apache MyFaces HTML
1.2
h
http://java.sun.com/jsf/html
<p>
Creates a UIComponent that represents a single column of data within a parent UIData component.
</p>
<p>
This tag is commonly used as a child of the h:dataTable tag, to represent a column of
data within an html table. It can be decorated with nested "header" and "footer" facets
which cause the output of header and footer rows.
</p>
<p>
The non-facet child components of this column are re-rendered on each table row
to generate the content of the cell. Those child components can reference the "var"
attribute of the containing h:dataTable to generate appropriate output for each row.
</p>column
org.apache.myfaces.taglib.html.HtmlColumnTag
JSP
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
id
false
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
binding
javax.faces.component.UIComponent
A boolean value that indicates whether this component should be rendered.
Default value: true.
rendered
java.lang.Boolean
CSS class to be used for the header.
headerClass
CSS class to be used for the footer.
footerClass
This tag renders as an HTML input element.
Unless otherwise specified, all attributes accept static values
or EL expressions.commandButton
org.apache.myfaces.taglib.html.HtmlCommandButtonTag
JSP
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
id
false
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
binding
javax.faces.component.UIComponent
A boolean value that indicates whether this component should be rendered.
Default value: true.
rendered
java.lang.Boolean
A boolean value that identifies the phase during which action events
should fire. During normal event processing, action methods and
action listener methods are fired during the "invoke application"
phase of request processing. If this attribute is set to "true",
these methods are fired instead at the end of the "apply request
values" phase.
immediate
boolean
The initial value of this component.
value
Specifies the action to take when this command is invoked.
If the value is an expression, it is expected to be a method
binding EL expression that identifies an action method. An action method
accepts no parameters and has a String return value, called the action
outcome, that identifies the next view displayed. The phase that this
event is fired in can be controlled via the immediate attribute.
If the value is a string literal, it is treated as a navigation outcome
for the current view. This is functionally equivalent to a reference to
an action method that returns the string literal.
action
java.lang.Object myMethod()
A method binding EL expression that identifies an action listener method
to be invoked if this component is activated by the user. An action
listener method accepts a parameter of type javax.faces.event.ActionEvent
and returns void. The phase that this event is fired in can be controlled
via the immediate attribute.
actionListener
void myMethod(javax.faces.event.ActionEvent)
CSS styling instructions.
style
The CSS class for this element. Corresponds to the HTML 'class' attribute.
styleClass
The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
dir
The base language of this document.
lang
An advisory title for this element. Often used by the user agent as a tooltip.
title
Script to be invoked when the element is clicked.
onclick
Script to be invoked when the element is double-clicked.
ondblclick
Script to be invoked when the pointing device is pressed over this element.
onmousedown
Script to be invoked when the pointing device is released over this element.
onmouseup
Script to be invoked when the pointing device is moved into this element.
onmouseover
Script to be invoked when the pointing device is moved while it is in this element.
onmousemove
Script to be invoked when the pointing device is moves out of this element.
onmouseout
Script to be invoked when a key is pressed over this element.
onkeypress
Script to be invoked when a key is pressed down over this element.
onkeydown
Script to be invoked when a key is released over this element.
onkeyup
Specifies a script to be invoked when the element loses focus.
onblur
Specifies a script to be invoked when the element receives focus.
onfocus
Specifies a script to be invoked when the element is modified.
onchange
Specifies a script to be invoked when the element is selected.
onselect
Sets the access key for this element.
accesskey
Specifies the position of this element within the tab order of the document.
tabindex
When true, this element cannot receive focus.
disabled
boolean
When true, indicates that this component cannot be modified by the user.
The element may receive focus unless it has also been disabled.
readonly
boolean
A diplay name for this component.
label
Absolute or relative URL of the image
image
Specifies alternative text that can be used by a browser that can't show this element.
alt
A hint to the user agent about the content type of the linked resource.
type
This tag renders as an HTML a element.
Unless otherwise specified, all attributes accept static values
or EL expressions.commandLink
org.apache.myfaces.taglib.html.HtmlCommandLinkTag
JSP
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
id
false
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
binding
javax.faces.component.UIComponent
A boolean value that indicates whether this component should be rendered.
Default value: true.
rendered
java.lang.Boolean
A boolean value that identifies the phase during which action events
should fire. During normal event processing, action methods and
action listener methods are fired during the "invoke application"
phase of request processing. If this attribute is set to "true",
these methods are fired instead at the end of the "apply request
values" phase.
immediate
boolean
The initial value of this component.
value
Specifies the action to take when this command is invoked.
If the value is an expression, it is expected to be a method
binding EL expression that identifies an action method. An action method
accepts no parameters and has a String return value, called the action
outcome, that identifies the next view displayed. The phase that this
event is fired in can be controlled via the immediate attribute.
If the value is a string literal, it is treated as a navigation outcome
for the current view. This is functionally equivalent to a reference to
an action method that returns the string literal.
action
java.lang.Object myMethod()
A method binding EL expression that identifies an action listener method
to be invoked if this component is activated by the user. An action
listener method accepts a parameter of type javax.faces.event.ActionEvent
and returns void. The phase that this event is fired in can be controlled
via the immediate attribute.
actionListener
void myMethod(javax.faces.event.ActionEvent)
CSS styling instructions.
style
The CSS class for this element. Corresponds to the HTML 'class' attribute.
styleClass
The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
dir
The base language of this document.
lang
An advisory title for this element. Often used by the user agent as a tooltip.
title
Script to be invoked when the element is clicked.
onclick
Script to be invoked when the element is double-clicked.
ondblclick
Script to be invoked when the pointing device is pressed over this element.
onmousedown
Script to be invoked when the pointing device is released over this element.
onmouseup
Script to be invoked when the pointing device is moved into this element.
onmouseover
Script to be invoked when the pointing device is moved while it is in this element.
onmousemove
Script to be invoked when the pointing device is moves out of this element.
onmouseout
Script to be invoked when a key is pressed over this element.
onkeypress
Script to be invoked when a key is pressed down over this element.
onkeydown
Script to be invoked when a key is released over this element.
onkeyup
Specifies a script to be invoked when the element loses focus.
onblur
Specifies a script to be invoked when the element receives focus.
onfocus
Sets the access key for this element.
accesskey
Specifies the character encoding of the linked resource.
charset
The position and the shape of the hotspot.
coords
The language code for teh link.
hreflang
When true, this element cannot receive focus.
disabled
boolean
A space-separated list of links defining the relationship from the current document
to the anchor specified by this hyperlink
rel
A space-separated list of Reverselinks.
rev
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
Names the frame that should display content generated by invoking this action.
target
Specifies the position of this element within the tab order of the document.
tabindex
A hint to the user agent about the content type of the linked resource.
type
<p>
This component renders an HTML table element.
</p>
<p>
This component may have nested facets with names "header" and "footer"
to specify header and footer rows.
</p>
<p>
The non-facet children of this component are expected to be
h:column components which describe the columns of the table.
</p>dataTable
org.apache.myfaces.taglib.html.HtmlDataTableTag
JSP
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
id
false
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
binding
javax.faces.component.UIComponent
A boolean value that indicates whether this component should be rendered.
Default value: true.
rendered
java.lang.Boolean
An EL expression that specifies the data model that backs this table. The value can be of any type.
A value of type DataModel is used directly. Array-like parameters of type java.util.List, array of Object,
java.sql.ResultSet, or javax.servlet.jsp.jstl.sql.Result are wrapped in a DataModel.
Other values are wrapped in a DataModel as a single row.
value
Defines the name of the request-scope variable that will hold the current row during iteration. This value must be a static value.
var
false
The number of rows to be displayed. Specify zero for all remaining rows in the table.
rows
int
The index of the first row to be displayed, where 0 is the first row.
first
int
A comma separated list of CSS class names to apply to td elements in
each column. More than one class can be applied to a column by separing the classes
with a space. I there are less classes than the number of columns, apply the same
sequence of classes to the remaining columns. If there are more classes specified
than the number of columns, ignore the last classes
columnClasses
The CSS class to be applied to footer cells.
footerClass
The CSS class to be applied to header cells.
headerClass
A comma separated list of CSS class names to apply to td elements in
each row. If tere are less classes than the number of rows, apply the same
sequence of classes to the remaining rows, so the pattern is repeated.
More than one class can be applied to a row by separing the classes
with a space.
rowClasses
A comma separated list of CSS class names to apply to all captions.
If tere are less classes than the number of rows, apply the same
sequence of classes to the remaining captions, so the pattern is repeated.
More than one class can be applied to a row by separing the classes
with a space.
captionClass
The CSS class to be applied to the Caption.
captionStyle
CSS styling instructions.
style
The CSS class for this element. Corresponds to the HTML 'class' attribute.
styleClass
The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
dir
The base language of this document.
lang
An advisory title for this element. Often used by the user agent as a tooltip.
title
Script to be invoked when the element is clicked.
onclick
Script to be invoked when the element is double-clicked.
ondblclick
Script to be invoked when the pointing device is pressed over this element.
onmousedown
Script to be invoked when the pointing device is released over this element.
onmouseup
Script to be invoked when the pointing device is moved into this element.
onmouseover
Script to be invoked when the pointing device is moved while it is in this element.
onmousemove
Script to be invoked when the pointing device is moves out of this element.
onmouseout
Script to be invoked when a key is pressed over this element.
onkeypress
Script to be invoked when a key is pressed down over this element.
onkeydown
Script to be invoked when a key is released over this element.
onkeyup
Specifies the width of the border of this element, in pixels. Deprecated in HTML 4.01.
border
int
The background color of this element.
bgcolor
Specifies the amount of empty space between the cell border and
its contents. It can be either a pixel length or a percentage.
cellpadding
Specifies the amount of space between the cells of the table.
It can be either a pixel length or a percentage of available
space.
cellspacing
Controls what part of the frame that surrounds a table is
visible. Values include: void, above, below, hsides, lhs,
rhs, vsides, box, and border.
frame
Controls how rules are rendered between cells. Values include:
none, groups, rows, cols, and all.
rules
Provides a summary of the contents of the table, for
accessibility purposes.
summary
Specifies the desired width of the table, as a pixel length or
a percentage of available space.
width
Renders an HTML form element.
Unless otherwise specified, all attributes accept static values
or EL expressions.form
org.apache.myfaces.taglib.html.HtmlFormTag
JSP
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
id
false
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
binding
javax.faces.component.UIComponent
A boolean value that indicates whether this component should be rendered.
Default value: true.
rendered
java.lang.Boolean
Defines a 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
boolean
CSS styling instructions.
style
The CSS class for this element. Corresponds to the HTML 'class' attribute.
styleClass
The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
dir
The base language of this document.
lang
An advisory title for this element. Often used by the user agent as a tooltip.
title
Script to be invoked when the element is clicked.
onclick
Script to be invoked when the element is double-clicked.
ondblclick
Script to be invoked when the pointing device is pressed over this element.
onmousedown
Script to be invoked when the pointing device is released over this element.
onmouseup
Script to be invoked when the pointing device is moved into this element.
onmouseover
Script to be invoked when the pointing device is moved while it is in this element.
onmousemove
Script to be invoked when the pointing device is moves out of this element.
onmouseout
Script to be invoked when a key is pressed over this element.
onkeypress
Script to be invoked when a key is pressed down over this element.
onkeydown
Script to be invoked when a key is released over this element.
onkeyup
Names the frame that should display content generated by invoking this action.
target
Provides a comma-separated list of content types that the
server processing this form can handle.
accept
The list of character encodings accepted by the server for this form.
acceptcharset
The content type used to submit this form to the server.
enctype
Script to be invoked when this form is reset.
onreset
Script to be invoked when this form is submitted.
onsubmit
<p>Renders an HTML img element.</p>
<p>
The value attribute specifies the url of the image to be displayed;
see the documentation for attribute "url" for more details.
</p>graphicImage
org.apache.myfaces.taglib.html.HtmlGraphicImageTag
JSP
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
id
false
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
binding
javax.faces.component.UIComponent
A boolean value that indicates whether this component should be rendered.
Default value: true.
rendered
java.lang.Boolean
The value property of the UIGraphic
value
<p>
The URL of the image. If the URL starts with a '/', it is relative
to the context path of the web application.
</p>
<p>
This attribute is an alias for the "value" property.
</p>
url
CSS styling instructions.
style
The CSS class for this element. Corresponds to the HTML 'class' attribute.
styleClass
The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
dir
The base language of this document.
lang
An advisory title for this element. Often used by the user agent as a tooltip.
title
Script to be invoked when the element is clicked.
onclick
Script to be invoked when the element is double-clicked.
ondblclick
Script to be invoked when the pointing device is pressed over this element.
onmousedown
Script to be invoked when the pointing device is released over this element.
onmouseup
Script to be invoked when the pointing device is moved into this element.
onmouseover
Script to be invoked when the pointing device is moved while it is in this element.
onmousemove
Script to be invoked when the pointing device is moves out of this element.
onmouseout
Script to be invoked when a key is pressed over this element.
onkeypress
Script to be invoked when a key is pressed down over this element.
onkeydown
Script to be invoked when a key is released over this element.
onkeyup
Specifies alternative text that can be used by a browser that can't show this element.
alt
Overrides the natural height of this image, by specifying height in pixels.
height
Overrides the natural width of this image, by specifying width in pixels.
width
A link to a long description of the image.
longdesc
Specifies an image map to use with this image.
usemap
Specifies server-side image map handling for this image.
ismap
boolean
Renders as an HTML input tag with its type set to "hidden".
Unless otherwise specified, all attributes accept static values
or EL expressions.inputHidden
org.apache.myfaces.taglib.html.HtmlInputHiddenTag
JSP
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
id
false
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
binding
javax.faces.component.UIComponent
A boolean value that indicates whether this component should be rendered.
Default value: true.
rendered
java.lang.Boolean
The initial value of this component.
value
An expression that specifies the Converter for this component.
The value can either be a static value (ID) or an EL expression.
When a static id is specified, an instance of the converter type
registered with that id is used. When this is an EL expression,
the result of evaluating the expression must be an object that
implements the Converter interface.
converter
javax.faces.convert.Converter
A boolean value that identifies the phase during which action events
should fire. During normal event processing, action methods and
action listener methods are fired during the "invoke application"
phase of request processing. If this attribute is set to "true",
these methods are fired instead at the end of the "apply request
values" phase.
immediate
boolean
A boolean value that indicates whether a value is required. Default value: false.
required
boolean
Text of the converter message.
converterMessage
Text which will be shown if a required value is not submitted.
requiredMessage
A method which is invoked during the validation phase for this component. It is
expected to check the submitted value for this component, and if not acceptable
then report a validation error for the component.
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
Text which will be shown, if validation fails.
validatorMessage
A method which is invoked during postback processing for the current view if the
submitted value for this component is not equal to the value which the "value" expression
for this component returns. The phase in which this method is invoked can be controlled
via the immediate attribute.
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
Renders as an HTML input tag with its type set to "password".
Unless otherwise specified, all attributes accept static values
or EL expressions.inputSecret
org.apache.myfaces.taglib.html.HtmlInputSecretTag
JSP
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
id
false
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
binding
javax.faces.component.UIComponent
A boolean value that indicates whether this component should be rendered.
Default value: true.
rendered
java.lang.Boolean
The initial value of this component.
value
An expression that specifies the Converter for this component.
The value can either be a static value (ID) or an EL expression.
When a static id is specified, an instance of the converter type
registered with that id is used. When this is an EL expression,
the result of evaluating the expression must be an object that
implements the Converter interface.
converter
javax.faces.convert.Converter
A boolean value that identifies the phase during which action events
should fire. During normal event processing, action methods and
action listener methods are fired during the "invoke application"
phase of request processing. If this attribute is set to "true",
these methods are fired instead at the end of the "apply request
values" phase.
immediate
boolean
A boolean value that indicates whether a value is required. Default value: false.
required
boolean
Text of the converter message.
converterMessage
Text which will be shown if a required value is not submitted.
requiredMessage
A method which is invoked during the validation phase for this component. It is
expected to check the submitted value for this component, and if not acceptable
then report a validation error for the component.
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
Text which will be shown, if validation fails.
validatorMessage
A method which is invoked during postback processing for the current view if the
submitted value for this component is not equal to the value which the "value" expression
for this component returns. The phase in which this method is invoked can be controlled
via the immediate attribute.
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
CSS styling instructions.
style
The CSS class for this element. Corresponds to the HTML 'class' attribute.
styleClass
The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
dir
The base language of this document.
lang
An advisory title for this element. Often used by the user agent as a tooltip.
title
Script to be invoked when the element is clicked.
onclick
Script to be invoked when the element is double-clicked.
ondblclick
Script to be invoked when the pointing device is pressed over this element.
onmousedown
Script to be invoked when the pointing device is released over this element.
onmouseup
Script to be invoked when the pointing device is moved into this element.
onmouseover
Script to be invoked when the pointing device is moved while it is in this element.
onmousemove
Script to be invoked when the pointing device is moves out of this element.
onmouseout
Script to be invoked when a key is pressed over this element.
onkeypress
Script to be invoked when a key is pressed down over this element.
onkeydown
Script to be invoked when a key is released over this element.
onkeyup
Specifies a script to be invoked when the element loses focus.
onblur
Specifies a script to be invoked when the element receives focus.
onfocus
Specifies a script to be invoked when the element is modified.
onchange
Specifies a script to be invoked when the element is selected.
onselect
Sets the access key for this element.
accesskey
Specifies the position of this element within the tab order of the document.
tabindex
When true, this element cannot receive focus.
disabled
boolean
When true, indicates that this component cannot be modified by the user.
The element may receive focus unless it has also been disabled.
readonly
boolean
A diplay name for this component.
label
Specifies alternative text that can be used by a browser that can't show this element.
alt
The initial width of this control, in characters.
size
int
The maximum number of characters allowed to be entered.
maxlength
int
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
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
boolean
Renders a HTML input element.
Unless otherwise specified, all attributes accept static values
or EL expressions.inputText
org.apache.myfaces.taglib.html.HtmlInputTextTag
JSP
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
id
false
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
binding
javax.faces.component.UIComponent
A boolean value that indicates whether this component should be rendered.
Default value: true.
rendered
java.lang.Boolean
The initial value of this component.
value
An expression that specifies the Converter for this component.
The value can either be a static value (ID) or an EL expression.
When a static id is specified, an instance of the converter type
registered with that id is used. When this is an EL expression,
the result of evaluating the expression must be an object that
implements the Converter interface.
converter
javax.faces.convert.Converter
A boolean value that identifies the phase during which action events
should fire. During normal event processing, action methods and
action listener methods are fired during the "invoke application"
phase of request processing. If this attribute is set to "true",
these methods are fired instead at the end of the "apply request
values" phase.
immediate
boolean
A boolean value that indicates whether a value is required. Default value: false.
required
boolean
Text of the converter message.
converterMessage
Text which will be shown if a required value is not submitted.
requiredMessage
A method which is invoked during the validation phase for this component. It is
expected to check the submitted value for this component, and if not acceptable
then report a validation error for the component.
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
Text which will be shown, if validation fails.
validatorMessage
A method which is invoked during postback processing for the current view if the
submitted value for this component is not equal to the value which the "value" expression
for this component returns. The phase in which this method is invoked can be controlled
via the immediate attribute.
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
CSS styling instructions.
style
The CSS class for this element. Corresponds to the HTML 'class' attribute.
styleClass
The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
dir
The base language of this document.
lang
An advisory title for this element. Often used by the user agent as a tooltip.
title
Script to be invoked when the element is clicked.
onclick
Script to be invoked when the element is double-clicked.
ondblclick
Script to be invoked when the pointing device is pressed over this element.
onmousedown
Script to be invoked when the pointing device is released over this element.
onmouseup
Script to be invoked when the pointing device is moved into this element.
onmouseover
Script to be invoked when the pointing device is moved while it is in this element.
onmousemove
Script to be invoked when the pointing device is moves out of this element.
onmouseout
Script to be invoked when a key is pressed over this element.
onkeypress
Script to be invoked when a key is pressed down over this element.
onkeydown
Script to be invoked when a key is released over this element.
onkeyup
Specifies a script to be invoked when the element loses focus.
onblur
Specifies a script to be invoked when the element receives focus.
onfocus
Specifies a script to be invoked when the element is modified.
onchange
Specifies a script to be invoked when the element is selected.
onselect
Sets the access key for this element.
accesskey
Specifies the position of this element within the tab order of the document.
tabindex
When true, this element cannot receive focus.
disabled
boolean
When true, indicates that this component cannot be modified by the user.
The element may receive focus unless it has also been disabled.
readonly
boolean
A diplay name for this component.
label
Specifies alternative text that can be used by a browser that can't show this element.
alt
The initial width of this control, in characters.
size
int
The maximum number of characters allowed to be entered.
maxlength
int
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
Renders a HTML textarea element.
Unless otherwise specified, all attributes accept static values
or EL expressions.inputTextarea
org.apache.myfaces.taglib.html.HtmlInputTextareaTag
JSP
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
id
false
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
binding
javax.faces.component.UIComponent
A boolean value that indicates whether this component should be rendered.
Default value: true.
rendered
java.lang.Boolean
The initial value of this component.
value
An expression that specifies the Converter for this component.
The value can either be a static value (ID) or an EL expression.
When a static id is specified, an instance of the converter type
registered with that id is used. When this is an EL expression,
the result of evaluating the expression must be an object that
implements the Converter interface.
converter
javax.faces.convert.Converter
A boolean value that identifies the phase during which action events
should fire. During normal event processing, action methods and
action listener methods are fired during the "invoke application"
phase of request processing. If this attribute is set to "true",
these methods are fired instead at the end of the "apply request
values" phase.
immediate
boolean
A boolean value that indicates whether a value is required. Default value: false.
required
boolean
Text of the converter message.
converterMessage
Text which will be shown if a required value is not submitted.
requiredMessage
A method which is invoked during the validation phase for this component. It is
expected to check the submitted value for this component, and if not acceptable
then report a validation error for the component.
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
Text which will be shown, if validation fails.
validatorMessage
A method which is invoked during postback processing for the current view if the
submitted value for this component is not equal to the value which the "value" expression
for this component returns. The phase in which this method is invoked can be controlled
via the immediate attribute.
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
CSS styling instructions.
style
The CSS class for this element. Corresponds to the HTML 'class' attribute.
styleClass
The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
dir
The base language of this document.
lang
An advisory title for this element. Often used by the user agent as a tooltip.
title
Script to be invoked when the element is clicked.
onclick
Script to be invoked when the element is double-clicked.
ondblclick
Script to be invoked when the pointing device is pressed over this element.
onmousedown
Script to be invoked when the pointing device is released over this element.
onmouseup
Script to be invoked when the pointing device is moved into this element.
onmouseover
Script to be invoked when the pointing device is moved while it is in this element.
onmousemove
Script to be invoked when the pointing device is moves out of this element.
onmouseout
Script to be invoked when a key is pressed over this element.
onkeypress
Script to be invoked when a key is pressed down over this element.
onkeydown
Script to be invoked when a key is released over this element.
onkeyup
Specifies a script to be invoked when the element loses focus.
onblur
Specifies a script to be invoked when the element receives focus.
onfocus
Specifies a script to be invoked when the element is modified.
onchange
Specifies a script to be invoked when the element is selected.
onselect
Sets the access key for this element.
accesskey
Specifies the position of this element within the tab order of the document.
tabindex
When true, this element cannot receive focus.
disabled
boolean
When true, indicates that this component cannot be modified by the user.
The element may receive focus unless it has also been disabled.
readonly
boolean
A diplay name for this component.
label
The width of this element, in characters.
cols
int
The height of this element, in characters.
rows
int
Renders text displaying information about the first FacesMessage
that is assigned to the component referenced by the "for" attribute.message
org.apache.myfaces.taglib.html.HtmlMessageTag
JSP
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
id
false
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
binding
javax.faces.component.UIComponent
A boolean value that indicates whether this component should be rendered.
Default value: true.
rendered
java.lang.Boolean
The ID of the component whose attached FacesMessage object (if present) should be
diplayed by this component.
for
true
Specifies whether the detailed information from the message should be shown. Default to false.
showDetail
boolean
Specifies whether the summary information from the message should be shown. Defaults to true.
showSummary
boolean
CSS styling instructions.
style
The CSS class for this element. Corresponds to the HTML 'class' attribute.
styleClass
The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
dir
The base language of this document.
lang
An advisory title for this element. Often used by the user agent as a tooltip.
title
CSS class to be used for messages with severity "INFO".
infoClass
CSS style to be used for messages with severity "INFO".
infoStyle
CSS class to be used for messages with severity "WARN".
warnClass
CSS style to be used for messages with severity "WARN".
warnStyle
CSS class to be used for messages with severity "ERROR".
errorClass
CSS style to be used for messages with severity "ERROR".
errorStyle
CSS class to be used for messages with severity "FATAL".
fatalClass
CSS style to be used for messages with severity "FATAL".
fatalStyle
If true, the message summary will be rendered as a tooltip (i.e. HTML title attribute).
tooltip
boolean
Renders all or some FacesMessages depending on the "for" and
"globalOnly" attributes:<br>
<ul>
<li>If globalOnly = true, only global messages, that have no
associated clientId, will be displayed.</li>
<li>else if there is a "for" attribute, only messages that are
assigned to the component referenced by the "for" attribute
are displayed.</li>
<li>else all messages are displayed.</li>
</ul>
Unless otherwise specified, all attributes accept static values
or EL expressions.messages
org.apache.myfaces.taglib.html.HtmlMessagesTag
JSP
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
id
false
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
binding
javax.faces.component.UIComponent
A boolean value that indicates whether this component should be rendered.
Default value: true.
rendered
java.lang.Boolean
Specifies whether only messages (FacesMessage objects) not associated with a
specific component should be displayed, ie whether messages should be ignored
if they are attached to a particular component. Defaults to false.
globalOnly
boolean
Specifies whether the detailed information from the message should be shown. Defaults to false.
showDetail
boolean
Specifies whether the summary information from the message should be shown. Defaults to true.
showSummary
boolean
CSS styling instructions.
style
The CSS class for this element. Corresponds to the HTML 'class' attribute.
styleClass
The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
dir
The base language of this document.
lang
An advisory title for this element. Often used by the user agent as a tooltip.
title
CSS class to be used for messages with severity "INFO".
infoClass
CSS style to be used for messages with severity "INFO".
infoStyle
CSS class to be used for messages with severity "WARN".
warnClass
CSS style to be used for messages with severity "WARN".
warnStyle
CSS class to be used for messages with severity "ERROR".
errorClass
CSS style to be used for messages with severity "ERROR".
errorStyle
CSS class to be used for messages with severity "FATAL".
fatalClass
CSS style to be used for messages with severity "FATAL".
fatalStyle
If true, the message summary will be rendered as a tooltip (i.e. HTML title attribute).
tooltip
boolean
The layout: "table" or "list". Default: list
layout
Renders as text, applying the child f:param values to the value
attribute as a MessageFormat string. If this element has an ID
or CSS style properties, the text is wrapped in a span element.
Unless otherwise specified, all attributes accept static values
or EL expressions.outputFormat
org.apache.myfaces.taglib.html.HtmlOutputFormatTag
JSP
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
id
false
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
binding
javax.faces.component.UIComponent
A boolean value that indicates whether this component should be rendered.
Default value: true.
rendered
java.lang.Boolean
The initial value of this component.
value
An expression that specifies the Converter for this component.
The value can either be a static value (ID) or an EL expression.
When a static id is specified, an instance of the converter type
registered with that id is used. When this is an EL expression,
the result of evaluating the expression must be an object that
implements the Converter interface.
converter
javax.faces.convert.Converter
CSS styling instructions.
style
The CSS class for this element. Corresponds to the HTML 'class' attribute.
styleClass
The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
dir
The base language of this document.
lang
An advisory title for this element. Often used by the user agent as a tooltip.
title
Indicates whether rendered markup should be escaped. Default: true
escape
boolean
Renders a HTML label element.
In addition to the JSF specification, MyFaces allows it to directly
give an output text via the "value" attribute.
Unless otherwise specified, all attributes accept static values
or EL expressions.outputLabel
org.apache.myfaces.taglib.html.HtmlOutputLabelTag
JSP
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
id
false
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
binding
javax.faces.component.UIComponent
A boolean value that indicates whether this component should be rendered.
Default value: true.
rendered
java.lang.Boolean
The initial value of this component.
value
An expression that specifies the Converter for this component.
The value can either be a static value (ID) or an EL expression.
When a static id is specified, an instance of the converter type
registered with that id is used. When this is an EL expression,
the result of evaluating the expression must be an object that
implements the Converter interface.
converter
javax.faces.convert.Converter
CSS styling instructions.
style
The CSS class for this element. Corresponds to the HTML 'class' attribute.
styleClass
The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
dir
The base language of this document.
lang
An advisory title for this element. Often used by the user agent as a tooltip.
title
Script to be invoked when the element is clicked.
onclick
Script to be invoked when the element is double-clicked.
ondblclick
Script to be invoked when the pointing device is pressed over this element.
onmousedown
Script to be invoked when the pointing device is released over this element.
onmouseup
Script to be invoked when the pointing device is moved into this element.
onmouseover
Script to be invoked when the pointing device is moved while it is in this element.
onmousemove
Script to be invoked when the pointing device is moves out of this element.
onmouseout
Script to be invoked when a key is pressed over this element.
onkeypress
Script to be invoked when a key is pressed down over this element.
onkeydown
Script to be invoked when a key is released over this element.
onkeyup
Specifies a script to be invoked when the element loses focus.
onblur
Specifies a script to be invoked when the element receives focus.
onfocus
Indicates whether rendered markup should be escaped. Default: true
escape
boolean
Sets the access key for this element.
accesskey
Specifies the position of this element within the tab order of the document.
tabindex
Client ID the label should be displayed for.
for
Renders a HTML a element. Child f:param elements are added to the href
attribute as query parameters. Other children are rendered as the link text or image.
Unless otherwise specified, all attributes accept static values
or EL expressions.outputLink
org.apache.myfaces.taglib.html.HtmlOutputLinkTag
JSP
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
id
false
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
binding
javax.faces.component.UIComponent
A boolean value that indicates whether this component should be rendered.
Default value: true.
rendered
java.lang.Boolean
The initial value of this component.
value
An expression that specifies the Converter for this component.
The value can either be a static value (ID) or an EL expression.
When a static id is specified, an instance of the converter type
registered with that id is used. When this is an EL expression,
the result of evaluating the expression must be an object that
implements the Converter interface.
converter
javax.faces.convert.Converter
CSS styling instructions.
style
The CSS class for this element. Corresponds to the HTML 'class' attribute.
styleClass
The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
dir
The base language of this document.
lang
An advisory title for this element. Often used by the user agent as a tooltip.
title
Script to be invoked when the element is clicked.
onclick
Script to be invoked when the element is double-clicked.
ondblclick
Script to be invoked when the pointing device is pressed over this element.
onmousedown
Script to be invoked when the pointing device is released over this element.
onmouseup
Script to be invoked when the pointing device is moved into this element.
onmouseover
Script to be invoked when the pointing device is moved while it is in this element.
onmousemove
Script to be invoked when the pointing device is moves out of this element.
onmouseout
Script to be invoked when a key is pressed over this element.
onkeypress
Script to be invoked when a key is pressed down over this element.
onkeydown
Script to be invoked when a key is released over this element.
onkeyup
Specifies a script to be invoked when the element loses focus.
onblur
Specifies a script to be invoked when the element receives focus.
onfocus
Sets the access key for this element.
accesskey
Specifies the character encoding of the linked resource.
charset
The position and the shape of the hotspot.
coords
The language code for teh link.
hreflang
When true, this element cannot receive focus.
disabled
boolean
A space-separated list of links defining the relationship from the current document
to the anchor specified by this hyperlink
rel
A space-separated list of Reverselinks.
rev
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
Names the frame that should display content generated by invoking this action.
target
Specifies the position of this element within the tab order of the document.
tabindex
A hint to the user agent about the content type of the linked resource.
type
Renders the value of the associated UIOutput component. If this
element has an ID or CSS style properties, the text is wrapped in
a span element.
Unless otherwise specified, all attributes accept static values
or EL expressions.outputText
org.apache.myfaces.taglib.html.HtmlOutputTextTag
JSP
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
id
false
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
binding
javax.faces.component.UIComponent
A boolean value that indicates whether this component should be rendered.
Default value: true.
rendered
java.lang.Boolean
The initial value of this component.
value
An expression that specifies the Converter for this component.
The value can either be a static value (ID) or an EL expression.
When a static id is specified, an instance of the converter type
registered with that id is used. When this is an EL expression,
the result of evaluating the expression must be an object that
implements the Converter interface.
converter
javax.faces.convert.Converter
CSS styling instructions.
style
The CSS class for this element. Corresponds to the HTML 'class' attribute.
styleClass
The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
dir
The base language of this document.
lang
An advisory title for this element. Often used by the user agent as a tooltip.
title
Indicates whether rendered markup should be escaped. Default: true
escape
boolean
<p>
This element renders as an HTML table with specified number of columns.
</p>
<p>
Children of this element are rendered as cells in the table, filling
rows from left to right. Facets named "header" and "footer" are optional
and specify the content of the thead and tfoot rows, respectively.
</p>panelGrid
org.apache.myfaces.taglib.html.HtmlPanelGridTag
JSP
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
id
false
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
binding
javax.faces.component.UIComponent
A boolean value that indicates whether this component should be rendered.
Default value: true.
rendered
java.lang.Boolean
CSS styling instructions.
style
The CSS class for this element. Corresponds to the HTML 'class' attribute.
styleClass
The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
dir
The base language of this document.
lang
An advisory title for this element. Often used by the user agent as a tooltip.
title
Script to be invoked when the element is clicked.
onclick
Script to be invoked when the element is double-clicked.
ondblclick
Script to be invoked when the pointing device is pressed over this element.
onmousedown
Script to be invoked when the pointing device is released over this element.
onmouseup
Script to be invoked when the pointing device is moved into this element.
onmouseover
Script to be invoked when the pointing device is moved while it is in this element.
onmousemove
Script to be invoked when the pointing device is moves out of this element.
onmouseout
Script to be invoked when a key is pressed over this element.
onkeypress
Script to be invoked when a key is pressed down over this element.
onkeydown
Script to be invoked when a key is released over this element.
onkeyup
Specifies the width of the border of this element, in pixels. Deprecated in HTML 4.01.
border
int
The background color of this element.
bgcolor
Specifies the amount of empty space between the cell border and
its contents. It can be either a pixel length or a percentage.
cellpadding
Specifies the amount of space between the cells of the table.
It can be either a pixel length or a percentage of available
space.
cellspacing
Controls what part of the frame that surrounds a table is
visible. Values include: void, above, below, hsides, lhs,
rhs, vsides, box, and border.
frame
Controls how rules are rendered between cells. Values include:
none, groups, rows, cols, and all.
rules
Provides a summary of the contents of the table, for
accessibility purposes.
summary
Specifies the desired width of the table, as a pixel length or
a percentage of available space.
width
Specifies the number of columns in the grid.
columns
int
CSS style to be used for the caption.
captionStyle
CSS class to be used for the caption.
captionClass
A comma separated list of CSS class names to apply to td elements in each column.
The first item in the list gets applied to the first column, the second item in
the list gets applied to the second column, etc. After all entries in the list
have been used, the list repeats again.
columnClasses
CSS class to be used for the footer.
footerClass
CSS class to be used for the header.
headerClass
A comma separated list of CSS class names to apply to td elements in each row.
The first item in the list gets applied to the first row, the second item in
the list gets applied to the second row, etc. After all entries in the list
have been used, the list repeats again.
rowClasses
This element is used to group other components where the
specification requires one child element. If any of the HTML or
CSS attributes are set, its content is rendered within a span element.
Unless otherwise specified, all attributes accept static values
or EL expressions.panelGroup
org.apache.myfaces.taglib.html.HtmlPanelGroupTag
JSP
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
id
false
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
binding
javax.faces.component.UIComponent
A boolean value that indicates whether this component should be rendered.
Default value: true.
rendered
java.lang.Boolean
CSS styling instructions.
style
The CSS class for this element. Corresponds to the HTML 'class' attribute.
styleClass
The type of layout markup to use when rendering this group. If the value is "block"
the renderer must produce an HTML "div" element. Otherwise HTML "span" element must be produced.
layout
Allow the user to choose a "true" or "false" value, presented as a
checkbox.
<p>
Renders as an HTML input tag with its type set to "checkbox", and
its name attribute set to the id. The "checked" attribute is rendered
if the value of this component is true.
<p>
Unless otherwise specified, all attributes accept static values
or EL expressions.selectBooleanCheckbox
org.apache.myfaces.taglib.html.HtmlSelectBooleanCheckboxTag
JSP
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
id
false
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
binding
javax.faces.component.UIComponent
A boolean value that indicates whether this component should be rendered.
Default value: true.
rendered
java.lang.Boolean
The initial value of this component.
value
An expression that specifies the Converter for this component.
The value can either be a static value (ID) or an EL expression.
When a static id is specified, an instance of the converter type
registered with that id is used. When this is an EL expression,
the result of evaluating the expression must be an object that
implements the Converter interface.
converter
javax.faces.convert.Converter
A boolean value that identifies the phase during which action events
should fire. During normal event processing, action methods and
action listener methods are fired during the "invoke application"
phase of request processing. If this attribute is set to "true",
these methods are fired instead at the end of the "apply request
values" phase.
immediate
boolean
A boolean value that indicates whether a value is required. Default value: false.
required
boolean
Text of the converter message.
converterMessage
Text which will be shown if a required value is not submitted.
requiredMessage
A method which is invoked during the validation phase for this component. It is
expected to check the submitted value for this component, and if not acceptable
then report a validation error for the component.
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
Text which will be shown, if validation fails.
validatorMessage
A method which is invoked during postback processing for the current view if the
submitted value for this component is not equal to the value which the "value" expression
for this component returns. The phase in which this method is invoked can be controlled
via the immediate attribute.
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
CSS styling instructions.
style
The CSS class for this element. Corresponds to the HTML 'class' attribute.
styleClass
The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
dir
The base language of this document.
lang
An advisory title for this element. Often used by the user agent as a tooltip.
title
Script to be invoked when the element is clicked.
onclick
Script to be invoked when the element is double-clicked.
ondblclick
Script to be invoked when the pointing device is pressed over this element.
onmousedown
Script to be invoked when the pointing device is released over this element.
onmouseup
Script to be invoked when the pointing device is moved into this element.
onmouseover
Script to be invoked when the pointing device is moved while it is in this element.
onmousemove
Script to be invoked when the pointing device is moves out of this element.
onmouseout
Script to be invoked when a key is pressed over this element.
onkeypress
Script to be invoked when a key is pressed down over this element.
onkeydown
Script to be invoked when a key is released over this element.
onkeyup
Specifies a script to be invoked when the element loses focus.
onblur
Specifies a script to be invoked when the element receives focus.
onfocus
Specifies a script to be invoked when the element is modified.
onchange
Specifies a script to be invoked when the element is selected.
onselect
Sets the access key for this element.
accesskey
Specifies the position of this element within the tab order of the document.
tabindex
When true, this element cannot receive focus.
disabled
boolean
When true, indicates that this component cannot be modified by the user.
The element may receive focus unless it has also been disabled.
readonly
boolean
A diplay name for this component.
label
Allow the user to select zero or more items from a set of
available options. This is presented as a table with one cell per
available option; each cell contains a checkbox and the option's
label. The "layout" attribute determines whether the checkboxes
are laid out horizontally or vertically.
<p>
The set of available options is defined by adding child
f:selectItem or f:selectItems components to this component.
<p>
The value attribute must be a value-binding expression to a
property of type List, Object array or primitive array. That
"collection" is expected to contain objects of the same type as
SelectItem.getValue() returns for the child SelectItem objects.
On rendering, any child whose value is in the list will be
selected initially. During the update phase, the property setter
is called to replace the original collection with a completely
new collection object of the appropriate type. The new collection
object contains the value of each child SelectItem object that
is currently selected.
<p>
Unless otherwise specified, all attributes accept static values
or EL expressions.selectManyCheckbox
org.apache.myfaces.taglib.html.HtmlSelectManyCheckboxTag
JSP
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
id
false
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
binding
javax.faces.component.UIComponent
A boolean value that indicates whether this component should be rendered.
Default value: true.
rendered
java.lang.Boolean
The initial value of this component.
value
An expression that specifies the Converter for this component.
The value can either be a static value (ID) or an EL expression.
When a static id is specified, an instance of the converter type
registered with that id is used. When this is an EL expression,
the result of evaluating the expression must be an object that
implements the Converter interface.
converter
javax.faces.convert.Converter
A boolean value that identifies the phase during which action events
should fire. During normal event processing, action methods and
action listener methods are fired during the "invoke application"
phase of request processing. If this attribute is set to "true",
these methods are fired instead at the end of the "apply request
values" phase.
immediate
boolean
A boolean value that indicates whether a value is required. Default value: false.
required
boolean
Text of the converter message.
converterMessage
Text which will be shown if a required value is not submitted.
requiredMessage
A method which is invoked during the validation phase for this component. It is
expected to check the submitted value for this component, and if not acceptable
then report a validation error for the component.
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
Text which will be shown, if validation fails.
validatorMessage
A method which is invoked during postback processing for the current view if the
submitted value for this component is not equal to the value which the "value" expression
for this component returns. The phase in which this method is invoked can be controlled
via the immediate attribute.
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
CSS styling instructions.
style
The CSS class for this element. Corresponds to the HTML 'class' attribute.
styleClass
The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
dir
The base language of this document.
lang
An advisory title for this element. Often used by the user agent as a tooltip.
title
Script to be invoked when the element is clicked.
onclick
Script to be invoked when the element is double-clicked.
ondblclick
Script to be invoked when the pointing device is pressed over this element.
onmousedown
Script to be invoked when the pointing device is released over this element.
onmouseup
Script to be invoked when the pointing device is moved into this element.
onmouseover
Script to be invoked when the pointing device is moved while it is in this element.
onmousemove
Script to be invoked when the pointing device is moves out of this element.
onmouseout
Script to be invoked when a key is pressed over this element.
onkeypress
Script to be invoked when a key is pressed down over this element.
onkeydown
Script to be invoked when a key is released over this element.
onkeyup
Specifies a script to be invoked when the element loses focus.
onblur
Specifies a script to be invoked when the element receives focus.
onfocus
Specifies a script to be invoked when the element is modified.
onchange
Specifies a script to be invoked when the element is selected.
onselect
Sets the access key for this element.
accesskey
Specifies the position of this element within the tab order of the document.
tabindex
When true, this element cannot receive focus.
disabled
boolean
When true, indicates that this component cannot be modified by the user.
The element may receive focus unless it has also been disabled.
readonly
boolean
A diplay name for this component.
label
Specifies the width of the border of this element, in pixels. Deprecated in HTML 4.01.
border
int
CSS class to be used for the enabled items.
enabledClass
CSS class to be used for the disabled items.
disabledClass
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
Allow the user to select zero or more items from a set of
available options. This is presented as a listbox which allows
multiple rows in the list to be selected simultaneously.
<p>
The set of available options is defined by adding child
f:selectItem or f:selectItems components to this component.
<p>
The list is rendered as an HTML select element. The "multiple"
attribute is set on the element and the size attribute is set to
the provided value, defaulting to the number of items in the list
if no value is provided. If the size is set to 1, then a
"drop-down" list (aka "combo-box") is presented, though if this is
the intention then a selectManyMenu should be used instead.
<p>
The value attribute must be a value-binding expression to a
property of type List, Object array or primitive array. That
"collection" is expected to contain objects of the same type as
SelectItem.getValue() returns for the child SelectItem objects.
On rendering, any child whose value is in the list will be
selected initially. During the update phase, the property is set
to contain a "collection" of values for those child SelectItem
objects that are currently selected.
<p>
Unless otherwise specified, all attributes accept static values
or EL expressions.selectManyListbox
org.apache.myfaces.taglib.html.HtmlSelectManyListboxTag
JSP
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
id
false
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
binding
javax.faces.component.UIComponent
A boolean value that indicates whether this component should be rendered.
Default value: true.
rendered
java.lang.Boolean
The initial value of this component.
value
An expression that specifies the Converter for this component.
The value can either be a static value (ID) or an EL expression.
When a static id is specified, an instance of the converter type
registered with that id is used. When this is an EL expression,
the result of evaluating the expression must be an object that
implements the Converter interface.
converter
javax.faces.convert.Converter
A boolean value that identifies the phase during which action events
should fire. During normal event processing, action methods and
action listener methods are fired during the "invoke application"
phase of request processing. If this attribute is set to "true",
these methods are fired instead at the end of the "apply request
values" phase.
immediate
boolean
A boolean value that indicates whether a value is required. Default value: false.
required
boolean
Text of the converter message.
converterMessage
Text which will be shown if a required value is not submitted.
requiredMessage
A method which is invoked during the validation phase for this component. It is
expected to check the submitted value for this component, and if not acceptable
then report a validation error for the component.
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
Text which will be shown, if validation fails.
validatorMessage
A method which is invoked during postback processing for the current view if the
submitted value for this component is not equal to the value which the "value" expression
for this component returns. The phase in which this method is invoked can be controlled
via the immediate attribute.
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
CSS styling instructions.
style
The CSS class for this element. Corresponds to the HTML 'class' attribute.
styleClass
The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
dir
The base language of this document.
lang
An advisory title for this element. Often used by the user agent as a tooltip.
title
Script to be invoked when the element is clicked.
onclick
Script to be invoked when the element is double-clicked.
ondblclick
Script to be invoked when the pointing device is pressed over this element.
onmousedown
Script to be invoked when the pointing device is released over this element.
onmouseup
Script to be invoked when the pointing device is moved into this element.
onmouseover
Script to be invoked when the pointing device is moved while it is in this element.
onmousemove
Script to be invoked when the pointing device is moves out of this element.
onmouseout
Script to be invoked when a key is pressed over this element.
onkeypress
Script to be invoked when a key is pressed down over this element.
onkeydown
Script to be invoked when a key is released over this element.
onkeyup
Specifies a script to be invoked when the element loses focus.
onblur
Specifies a script to be invoked when the element receives focus.
onfocus
Specifies a script to be invoked when the element is modified.
onchange
Specifies a script to be invoked when the element is selected.
onselect
Sets the access key for this element.
accesskey
Specifies the position of this element within the tab order of the document.
tabindex
When true, this element cannot receive focus.
disabled
boolean
When true, indicates that this component cannot be modified by the user.
The element may receive focus unless it has also been disabled.
readonly
boolean
A diplay name for this component.
label
CSS class to be used for the enabled items.
enabledClass
CSS class to be used for the disabled items.
disabledClass
The initial width of this control, in characters.
size
int
Allow the user to select zero or more items from a set of available
options. This is presented as a drop-down "combo-box" which allows
multiple rows in the list to be selected simultaneously.
<p>
The set of available options is defined by adding child
f:selectItem or f:selectItems components to this component.
<p>
Renders as an HTML select element, with the choices made up of
child f:selectItem or f:selectItems elements. The multiple
attribute is set and the size attribute is set to 1.
<p>
The value attribute must be a value-binding expression to a
property of type List, Object array or primitive array. That
"collection" is expected to contain objects of the same type as
SelectItem.getValue() returns for the child SelectItem objects.
On rendering, any child whose value is in the list will be
selected initially. During the update phase, the property is set
to contain a "collection" of values for those child SelectItem
objects that are currently selected.
<p>
Unless otherwise specified, all attributes accept static values
or EL expressions.selectManyMenu
org.apache.myfaces.taglib.html.HtmlSelectManyMenuTag
JSP
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
id
false
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
binding
javax.faces.component.UIComponent
A boolean value that indicates whether this component should be rendered.
Default value: true.
rendered
java.lang.Boolean
The initial value of this component.
value
An expression that specifies the Converter for this component.
The value can either be a static value (ID) or an EL expression.
When a static id is specified, an instance of the converter type
registered with that id is used. When this is an EL expression,
the result of evaluating the expression must be an object that
implements the Converter interface.
converter
javax.faces.convert.Converter
A boolean value that identifies the phase during which action events
should fire. During normal event processing, action methods and
action listener methods are fired during the "invoke application"
phase of request processing. If this attribute is set to "true",
these methods are fired instead at the end of the "apply request
values" phase.
immediate
boolean
A boolean value that indicates whether a value is required. Default value: false.
required
boolean
Text of the converter message.
converterMessage
Text which will be shown if a required value is not submitted.
requiredMessage
A method which is invoked during the validation phase for this component. It is
expected to check the submitted value for this component, and if not acceptable
then report a validation error for the component.
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
Text which will be shown, if validation fails.
validatorMessage
A method which is invoked during postback processing for the current view if the
submitted value for this component is not equal to the value which the "value" expression
for this component returns. The phase in which this method is invoked can be controlled
via the immediate attribute.
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
CSS styling instructions.
style
The CSS class for this element. Corresponds to the HTML 'class' attribute.
styleClass
The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
dir
The base language of this document.
lang
An advisory title for this element. Often used by the user agent as a tooltip.
title
Script to be invoked when the element is clicked.
onclick
Script to be invoked when the element is double-clicked.
ondblclick
Script to be invoked when the pointing device is pressed over this element.
onmousedown
Script to be invoked when the pointing device is released over this element.
onmouseup
Script to be invoked when the pointing device is moved into this element.
onmouseover
Script to be invoked when the pointing device is moved while it is in this element.
onmousemove
Script to be invoked when the pointing device is moves out of this element.
onmouseout
Script to be invoked when a key is pressed over this element.
onkeypress
Script to be invoked when a key is pressed down over this element.
onkeydown
Script to be invoked when a key is released over this element.
onkeyup
Specifies a script to be invoked when the element loses focus.
onblur
Specifies a script to be invoked when the element receives focus.
onfocus
Specifies a script to be invoked when the element is modified.
onchange
Specifies a script to be invoked when the element is selected.
onselect
Sets the access key for this element.
accesskey
Specifies the position of this element within the tab order of the document.
tabindex
When true, this element cannot receive focus.
disabled
boolean
When true, indicates that this component cannot be modified by the user.
The element may receive focus unless it has also been disabled.
readonly
boolean
A diplay name for this component.
label
CSS class to be used for the enabled items.
enabledClass
CSS class to be used for the disabled items.
disabledClass
Allow the user to choose one option from a set of options.
<p>
Rendered as a listbox with the MULTIPLE attribute set to false.
<p>
The available choices are defined via child f:selectItem or
f:selectItems elements. The size of the listbox defaults to the
number of available choices; if size is explicitly set to a
smaller value, then scrollbars will be rendered. If size is set
to 1 then a "drop-down menu" (aka "combo-box") is rendered, though
if this is the intent then selectOneMenu should be used instead.
<p>
The value attribute of this component is read to determine
which of the available options is initially selected; its value
should match the "value" property of one of the child SelectItem
objects.
<p>
On submit of the enclosing form, the value attribute's bound
property is updated to contain the "value" property from the
chosen SelectItem.
<p>
Unless otherwise specified, all attributes accept static values
or EL expressions.selectOneListbox
org.apache.myfaces.taglib.html.HtmlSelectOneListboxTag
JSP
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
id
false
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
binding
javax.faces.component.UIComponent
A boolean value that indicates whether this component should be rendered.
Default value: true.
rendered
java.lang.Boolean
The initial value of this component.
value
An expression that specifies the Converter for this component.
The value can either be a static value (ID) or an EL expression.
When a static id is specified, an instance of the converter type
registered with that id is used. When this is an EL expression,
the result of evaluating the expression must be an object that
implements the Converter interface.
converter
javax.faces.convert.Converter
A boolean value that identifies the phase during which action events
should fire. During normal event processing, action methods and
action listener methods are fired during the "invoke application"
phase of request processing. If this attribute is set to "true",
these methods are fired instead at the end of the "apply request
values" phase.
immediate
boolean
A boolean value that indicates whether a value is required. Default value: false.
required
boolean
Text of the converter message.
converterMessage
Text which will be shown if a required value is not submitted.
requiredMessage
A method which is invoked during the validation phase for this component. It is
expected to check the submitted value for this component, and if not acceptable
then report a validation error for the component.
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
Text which will be shown, if validation fails.
validatorMessage
A method which is invoked during postback processing for the current view if the
submitted value for this component is not equal to the value which the "value" expression
for this component returns. The phase in which this method is invoked can be controlled
via the immediate attribute.
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
CSS styling instructions.
style
The CSS class for this element. Corresponds to the HTML 'class' attribute.
styleClass
The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
dir
The base language of this document.
lang
An advisory title for this element. Often used by the user agent as a tooltip.
title
Script to be invoked when the element is clicked.
onclick
Script to be invoked when the element is double-clicked.
ondblclick
Script to be invoked when the pointing device is pressed over this element.
onmousedown
Script to be invoked when the pointing device is released over this element.
onmouseup
Script to be invoked when the pointing device is moved into this element.
onmouseover
Script to be invoked when the pointing device is moved while it is in this element.
onmousemove
Script to be invoked when the pointing device is moves out of this element.
onmouseout
Script to be invoked when a key is pressed over this element.
onkeypress
Script to be invoked when a key is pressed down over this element.
onkeydown
Script to be invoked when a key is released over this element.
onkeyup
Specifies a script to be invoked when the element loses focus.
onblur
Specifies a script to be invoked when the element receives focus.
onfocus
Specifies a script to be invoked when the element is modified.
onchange
Specifies a script to be invoked when the element is selected.
onselect
Sets the access key for this element.
accesskey
Specifies the position of this element within the tab order of the document.
tabindex
When true, this element cannot receive focus.
disabled
boolean
When true, indicates that this component cannot be modified by the user.
The element may receive focus unless it has also been disabled.
readonly
boolean
A diplay name for this component.
label
CSS class to be used for the enabled items.
enabledClass
CSS class to be used for the disabled items.
disabledClass
The initial width of this control, in characters.
size
int
Allow the user to choose one option from a set of options.
<p>
Renders a drop-down menu (aka "combo-box") containing a set of
choices, of which only one can be chosen at a time. The available
choices are defined via child f:selectItem or f:selectItems
elements.
<p>
The value attribute of this component is read to determine
which of the available options is initially selected; its value
should match the "value" property of one of the child SelectItem
objects.
<p>
On submit of the enclosing form, the value attribute's bound property
is updated to contain the "value" property from the chosen SelectItem.
<p>
Unless otherwise specified, all attributes accept static values
or EL expressions.selectOneMenu
org.apache.myfaces.taglib.html.HtmlSelectOneMenuTag
JSP
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
id
false
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
binding
javax.faces.component.UIComponent
A boolean value that indicates whether this component should be rendered.
Default value: true.
rendered
java.lang.Boolean
The initial value of this component.
value
An expression that specifies the Converter for this component.
The value can either be a static value (ID) or an EL expression.
When a static id is specified, an instance of the converter type
registered with that id is used. When this is an EL expression,
the result of evaluating the expression must be an object that
implements the Converter interface.
converter
javax.faces.convert.Converter
A boolean value that identifies the phase during which action events
should fire. During normal event processing, action methods and
action listener methods are fired during the "invoke application"
phase of request processing. If this attribute is set to "true",
these methods are fired instead at the end of the "apply request
values" phase.
immediate
boolean
A boolean value that indicates whether a value is required. Default value: false.
required
boolean
Text of the converter message.
converterMessage
Text which will be shown if a required value is not submitted.
requiredMessage
A method which is invoked during the validation phase for this component. It is
expected to check the submitted value for this component, and if not acceptable
then report a validation error for the component.
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
Text which will be shown, if validation fails.
validatorMessage
A method which is invoked during postback processing for the current view if the
submitted value for this component is not equal to the value which the "value" expression
for this component returns. The phase in which this method is invoked can be controlled
via the immediate attribute.
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
CSS styling instructions.
style
The CSS class for this element. Corresponds to the HTML 'class' attribute.
styleClass
The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
dir
The base language of this document.
lang
An advisory title for this element. Often used by the user agent as a tooltip.
title
Script to be invoked when the element is clicked.
onclick
Script to be invoked when the element is double-clicked.
ondblclick
Script to be invoked when the pointing device is pressed over this element.
onmousedown
Script to be invoked when the pointing device is released over this element.
onmouseup
Script to be invoked when the pointing device is moved into this element.
onmouseover
Script to be invoked when the pointing device is moved while it is in this element.
onmousemove
Script to be invoked when the pointing device is moves out of this element.
onmouseout
Script to be invoked when a key is pressed over this element.
onkeypress
Script to be invoked when a key is pressed down over this element.
onkeydown
Script to be invoked when a key is released over this element.
onkeyup
Specifies a script to be invoked when the element loses focus.
onblur
Specifies a script to be invoked when the element receives focus.
onfocus
Specifies a script to be invoked when the element is modified.
onchange
Specifies a script to be invoked when the element is selected.
onselect
Sets the access key for this element.
accesskey
Specifies the position of this element within the tab order of the document.
tabindex
When true, this element cannot receive focus.
disabled
boolean
When true, indicates that this component cannot be modified by the user.
The element may receive focus unless it has also been disabled.
readonly
boolean
A diplay name for this component.
label
CSS class to be used for the enabled items.
enabledClass
CSS class to be used for the disabled items.
disabledClass
Allow the user to choose one option from a set of options.
<p>
Renders as an HTML table element, containing an input element for
each child f:selectItem or f:selectItems elements. The input
elements are rendered as type radio.
<p>
The value attribute of this component is read to determine
which of the available options is initially selected; its value should
match the "value" property of one of the child SelectItem objects.
<p>
On submit of the enclosing form, the value attribute's bound property
is updated to contain the "value" property from the chosen SelectItem.
<p>
Unless otherwise specified, all attributes accept static values
or EL expressions.selectOneRadio
org.apache.myfaces.taglib.html.HtmlSelectOneRadioTag
JSP
The developer-assigned ID of this component. The ID must be unique
within the scope of the tag's enclosing naming container (e.g.
h:form or f:subview). This value must be a static value.
id
false
Identifies a backing bean property (of type UIComponent or appropriate
subclass) to bind to this component instance. This value must be an
EL expression.
binding
javax.faces.component.UIComponent
A boolean value that indicates whether this component should be rendered.
Default value: true.
rendered
java.lang.Boolean
The initial value of this component.
value
An expression that specifies the Converter for this component.
The value can either be a static value (ID) or an EL expression.
When a static id is specified, an instance of the converter type
registered with that id is used. When this is an EL expression,
the result of evaluating the expression must be an object that
implements the Converter interface.
converter
javax.faces.convert.Converter
A boolean value that identifies the phase during which action events
should fire. During normal event processing, action methods and
action listener methods are fired during the "invoke application"
phase of request processing. If this attribute is set to "true",
these methods are fired instead at the end of the "apply request
values" phase.
immediate
boolean
A boolean value that indicates whether a value is required. Default value: false.
required
boolean
Text of the converter message.
converterMessage
Text which will be shown if a required value is not submitted.
requiredMessage
A method which is invoked during the validation phase for this component. It is
expected to check the submitted value for this component, and if not acceptable
then report a validation error for the component.
validator
void myMethod(javax.faces.context.FacesContext, javax.faces.component.UIComponent, java.lang.Object)
Text which will be shown, if validation fails.
validatorMessage
A method which is invoked during postback processing for the current view if the
submitted value for this component is not equal to the value which the "value" expression
for this component returns. The phase in which this method is invoked can be controlled
via the immediate attribute.
valueChangeListener
void myMethod(javax.faces.event.ValueChangeEvent)
CSS styling instructions.
style
The CSS class for this element. Corresponds to the HTML 'class' attribute.
styleClass
The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
dir
The base language of this document.
lang
An advisory title for this element. Often used by the user agent as a tooltip.
title
Script to be invoked when the element is clicked.
onclick
Script to be invoked when the element is double-clicked.
ondblclick
Script to be invoked when the pointing device is pressed over this element.
onmousedown
Script to be invoked when the pointing device is released over this element.
onmouseup
Script to be invoked when the pointing device is moved into this element.
onmouseover
Script to be invoked when the pointing device is moved while it is in this element.
onmousemove
Script to be invoked when the pointing device is moves out of this element.
onmouseout
Script to be invoked when a key is pressed over this element.
onkeypress
Script to be invoked when a key is pressed down over this element.
onkeydown
Script to be invoked when a key is released over this element.
onkeyup
Specifies a script to be invoked when the element loses focus.
onblur
Specifies a script to be invoked when the element receives focus.
onfocus
Specifies a script to be invoked when the element is modified.
onchange
Specifies a script to be invoked when the element is selected.
onselect
Sets the access key for this element.
accesskey
Specifies the position of this element within the tab order of the document.
tabindex
When true, this element cannot receive focus.
disabled
boolean
When true, indicates that this component cannot be modified by the user.
The element may receive focus unless it has also been disabled.
readonly
boolean
A diplay name for this component.
label
CSS class to be used for the enabled items.
enabledClass
CSS class to be used for the disabled items.
disabledClass
Specifies the width of the border of this element, in pixels. Deprecated in HTML 4.01.
border
int
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