HtmlMessage

java.lang.Object
- jakarta.faces.component.UIComponent
- - jakarta.faces.component.UIComponentBase
  - - jakarta.faces.component.UIMessage
    - - jakarta.faces.component.html.HtmlMessage

All Implemented Interfaces:

PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder, java.util.EventListener
```
public class HtmlMessage
extends UIMessage
```
By default, the rendererType property must be set to "jakarta.faces.Message". This value can be changed by calling the setRendererType() method.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class HtmlMessage.PropertyKeys
Properties used by this component

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`HtmlMessage.PropertyKeys` Properties used by this component

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COMPONENT_TYPE
The standard component type for this component.
- Fields inherited from class jakarta.faces.component.UIMessage
  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, FACETS_KEY, VIEW_LOCATION_KEY

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COMPONENT_TYPE` The standard component type for this component.

Constructor Summary

Constructors
Constructor and Description

HtmlMessage()

Constructors
Constructor and Description
`HtmlMessage()`

Method Summary

All Methods Instance Methods Concrete Methods
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`	`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`	`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.

Methods inherited from class jakarta.faces.component.UIMessage
getFamily, getFor, isRedisplay, isShowDetail, isShowSummary, setFor, setRedisplay, setShowDetail, setShowSummary

Methods inherited from class jakarta.faces.component.UIComponentBase
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, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - COMPONENT_TYPE
```
public static final java.lang.String COMPONENT_TYPE
```
    The standard component type for this component.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HtmlMessage
```
public HtmlMessage()
```
- Method Detail
  - getDir
```
public java.lang.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(java.lang.String dir)
```
    Set the value of the dir property.
    
    Parameters:
    
    dir - the new property value
  - getErrorClass
```
public java.lang.String getErrorClass()
```
    Return the value of the errorClass property.
    
    Returns:
    
    the property value
    Contents: CSS style class to apply to any message with a severity class of "ERROR".
  - setErrorClass
```
public void setErrorClass(java.lang.String errorClass)
```
    Set the value of the errorClass property.
    
    Parameters:
    
    errorClass - the new property value
  - getErrorStyle
```
public java.lang.String getErrorStyle()
```
    Return the value of the errorStyle property.
    
    Returns:
    
    the property value
    Contents: CSS style(s) to apply to any message with a severity class of "ERROR".
  - setErrorStyle
```
public void setErrorStyle(java.lang.String errorStyle)
```
    Set the value of the errorStyle property.
    
    Parameters:
    
    errorStyle - the new property value
  - getFatalClass
```
public java.lang.String getFatalClass()
```
    Return the value of the fatalClass property.
    
    Returns:
    
    the property value
    Contents: CSS style class to apply to any message with a severity class of "FATAL".
  - setFatalClass
```
public void setFatalClass(java.lang.String fatalClass)
```
    Set the value of the fatalClass property.
    
    Parameters:
    
    fatalClass - the new property value
  - getFatalStyle
```
public java.lang.String getFatalStyle()
```
    Return the value of the fatalStyle property.
    
    Returns:
    
    the property value
    Contents: CSS style(s) to apply to any message with a severity class of "FATAL".
  - setFatalStyle
```
public void setFatalStyle(java.lang.String fatalStyle)
```
    Set the value of the fatalStyle property.
    
    Parameters:
    
    fatalStyle - the new property value
  - getInfoClass
```
public java.lang.String getInfoClass()
```
    Return the value of the infoClass property.
    
    Returns:
    
    the property value
    Contents: CSS style class to apply to any message with a severity class of "INFO".
  - setInfoClass
```
public void setInfoClass(java.lang.String infoClass)
```
    Set the value of the infoClass property.
    
    Parameters:
    
    infoClass - the new property value
  - getInfoStyle
```
public java.lang.String getInfoStyle()
```
    Return the value of the infoStyle property.
    
    Returns:
    
    the property value
    Contents: CSS style(s) to apply to any message with a severity class of "INFO".
  - setInfoStyle
```
public void setInfoStyle(java.lang.String infoStyle)
```
    Set the value of the infoStyle property.
    
    Parameters:
    
    infoStyle - the new property value
  - getLang
```
public java.lang.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(java.lang.String lang)
```
    Set the value of the lang property.
    
    Parameters:
    
    lang - the new property value
  - getRole
```
public java.lang.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(java.lang.String role)
```
    Set the value of the role property.
    
    Parameters:
    
    role - the new property value
  - getStyle
```
public java.lang.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(java.lang.String style)
```
    Set the value of the style property.
    
    Parameters:
    
    style - the new property value
  - getStyleClass
```
public java.lang.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(java.lang.String styleClass)
```
    Set the value of the styleClass property.
    
    Parameters:
    
    styleClass - the new property value
  - getTitle
```
public java.lang.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(java.lang.String title)
```
    Set the value of the title property.
    
    Parameters:
    
    title - the new property value
  - isTooltip
```
public boolean isTooltip()
```
    Return the value of the tooltip property.
    
    Returns:
    
    the property value
    Contents: Flag indicating whether the detail portion of the message should be displayed as a tooltip.
  - setTooltip
```
public void setTooltip(boolean tooltip)
```
    Set the value of the tooltip property.
    
    Parameters:
    
    tooltip - the new property value
  - getWarnClass
```
public java.lang.String getWarnClass()
```
    Return the value of the warnClass property.
    
    Returns:
    
    the property value
    Contents: CSS style class to apply to any message with a severity class of "WARN".
  - setWarnClass
```
public void setWarnClass(java.lang.String warnClass)
```
    Set the value of the warnClass property.
    
    Parameters:
    
    warnClass - the new property value
  - getWarnStyle
```
public java.lang.String getWarnStyle()
```
    Return the value of the warnStyle property.
    
    Returns:
    
    the property value
    Contents: CSS style(s) to apply to any message with a severity class of "WARN".
  - setWarnStyle
```
public void setWarnStyle(java.lang.String warnStyle)
```
    Set the value of the warnStyle property.
    
    Parameters:
    
    warnStyle - the new property value

Class HtmlMessage

Nested Class Summary

Field Summary

Fields inherited from class jakarta.faces.component.UIMessage

Fields inherited from class jakarta.faces.component.UIComponent

Constructor Summary

Method Summary

Methods inherited from class jakarta.faces.component.UIMessage

Methods inherited from class jakarta.faces.component.UIComponentBase

Methods inherited from class jakarta.faces.component.UIComponent

Methods inherited from class java.lang.Object

Field Detail

COMPONENT_TYPE

Constructor Detail

HtmlMessage

Method Detail

getDir

setDir

getErrorClass

setErrorClass

getErrorStyle

setErrorStyle

getFatalClass

setFatalClass

getFatalStyle

setFatalStyle

getInfoClass

setInfoClass

getInfoStyle

setInfoStyle

getLang

setLang

getRole

setRole

getStyle

setStyle

getStyleClass

setStyleClass

getTitle

setTitle

isTooltip

setTooltip

getWarnClass

setWarnClass

getWarnStyle

setWarnStyle