com.ibm.xsp.component.xp
Class XspMessages

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIMessages
              com.ibm.xsp.component.UIMessagesEx
                  com.ibm.xsp.component.xp.XspMessages

All Implemented Interfaces:

ThemeControl, javax.faces.component.StateHolder

public class XspMessages
extends UIMessagesEx

A control that displays warning, information, and error messages for all controls on a page.

XPages Core Controls - Display Errors

Nested Class Summary

Nested classes/interfaces inherited from class javax.faces.component.UIComponentBase

javax.faces.component.UIComponentBase.AggregatedIterator, javax.faces.component.UIComponentBase.UnmodifiableIterator

Nested classes/interfaces inherited from class javax.faces.component.UIComponent

javax.faces.component.UIComponent.StateMap, javax.faces.component.UIComponent.StateMapEntry

Field Summary

static java.lang.String

COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIMessages

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponentBase

EMPTY_ITERATOR

Fields inherited from class javax.faces.component.UIComponent

_xspStateId

Constructor Summary

XspMessages()

Method Summary

java.lang.String	getDir() Return the value of the dir property.
java.lang.String	getErrorClass() Return the value of the errorClass property.
java.lang.String	getErrorStyle() Return the value of the errorStyle property.
java.lang.String	getFatalClass() Return the value of the fatalClass property.
java.lang.String	getFatalStyle() Return the value of the fatalStyle property.
java.lang.String	getInfoClass() Return the value of the infoClass property.
java.lang.String	getInfoStyle() Return the value of the infoStyle property.
java.lang.String	getLang() Return the value of the lang property.
java.lang.String	getLayout() Return the value of the layout property.
java.lang.String	getRole() Return the value of the role property.
java.lang.String	getStyle() Return the value of the style property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
java.lang.String	getTitle() Return the value of the title property.
java.lang.String	getWarnClass() Return the value of the warnClass property.
java.lang.String	getWarnStyle() Return the value of the warnStyle property.
boolean	isTooltip() Return the value of the tooltip property.
void	restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
java.lang.Object	saveState(javax.faces.context.FacesContext _context)
void	setDir(java.lang.String dir) Set the value of the dir property.
void	setErrorClass(java.lang.String errorClass) Set the value of the errorClass property.
void	setErrorStyle(java.lang.String errorStyle) Set the value of the errorStyle property.
void	setFatalClass(java.lang.String fatalClass) Set the value of the fatalClass property.
void	setFatalStyle(java.lang.String fatalStyle) Set the value of the fatalStyle property.
void	setInfoClass(java.lang.String infoClass) Set the value of the infoClass property.
void	setInfoStyle(java.lang.String infoStyle) Set the value of the infoStyle property.
void	setLang(java.lang.String lang) Set the value of the lang property.
void	setLayout(java.lang.String layout) Set the value of the layout property.
void	setRole(java.lang.String role) Set the value of the role property.
void	setStyle(java.lang.String style) Set the value of the style property.
void	setStyleClass(java.lang.String styleClass) Set the value of the styleClass property.
void	setTitle(java.lang.String title) Set the value of the title property.
void	setTooltip(boolean tooltip) Set the value of the tooltip property.
void	setWarnClass(java.lang.String warnClass) Set the value of the warnClass property.
void	setWarnStyle(java.lang.String warnStyle) Set the value of the warnStyle property.

Methods inherited from class com.ibm.xsp.component.UIMessagesEx

getStyleKitFamily

Methods inherited from class javax.faces.component.UIMessages

getFamily, isGlobalOnly, isShowDetail, isShowSummary, setGlobalOnly, setShowDetail, setShowSummary

Methods inherited from class javax.faces.component.UIComponentBase

_xspCleanTransientData, _xspGetReadOnlyObj, _xspGetRendererData, _xspRemoveReadOnlyObj, _xspRemoveRendererData, _xspSetIdUnchecked, _xspSetReadOnlyObj, _xspSetRendererData, addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, 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

_xspGetStateId, _xspGetStateMap, _xspRestoreAttribute, _xspRestoreState, _xspSaveState, invokeOnComponent, isVisitable, markInitialState, setControlState, visitTree

Methods inherited from class java.lang.Object

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

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

XspMessages

public XspMessages()

Method Detail

getDir

public java.lang.String getDir()

Return the value of the dir property. Contents:

Specifies the direction for text that does not inherit a direction. Valid values are 'LTR' (left to right) and 'RTL' (right to left).

getErrorClass

public java.lang.String getErrorClass()

Return the value of the errorClass property. Contents:

CSS style class to apply to any message with a severity class of "ERROR"

getErrorStyle

public java.lang.String getErrorStyle()

Return the value of the errorStyle property. Contents:

CSS style(s) to apply to any message with a severity class of "ERROR"

getFatalClass

public java.lang.String getFatalClass()

Return the value of the fatalClass property. Contents:

CSS style class to apply to any message with a severity class of "FATAL"

getFatalStyle

public java.lang.String getFatalStyle()

Return the value of the fatalStyle property. Contents:

CSS style(s) to apply to any message with a severity class of "FATAL"

getInfoClass

public java.lang.String getInfoClass()

Return the value of the infoClass property. Contents:

CSS style class to apply to any message with a severity class of "INFO"

getInfoStyle

public java.lang.String getInfoStyle()

Return the value of the infoStyle property. Contents:

CSS style(s) to apply to any message with a severity class of "INFO"

getLang

public java.lang.String getLang()

Return the value of the lang property. Contents:

Describes the language used in the generated markup of the control.

getLayout

public java.lang.String getLayout()

Return the value of the layout property. Contents:

The type of layout markup to use when rendering error messages. Valid values are "table" (an HTML table) and "list" (an HTML list). If not specified, the default value is "list".

getRole

public java.lang.String getRole()

Return the value of the role property. Contents:

Describes the role of the current UI element/area. It can be used by assistive technologies to determine its purpose.

getStyle

public java.lang.String getStyle()

Return the value of the style property. Contents:

Specifies CSS style(s) to be applied when this control is rendered.

XPages Styling Category - style

getStyleClass

public java.lang.String getStyleClass()

Return the value of the styleClass property. Contents:

Specifies the space-separated list of CSS style class(es) to be applied when this control is rendered. This value must be passed through as the "class" attribute on generated markup.

getTitle

public java.lang.String getTitle()

Return the value of the title property. Contents:

Provides title information for controls.

getWarnClass

public java.lang.String getWarnClass()

Return the value of the warnClass property. Contents:

CSS style class to apply to any message with a severity class of "WARN"

getWarnStyle

public java.lang.String getWarnStyle()

Return the value of the warnStyle property. Contents:

CSS style(s) to apply to any message with a severity class of "WARN"

isTooltip

public boolean isTooltip()

Return the value of the tooltip property. Contents:

Flag indicating whether the detail portion of the message should be displayed as a tool tip

restoreState

public void restoreState(javax.faces.context.FacesContext _context,
                         java.lang.Object _state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class javax.faces.component.UIMessages

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext _context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIMessages

setDir

public void setDir(java.lang.String dir)

Set the value of the dir property.

setErrorClass

public void setErrorClass(java.lang.String errorClass)

Set the value of the errorClass property.

setErrorStyle

public void setErrorStyle(java.lang.String errorStyle)

Set the value of the errorStyle property.

setFatalClass

public void setFatalClass(java.lang.String fatalClass)

Set the value of the fatalClass property.

setFatalStyle

public void setFatalStyle(java.lang.String fatalStyle)

Set the value of the fatalStyle property.

setInfoClass

public void setInfoClass(java.lang.String infoClass)

Set the value of the infoClass property.

setInfoStyle

public void setInfoStyle(java.lang.String infoStyle)

Set the value of the infoStyle property.

setLang

public void setLang(java.lang.String lang)

Set the value of the lang property.

setLayout

public void setLayout(java.lang.String layout)

Set the value of the layout property.

setRole

public void setRole(java.lang.String role)

Set the value of the role property.

setStyle

public void setStyle(java.lang.String style)

Set the value of the style property.

setStyleClass

public void setStyleClass(java.lang.String styleClass)

Set the value of the styleClass property.

setTitle

public void setTitle(java.lang.String title)

Set the value of the title property.

setTooltip

public void setTooltip(boolean tooltip)

Set the value of the tooltip property.

setWarnClass

public void setWarnClass(java.lang.String warnClass)

Set the value of the warnClass property.

setWarnStyle

public void setWarnStyle(java.lang.String warnStyle)

Set the value of the warnStyle property.