- java.lang.Object
-
- javax.faces.component.UIComponent
-
- javax.faces.component.UIComponentBase
-
- javax.faces.component.UIMessages
-
- All Implemented Interfaces:
- EventListener, PartialStateHolder, StateHolder, TransientStateHolder, ComponentSystemEventListener, FacesListener, SystemEventListenerHolder
- Direct Known Subclasses:
- HtmlMessages
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 thesetRendererType()
method.
-
-
Field Summary
Fields Modifier and Type Field and 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 javax.faces.component.UIComponent
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY
-
-
Constructor Summary
Constructors Constructor and Description UIMessages()
Create a newUIMessages
instance with default property values.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method and Description 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
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 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 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 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 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, getListenersForEventClass, getParent, getPassThroughAttributes, 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, subscribeToEvent, unsubscribeFromEvent
-
Methods inherited from class javax.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
-
UIMessages
public UIMessages()
Create a new
UIMessages
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.- Specified by:
getFamily
in classUIComponent
-
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
-
isGlobalOnly
public 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.
-
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.
- Parameters:
globalOnly
- The new flag value
-
isShowDetail
public boolean isShowDetail()
Return the flag indicating whether the
detail
property of the associated message(s) should be displayed. Defaults to false.
-
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 true.
-
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
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 18/08/2025 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-javaee-rf-javax/faces/component/UIMessages.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur van deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.