org.apache.myfaces.component.html.ext
Class HtmlMessage

java.lang.Object
  |
  +--javax.faces.component.UIComponent
        |
        +--javax.faces.component.UIComponentBase
              |
              +--javax.faces.component.UIMessage
                    |
                    +--javax.faces.component.html.HtmlMessage
                          |
                          +--org.apache.myfaces.component.html.ext.HtmlMessage
All Implemented Interfaces:
javax.faces.component.StateHolder, UserRoleAware

public class HtmlMessage
extends javax.faces.component.html.HtmlMessage
implements UserRoleAware

Version:
$Revision: 1.10 $ $Date: 2005/01/22 19:47:44 $ $Log: HtmlMessage.java,v $ Revision 1.10 2005/01/22 19:47:44 mmarinschek Message rendering updated - if a validation exception needs to be rendered, the id of the component is replaced with a label. Revision 1.9 2005/01/16 20:09:53 matzew added patch form Sean Schofield. forceId for reuse of "legacy JavaScript" (MyFaces-70) Revision 1.8 2004/10/13 11:50:56 matze renamed packages to org.apache Revision 1.7 2004/07/01 21:53:05 mwessendorf ASF switch Revision 1.6 2004/05/18 14:31:36 manolito user role support completely moved to components source tree Revision 1.5 2004/04/01 09:23:12 manolito more extended components Revision 1.4 2004/03/31 14:51:45 manolito summaryFormat and detailFormat support Revision 1.3 2004/03/31 11:58:33 manolito custom component refactoring Revision 1.2 2004/03/30 17:47:32 manolito Message and Messages refactored Revision 1.1 2004/03/30 13:27:04 manolito extended Message component
Author:
Manfred Geiler (latest modification by $Author: mmarinschek $)

Field Summary
static java.lang.String COMPONENT_TYPE
           
 
Fields inherited from class javax.faces.component.UIMessage
COMPONENT_FAMILY
 
Fields inherited from interface org.apache.myfaces.component.UserRoleAware
ENABLED_ON_USER_ROLE_ATTR, VISIBLE_ON_USER_ROLE_ATTR
 
Constructor Summary
HtmlMessage()
           
 
Method Summary
 java.lang.String getClientId(javax.faces.context.FacesContext context)
           
 java.lang.String getDetailFormat()
           
 java.lang.String getEnabledOnUserRole()
           
 java.lang.String getSummaryFormat()
           
 java.lang.String getVisibleOnUserRole()
           
 boolean isRendered()
           
 boolean isReplaceIdWithLabel()
           
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setDetailFormat(java.lang.String detailFormat)
           
 void setEnabledOnUserRole(java.lang.String enabledOnUserRole)
           
 void setReplaceIdWithLabel(boolean replaceIdWithLabel)
           
 void setSummaryFormat(java.lang.String summaryFormat)
           
 void setVisibleOnUserRole(java.lang.String visibleOnUserRole)
           
 
Methods inherited from class javax.faces.component.html.HtmlMessage
getErrorClass, getErrorStyle, getFatalClass, getFatalStyle, getInfoClass, getInfoStyle, getStyle, getStyleClass, getTitle, getWarnClass, getWarnStyle, isTooltip, setErrorClass, setErrorStyle, setFatalClass, setFatalStyle, setInfoClass, setInfoStyle, setStyle, setStyleClass, setTitle, setTooltip, setWarnClass, setWarnStyle
 
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, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
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
See Also:
Constant Field Values
Constructor Detail

HtmlMessage

public HtmlMessage()
Method Detail

getClientId

public java.lang.String getClientId(javax.faces.context.FacesContext context)
Overrides:
getClientId in class javax.faces.component.UIComponentBase

setSummaryFormat

public void setSummaryFormat(java.lang.String summaryFormat)

getSummaryFormat

public java.lang.String getSummaryFormat()

setDetailFormat

public void setDetailFormat(java.lang.String detailFormat)

getDetailFormat

public java.lang.String getDetailFormat()

setEnabledOnUserRole

public void setEnabledOnUserRole(java.lang.String enabledOnUserRole)
Specified by:
setEnabledOnUserRole in interface UserRoleAware

getEnabledOnUserRole

public java.lang.String getEnabledOnUserRole()
Specified by:
getEnabledOnUserRole in interface UserRoleAware

setVisibleOnUserRole

public void setVisibleOnUserRole(java.lang.String visibleOnUserRole)
Specified by:
setVisibleOnUserRole in interface UserRoleAware

getVisibleOnUserRole

public java.lang.String getVisibleOnUserRole()
Specified by:
getVisibleOnUserRole in interface UserRoleAware

setReplaceIdWithLabel

public void setReplaceIdWithLabel(boolean replaceIdWithLabel)

isReplaceIdWithLabel

public boolean isReplaceIdWithLabel()

isRendered

public boolean isRendered()
Overrides:
isRendered in class javax.faces.component.UIComponentBase

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class javax.faces.component.html.HtmlMessage

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)
Specified by:
restoreState in interface javax.faces.component.StateHolder
Overrides:
restoreState in class javax.faces.component.html.HtmlMessage