Class 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.
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String COMPONENT_FAMILY  
      static String COMPONENT_TYPE  
      • 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
    • Constructor Summary

      Constructors 
      Constructor Description
      UIMessages()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      CustomClass getCustomClass()
      Sets a CSS class in its parent, if the parent supports it.
      String getFamily()  
      Markup getMarkup()  
      Integer getMaxNumber()
      Sets the maximum number of messages to show.
      jakarta.faces.application.FacesMessage.Severity getMaxSeverity()
      Sets the maximum severity to be shown.
      jakarta.faces.application.FacesMessage.Severity getMinSeverity()
      Sets the mininum severity to be shown.
      OrderBy getOrderBy()
      Sets the order of the messages.
      boolean isConfirmation()
      Has the user to confirm this message?
      void restoreState​(jakarta.faces.context.FacesContext context, Object state)  
      void setConfirmation​(boolean confirmation)  
      void setCustomClass​(CustomClass customClass)  
      void setMarkup​(Markup markup)  
      void setMaxNumber​(Integer maxNumber)  
      void setMaxSeverity​(jakarta.faces.application.FacesMessage.Severity maxSeverity)  
      void setMinSeverity​(jakarta.faces.application.FacesMessage.Severity minSeverity)  
      void setOrderBy​(OrderBy orderBy)  
      • Methods inherited from class jakarta.faces.component.UIMessages

        getFor, isGlobalOnly, isRedisplay, isShowDetail, isShowSummary, setFor, setGlobalOnly, setRedisplay, setShowDetail, setShowSummary
      • Methods 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, visitTree
      • Methods 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, unsubscribeFromEvent
      • Methods inherited from interface jakarta.faces.component.behavior.ClientBehaviorHolder

        addClientBehavior, getClientBehaviors, getDefaultEventName, getEventNames
    • Constructor Detail

      • UIMessages

        public UIMessages()
    • Method Detail

      • getFamily

        public String getFamily()
        Overrides:
        getFamily in class jakarta.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:
        getMinSeverity in class AbstractUIMessages
      • setMinSeverity

        public void setMinSeverity​(jakarta.faces.application.FacesMessage.Severity minSeverity)
      • setMaxNumber

        public void setMaxNumber​(Integer maxNumber)
      • getCustomClass

        public CustomClass 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:
        getCustomClass in interface Visual
      • getOrderBy

        public OrderBy getOrderBy()
        Sets the order of the messages.
        Default: occurrence
        Allowed Values: occurrence,severity
        Specified by:
        getOrderBy in class AbstractUIMessages
      • setOrderBy

        public void setOrderBy​(OrderBy orderBy)
      • 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:
        isConfirmation in class AbstractUIMessages
      • 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:
        getMaxSeverity in class AbstractUIMessages
      • setMaxSeverity

        public void setMaxSeverity​(jakarta.faces.application.FacesMessage.Severity maxSeverity)
      • restoreState

        public void restoreState​(jakarta.faces.context.FacesContext context,
                                 Object state)
        Specified by:
        restoreState in interface jakarta.faces.component.StateHolder
        Overrides:
        restoreState in class jakarta.faces.component.UIComponentBase