Class UIMessage
- java.lang.Object
-
- jakarta.faces.component.UIComponent
-
- jakarta.faces.component.UIComponentBase
-
- jakarta.faces.component.UIMessage
-
- All Implemented Interfaces:
PartialStateHolder
,StateHolder
,TransientStateHolder
,ComponentSystemEventListener
,FacesListener
,SystemEventListenerHolder
,EventListener
- Direct Known Subclasses:
HtmlMessage
public class UIMessage extends UIComponentBase
This component is responsible for displaying messages for a specific
UIComponent
, identified by aclientId
or component id relative to the closest ancestorNamingContainer
. The component obtains the messages from theFacesContext
.By default, the
rendererType
property must be set to "jakarta.faces.Message
". This value can be changed by calling thesetRendererType()
method.
-
-
Field Summary
Fields Modifier and Type Field Description 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 jakarta.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, FACETS_KEY, VIEW_LOCATION_KEY
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getFamily()
Return the identifier of the component family to which this component belongs.String
getFor()
Return the Identifier of the component for which to render error messages.boolean
isRedisplay()
boolean
isShowDetail()
Return the flag indicating whether thedetail
property of the associated message(s) should be displayed.boolean
isShowSummary()
Return the flag indicating whether thesummary
property of the associated message(s) should be displayed.void
setFor(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 thedetail
property of the associated message(s) should be displayed.void
setShowDetail(boolean showDetail)
Set the flag indicating whether thedetail
property of the associated message(s) should be displayed.void
setShowSummary(boolean showSummary)
Set the flag indicating whether thesummary
property of the associated message(s) should be displayed.-
Methods inherited from class jakarta.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, 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
-
Methods inherited from class jakarta.faces.component.UIComponent
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
-
-
-
-
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 appropriateRenderer
for this component instance. Note this method should NOT returnnull
- Specified by:
getFamily
in classUIComponent
- Returns:
- the component family (not null).
-
getFor
public 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.- Returns:
- the for client identifier.
-
setFor
public void setFor(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.
- 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 totrue
.- Returns:
true
if detail is to be shown,false
otherwise.
-
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 tofalse
.- Returns:
true
if the summary is to be shown,false
otherwise.
-
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 thisUIMessage
instance should redisplayFacesMessage
s that have already been handled, otherwise returnsfalse
. By default this method will always returntrue
ifsetRedisplay(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
-
-