javax.faces.component.html
Class HtmlMessage

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIMessage
              extended by javax.faces.component.html.HtmlMessage
All Implemented Interfaces:
StateHolder

public class HtmlMessage
extends UIMessage


Field Summary
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Constructor Summary
HtmlMessage()
          Construct an instance of the HtmlMessage.
 
Method Summary
 java.lang.String getDir()
          Gets The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
 java.lang.String getErrorClass()
          Gets CSS class to be used for messages with severity "ERROR".
 java.lang.String getErrorStyle()
          Gets CSS style to be used for messages with severity "ERROR".
 java.lang.String getFamily()
           
 java.lang.String getFatalClass()
          Gets CSS class to be used for messages with severity "FATAL".
 java.lang.String getFatalStyle()
          Gets CSS style to be used for messages with severity "FATAL".
 java.lang.String getInfoClass()
          Gets CSS class to be used for messages with severity "INFO".
 java.lang.String getInfoStyle()
          Gets CSS style to be used for messages with severity "INFO".
 java.lang.String getLang()
          Gets The base language of this document.
 java.lang.String getStyle()
          Gets CSS styling instructions.
 java.lang.String getStyleClass()
          Gets The CSS class for this element.
 java.lang.String getTitle()
          Gets An advisory title for this element.
 java.lang.String getWarnClass()
          Gets CSS class to be used for messages with severity "WARN".
 java.lang.String getWarnStyle()
          Gets CSS style to be used for messages with severity "WARN".
 boolean isTooltip()
          Gets If true, the message summary will be rendered as a tooltip (i.e.
 void restoreState(FacesContext facesContext, java.lang.Object state)
          Invoked in the "restore view" phase, this initialises this object's members from the values saved previously into the provided state object.
 java.lang.Object saveState(FacesContext facesContext)
          Invoked after the render phase has completed, this method returns an object which can be passed to the restoreState of some other instance of UIComponentBase to reset that object's state to the same values as this object currently has.
 void setDir(java.lang.String dir)
          Sets The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
 void setErrorClass(java.lang.String errorClass)
          Sets CSS class to be used for messages with severity "ERROR".
 void setErrorStyle(java.lang.String errorStyle)
          Sets CSS style to be used for messages with severity "ERROR".
 void setFatalClass(java.lang.String fatalClass)
          Sets CSS class to be used for messages with severity "FATAL".
 void setFatalStyle(java.lang.String fatalStyle)
          Sets CSS style to be used for messages with severity "FATAL".
 void setInfoClass(java.lang.String infoClass)
          Sets CSS class to be used for messages with severity "INFO".
 void setInfoStyle(java.lang.String infoStyle)
          Sets CSS style to be used for messages with severity "INFO".
 void setLang(java.lang.String lang)
          Sets The base language of this document.
 void setStyle(java.lang.String style)
          Sets CSS styling instructions.
 void setStyleClass(java.lang.String styleClass)
          Sets The CSS class for this element.
 void setTitle(java.lang.String title)
          Sets An advisory title for this element.
 void setTooltip(boolean tooltip)
          Sets If true, the message summary will be rendered as a tooltip (i.e.
 void setWarnClass(java.lang.String warnClass)
          Sets CSS class to be used for messages with severity "WARN".
 void setWarnStyle(java.lang.String warnStyle)
          Sets CSS style to be used for messages with severity "WARN".
 
Methods inherited from class javax.faces.component.UIMessage
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_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values
Constructor Detail

HtmlMessage

public HtmlMessage()
Construct an instance of the HtmlMessage.

Method Detail

getStyle

public java.lang.String getStyle()
Gets CSS styling instructions.

Returns:
the new style value

setStyle

public void setStyle(java.lang.String style)
Sets CSS styling instructions.

Parameters:
style - the new style value

getStyleClass

public java.lang.String getStyleClass()
Gets The CSS class for this element. Corresponds to the HTML 'class' attribute.

Returns:
the new styleClass value

setStyleClass

public void setStyleClass(java.lang.String styleClass)
Sets The CSS class for this element. Corresponds to the HTML 'class' attribute.

Parameters:
styleClass - the new styleClass value

getDir

public java.lang.String getDir()
Gets The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).

Returns:
the new dir value

setDir

public void setDir(java.lang.String dir)
Sets The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).

Parameters:
dir - the new dir value

getLang

public java.lang.String getLang()
Gets The base language of this document.

Returns:
the new lang value

setLang

public void setLang(java.lang.String lang)
Sets The base language of this document.

Parameters:
lang - the new lang value

getTitle

public java.lang.String getTitle()
Gets An advisory title for this element. Often used by the user agent as a tooltip.

Returns:
the new title value

setTitle

public void setTitle(java.lang.String title)
Sets An advisory title for this element. Often used by the user agent as a tooltip.

Parameters:
title - the new title value

getInfoClass

public java.lang.String getInfoClass()
Gets CSS class to be used for messages with severity "INFO".

Returns:
the new infoClass value

setInfoClass

public void setInfoClass(java.lang.String infoClass)
Sets CSS class to be used for messages with severity "INFO".

Parameters:
infoClass - the new infoClass value

getInfoStyle

public java.lang.String getInfoStyle()
Gets CSS style to be used for messages with severity "INFO".

Returns:
the new infoStyle value

setInfoStyle

public void setInfoStyle(java.lang.String infoStyle)
Sets CSS style to be used for messages with severity "INFO".

Parameters:
infoStyle - the new infoStyle value

getWarnClass

public java.lang.String getWarnClass()
Gets CSS class to be used for messages with severity "WARN".

Returns:
the new warnClass value

setWarnClass

public void setWarnClass(java.lang.String warnClass)
Sets CSS class to be used for messages with severity "WARN".

Parameters:
warnClass - the new warnClass value

getWarnStyle

public java.lang.String getWarnStyle()
Gets CSS style to be used for messages with severity "WARN".

Returns:
the new warnStyle value

setWarnStyle

public void setWarnStyle(java.lang.String warnStyle)
Sets CSS style to be used for messages with severity "WARN".

Parameters:
warnStyle - the new warnStyle value

getErrorClass

public java.lang.String getErrorClass()
Gets CSS class to be used for messages with severity "ERROR".

Returns:
the new errorClass value

setErrorClass

public void setErrorClass(java.lang.String errorClass)
Sets CSS class to be used for messages with severity "ERROR".

Parameters:
errorClass - the new errorClass value

getErrorStyle

public java.lang.String getErrorStyle()
Gets CSS style to be used for messages with severity "ERROR".

Returns:
the new errorStyle value

setErrorStyle

public void setErrorStyle(java.lang.String errorStyle)
Sets CSS style to be used for messages with severity "ERROR".

Parameters:
errorStyle - the new errorStyle value

getFatalClass

public java.lang.String getFatalClass()
Gets CSS class to be used for messages with severity "FATAL".

Returns:
the new fatalClass value

setFatalClass

public void setFatalClass(java.lang.String fatalClass)
Sets CSS class to be used for messages with severity "FATAL".

Parameters:
fatalClass - the new fatalClass value

getFatalStyle

public java.lang.String getFatalStyle()
Gets CSS style to be used for messages with severity "FATAL".

Returns:
the new fatalStyle value

setFatalStyle

public void setFatalStyle(java.lang.String fatalStyle)
Sets CSS style to be used for messages with severity "FATAL".

Parameters:
fatalStyle - the new fatalStyle value

isTooltip

public boolean isTooltip()
Gets If true, the message summary will be rendered as a tooltip (i.e. HTML title attribute).

Returns:
the new tooltip value

setTooltip

public void setTooltip(boolean tooltip)
Sets If true, the message summary will be rendered as a tooltip (i.e. HTML title attribute).

Parameters:
tooltip - the new tooltip value

saveState

public java.lang.Object saveState(FacesContext facesContext)
Description copied from class: UIComponentBase
Invoked after the render phase has completed, this method returns an object which can be passed to the restoreState of some other instance of UIComponentBase to reset that object's state to the same values as this object currently has.

Specified by:
saveState in interface StateHolder
Overrides:
saveState in class UIMessage

restoreState

public void restoreState(FacesContext facesContext,
                         java.lang.Object state)
Description copied from class: UIComponentBase
Invoked in the "restore view" phase, this initialises this object's members from the values saved previously into the provided state object.

Specified by:
restoreState in interface StateHolder
Overrides:
restoreState in class UIMessage
state - is an object previously returned by the saveState method of this class.

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class UIMessage


Copyright © 2009 Apache Software Foundation. All Rights Reserved.