org.apache.myfaces.tobago.component
Class UIMessages

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

All Implemented Interfaces:

javax.faces.component.StateHolder, SupportsMarkup, Configurable, LayoutBase, LayoutComponent

public class UIMessages
extends AbstractUIMessages
implements SupportsMarkup

Renders error/validation messages. UIComponent class, generated from template component1.2.stg with class MessagesTagDeclaration.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIMessages

AbstractUIMessages.Item, AbstractUIMessages.ItemComparator, AbstractUIMessages.OrderBy

Field Summary

static String

COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIMessages

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

UIMessages()

Method Summary

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()
Measure	getMaximumHeight()
Measure	getMaximumWidth()
Integer	getMaxNumber() Sets the maximum number of messages to show.
javax.faces.application.FacesMessage.Severity	getMaxSeverity() Sets the maximum severity to be shown.
Measure	getMinimumHeight()
Measure	getMinimumWidth()
javax.faces.application.FacesMessage.Severity	getMinSeverity() Sets the mininum severity to be shown.
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?
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(javax.faces.context.FacesContext context, Object componentState)
Object	saveState(javax.faces.context.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	setMaximumHeight(Measure maximumHeight)
void	setMaximumWidth(Measure maximumWidth)
void	setMaxNumber(Integer maxNumber)
void	setMaxSeverity(javax.faces.application.FacesMessage.Severity maxSeverity)
void	setMinimumHeight(Measure minimumHeight)
void	setMinimumWidth(Measure minimumWidth)
void	setMinSeverity(javax.faces.application.FacesMessage.Severity minSeverity)
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)

Methods inherited from class org.apache.myfaces.tobago.internal.component.AbstractUIMessages

createMessageList

Methods inherited from class javax.faces.component.UIMessages

getFamily, isGlobalOnly, setGlobalOnly

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId, getValueExpression, setValueExpression

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.myfaces.tobago.layout.LayoutComponent

isRendered

Methods inherited from interface org.apache.myfaces.tobago.config.Configurable

getRendererType

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

UIMessages

public UIMessages()

Method Detail

getMarkup

public Markup getMarkup()

Specified by:

getMarkup in interface SupportsMarkup

setMarkup

public void setMarkup(Markup markup)

Specified by:

setMarkup in interface SupportsMarkup

isShowSummary

public boolean isShowSummary()

Flag indicating whether the summary should be included
Default: true

Overrides:

isShowSummary in class javax.faces.component.UIMessages

setShowSummary

public void setShowSummary(boolean showSummary)

Overrides:

setShowSummary in class javax.faces.component.UIMessages

getOrderBy

public AbstractUIMessages.OrderBy getOrderBy()

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

Specified by:

getOrderBy in class AbstractUIMessages

setOrderBy

public void setOrderBy(AbstractUIMessages.OrderBy orderBy)

getGlobalOnly

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

setGlobalOnly

public void setGlobalOnly(String globalOnly)

getMarginLeft

public Measure getMarginLeft()

Specified by:

getMarginLeft in interface LayoutBase

setMarginLeft

public void setMarginLeft(Measure marginLeft)

Specified by:

setMarginLeft in interface LayoutBase

getFor

public String getFor()

Id of the component, this is related to.

Specified by:

getFor in class AbstractUIMessages

setFor

public void setFor(String forComponent)

getMinimumHeight

public Measure getMinimumHeight()

Specified by:

getMinimumHeight in interface LayoutBase

setMinimumHeight

public void setMinimumHeight(Measure minimumHeight)

Specified by:

setMinimumHeight in interface LayoutBase

getMaxSeverity

public javax.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(javax.faces.application.FacesMessage.Severity maxSeverity)

getMinSeverity

public javax.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(javax.faces.application.FacesMessage.Severity minSeverity)

getHeight

public Measure getHeight()

This value will usually be set by the layout manager.

Specified by:

getHeight in interface LayoutBase

setHeight

public void setHeight(Measure height)

Specified by:

setHeight in interface LayoutBase

getMinimumWidth

public Measure getMinimumWidth()

Specified by:

getMinimumWidth in interface LayoutBase

setMinimumWidth

public void setMinimumWidth(Measure minimumWidth)

Specified by:

setMinimumWidth in interface LayoutBase

getRowSpan

public Integer getRowSpan()

Specified by:

getRowSpan in interface LayoutComponent

setRowSpan

public void setRowSpan(Integer rowSpan)

Specified by:

setRowSpan in interface LayoutComponent

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

setConfirmation

public void setConfirmation(boolean confirmation)

getLeft

public Measure getLeft()

This value will usually be set by the layout manager.

Specified by:

getLeft in interface LayoutBase

setLeft

public void setLeft(Measure left)

Specified by:

setLeft in interface LayoutBase

getColumnSpan

public Integer getColumnSpan()

Specified by:

getColumnSpan in interface LayoutComponent

setColumnSpan

public void setColumnSpan(Integer columnSpan)

Specified by:

setColumnSpan in interface LayoutComponent

getMaximumHeight

public Measure getMaximumHeight()

Specified by:

getMaximumHeight in interface LayoutBase

setMaximumHeight

public void setMaximumHeight(Measure maximumHeight)

Specified by:

setMaximumHeight in interface LayoutBase

getTop

public Measure getTop()

This value will usually be set by the layout manager.

Specified by:

getTop in interface LayoutBase

setTop

public void setTop(Measure top)

Specified by:

setTop in interface LayoutBase

getCurrentWidth

public Measure getCurrentWidth()

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

Specified by:

getCurrentWidth in interface LayoutBase

setCurrentWidth

public void setCurrentWidth(Measure currentWidth)

Specified by:

setCurrentWidth in interface LayoutBase

getMarginTop

public Measure getMarginTop()

Specified by:

getMarginTop in interface LayoutBase

setMarginTop

public void setMarginTop(Measure marginTop)

Specified by:

setMarginTop in interface LayoutBase

getMarginRight

public Measure getMarginRight()

Specified by:

getMarginRight in interface LayoutBase

setMarginRight

public void setMarginRight(Measure marginRight)

Specified by:

setMarginRight in interface LayoutBase

getWidth

public Measure getWidth()

This value will usually be set by the layout manager.

Specified by:

getWidth in interface LayoutBase

setWidth

public void setWidth(Measure width)

Specified by:

setWidth in interface LayoutBase

getCurrentHeight

public Measure getCurrentHeight()

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

Specified by:

getCurrentHeight in interface LayoutBase

setCurrentHeight

public void setCurrentHeight(Measure currentHeight)

Specified by:

setCurrentHeight in interface LayoutBase

getPreferredHeight

public Measure getPreferredHeight()

Specified by:

getPreferredHeight in interface LayoutBase

setPreferredHeight

public void setPreferredHeight(Measure preferredHeight)

Specified by:

setPreferredHeight in interface LayoutBase

isShowDetail

public boolean isShowDetail()

Flag indicating whether the detail should be included
Default: false

Overrides:

isShowDetail in class javax.faces.component.UIMessages

setShowDetail

public void setShowDetail(boolean showDetail)

Overrides:

setShowDetail in class javax.faces.component.UIMessages

getDisplay

public Display getDisplay()

This attribute is for internal use only.

Specified by:

getDisplay in interface LayoutComponent

setDisplay

public void setDisplay(Display display)

Specified by:

setDisplay in interface LayoutComponent

getMaximumWidth

public Measure getMaximumWidth()

Specified by:

getMaximumWidth in interface LayoutBase

setMaximumWidth

public void setMaximumWidth(Measure maximumWidth)

Specified by:

setMaximumWidth in interface LayoutBase

getPreferredWidth

public Measure getPreferredWidth()

Specified by:

getPreferredWidth in interface LayoutBase

setPreferredWidth

public void setPreferredWidth(Measure preferredWidth)

Specified by:

setPreferredWidth in interface LayoutBase

getMarginBottom

public Measure getMarginBottom()

Specified by:

getMarginBottom in interface LayoutBase

setMarginBottom

public void setMarginBottom(Measure marginBottom)

Specified by:

setMarginBottom in interface LayoutBase

getVerticalIndex

public Integer getVerticalIndex()

This attribute is for internal use only.

Specified by:

getVerticalIndex in interface LayoutComponent

setVerticalIndex

public void setVerticalIndex(Integer verticalIndex)

Specified by:

setVerticalIndex in interface LayoutComponent

getCurrentMarkup

public Markup getCurrentMarkup()

Specified by:

getCurrentMarkup in interface SupportsMarkup

Specified by:

getCurrentMarkup in interface Configurable

setCurrentMarkup

public void setCurrentMarkup(Markup currentMarkup)

Specified by:

setCurrentMarkup in interface SupportsMarkup

getHorizontalIndex

public Integer getHorizontalIndex()

This attribute is for internal use only.

Specified by:

getHorizontalIndex in interface LayoutComponent

setHorizontalIndex

public void setHorizontalIndex(Integer horizontalIndex)

Specified by:

setHorizontalIndex in interface LayoutComponent

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)

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         Object componentState)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIMessages

saveState

public Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIMessages