javax.faces.component
Class UIMessage

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

public class UIMessage
extends UIComponentBase


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
UIMessage()
          Construct an instance of the UIMessage.
 
Method Summary
 java.lang.String getFamily()
           
 java.lang.String getFor()
          Gets The ID of the component whose attached FacesMessage object (if present) should be diplayed by this component.
 boolean isShowDetail()
          Gets Specifies whether the detailed information from the message should be shown.
 boolean isShowSummary()
          Gets Specifies whether the summary information from the message should be shown.
 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 setFor(java.lang.String forParam)
          Sets The ID of the component whose attached FacesMessage object (if present) should be diplayed by this component.
 void setShowDetail(boolean showDetail)
          Sets Specifies whether the detailed information from the message should be shown.
 void setShowSummary(boolean showSummary)
          Sets Specifies whether the summary information from the message should be shown.
 
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

UIMessage

public UIMessage()
Construct an instance of the UIMessage.

Method Detail

getFor

public java.lang.String getFor()
Gets The ID of the component whose attached FacesMessage object (if present) should be diplayed by this component.

This is a required property on the component.

Returns:
the new for value

setFor

public void setFor(java.lang.String forParam)
Sets The ID of the component whose attached FacesMessage object (if present) should be diplayed by this component.

This is a required property on the component.

Parameters:
forParam - the new for value

isShowDetail

public boolean isShowDetail()
Gets Specifies whether the detailed information from the message should be shown. Default to false.

Returns:
the new showDetail value

setShowDetail

public void setShowDetail(boolean showDetail)
Sets Specifies whether the detailed information from the message should be shown. Default to false.

Parameters:
showDetail - the new showDetail value

isShowSummary

public boolean isShowSummary()
Gets Specifies whether the summary information from the message should be shown. Defaults to true.

Returns:
the new showSummary value

setShowSummary

public void setShowSummary(boolean showSummary)
Sets Specifies whether the summary information from the message should be shown. Defaults to true.

Parameters:
showSummary - the new showSummary 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 UIComponentBase

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 UIComponentBase
state - is an object previously returned by the saveState method of this class.

getFamily

public java.lang.String getFamily()
Specified by:
getFamily in class UIComponent


Copyright © 2010 Apache Software Foundation. All Rights Reserved.