org.rcfaces.core.component
Class MessagesComponent

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIMessages
              org.rcfaces.core.internal.component.CameliaMessagesComponent
                  org.rcfaces.core.component.AbstractMessagesComponent
                      org.rcfaces.core.component.MessagesComponent

All Implemented Interfaces:

StateHolder, IClientDataCapability, IErrorEventCapability, IForegroundBackgroundColorCapability, IHeightCapability, IHelpCapability, IHiddenModeCapability, IInitEventCapability, ILayoutPositionCapability, ILookAndFeelCapability, IMarginCapability, IMouseEventCapability, IPartialRenderingCapability, IPositionCapability, IPropertyChangeEventCapability, IServerDataCapability, ISeverityStyleClassCapability, ISizeCapability, IStyleClassCapability, IToolTipCapability, IUnlockedClientAttributesCapability, IUserEventCapability, IVisibilityCapability, IWAIRoleCapability, IWidthCapability, org.rcfaces.core.internal.capability.IComponentLifeCycle, org.rcfaces.core.internal.capability.IRCFacesComponent, org.rcfaces.core.internal.manager.IClientDataManager, org.rcfaces.core.internal.manager.IContainerManager, org.rcfaces.core.internal.manager.IServerDataManager, org.rcfaces.core.internal.manager.ITransientAttributesManager

public class MessagesComponent
extends AbstractMessagesComponent
implements ISeverityStyleClassCapability

The messages Component is a placeholder for error messages (several messages can be shown simultaneously).

The messages Component has the following capabilities :

• ISeverityStyleClassCapability

The default messages renderer is linked to the f_messages javascript class. f_messages extends f_component, fa_messageText

Table of component style classes:

Style Name	Description
f_messages	Defines styles for the wrapper element

Field Summary

protected static Set	CAMELIA_ATTRIBUTES
static String	COMPONENT_TYPE

Fields inherited from class org.rcfaces.core.internal.component.CameliaMessagesComponent

engine

Fields inherited from class javax.faces.component.UIMessages

COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIComponent

bindings

Fields inherited from interface org.rcfaces.core.component.capability.IHiddenModeCapability

CLIENT_HIDDEN_MODE, DEFAULT_HIDDEN_MODE, IGNORE_HIDDEN_MODE, PHANTOM_HIDDEN_MODE, SERVER_HIDDEN_MODE

Constructor Summary

MessagesComponent()

MessagesComponent(String componentId)

Method Summary

protected Set	getCameliaFields()
String	getErrorStyleClass() Returns a space-separated list of CSS style class(es) to be applied for error messages.
String	getErrorStyleClass(FacesContext facesContext) See getErrorStyleClass() for more details
String	getFatalStyleClass() Returns a space-separated list of CSS style class(es) to be applied for fatal messages.
String	getFatalStyleClass(FacesContext facesContext) See getFatalStyleClass() for more details
String	getInfoStyleClass() Returns a space-separated list of CSS style class(es) to be applied for info messages.
String	getInfoStyleClass(FacesContext facesContext) See getInfoStyleClass() for more details
int	getMaxCount()
int	getMaxCount(FacesContext facesContext)
String	getWarnStyleClass() Returns a space-separated list of CSS style class(es) to be applied for warning messages.
String	getWarnStyleClass(FacesContext facesContext) See getWarnStyleClass() for more details
boolean	isErrorStyleClassSetted() Returns true if the attribute "errorStyleClass" is set.
boolean	isFatalStyleClassSetted() Returns true if the attribute "fatalStyleClass" is set.
boolean	isInfoStyleClassSetted() Returns true if the attribute "infoStyleClass" is set.
boolean	isMaxCountSetted() Returns true if the attribute "maxCount" is set.
boolean	isShowActiveComponentMessage()
boolean	isShowActiveComponentMessage(FacesContext facesContext)
boolean	isShowActiveComponentMessageSetted() Returns true if the attribute "showActiveComponentMessage" is set.
boolean	isShowIfMessage()
boolean	isShowIfMessage(FacesContext facesContext)
boolean	isShowIfMessageSetted() Returns true if the attribute "showIfMessage" is set.
boolean	isWarnStyleClassSetted() Returns true if the attribute "warnStyleClass" is set.
void	setErrorStyleClass(String errorStyleClass) Sets a space-separated list of CSS style class(es) to be applied for error messages.
void	setFatalStyleClass(String fatalStyleClass) Sets a space-separated list of CSS style class(es) to be applied for fatal messages.
void	setInfoStyleClass(String infoStyleClass) Sets a space-separated list of CSS style class(es) to be applied for info messages.
void	setMaxCount(int maxCount)
void	setShowActiveComponentMessage(boolean showActiveComponentMessage)
void	setShowIfMessage(boolean showIfMessage)
void	setWarnStyleClass(String warnStyleClass) Sets a space-separated list of CSS style class(es) to be applied for warning messages.

Methods inherited from class org.rcfaces.core.component.AbstractMessagesComponent

addErrorListener, addInitListener, addMouseOutListener, addMouseOverListener, addPropertyChangeListener, addUserEventListener, getAriaLabel, getAriaLabel, getAriaLevel, getAriaLevel, getBackgroundColor, getBackgroundColor, getBottom, getBottom, getClientData, getClientData, getClientDataCount, getClientDataMap, getClientDataMap, getForegroundColor, getForegroundColor, getHeight, getHeight, getHelpMessage, getHelpMessage, getHelpURL, getHelpURL, getHiddenMode, getHiddenMode, getLeft, getLeft, getLookId, getLookId, getMarginBottom, getMarginBottom, getMarginLeft, getMarginLeft, getMarginRight, getMarginRight, getMarginTop, getMarginTop, getRight, getRight, getServerData, getServerData, getServerDataCount, getServerDataMap, getServerDataMap, getStyleClass, getStyleClass, getToolTipText, getToolTipText, getTop, getTop, getUnlockedClientAttributeNames, getUnlockedClientAttributeNames, getVisibleState, getVisibleState, getWaiRole, getWaiRole, getWidth, getWidth, getX, getX, getY, getY, isAriaLabelSetted, isAriaLevelSetted, isBackgroundColorSetted, isBottomSetted, isForegroundColorSetted, isHeightSetted, isHelpMessageSetted, isHelpURLSetted, isHiddenModeSetted, isLeftSetted, isLookIdSetted, isMarginBottomSetted, isMarginLeftSetted, isMarginRightSetted, isMarginTopSetted, isPartialRendering, isPartialRendering, isPartialRenderingSetted, isRightSetted, isStyleClassSetted, isToolTipTextSetted, isTopSetted, isUnlockedClientAttributeNamesSetted, isVisible, isVisible, isVisibleSetted, isWaiRoleSetted, isWidthSetted, isXSetted, isYSetted, listClientDataKeys, listClientDataKeys, listErrorListeners, listInitListeners, listMouseOutListeners, listMouseOverListeners, listPropertyChangeListeners, listServerDataKeys, listServerDataKeys, listUserEventListeners, removeClientData, removeErrorListener, removeInitListener, removeMouseOutListener, removeMouseOverListener, removePropertyChangeListener, removeServerData, removeUserEventListener, setAriaLabel, setAriaLevel, setBackgroundColor, setBottom, setClientData, setClientData, setForegroundColor, setHeight, setHelpMessage, setHelpURL, setHiddenMode, setHiddenMode, setLeft, setLookId, setMarginBottom, setMarginLeft, setMarginRight, setMargins, setMarginTop, setPartialRendering, setRight, setServerData, setServerData, setStyleClass, setToolTipText, setTop, setUnlockedClientAttributeNames, setVisible, setWaiRole, setWidth, setX, setY

Methods inherited from class org.rcfaces.core.internal.component.CameliaMessagesComponent

clearListeners, confirmListenerAppend, constructPhase, constructTemplate, decodePhase, encodeBegin, encodeChildren, encodeEnd, getAsyncRenderer, getCameliaValueAlias, getChildren, getChildrenListState, getFamily, getRendererType, getTransientAttribute, getValueExpression, hasDefaultProperties, initializeComponent, initializePhase, isClientRendered, isRendered, isTemplateComponent, processDecodes, processEngineUpdates, processEngineValidators, processUpdates, processValidators, queueEvent, renderPhase, restoreState, saveState, setDefaultProperties, setRendered, setTransientAttribute, setValueExpression, toString, updatePhase, validationPhase, verifyAsyncDecode

Methods inherited from class javax.faces.component.UIMessages

isGlobalOnly, isShowDetail, isShowSummary, setGlobalOnly, setShowDetail, setShowSummary

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, broadcast, decode, findComponent, getAttributes, getChildCount, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendersChildren, getValueBinding, invokeOnComponent, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.rcfaces.core.component.capability.IStyleClassCapability

getStyleClass, setStyleClass

Methods inherited from interface org.rcfaces.core.internal.manager.IContainerManager

getChildCount

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

CAMELIA_ATTRIBUTES

protected static final Set CAMELIA_ATTRIBUTES

Constructor Detail

MessagesComponent

public MessagesComponent()

MessagesComponent

public MessagesComponent(String componentId)

Method Detail

getErrorStyleClass

public String getErrorStyleClass()

Description copied from interface: ISeverityStyleClassCapability

Returns a space-separated list of CSS style class(es) to be applied for error messages. This value will be passed through as the "class" attribute on generated markup.

Specified by:

getErrorStyleClass in interface ISeverityStyleClassCapability

Returns:

list of CSS style classes

getErrorStyleClass

public String getErrorStyleClass(FacesContext facesContext)

See getErrorStyleClass() for more details

isErrorStyleClassSetted

public final boolean isErrorStyleClassSetted()

Returns true if the attribute "errorStyleClass" is set.

Returns:

true if the attribute is set.

setErrorStyleClass

public void setErrorStyleClass(String errorStyleClass)

Description copied from interface: ISeverityStyleClassCapability

Sets a space-separated list of CSS style class(es) to be applied for error messages. This value will be passed through as the "class" attribute on generated markup.

Specified by:

setErrorStyleClass in interface ISeverityStyleClassCapability

Parameters:

errorStyleClass - list of CSS style classes

getFatalStyleClass

public String getFatalStyleClass()

Description copied from interface: ISeverityStyleClassCapability

Returns a space-separated list of CSS style class(es) to be applied for fatal messages. This value will be passed through as the "class" attribute on generated markup.

Specified by:

getFatalStyleClass in interface ISeverityStyleClassCapability

Returns:

list of CSS style classes

getFatalStyleClass

public String getFatalStyleClass(FacesContext facesContext)

See getFatalStyleClass() for more details

isFatalStyleClassSetted

public final boolean isFatalStyleClassSetted()

Returns true if the attribute "fatalStyleClass" is set.

Returns:

true if the attribute is set.

setFatalStyleClass

public void setFatalStyleClass(String fatalStyleClass)

Description copied from interface: ISeverityStyleClassCapability

Sets a space-separated list of CSS style class(es) to be applied for fatal messages. This value will be passed through as the "class" attribute on generated markup.

Specified by:

setFatalStyleClass in interface ISeverityStyleClassCapability

Parameters:

fatalStyleClass - list of CSS style classes

getInfoStyleClass

public String getInfoStyleClass()

Description copied from interface: ISeverityStyleClassCapability

Returns a space-separated list of CSS style class(es) to be applied for info messages. This value will be passed through as the "class" attribute on generated markup.

Specified by:

getInfoStyleClass in interface ISeverityStyleClassCapability

Returns:

list of CSS style classes

getInfoStyleClass

public String getInfoStyleClass(FacesContext facesContext)

See getInfoStyleClass() for more details

isInfoStyleClassSetted

public final boolean isInfoStyleClassSetted()

Returns true if the attribute "infoStyleClass" is set.

Returns:

true if the attribute is set.

setInfoStyleClass

public void setInfoStyleClass(String infoStyleClass)

Description copied from interface: ISeverityStyleClassCapability

Sets a space-separated list of CSS style class(es) to be applied for info messages. This value will be passed through as the "class" attribute on generated markup.

Specified by:

setInfoStyleClass in interface ISeverityStyleClassCapability

Parameters:

infoStyleClass - list of CSS style classes

getWarnStyleClass

public String getWarnStyleClass()

Description copied from interface: ISeverityStyleClassCapability

Returns a space-separated list of CSS style class(es) to be applied for warning messages. This value will be passed through as the "class" attribute on generated markup.

Specified by:

getWarnStyleClass in interface ISeverityStyleClassCapability

Returns:

list of CSS style classes

getWarnStyleClass

public String getWarnStyleClass(FacesContext facesContext)

See getWarnStyleClass() for more details

isWarnStyleClassSetted

public final boolean isWarnStyleClassSetted()

Returns true if the attribute "warnStyleClass" is set.

Returns:

true if the attribute is set.

setWarnStyleClass

public void setWarnStyleClass(String warnStyleClass)

Description copied from interface: ISeverityStyleClassCapability

Sets a space-separated list of CSS style class(es) to be applied for warning messages. This value will be passed through as the "class" attribute on generated markup.

Specified by:

setWarnStyleClass in interface ISeverityStyleClassCapability

Parameters:

warnStyleClass - list of CSS style classes

isShowIfMessage

public boolean isShowIfMessage()

isShowIfMessage

public boolean isShowIfMessage(FacesContext facesContext)

setShowIfMessage

public void setShowIfMessage(boolean showIfMessage)

isShowIfMessageSetted

public boolean isShowIfMessageSetted()

Returns true if the attribute "showIfMessage" is set.

Returns:

true if the attribute is set.

isShowActiveComponentMessage

public boolean isShowActiveComponentMessage()

isShowActiveComponentMessage

public boolean isShowActiveComponentMessage(FacesContext facesContext)

setShowActiveComponentMessage

public void setShowActiveComponentMessage(boolean showActiveComponentMessage)

isShowActiveComponentMessageSetted

public boolean isShowActiveComponentMessageSetted()

Returns true if the attribute "showActiveComponentMessage" is set.

Returns:

true if the attribute is set.

getMaxCount

public int getMaxCount()

getMaxCount

public int getMaxCount(FacesContext facesContext)

setMaxCount

public void setMaxCount(int maxCount)

isMaxCountSetted

public boolean isMaxCountSetted()

Returns true if the attribute "maxCount" is set.

Returns:

true if the attribute is set.

getCameliaFields

protected Set getCameliaFields()

Overrides:

getCameliaFields in class AbstractMessagesComponent