org.richfaces.component

Class UINotifyMessage

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIMessage

org.richfaces.component.AbstractNotifyMessage

org.richfaces.component.UINotifyMessage

All Implemented Interfaces:

EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, org.ajax4jsf.component.AjaxOutput, ClientSideMessage, org.richfaces.component.NotifyAttributes

Direct Known Subclasses:

HtmlNotifyMessage

@Generated(value={"RichFaces CDK","4.3.1.Final"})
public class UINotifyMessage
extends AbstractNotifyMessage
implements org.ajax4jsf.component.AjaxOutput, ClientSideMessage, org.richfaces.component.NotifyAttributes

The <rich:notifyMessage> component is built on top of <rich:notify>, the difference is in usage. The <rich:notifyMessage> component displays FacesMessages associated with a given component, similar to <rich:message>: one notification is displayed for first FacesMessage in the stack that is risen either programatically or during conversion/validation of the component. The severity of the message determines the color and icon of the resulting notification.

Author:

Lukas Fryc, Brian Leathem

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	UINotifyMessage.Properties

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
UINotifyMessage()

Method Summary

Methods

Modifier and Type	Method and Description
String	getFamily()
Double	getNonblockingOpacity()
String	getStack()
Integer	getStayTime()
String	getStyleClass()
boolean	isAjaxRendered()
boolean	isEscape()
boolean	isKeepTransient()
boolean	isNonblocking()
boolean	isShowCloseButton()
boolean	isShowShadow()
boolean	isSticky()
void	setAjaxRendered(boolean ajaxRendered)
void	setEscape(boolean escape)
void	setKeepTransient(boolean keepTransient)
void	setNonblocking(boolean nonblocking)
void	setNonblockingOpacity(Double nonblockingOpacity)
void	setShowCloseButton(boolean showCloseButton)
void	setShowShadow(boolean showShadow)
void	setStack(String stack)
void	setStayTime(Integer stayTime)
void	setSticky(boolean sticky)
void	setStyleClass(String styleClass)

Methods inherited from class org.richfaces.component.AbstractNotifyMessage

updateMessages

Methods inherited from class javax.faces.component.UIMessage

getFor, isRedisplay, isShowDetail, isShowSummary, setFor, setRedisplay, setShowDetail, setShowSummary

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTree

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.richfaces.component.ClientSideMessage

getFor, updateMessages

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

Constructor Detail

UINotifyMessage

public UINotifyMessage()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIMessage

isAjaxRendered

public boolean isAjaxRendered()

Specified by:

isAjaxRendered in interface org.ajax4jsf.component.AjaxOutput

Specified by:

isAjaxRendered in class AbstractNotifyMessage

setAjaxRendered

public void setAjaxRendered(boolean ajaxRendered)

Specified by:

setAjaxRendered in interface org.ajax4jsf.component.AjaxOutput

isEscape

public boolean isEscape()

Specified by:

isEscape in class AbstractNotifyMessage

setEscape

public void setEscape(boolean escape)

isKeepTransient

public boolean isKeepTransient()

Specified by:

isKeepTransient in interface org.ajax4jsf.component.AjaxOutput

Specified by:

isKeepTransient in class AbstractNotifyMessage

setKeepTransient

public void setKeepTransient(boolean keepTransient)

Specified by:

setKeepTransient in interface org.ajax4jsf.component.AjaxOutput

isNonblocking

public boolean isNonblocking()

Specified by:

isNonblocking in interface org.richfaces.component.NotifyAttributes

setNonblocking

public void setNonblocking(boolean nonblocking)

Specified by:

setNonblocking in interface org.richfaces.component.NotifyAttributes

getNonblockingOpacity

public Double getNonblockingOpacity()

Specified by:

getNonblockingOpacity in interface org.richfaces.component.NotifyAttributes

setNonblockingOpacity

public void setNonblockingOpacity(Double nonblockingOpacity)

Specified by:

setNonblockingOpacity in interface org.richfaces.component.NotifyAttributes

isShowCloseButton

public boolean isShowCloseButton()

Specified by:

isShowCloseButton in interface org.richfaces.component.NotifyAttributes

setShowCloseButton

public void setShowCloseButton(boolean showCloseButton)

Specified by:

setShowCloseButton in interface org.richfaces.component.NotifyAttributes

isShowShadow

public boolean isShowShadow()

Specified by:

isShowShadow in interface org.richfaces.component.NotifyAttributes

setShowShadow

public void setShowShadow(boolean showShadow)

Specified by:

setShowShadow in interface org.richfaces.component.NotifyAttributes

getStack

public String getStack()

Specified by:

getStack in interface org.richfaces.component.NotifyAttributes

setStack

public void setStack(String stack)

Specified by:

setStack in interface org.richfaces.component.NotifyAttributes

getStayTime

public Integer getStayTime()

Specified by:

getStayTime in interface org.richfaces.component.NotifyAttributes

setStayTime

public void setStayTime(Integer stayTime)

Specified by:

setStayTime in interface org.richfaces.component.NotifyAttributes

isSticky

public boolean isSticky()

Specified by:

isSticky in interface org.richfaces.component.NotifyAttributes

setSticky

public void setSticky(boolean sticky)

Specified by:

setSticky in interface org.richfaces.component.NotifyAttributes

getStyleClass

public String getStyleClass()

Specified by:

getStyleClass in interface org.richfaces.component.NotifyAttributes

setStyleClass

public void setStyleClass(String styleClass)

Specified by:

setStyleClass in interface org.richfaces.component.NotifyAttributes