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 "jakarta.faces.Messages
". 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 |
---|
UIMessages()
Create a new
UIMessages 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 client identifier of the component for which this component represents associated message(s) (if any). |
boolean |
isGlobalOnly()
Return the flag indicating whether only global messages (that is, messages with no associated client identifier)
should be rendered.
|
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 client identifier of the component for which this component represents associated message(s) (if any).
|
void |
setGlobalOnly(boolean globalOnly)
Set the flag indicating whether only global messages (that is, messages with no associated client identifier) should
be rendered.
|
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, unsubscribeFromEvent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree
public 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 UIMessages()
Create a new UIMessages
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 UIComponent
public java.lang.String getFor()
Return the client identifier of the component for which this component represents associated message(s) (if any).
public void setFor(java.lang.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.
newFor
- The new client idpublic boolean isGlobalOnly()
Return the flag indicating whether only global messages (that is, messages with no associated client identifier) should be rendered. Mutually exclusive with the "for" property which takes precedence. Defaults to false.
true
if only global messages are to be shown, false
otherwise.public void setGlobalOnly(boolean globalOnly)
Set the flag indicating whether only global messages (that is, messages with no associated client identifier) should be rendered.
globalOnly
- The new flag valuepublic boolean isShowDetail()
Return the flag indicating whether the detail
property of the associated message(s) should be displayed.
Defaults to false.
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 true.
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
FacesMessage
s 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