Package jakarta.faces.component.html

Class HtmlOutputFormat

java.lang.Object

jakarta.faces.component.UIComponent

jakarta.faces.component.UIComponentBase

jakarta.faces.component.UIOutput

jakarta.faces.component.html.HtmlOutputFormat

All Implemented Interfaces:

PartialStateHolder, StateHolder, TransientStateHolder, ValueHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder, EventListener

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	HtmlOutputFormat.PropertyKeys

Field Summary

Fields

Modifier and Type	Field	Description
static String	COMPONENT_TYPE	The standard component type for this component.

Fields inherited from class jakarta.faces.component.UIOutput

COMPONENT_FAMILY

Fields inherited from class jakarta.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor	Description
HtmlOutputFormat()

Method Summary

Modifier and Type	Method	Description
String	getDir()	Return the value of the dir property.
String	getLang()	Return the value of the lang property.
String	getRole()	Return the value of the role property.
String	getStyle()	Return the value of the style property.
String	getStyleClass()	Return the value of the styleClass property.
String	getTitle()	Return the value of the title property.
boolean	isEscape()	Return the value of the escape property.
void	setDir(String dir)	Set the value of the dir property.
void	setEscape(boolean escape)	Set the value of the escape property.
void	setLang(String lang)	Set the value of the lang property.
void	setRole(String role)	Set the value of the role property.
void	setStyle(String style)	Set the value of the style property.
void	setStyleClass(String styleClass)	Set the value of the styleClass property.
void	setTitle(String title)	Set the value of the title property.

Methods inherited from class jakarta.faces.component.UIOutput

clearInitialState, getConverter, getFamily, getLocalValue, getValue, markInitialState, resetValue, restoreState, saveState, setConverter, setValue

Methods inherited from class jakarta.faces.component.UIComponentBase

addClientBehavior, 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, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class jakarta.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

COMPONENT_TYPE

public static final String COMPONENT_TYPE

The standard component type for this component.

See Also:

Constant Field Values

Constructor Details

HtmlOutputFormat

public HtmlOutputFormat()

Method Details

getDir

public String getDir()

Return the value of the dir property.

Returns:

the property value

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.

setDir

public void setDir(String dir)

Set the value of the dir property.

Parameters:

dir - the new property value

isEscape

public boolean isEscape()

Return the value of the escape property.

Returns:

the property value

Contents: Flag indicating that characters that are sensitive in HTML and XML markup must be escaped. This flag is set to "true" by default.

setEscape

public void setEscape(boolean escape)

Set the value of the escape property.

Parameters:

escape - the new property value

getLang

public String getLang()

Return the value of the lang property.

Returns:

the property value

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

setLang

public void setLang(String lang)

Set the value of the lang property.

Parameters:

lang - the new property value

getRole

public String getRole()

Return the value of the role property.

Returns:

the property value

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.

setRole

public void setRole(String role)

Set the value of the role property.

Parameters:

role - the new property value

getStyle

public String getStyle()

Return the value of the style property.

Returns:

the property value

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

setStyle

public void setStyle(String style)

Set the value of the style property.

Parameters:

style - the new property value

getStyleClass

public String getStyleClass()

Return the value of the styleClass property.

Returns:

the property value

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.

setStyleClass

public void setStyleClass(String styleClass)

Set the value of the styleClass property.

Parameters:

styleClass - the new property value

getTitle

public String getTitle()

Return the value of the title property.

Returns:

the property value

Contents: Advisory title information about markup elements generated for this component.

setTitle

public void setTitle(String title)

Set the value of the title property.

Parameters:

title - the new property value