public class HtmlMessages extends UIMessages
By default, the rendererType
property must be set to "jakarta.faces.Messages
". This value
can be changed by calling the setRendererType()
method.
Modifier and Type | Class and Description |
---|---|
protected static class |
HtmlMessages.PropertyKeys |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPONENT_TYPE
The standard component type for this component.
|
COMPONENT_FAMILY
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 and Description |
---|
HtmlMessages() |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDir()
Return the value of the
dir property. |
java.lang.String |
getErrorClass()
Return the value of the
errorClass property. |
java.lang.String |
getErrorStyle()
Return the value of the
errorStyle property. |
java.lang.String |
getFatalClass()
Return the value of the
fatalClass property. |
java.lang.String |
getFatalStyle()
Return the value of the
fatalStyle property. |
java.lang.String |
getInfoClass()
Return the value of the
infoClass property. |
java.lang.String |
getInfoStyle()
Return the value of the
infoStyle property. |
java.lang.String |
getLang()
Return the value of the
lang property. |
java.lang.String |
getLayout()
Return the value of the
layout 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. |
java.lang.String |
getWarnClass()
Return the value of the
warnClass property. |
java.lang.String |
getWarnStyle()
Return the value of the
warnStyle property. |
boolean |
isTooltip()
Return the value of the
tooltip property. |
void |
setDir(java.lang.String dir)
Set the value of the
dir property. |
void |
setErrorClass(java.lang.String errorClass)
Set the value of the
errorClass property. |
void |
setErrorStyle(java.lang.String errorStyle)
Set the value of the
errorStyle property. |
void |
setFatalClass(java.lang.String fatalClass)
Set the value of the
fatalClass property. |
void |
setFatalStyle(java.lang.String fatalStyle)
Set the value of the
fatalStyle property. |
void |
setInfoClass(java.lang.String infoClass)
Set the value of the
infoClass property. |
void |
setInfoStyle(java.lang.String infoStyle)
Set the value of the
infoStyle property. |
void |
setLang(java.lang.String lang)
Set the value of the
lang property. |
void |
setLayout(java.lang.String layout)
Set the value of the
layout 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. |
void |
setTooltip(boolean tooltip)
Set the value of the
tooltip property. |
void |
setWarnClass(java.lang.String warnClass)
Set the value of the
warnClass property. |
void |
setWarnStyle(java.lang.String warnStyle)
Set the value of the
warnStyle property. |
getFamily, getFor, isGlobalOnly, isRedisplay, isShowDetail, isShowSummary, setFor, setGlobalOnly, setRedisplay, setShowDetail, setShowSummary
addClientBehavior, addFacesListener, broadcast, clearInitialState, 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, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent
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
public 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 java.lang.String getErrorClass()
Return the value of the errorClass
property.
Contents: CSS style class to apply to any message with a severity class of "ERROR".
public void setErrorClass(java.lang.String errorClass)
Set the value of the errorClass
property.
errorClass
- the new property valuepublic java.lang.String getErrorStyle()
Return the value of the errorStyle
property.
Contents: CSS style(s) to apply to any message with a severity class of "ERROR".
public void setErrorStyle(java.lang.String errorStyle)
Set the value of the errorStyle
property.
errorStyle
- the new property valuepublic java.lang.String getFatalClass()
Return the value of the fatalClass
property.
Contents: CSS style class to apply to any message with a severity class of "FATAL".
public void setFatalClass(java.lang.String fatalClass)
Set the value of the fatalClass
property.
fatalClass
- the new property valuepublic java.lang.String getFatalStyle()
Return the value of the fatalStyle
property.
Contents: CSS style(s) to apply to any message with a severity class of "FATAL".
public void setFatalStyle(java.lang.String fatalStyle)
Set the value of the fatalStyle
property.
fatalStyle
- the new property valuepublic java.lang.String getInfoClass()
Return the value of the infoClass
property.
Contents: CSS style class to apply to any message with a severity class of "INFO".
public void setInfoClass(java.lang.String infoClass)
Set the value of the infoClass
property.
infoClass
- the new property valuepublic java.lang.String getInfoStyle()
Return the value of the infoStyle
property.
Contents: CSS style(s) to apply to any message with a severity class of "INFO".
public void setInfoStyle(java.lang.String infoStyle)
Set the value of the infoStyle
property.
infoStyle
- 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 getLayout()
Return the value of the layout
property.
Contents: The type of layout markup to use when rendering error messages. Valid values are "table" (an HTML table) and "list" (an HTML list). If not specified, the default value is "list".
public void setLayout(java.lang.String layout)
Set the value of the layout
property.
layout
- 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 valuepublic boolean isTooltip()
Return the value of the tooltip
property.
Contents: Flag indicating whether the detail portion of the message should be displayed as a tooltip.
public void setTooltip(boolean tooltip)
Set the value of the tooltip
property.
tooltip
- the new property valuepublic java.lang.String getWarnClass()
Return the value of the warnClass
property.
Contents: CSS style class to apply to any message with a severity class of "WARN".
public void setWarnClass(java.lang.String warnClass)
Set the value of the warnClass
property.
warnClass
- the new property valuepublic java.lang.String getWarnStyle()
Return the value of the warnStyle
property.
Contents: CSS style(s) to apply to any message with a severity class of "WARN".
public void setWarnStyle(java.lang.String warnStyle)
Set the value of the warnStyle
property.
warnStyle
- the new property value