Package jakarta.faces.component.html

Class HtmlMessages

java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UIMessages
jakarta.faces.component.html.HtmlMessages
All Implemented Interfaces:
PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder, EventListener
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.

  • Field Details

  • Constructor Details

  • 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

    • getErrorClass

      public 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​(String errorClass)

      Set the value of the errorClass property.

      Parameters:
      errorClass - the new property value

    • getErrorStyle

      public 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​(String errorStyle)

      Set the value of the errorStyle property.

      Parameters:
      errorStyle - the new property value

    • getFatalClass

      public 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​(String fatalClass)

      Set the value of the fatalClass property.

      Parameters:
      fatalClass - the new property value

    • getFatalStyle

      public 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​(String fatalStyle)

      Set the value of the fatalStyle property.

      Parameters:
      fatalStyle - the new property value

    • getInfoClass

      public 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​(String infoClass)

      Set the value of the infoClass property.

      Parameters:
      infoClass - the new property value

    • getInfoStyle

      public 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​(String infoStyle)

      Set the value of the infoStyle property.

      Parameters:
      infoStyle - 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

    • getLayout

      public String getLayout()

      Return the value of the layout property.

      Returns:
      the property value

      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".

    • setLayout

      public void setLayout​(String layout)

      Set the value of the layout property.

      Parameters:
      layout - 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

    • 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 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​(String warnClass)

      Set the value of the warnClass property.

      Parameters:
      warnClass - the new property value

    • getWarnStyle

      public 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​(String warnStyle)

      Set the value of the warnStyle property.

      Parameters:
      warnStyle - the new property value