javax.faces.component
Class UIMessage

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

All Implemented Interfaces:

StateHolder

public class UIMessage
extends UIComponentBase

Javadoc says default for showDetail is false, but Specs say it is true!? see Javadoc of JSF Specification

Version:

$Revision: 676278 $ $Date: 2008-07-13 03:35:04 -0500 (Sun, 13 Jul 2008) $

Author:

Manfred Geiler (latest modification by $Author: skitching $)

Field Summary

static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

Constructor Summary

UIMessage()

Method Summary

String	getFamily()
String	getFor() An EL expression, returning a String, with the unique ID of the component for which messages should be displayed.
boolean	isShowDetail() An EL expression, returning a boolean, that controls whether the detail text of the associated messages is displayed.
boolean	isShowSummary() An EL expression, returning a boolean, that controls whether the summary text of the associated messages is displayed.
void	restoreState(FacesContext context, Object state) Invoked in the "restore view" phase, this initialises this object's members from the values saved previously into the provided state object.
Object	saveState(FacesContext context) 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(String forValue)
void	setShowDetail(boolean showDetail)
void	setShowSummary(boolean showSummary)

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, 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 String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

UIMessage

public UIMessage()

Method Detail

getFamily

public String getFamily()

Specified by:

getFamily in class UIComponent

setFor

public void setFor(String forValue)

getFor

public String getFor()

An EL expression, returning a String, with the unique ID of the component for which messages should be displayed. This string has the same format as that accepted by the UIComponent.findComponent() method.

setShowDetail

public void setShowDetail(boolean showDetail)

isShowDetail

public boolean isShowDetail()

An EL expression, returning a boolean, that controls whether the detail text of the associated messages is displayed. Default: false.

setShowSummary

public void setShowSummary(boolean showSummary)

isShowSummary

public boolean isShowSummary()

An EL expression, returning a boolean, that controls whether the summary text of the associated messages is displayed. Default: true.

saveState

public Object saveState(FacesContext context)

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 context,
                         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.