Render parameterized text. Obtain the
style, styleClass,
dir, and
lang attributees from this component. If
any are
present, render a "span" element. Output the
styleClass attribute (if present) as the
value of the
class attribute. Output the style
attribute as the value of the style
attribute.
Output the dir and lang
attributes as
pass through attributes. Accrue a list of the values of all child
UIParameter components of this component.
If there
are one or more accumulated parameter values, convert the list of
parameter values to an Object array, call
MessageFormat.format(), passing the
value of this component as the first
argument, and
the array of parameter values as the second argument, and render
the result. Otherwise, render the value of
this
component unmodified.
| Info | Value |
|---|---|
| Component Type | jakarta.faces.HtmlOutputFormat |
| Handler Class | None |
| Renderer Type | jakarta.faces.Format |
| Description | None |
| Name | Required | Type | Description |
|---|---|---|---|
converter | false | jakarta.el.ValueExpression
(must evaluate to jakarta.faces.convert.Converter)
| Converter instance registered with this component. |
id | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| The component identifier for this component. This value must be unique within the closest parent component that is a naming container. |
rendered | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Flag indicating whether or not this component should be rendered (during Render Response Phase), or processed on any subsequent form submit. The default value for this property is true. |
value | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Object)
| The current value of this component. |
dir | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). |
escape | false | jakarta.el.ValueExpression
(must evaluate to java.lang.Boolean)
| Flag indicating that characters that are sensitive in HTML and XML markup must be escaped. This flag is set to "true" by default. |
lang | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Code describing the language used in the generated markup for this component. |
style | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| CSS style(s) to be applied when this component is rendered. |
styleClass | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Space-separated list of CSS style class(es) to be applied when this element is rendered. This value must be passed through as the "class" attribute on generated markup. |
title | false | jakarta.el.ValueExpression
(must evaluate to java.lang.String)
| Advisory title information about markup elements generated for this component. |
binding | false | jakarta.el.ValueExpression
(must evaluate to jakarta.faces.component.UIComponent)
| The ValueExpression linking this component to a property in a backing bean |
role | false | jakarta.el.ValueExpression
(must evaluate to 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. |