public class HtmlOutputFormat extends UIOutput
Represents a component that looks up a localized message in a resource bundle, optionally uses it as a
MessageFormat pattern string and substitutes in parameter values from nested UIParameter
components, and renders the result. If the "dir" or "lang" attributes are present, render a span element
and pass them through as attributes on the span.
By default, the rendererType property must be set to "jakarta.faces.Format". This value can
be changed by calling the setRendererType() method.
| Modifier and Type | Class and Description |
|---|---|
protected static class |
HtmlOutputFormat.PropertyKeys
The property keys.
|
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
COMPONENT_TYPE
The standard component type for this component.
|
COMPONENT_FAMILYATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY| Constructor and Description |
|---|
HtmlOutputFormat() |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getDir()
Return the value of the
dir property. |
java.lang.String |
getLang()
Return the value of the
lang property. |
java.lang.String |
getRole()
Return the value of the
role property. |
java.lang.String |
getStyle()
Return the value of the
style property. |
java.lang.String |
getStyleClass()
Return the value of the
styleClass property. |
java.lang.String |
getTitle()
Return the value of the
title property. |
boolean |
isEscape()
Return the value of the
escape property. |
void |
setDir(java.lang.String dir)
Set the value of the
dir property. |
void |
setEscape(boolean escape)
Set the value of the
escape property. |
void |
setLang(java.lang.String lang)
Set the value of the
lang property. |
void |
setRole(java.lang.String role)
Set the value of the
role property. |
void |
setStyle(java.lang.String style)
Set the value of the
style property. |
void |
setStyleClass(java.lang.String styleClass)
Set the value of the
styleClass property. |
void |
setTitle(java.lang.String title)
Set the value of the
title property. |
clearInitialState, getConverter, getFamily, getLocalValue, getValue, markInitialState, resetValue, restoreState, saveState, setConverter, setValueaddClientBehavior, addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTreepublic static final java.lang.String COMPONENT_TYPE
The standard component type for this component.
public java.lang.String getDir()
Return the value of the dir property.
Contents: Direction indication for text that does not inherit directionality. Valid values are "LTR" (left-to-right) and "RTL" (right-to-left). These attributes are case sensitive when rendering to XHTML, so care must be taken to have the correct case.
public void setDir(java.lang.String dir)
Set the value of the dir property.
dir - the new property valuepublic boolean isEscape()
Return the value of the escape property.
Contents: Flag indicating that characters that are sensitive in HTML and XML markup must be escaped. This flag is set to "true" by default.
public void setEscape(boolean escape)
Set the value of the escape property.
escape - the new property valuepublic java.lang.String getLang()
Return the value of the lang property.
Contents: Code describing the language used in the generated markup for this component.
public void setLang(java.lang.String lang)
Set the value of the lang property.
lang - the new property valuepublic java.lang.String getRole()
Return the value of the role property.
Contents:
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.
public void setRole(java.lang.String role)
Set the value of the role property.
role - the new property valuepublic java.lang.String getStyle()
Return the value of the style property.
Contents: CSS style(s) to be applied when this component is rendered.
public void setStyle(java.lang.String style)
Set the value of the style property.
style - the new property valuepublic java.lang.String getStyleClass()
Return the value of the styleClass property.
Contents: 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.
public void setStyleClass(java.lang.String styleClass)
Set the value of the styleClass property.
styleClass - the new property valuepublic java.lang.String getTitle()
Return the value of the title property.
Contents: Advisory title information about markup elements generated for this component.
public void setTitle(java.lang.String title)
Set the value of the title property.
title - the new property value