public class UIMessage extends UIComponentBase
This component is responsible for displaying messages for a specific
UIComponent, identified by a clientId or component id
relative to the closest ancestor NamingContainer. The component obtains the messages from the
FacesContext.
By default, the rendererType property must be set to "jakarta.faces.Message". This value
can be changed by calling the setRendererType() method.
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
COMPONENT_FAMILY
The standard component family for this component.
|
static java.lang.String |
COMPONENT_TYPE
The standard component type for this component.
|
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY| Constructor and Description |
|---|
UIMessage()
Create a new
UIMessage instance with default property values. |
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getFamily()
Return the identifier of the component family to which this component belongs. |
java.lang.String |
getFor()
Return the Identifier of the component for which to render error messages.
|
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(java.lang.String newFor)
Set the 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. |
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTreepublic static final java.lang.String COMPONENT_TYPE
The standard component type for this component.
public static final java.lang.String COMPONENT_FAMILY
The standard component family for this component.
public UIMessage()
Create a new UIMessage instance with default property values.
public java.lang.String getFamily()
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. Note this method should NOT return null
getFamily in class UIComponentpublic java.lang.String getFor()
Return the Identifier of the component for which to render error messages.
If this component is within the same NamingContainer as the target component, this must be the component identifier.
Otherwise, it must be an absolute component identifier (starting with ":"). See the UIComponent.findComponent(java.lang.String)
for more information.
public void setFor(java.lang.String newFor)
Set the identifier of the component for which this component represents associated message(s) (if any). This property must be set before the message is displayed.
newFor - The new client idpublic boolean isShowDetail()
Return the flag indicating whether the detail property of the associated message(s) should be displayed.
Defaults to true.
true if detail is to be shown, false otherwise.public void setShowDetail(boolean showDetail)
Set the flag indicating whether the detail property of the associated message(s) should be displayed.
showDetail - The new flagpublic boolean isShowSummary()
Return the flag indicating whether the summary property of the associated message(s) should be
displayed. Defaults to false.
true if the summary is to be shown, false otherwise.public void setShowSummary(boolean showSummary)
Set the flag indicating whether the summary property of the associated message(s) should be displayed.
showSummary - The new flag valuepublic boolean isRedisplay()
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.public void setRedisplay(boolean redisplay)
Set the flag indicating whether the detail property of the associated message(s) should be displayed.
redisplay - flag indicating whether previously handled messages are redisplayed or not