Top Description Inners Fields Constructors Methods
javax.faces.component.html

public Class HtmlMessage

extends UIMessage
Class Inheritance
Imports
java.io.IOException, java.util.ArrayList, .Arrays, .List, javax.faces.context.FacesContext, javax.el.MethodExpression, .ValueExpression

By default, the rendererType property must be set to "javax.faces.Message". This value can be changed by calling the setRendererType() method.

Nested and Inner Type Summary

Modifier and TypeClass and Description
protected static enum

Field Summary

Modifier and TypeField and Description
public static final String
COMPONENT_TYPE

Hides javax.faces.component.UIMessage.COMPONENT_TYPE.

The standard component type for this component.

private static final String
Inherited from javax.faces.component.UIMessage:
COMPONENT_FAMILY

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public String

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.

getDir
()

Return the value of the dir property.

public String

Returns:

the property value

Contents: CSS style class to apply to any message with a severity class of "ERROR".

getErrorClass
()

Return the value of the errorClass property.

public String

Returns:

the property value

Contents: CSS style(s) to apply to any message with a severity class of "ERROR".

getErrorStyle
()

Return the value of the errorStyle property.

public String

Returns:

the property value

Contents: CSS style class to apply to any message with a severity class of "FATAL".

getFatalClass
()

Return the value of the fatalClass property.

public String

Returns:

the property value

Contents: CSS style(s) to apply to any message with a severity class of "FATAL".

getFatalStyle
()

Return the value of the fatalStyle property.

public String

Returns:

the property value

Contents: CSS style class to apply to any message with a severity class of "INFO".

getInfoClass
()

Return the value of the infoClass property.

public String

Returns:

the property value

Contents: CSS style(s) to apply to any message with a severity class of "INFO".

getInfoStyle
()

Return the value of the infoStyle property.

public String

Returns:

the property value

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

getLang
()

Return the value of the lang property.

public String

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.

getRole
()

Return the value of the role property.

public String

Returns:

the property value

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

getStyle
()

Return the value of the style property.

public String

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.

getStyleClass
()

Return the value of the styleClass property.

public String

Returns:

the property value

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

getTitle
()

Return the value of the title property.

public String

Returns:

the property value

Contents: CSS style class to apply to any message with a severity class of "WARN".

getWarnClass
()

Return the value of the warnClass property.

public String

Returns:

the property value

Contents: CSS style(s) to apply to any message with a severity class of "WARN".

getWarnStyle
()

Return the value of the warnStyle property.

private void
public boolean

Returns:

the property value

Contents: Flag indicating whether the detail portion of the message should be displayed as a tooltip.

isTooltip
()

Return the value of the tooltip property.

public void
setDir(String
the new property value
dir
)

Set the value of the dir property.

public void
setErrorClass(String
the new property value
errorClass
)

Set the value of the errorClass property.

public void
setErrorStyle(String
the new property value
errorStyle
)

Set the value of the errorStyle property.

public void
setFatalClass(String
the new property value
fatalClass
)

Set the value of the fatalClass property.

public void
setFatalStyle(String
the new property value
fatalStyle
)

Set the value of the fatalStyle property.

public void
setInfoClass(String
the new property value
infoClass
)

Set the value of the infoClass property.

public void
setInfoStyle(String
the new property value
infoStyle
)

Set the value of the infoStyle property.

public void
setLang(String
the new property value
lang
)

Set the value of the lang property.

public void
setRole(String
the new property value
role
)

Set the value of the role property.

public void
setStyle(String
the new property value
style
)

Set the value of the style property.

public void
setStyleClass(String
the new property value
styleClass
)

Set the value of the styleClass property.

public void
setTitle(String
the new property value
title
)

Set the value of the title property.

public void
setTooltip(boolean
the new property value
tooltip
)

Set the value of the tooltip property.

public void
setWarnClass(String
the new property value
warnClass
)

Set the value of the warnClass property.

public void
setWarnStyle(String
the new property value
warnStyle
)

Set the value of the warnStyle property.

Inherited from javax.faces.component.UIMessage:
getFamilygetForisRedisplayisShowDetailisShowSummarysetForsetRedisplaysetShowDetailsetShowSummary

Field Detail

COMPONENT_TYPEback to summary
public static final String COMPONENT_TYPE

Hides javax.faces.component.UIMessage.COMPONENT_TYPE.

The standard component type for this component.

OPTIMIZED_PACKAGEback to summary
private static final String OPTIMIZED_PACKAGE

Constructor Detail

HtmlMessageback to summary
public HtmlMessage()

Method Detail

getDirback to summary
public String getDir()

Return the value of the dir property.

Returns:String

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.

getErrorClassback to summary
public String getErrorClass()

Return the value of the errorClass property.

Returns:String

the property value

Contents: CSS style class to apply to any message with a severity class of "ERROR".

getErrorStyleback to summary
public String getErrorStyle()

Return the value of the errorStyle property.

Returns:String

the property value

Contents: CSS style(s) to apply to any message with a severity class of "ERROR".

getFatalClassback to summary
public String getFatalClass()

Return the value of the fatalClass property.

Returns:String

the property value

Contents: CSS style class to apply to any message with a severity class of "FATAL".

getFatalStyleback to summary
public String getFatalStyle()

Return the value of the fatalStyle property.

Returns:String

the property value

Contents: CSS style(s) to apply to any message with a severity class of "FATAL".

getInfoClassback to summary
public String getInfoClass()

Return the value of the infoClass property.

Returns:String

the property value

Contents: CSS style class to apply to any message with a severity class of "INFO".

getInfoStyleback to summary
public String getInfoStyle()

Return the value of the infoStyle property.

Returns:String

the property value

Contents: CSS style(s) to apply to any message with a severity class of "INFO".

getLangback to summary
public String getLang()

Return the value of the lang property.

Returns:String

the property value

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

getRoleback to summary
public String getRole()

Return the value of the role property.

Returns:String

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.

getStyleback to summary
public String getStyle()

Return the value of the style property.

Returns:String

the property value

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

getStyleClassback to summary
public String getStyleClass()

Return the value of the styleClass property.

Returns:String

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.

getTitleback to summary
public String getTitle()

Return the value of the title property.

Returns:String

the property value

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

getWarnClassback to summary
public String getWarnClass()

Return the value of the warnClass property.

Returns:String

the property value

Contents: CSS style class to apply to any message with a severity class of "WARN".

getWarnStyleback to summary
public String getWarnStyle()

Return the value of the warnStyle property.

Returns:String

the property value

Contents: CSS style(s) to apply to any message with a severity class of "WARN".

handleAttributeback to summary
private void handleAttribute(String name, Object value)
isTooltipback to summary
public boolean isTooltip()

Return the value of the tooltip property.

Returns:boolean

the property value

Contents: Flag indicating whether the detail portion of the message should be displayed as a tooltip.

setDirback to summary
public void setDir(String dir)

Set the value of the dir property.

Parameters
dir:String

the new property value

setErrorClassback to summary
public void setErrorClass(String errorClass)

Set the value of the errorClass property.

Parameters
errorClass:String

the new property value

setErrorStyleback to summary
public void setErrorStyle(String errorStyle)

Set the value of the errorStyle property.

Parameters
errorStyle:String

the new property value

setFatalClassback to summary
public void setFatalClass(String fatalClass)

Set the value of the fatalClass property.

Parameters
fatalClass:String

the new property value

setFatalStyleback to summary
public void setFatalStyle(String fatalStyle)

Set the value of the fatalStyle property.

Parameters
fatalStyle:String

the new property value

setInfoClassback to summary
public void setInfoClass(String infoClass)

Set the value of the infoClass property.

Parameters
infoClass:String

the new property value

setInfoStyleback to summary
public void setInfoStyle(String infoStyle)

Set the value of the infoStyle property.

Parameters
infoStyle:String

the new property value

setLangback to summary
public void setLang(String lang)

Set the value of the lang property.

Parameters
lang:String

the new property value

setRoleback to summary
public void setRole(String role)

Set the value of the role property.

Parameters
role:String

the new property value

setStyleback to summary
public void setStyle(String style)

Set the value of the style property.

Parameters
style:String

the new property value

setStyleClassback to summary
public void setStyleClass(String styleClass)

Set the value of the styleClass property.

Parameters
styleClass:String

the new property value

setTitleback to summary
public void setTitle(String title)

Set the value of the title property.

Parameters
title:String

the new property value

setTooltipback to summary
public void setTooltip(boolean tooltip)

Set the value of the tooltip property.

Parameters
tooltip:boolean

the new property value

setWarnClassback to summary
public void setWarnClass(String warnClass)

Set the value of the warnClass property.

Parameters
warnClass:String

the new property value

setWarnStyleback to summary
public void setWarnStyle(String warnStyle)

Set the value of the warnStyle property.

Parameters
warnStyle:String

the new property value

javax.faces.component.html back to summary

protected final Enum HtmlMessage.PropertyKeys

extends Enum<HtmlMessage.PropertyKeys>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final HtmlMessage.PropertyKeys
public static final HtmlMessage.PropertyKeys
public static final HtmlMessage.PropertyKeys
public static final HtmlMessage.PropertyKeys
public static final HtmlMessage.PropertyKeys
public static final HtmlMessage.PropertyKeys
public static final HtmlMessage.PropertyKeys
public static final HtmlMessage.PropertyKeys
public static final HtmlMessage.PropertyKeys
public static final HtmlMessage.PropertyKeys
public static final HtmlMessage.PropertyKeys
public static final HtmlMessage.PropertyKeys
public static final HtmlMessage.PropertyKeys
pack-priv String
public static final HtmlMessage.PropertyKeys
public static final HtmlMessage.PropertyKeys

Constructor Summary

AccessConstructor and Description
private
PropertyKeys(String toString)

private

Method Summary

Modifier and TypeMethod and Description
public String
toString()

Overrides java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration.
public static HtmlMessage.PropertyKeys
public static HtmlMessage.PropertyKeys[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinalvalueOf

Field Detail

dirback to summary
public static final HtmlMessage.PropertyKeys dir
errorClassback to summary
public static final HtmlMessage.PropertyKeys errorClass
errorStyleback to summary
public static final HtmlMessage.PropertyKeys errorStyle
fatalClassback to summary
public static final HtmlMessage.PropertyKeys fatalClass
fatalStyleback to summary
public static final HtmlMessage.PropertyKeys fatalStyle
infoClassback to summary
public static final HtmlMessage.PropertyKeys infoClass
infoStyleback to summary
public static final HtmlMessage.PropertyKeys infoStyle
langback to summary
public static final HtmlMessage.PropertyKeys lang
roleback to summary
public static final HtmlMessage.PropertyKeys role
styleback to summary
public static final HtmlMessage.PropertyKeys style
styleClassback to summary
public static final HtmlMessage.PropertyKeys styleClass
titleback to summary
public static final HtmlMessage.PropertyKeys title
tooltipback to summary
public static final HtmlMessage.PropertyKeys tooltip
toStringback to summary
pack-priv String toString
warnClassback to summary
public static final HtmlMessage.PropertyKeys warnClass
warnStyleback to summary
public static final HtmlMessage.PropertyKeys warnStyle

Constructor Detail

PropertyKeysback to summary
private PropertyKeys(String toString)
PropertyKeysback to summary
private PropertyKeys()

Method Detail

toStringback to summary
public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

valueOfback to summary
public static HtmlMessage.PropertyKeys valueOf(String name)
valuesback to summary
public static HtmlMessage.PropertyKeys[] values()