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:
EventListener, PartialStateHolder, StateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder
Direct Known Subclasses:
HtmlMessage

public class UIMessage
extends UIComponentBase

This component is responsible for displaying messages for a specific UIComponent, identified by a clientId. The component obtains the messages from the FacesContext.

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


Field Summary
static String COMPONENT_FAMILY
          The standard component family for this component.
static String COMPONENT_TYPE
          The standard component type for this component.
 
Fields inherited from class javax.faces.component.UIComponent
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
 
Constructor Summary
UIMessage()
          Create a new UIMessage instance with default property values.
 
Method Summary
 String getFamily()
          Return the identifier of the component family to which this component belongs.
 String getFor()
          Return the client identifier of the component for which this component represents associated message(s) (if any).
 boolean isRedisplay()
           
 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 setFor(String newFor)
          Set the client identifier of the component for which this component represents associated message(s) (if any).
 void setRedisplay(boolean redisplay)
          Set the flag indicating whether the detail property of the associated message(s) should be displayed.
 void setShowDetail(boolean showDetail)
          Set the flag indicating whether the detail property of the associated message(s) should be displayed.
 void setShowSummary(boolean showSummary)
          Set the flag indicating whether the summary property of the associated message(s) should be displayed.
 
Methods inherited from class javax.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent, visitTree
 
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

The standard component type for this component.

See Also:
Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

The standard component family for this component.

See Also:
Constant Field Values
Constructor Detail

UIMessage

public UIMessage()

Create a new UIMessage instance with default property values.

Method Detail

getFamily

public String getFamily()
Description copied from class: UIComponent

Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance.

Specified by:
getFamily in class UIComponent

getFor

public String getFor()

Return the client identifier of the component for which this component represents associated message(s) (if any).


setFor

public void setFor(String newFor)

Set the client identifier of the component for which this component represents associated message(s) (if any). This property must be set before the message is displayed.

Parameters:
newFor - The new client id

isShowDetail

public boolean isShowDetail()

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


setShowDetail

public void setShowDetail(boolean showDetail)

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

Parameters:
showDetail - The new flag

isShowSummary

public boolean isShowSummary()

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


setShowSummary

public void setShowSummary(boolean showSummary)

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

Parameters:
showSummary - The new flag value

isRedisplay

public boolean isRedisplay()
Returns:
true if this UIMessage instance should redisplay FacesMessages that have already been handled, otherwise returns false. By default this method will always return true if setRedisplay(boolean) has not been called.
Since:
2.0

setRedisplay

public void setRedisplay(boolean redisplay)

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

Parameters:
redisplay - flag indicating whether previously handled messages are redisplayed or not
Since:
2.0


Copyright © 2002-2009 Sun Microsystems, Inc. All Rights Reserved.