javax.faces.component.html
Class HtmlMessage

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIMessage
              javax.faces.component.html.HtmlMessage

All Implemented Interfaces:

StateHolder

public class HtmlMessage
extends UIMessage

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

Field Summary

static String

COMPONENT_TYPE The standard component type for this component.

Fields inherited from class javax.faces.component.UIMessage

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

HtmlMessage()

Method Summary

String	getDir() Return the value of the dir property.
String	getErrorClass() Return the value of the errorClass property.
String	getErrorStyle() Return the value of the errorStyle property.
String	getFatalClass() Return the value of the fatalClass property.
String	getFatalStyle() Return the value of the fatalStyle property.
String	getInfoClass() Return the value of the infoClass property.
String	getInfoStyle() Return the value of the infoStyle property.
String	getLang() Return the value of the lang 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.
String	getWarnClass() Return the value of the warnClass property.
String	getWarnStyle() Return the value of the warnStyle property.
boolean	isTooltip() Return the value of the tooltip property.
void	restoreState(FacesContext _context, Object _state) Perform any processing required to restore the state from the entries in the state Object.
Object	saveState(FacesContext _context) Gets the state of the instance as a Serializable Object.
void	setDir(String dir) Set the value of the dir property.
void	setErrorClass(String errorClass) Set the value of the errorClass property.
void	setErrorStyle(String errorStyle) Set the value of the errorStyle property.
void	setFatalClass(String fatalClass) Set the value of the fatalClass property.
void	setFatalStyle(String fatalStyle) Set the value of the fatalStyle property.
void	setInfoClass(String infoClass) Set the value of the infoClass property.
void	setInfoStyle(String infoStyle) Set the value of the infoStyle property.
void	setLang(String lang) Set the value of the lang 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.
void	setTooltip(boolean tooltip) Set the value of the tooltip property.
void	setWarnClass(String warnClass) Set the value of the warnClass property.
void	setWarnStyle(String warnStyle) Set the value of the warnStyle property.

Methods inherited from class javax.faces.component.UIMessage

getFamily, getFor, isShowDetail, isShowSummary, setFor, setShowDetail, setShowSummary

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId, getValueExpression, setValueExpression

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 String COMPONENT_TYPE

The standard component type for this component.

See Also:

Constant Field Values

Constructor Detail

HtmlMessage

public HtmlMessage()

Method Detail

getDir

public 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).

setDir

public void setDir(String dir)

Set the value of the dir property.

getErrorClass

public String getErrorClass()

Return the value of the errorClass property.

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.

getErrorStyle

public String getErrorStyle()

Return the value of the errorStyle property.

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.

getFatalClass

public String getFatalClass()

Return the value of the fatalClass property.

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.

getFatalStyle

public String getFatalStyle()

Return the value of the fatalStyle property.

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.

getInfoClass

public String getInfoClass()

Return the value of the infoClass property.

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.

getInfoStyle

public String getInfoStyle()

Return the value of the infoStyle property.

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.

getLang

public String getLang()

Return the value of the lang property.

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.

getStyle

public String getStyle()

Return the value of the style property.

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.

getStyleClass

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

setStyleClass

public void setStyleClass(String styleClass)

Set the value of the styleClass property.

getTitle

public String getTitle()

Return the value of the title property.

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

setTitle

public void setTitle(String title)

Set the value of the title property.

isTooltip

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

setTooltip

public void setTooltip(boolean tooltip)

Set the value of the tooltip property.

getWarnClass

public String getWarnClass()

Return the value of the warnClass property.

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.

getWarnStyle

public String getWarnStyle()

Return the value of the warnStyle property.

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.

saveState

public Object saveState(FacesContext _context)

Description copied from interface: StateHolder

Gets the state of the instance as a Serializable Object.

If the class that implements this interface has references to instances that implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the StateHolder.saveState(javax.faces.context.FacesContext) method on all those instances as well. This method must not save the state of children and facets. That is done via the StateManager

This method must not alter the state of the implementing object. In other words, after executing this code:

 Object state = component.saveState(facesContext);
 

component should be the same as before executing it.

The return from this method must be Serializable

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class UIMessage

restoreState

public void restoreState(FacesContext _context,
                         Object _state)

Description copied from interface: StateHolder

Perform any processing required to restore the state from the entries in the state Object.

If the class that implements this interface has references to instances that also implement StateHolder (such as a UIComponent with event handlers, validators, etc.) this method must call the StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object) method on all those instances as well.

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class UIMessage