Class Hierarchy All Classes All Fields and Methods

 

Class javax.faces.component.UIMessages 

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

public class UIMessages
extends UIComponentBase

The renderer for this component is responsible for obtaining the messages from the FacesContext and displaying them to the user.

This component supports the Messages renderer-type.

By default, the rendererType property must be set to "javax.faces.Messages". This value can be changed by calling the setRendererType() method.

Field Index
Field Description
COMPONENT_FAMILY The standard component family for this component.
COMPONENT_TYPE The standard component type for this component.

Constructor Index
Constructor Description
UIMessages() Create a new UIMessages instance with default property values.

Method Index
Method Description
String getFamily()  
boolean isGlobalOnly() Return the flag indicating whether only global messages (that is, messages with no associated client identifier) should be rendered.
boolean isShowDetail() Return the flag indicating whether the detail property of the associated message(s) should be displayed.
boolean isShowSummary() Return the flag indicating whether the summary property of the associated message(s) should be displayed.
void restoreState(FacesContext, Object)  
Object saveState(FacesContext)  
void setGlobalOnly(boolean) Set the flag indicating whether only global messages (that is, messages with no associated client identifier) should be rendered.
void setShowDetail(boolean) Set the flag indicating whether the detail property of the associated message(s) should be displayed.
void setShowSummary(boolean) Set the flag indicating whether the summary property of the associated message(s) should be displayed.

 

Fields

 

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

The standard component family for this component.

 

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

The standard component type for this component.

 

Constructors

 

UIMessages

public UIMessages()

Create a new UIMessages instance with default property values.

 

Methods

 

getFamily

public String getFamily()

 

isGlobalOnly

public boolean isGlobalOnly()

Return the flag indicating whether only global messages (that is, messages with no associated client identifier) should be rendered. Defaults to false.

 

isShowDetail

public boolean isShowDetail()

Return the flag indicating whether the detail property of the associated message(s) should be displayed. Defaults to false.

 

isShowSummary

public boolean isShowSummary()

Return the flag indicating whether the summary property of the associated message(s) should be displayed. Defaults to true.

 

restoreState

public void restoreState(FacesContext context,
                         Object state)

 

saveState

public Object saveState(FacesContext context)

 

setGlobalOnly

public void setGlobalOnly(boolean globalOnly)

Set the flag indicating whether only global messages (that is, messages with no associated client identifier) should be rendered.

 

setShowDetail

public void setShowDetail(boolean showDetail)

Set the flag indicating whether the detail property of the associated message(s) should be displayed.

 

setShowSummary

public void setShowSummary(boolean showSummary)

Set the flag indicating whether the summary property of the associated message(s) should be displayed.

Class Hierarchy All Classes All Fields and Methods