public class

UIMessages

extends AbstractUIMessages
implements SupportsMarkup
java.lang.Object
   ↳ javax.faces.component.UIComponent
     ↳ javax.faces.component.UIComponentBase
       ↳ javax.faces.component.UIMessages
         ↳ org.apache.myfaces.tobago.internal.component.AbstractUIMessages
           ↳ org.apache.myfaces.tobago.component.UIMessages

Class Overview

Renders error/validation messages. UIComponent class, generated from template component1.2.stg with class org.apache.myfaces.tobago.internal.taglib.component.MessagesTagDeclaration.

Summary

Constants
String COMPONENT_TYPE
[Expand]
Inherited Constants
From class javax.faces.component.UIMessages
[Expand]
Inherited Fields
From class javax.faces.component.UIComponent
Public Constructors
UIMessages()
Public Methods
Integer getColumnSpan()
Measure getCurrentHeight()
This value will usually be set by the layout manager.
Markup getCurrentMarkup()
Measure getCurrentWidth()
This value will usually be set by the layout manager.
Display getDisplay()
This attribute is for internal use only.
String getFor()
Id of the component, this is related to.
String getGlobalOnly()
Flag indicating that only messages that are not associated to any particular UIComponent should be displayed.
Measure getHeight()
This value will usually be set by the layout manager.
Integer getHorizontalIndex()
This attribute is for internal use only.
Measure getLeft()
This value will usually be set by the layout manager.
Measure getMarginBottom()
Measure getMarginLeft()
Measure getMarginRight()
Measure getMarginTop()
Markup getMarkup()
Integer getMaxNumber()
Sets the maximum number of messages to show.
FacesMessage.Severity getMaxSeverity()
Sets the maximum severity to be shown.
Measure getMaximumHeight()
Measure getMaximumWidth()
FacesMessage.Severity getMinSeverity()
Sets the mininum severity to be shown.
Measure getMinimumHeight()
Measure getMinimumWidth()
AbstractUIMessages.OrderBy getOrderBy()
Sets the order of the messages.
Measure getPreferredHeight()
Measure getPreferredWidth()
Integer getRowSpan()
Measure getTop()
This value will usually be set by the layout manager.
Integer getVerticalIndex()
This attribute is for internal use only.
Measure getWidth()
This value will usually be set by the layout manager.
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.
boolean isShowDetail()
Flag indicating whether the detail should be included
Default: false
boolean isShowSummary()
Flag indicating whether the summary should be included
Default: true
void restoreState(FacesContext context, Object componentState)
Object saveState(FacesContext context)
void setColumnSpan(Integer columnSpan)
void setConfirmation(boolean confirmation)
void setCurrentHeight(Measure currentHeight)
void setCurrentMarkup(Markup currentMarkup)
void setCurrentWidth(Measure currentWidth)
void setDisplay(Display display)
void setFor(String forComponent)
void setGlobalOnly(String globalOnly)
void setHeight(Measure height)
void setHorizontalIndex(Integer horizontalIndex)
void setLeft(Measure left)
void setMarginBottom(Measure marginBottom)
void setMarginLeft(Measure marginLeft)
void setMarginRight(Measure marginRight)
void setMarginTop(Measure marginTop)
void setMarkup(Markup markup)
void setMaxNumber(Integer maxNumber)
void setMaxSeverity(FacesMessage.Severity maxSeverity)
void setMaximumHeight(Measure maximumHeight)
void setMaximumWidth(Measure maximumWidth)
void setMinSeverity(FacesMessage.Severity minSeverity)
void setMinimumHeight(Measure minimumHeight)
void setMinimumWidth(Measure minimumWidth)
void setOrderBy(AbstractUIMessages.OrderBy orderBy)
void setPreferredHeight(Measure preferredHeight)
void setPreferredWidth(Measure preferredWidth)
void setRowSpan(Integer rowSpan)
void setShowDetail(boolean showDetail)
void setShowSummary(boolean showSummary)
void setTop(Measure top)
void setVerticalIndex(Integer verticalIndex)
void setWidth(Measure width)
[Expand]
Inherited Methods
From class org.apache.myfaces.tobago.internal.component.AbstractUIMessages
From class javax.faces.component.UIMessages
From class javax.faces.component.UIComponentBase
From class javax.faces.component.UIComponent
From class java.lang.Object
From interface javax.faces.component.StateHolder
From interface org.apache.myfaces.tobago.component.SupportsMarkup
From interface org.apache.myfaces.tobago.config.Configurable
From interface org.apache.myfaces.tobago.layout.LayoutBase
From interface org.apache.myfaces.tobago.layout.LayoutComponent

Constants

public static final String COMPONENT_TYPE

Constant Value: "org.apache.myfaces.tobago.Messages"

Public Constructors

public UIMessages ()

Public Methods

public Integer getColumnSpan ()

public Measure getCurrentHeight ()

This value will usually be set by the layout manager. It holds the current height computed by the layout manager.

public Markup getCurrentMarkup ()

public Measure getCurrentWidth ()

This value will usually be set by the layout manager. It holds the current width computed by the layout manager.

public Display getDisplay ()

This attribute is for internal use only.

public String getFor ()

Id of the component, this is related to.

public String getGlobalOnly ()

Flag indicating that only messages that are not associated to any particular UIComponent should be displayed. That are messages without clientId.
Default: false

public Measure getHeight ()

This value will usually be set by the layout manager.

public Integer getHorizontalIndex ()

This attribute is for internal use only.

public Measure getLeft ()

This value will usually be set by the layout manager.

public Measure getMarginBottom ()

public Measure getMarginLeft ()

public Measure getMarginRight ()

public Measure getMarginTop ()

public Markup getMarkup ()

public Integer getMaxNumber ()

Sets the maximum number of messages to show.
Default: 2147483647

public 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

public Measure getMaximumHeight ()

public Measure getMaximumWidth ()

public FacesMessage.Severity getMinSeverity ()

Sets the mininum severity to be shown. E. g. "warn" shows only "warn", "error" and "fatal".
Default: info

public Measure getMinimumHeight ()

public Measure getMinimumWidth ()

public AbstractUIMessages.OrderBy getOrderBy ()

Sets the order of the messages.
Default: occurrence
Allowed Values: occurrence,severity

public Measure getPreferredHeight ()

public Measure getPreferredWidth ()

public Integer getRowSpan ()

public Measure getTop ()

This value will usually be set by the layout manager.

public Integer getVerticalIndex ()

This attribute is for internal use only.

public Measure getWidth ()

This value will usually be set by the layout manager.

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

public boolean isShowDetail ()

Flag indicating whether the detail should be included
Default: false

public boolean isShowSummary ()

Flag indicating whether the summary should be included
Default: true

public void restoreState (FacesContext context, Object componentState)

public Object saveState (FacesContext context)

public void setColumnSpan (Integer columnSpan)

public void setConfirmation (boolean confirmation)

public void setCurrentHeight (Measure currentHeight)

public void setCurrentMarkup (Markup currentMarkup)

public void setCurrentWidth (Measure currentWidth)

public void setDisplay (Display display)

public void setFor (String forComponent)

public void setGlobalOnly (String globalOnly)

public void setHeight (Measure height)

public void setHorizontalIndex (Integer horizontalIndex)

public void setLeft (Measure left)

public void setMarginBottom (Measure marginBottom)

public void setMarginLeft (Measure marginLeft)

public void setMarginRight (Measure marginRight)

public void setMarginTop (Measure marginTop)

public void setMarkup (Markup markup)

public void setMaxNumber (Integer maxNumber)

public void setMaxSeverity (FacesMessage.Severity maxSeverity)

public void setMaximumHeight (Measure maximumHeight)

public void setMaximumWidth (Measure maximumWidth)

public void setMinSeverity (FacesMessage.Severity minSeverity)

public void setMinimumHeight (Measure minimumHeight)

public void setMinimumWidth (Measure minimumWidth)

public void setOrderBy (AbstractUIMessages.OrderBy orderBy)

public void setPreferredHeight (Measure preferredHeight)

public void setPreferredWidth (Measure preferredWidth)

public void setRowSpan (Integer rowSpan)

public void setShowDetail (boolean showDetail)

public void setShowSummary (boolean showSummary)

public void setTop (Measure top)

public void setVerticalIndex (Integer verticalIndex)

public void setWidth (Measure width)