Class UIMessages

    • 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 appropriate Renderer for this component instance. Note this method should NOT return null

        Specified by:
        getFamily in class UIComponent
        Returns:
        the component family (not null).
      • getFor

        public String getFor()

        Return the client identifier of the component for which this component represents associated message(s) (if any).

        Returns:
        the for client identifier.
      • 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.

        Returns:
        true if only global messages are to be shown, false otherwise.
      • 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.

        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 to true.

        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 this UIMessage instance should redisplay FacesMessages that have already been handled, otherwise returns false. By default this method will always return true if setRedisplay(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