java.lang.Object
jakarta.faces.component.UIComponent
jakarta.faces.component.UIComponentBase
jakarta.faces.component.UIMessages
org.apache.myfaces.tobago.internal.component.AbstractUIMessages
org.apache.myfaces.tobago.component.UIMessages
- All Implemented Interfaces:
jakarta.faces.component.behavior.ClientBehaviorHolder,jakarta.faces.component.PartialStateHolder,jakarta.faces.component.StateHolder,jakarta.faces.component.TransientStateHolder,jakarta.faces.event.ComponentSystemEventListener,jakarta.faces.event.FacesListener,jakarta.faces.event.SystemEventListenerHolder,EventListener,Visual
@Generated("component.stg")
public class UIMessages
extends AbstractUIMessages
implements jakarta.faces.component.behavior.ClientBehaviorHolder
Renders error/validation messages.
UIComponent class, generated from template
component.stg with class
MessagesTagDeclaration.-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIMessages
AbstractUIMessages.Item -
Field Summary
FieldsFields 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 -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionSets a CSS class in its parent, if the parent supports it.Sets the maximum number of messages to show.jakarta.faces.application.FacesMessage.SeveritySets the maximum severity to be shown.jakarta.faces.application.FacesMessage.SeveritySets the mininum severity to be shown.Sets the order of the messages.booleanHas the user to confirm this message?voidrestoreState(jakarta.faces.context.FacesContext context, Object state) voidsetConfirmation(boolean confirmation) voidsetCustomClass(CustomClass customClass) voidvoidsetMaxNumber(Integer maxNumber) voidsetMaxSeverity(jakarta.faces.application.FacesMessage.Severity maxSeverity) voidsetMinSeverity(jakarta.faces.application.FacesMessage.Severity minSeverity) voidsetOrderBy(OrderBy orderBy) Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIMessages
createMessageListMethods inherited from class jakarta.faces.component.UIMessages
getFor, isGlobalOnly, isRedisplay, isShowDetail, isShowSummary, setFor, setGlobalOnly, setRedisplay, setShowDetail, setShowSummaryMethods inherited from class jakarta.faces.component.UIComponentBase
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, visitTreeMethods inherited from class jakarta.faces.component.UIComponent
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEventMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolder
addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNamesMethods inherited from interface org.apache.myfaces.tobago.component.Visual
getRendererType, isPlain
-
Field Details
-
COMPONENT_TYPE
-
COMPONENT_FAMILY
- See Also:
-
-
Constructor Details
-
UIMessages
public UIMessages()
-
-
Method Details
-
getFamily
- Overrides:
getFamilyin classjakarta.faces.component.UIMessages
-
getMinSeverity
public jakarta.faces.application.FacesMessage.Severity getMinSeverity()Sets the mininum severity to be shown. E. g. "warn" shows only "warn", "error" and "fatal".
Default:info- Specified by:
getMinSeverityin classAbstractUIMessages
-
setMinSeverity
public void setMinSeverity(jakarta.faces.application.FacesMessage.Severity minSeverity) -
getMaxNumber
Sets the maximum number of messages to show.
Default:2147483647- Specified by:
getMaxNumberin classAbstractUIMessages
-
setMaxNumber
-
getMarkup
-
setMarkup
-
getCustomClass
Sets a CSS class in its parent, if the parent supports it. Which this feature it is possible to put a CSS class name into a component with the <tc:style> tag. Example:<tc:in> <tc:style customClass="my-emphasized"/> </tc:in>One capability is, to used external CSS libs.
This feature should not be used imprudent. Because it might be unstable against changes in the renderered HTML code.- Specified by:
getCustomClassin interfaceVisual
-
setCustomClass
- Specified by:
setCustomClassin interfaceVisual
-
getOrderBy
Sets the order of the messages.
Default:occurrence
Allowed Values:occurrence,severity- Specified by:
getOrderByin classAbstractUIMessages
-
setOrderBy
-
isConfirmation
public boolean isConfirmation()Has the user to confirm this message? This attributes handles the case, if the application wants to warn the user about a problem, and the user has to confirm the message before he/she can continue.
Default:false- Specified by:
isConfirmationin classAbstractUIMessages
-
setConfirmation
public void setConfirmation(boolean confirmation) -
getMaxSeverity
public jakarta.faces.application.FacesMessage.Severity getMaxSeverity()Sets the maximum severity to be shown. E. g. "warn" shows only "warn" and "info". When setting this attribute you usually shoud take care, that you have a second message tag to show the higher severity levels.
Default:fatal- Specified by:
getMaxSeverityin classAbstractUIMessages
-
setMaxSeverity
public void setMaxSeverity(jakarta.faces.application.FacesMessage.Severity maxSeverity) -
restoreState
- Specified by:
restoreStatein interfacejakarta.faces.component.StateHolder- Overrides:
restoreStatein classjakarta.faces.component.UIComponentBase
-