Class UIMessages

java.lang.Object
org.apache.myfaces.tobago.internal.component.AbstractUIMessages
org.apache.myfaces.tobago.component.UIMessages
All Implemented Interfaces:
EventListener, Visual
@Generated("component.stg") public class UIMessages extends AbstractUIMessages
Renders error/validation messages. UIComponent class, generated from template component.stg with class MessagesTagDeclaration.

  • Field Details

  • Constructor Details

    • UIMessages

      public UIMessages()

  • Method Details

    • getFamily

      public String getFamily()

    • getMinSeverity

      public jakarta.faces.application.FacesMessage.Severity getMinSeverity()
      Sets the minimum 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)

    • getMaxNumber

      public Integer getMaxNumber()
      Sets the maximum number of messages to show.
      Default: 2147483647
      Specified by:
      getMaxNumber in class AbstractUIMessages

    • setMaxNumber

      public void setMaxNumber(Integer maxNumber)

    • getMarkup

      public Markup getMarkup()
      Specified by:
      getMarkup in interface Visual

    • setMarkup

      public void setMarkup(Markup markup)
      Specified by:
      setMarkup in interface Visual

    • 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

    • setCustomClass

      public void setCustomClass(CustomClass customClass)
      Specified by:
      setCustomClass 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 should 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)

    • addClientBehavior

      void addClientBehavior(String arg0, jakarta.faces.component.behavior.ClientBehavior arg1)

    • getClientBehaviors

      Map<String, List<jakarta.faces.component.behavior.ClientBehavior>> getClientBehaviors()

    • getDefaultEventName

      String getDefaultEventName()

    • getEventNames

      Collection<String> getEventNames()

    • isGlobalOnly

      public boolean isGlobalOnly()

    • setGlobalOnly

      public void setGlobalOnly(boolean arg0)

    • isShowDetail

      public boolean isShowDetail()

    • setShowDetail

      public void setShowDetail(boolean arg0)

    • isShowSummary

      public boolean isShowSummary()

    • setShowSummary

      public void setShowSummary(boolean arg0)

    • isRedisplay

      public boolean isRedisplay()

    • setRedisplay

      public void setRedisplay(boolean arg0)

    • getFor

      public String getFor()

    • setFor

      public void setFor(String arg0)

    • setId

      public void setId(String arg0)

    • setParent

      public void setParent(jakarta.faces.component.UIComponent arg0)

    • addClientBehavior

      public void addClientBehavior(String arg0, jakarta.faces.component.behavior.ClientBehavior arg1)

    • broadcast

      public void broadcast(jakarta.faces.event.FacesEvent arg0) throws jakarta.faces.event.AbortProcessingException
      Throws:
      jakarta.faces.event.AbortProcessingException

    • clearInitialState

      public void clearInitialState()

    • decode

      public void decode(jakarta.faces.context.FacesContext arg0)

    • encodeAll

      public void encodeAll(jakarta.faces.context.FacesContext arg0) throws IOException
      Throws:
      IOException

    • encodeBegin

      public void encodeBegin(jakarta.faces.context.FacesContext arg0) throws IOException
      Throws:
      IOException

    • encodeChildren

      public void encodeChildren(jakarta.faces.context.FacesContext arg0) throws IOException
      Throws:
      IOException

    • encodeEnd

      public void encodeEnd(jakarta.faces.context.FacesContext arg0) throws IOException
      Throws:
      IOException

    • findComponent

      public jakarta.faces.component.UIComponent findComponent(String arg0)

    • getAttributes

      public Map<String,Object> getAttributes()

    • getPassThroughAttributes

      public Map<String,Object> getPassThroughAttributes(boolean arg0)

    • getChildCount

      public int getChildCount()

    • getChildren

      public List<jakarta.faces.component.UIComponent> getChildren()

    • getClientBehaviors

      public Map<String, List<jakarta.faces.component.behavior.ClientBehavior>> getClientBehaviors()

    • getClientId

      public String getClientId(jakarta.faces.context.FacesContext arg0)

    • getDefaultEventName

      public String getDefaultEventName()

    • getEventNames

      public Collection<String> getEventNames()

    • getFacet

      public jakarta.faces.component.UIComponent getFacet(String arg0)

    • getFacetCount

      public int getFacetCount()

    • getFacets

      public Map<String, jakarta.faces.component.UIComponent> getFacets()

    • getFacetsAndChildren

      public Iterator<jakarta.faces.component.UIComponent> getFacetsAndChildren()

    • getId

      public String getId()

    • getParent

      public jakarta.faces.component.UIComponent getParent()

    • getRendererType

      public String getRendererType()

    • getRendersChildren

      public boolean getRendersChildren()

    • invokeOnComponent

      public boolean invokeOnComponent(jakarta.faces.context.FacesContext arg0, String arg1, jakarta.faces.component.ContextCallback arg2) throws jakarta.faces.FacesException
      Throws:
      jakarta.faces.FacesException

    • visitTree

      public boolean visitTree(jakarta.faces.component.visit.VisitContext arg0, jakarta.faces.component.visit.VisitCallback arg1)

    • isRendered

      public boolean isRendered()

    • isTransient

      public boolean isTransient()

    • markInitialState

      public void markInitialState()

    • addFacesListener

      protected void addFacesListener(jakarta.faces.event.FacesListener arg0)

    • getFacesContext

      protected jakarta.faces.context.FacesContext getFacesContext()

    • getFacesListeners

      protected jakarta.faces.event.FacesListener[] getFacesListeners(Class arg0)

    • getRenderer

      protected jakarta.faces.render.Renderer getRenderer(jakarta.faces.context.FacesContext arg0)

    • removeFacesListener

      protected void removeFacesListener(jakarta.faces.event.FacesListener arg0)

    • queueEvent

      public void queueEvent(jakarta.faces.event.FacesEvent arg0)

    • processDecodes

      public void processDecodes(jakarta.faces.context.FacesContext arg0)

    • processValidators

      public void processValidators(jakarta.faces.context.FacesContext arg0)

    • processUpdates

      public void processUpdates(jakarta.faces.context.FacesContext arg0)

    • processSaveState

      public Object processSaveState(jakarta.faces.context.FacesContext arg0)

    • processRestoreState

      public void processRestoreState(jakarta.faces.context.FacesContext arg0, Object arg1)

    • setTransient

      public void setTransient(boolean arg0)

    • saveAttachedState

      public static Object saveAttachedState(jakarta.faces.context.FacesContext arg0, Object arg1)

    • restoreAttachedState

      public static Object restoreAttachedState(jakarta.faces.context.FacesContext arg0, Object arg1) throws IllegalStateException
      Throws:
      IllegalStateException

    • saveState

      public Object saveState(jakarta.faces.context.FacesContext arg0)

    • setRendered

      public void setRendered(boolean arg0)

    • setRendererType

      public void setRendererType(String arg0)

    • getPassThroughAttributes

      public Map<String,Object> getPassThroughAttributes()

    • initialStateMarked

      public boolean initialStateMarked()

    • isCompositeComponent

      public static boolean isCompositeComponent(jakarta.faces.component.UIComponent arg0)

    • isInView

      public boolean isInView()

    • isVisitable

      protected boolean isVisitable(jakarta.faces.component.visit.VisitContext arg0)

    • setValueExpression

      public void setValueExpression(String arg0, jakarta.el.ValueExpression arg1)

    • getClientId

      public String getClientId()

    • getCompositeComponentParent

      public static jakarta.faces.component.UIComponent getCompositeComponentParent(jakarta.faces.component.UIComponent arg0)

    • getContainerClientId

      public String getContainerClientId(jakarta.faces.context.FacesContext arg0)

    • getCurrentComponent

      public static jakarta.faces.component.UIComponent getCurrentComponent(jakarta.faces.context.FacesContext arg0)

    • getCurrentCompositeComponent

      public static jakarta.faces.component.UIComponent getCurrentCompositeComponent(jakarta.faces.context.FacesContext arg0)

    • getListenersForEventClass

      public List<jakarta.faces.event.SystemEventListener> getListenersForEventClass(Class<? extends jakarta.faces.event.SystemEvent> arg0)

    • getNamingContainer

      public jakarta.faces.component.UIComponent getNamingContainer()

    • setInView

      public void setInView(boolean arg0)

    • getResourceBundleMap

      public Map<String,String> getResourceBundleMap()

    • getValueExpression

      public jakarta.el.ValueExpression getValueExpression(String arg0)

    • processEvent

      public void processEvent(jakarta.faces.event.ComponentSystemEvent arg0) throws jakarta.faces.event.AbortProcessingException
      Throws:
      jakarta.faces.event.AbortProcessingException

    • subscribeToEvent

      public void subscribeToEvent(Class<? extends jakarta.faces.event.SystemEvent> arg0, jakarta.faces.event.ComponentSystemEventListener arg1)

    • unsubscribeFromEvent

      public void unsubscribeFromEvent(Class<? extends jakarta.faces.event.SystemEvent> arg0, jakarta.faces.event.ComponentSystemEventListener arg1)

    • getStateHelper

      protected jakarta.faces.component.StateHelper getStateHelper()

    • getStateHelper

      protected jakarta.faces.component.StateHelper getStateHelper(boolean arg0)

    • getTransientStateHelper

      public jakarta.faces.component.TransientStateHelper getTransientStateHelper()

    • getTransientStateHelper

      public jakarta.faces.component.TransientStateHelper getTransientStateHelper(boolean arg0)

    • restoreTransientState

      public void restoreTransientState(jakarta.faces.context.FacesContext arg0, Object arg1)

    • saveTransientState

      public Object saveTransientState(jakarta.faces.context.FacesContext arg0)

    • popComponentFromEL

      public void popComponentFromEL(jakarta.faces.context.FacesContext arg0)

    • pushComponentToEL

      public void pushComponentToEL(jakarta.faces.context.FacesContext arg0, jakarta.faces.component.UIComponent arg1)