JavaServer Faces

Name

UIMessage

Synopsis

This class represents a message component. A message component renders the first message queued for a specific component, if any. The default rendererType is javax.faces.Message.

Class name:	javax.faces.component.UIMessage
Extends:	javax.faces.component.UIComponentBase
Implements:	javax.faces.component.StateHolder

Fields

public static String COMPONENT_FAMILY

The component family: javax.faces.Message.

public static String COMPONENT_TYPE

The component family: javax.faces.Message.

Constructor

public UIMessage()

Creates a new instance.

Methods

public String getFamily()

Returns the component family ID.

public String getFor()

Returns the client ID of the component to render a message for.

public boolean isShowDetail()

Returns true if the message details are rendered.

public boolean isShowSummary()

Returns true if the message summary are rendered.

public void restoreState(javax.faces.context.FacesContext context, Object state)

Restores the state for this instance from the provided value; an Object previously returned by the saveState() method.

public Object saveState(javax.faces.context.FacesContext context)

Returns the state for this instance as an Object to be passed to the restoreState() method when the instance is restored for the next request.

public void setFor(String clientID)

Sets the client ID of the component to render a message for.

public void setShowDetail(boolean showDetail)

Sets the showDetail property. The default is true.

public void setShowSummary(boolean ...