org.richfaces.ui.message.notifyMessage

Class UINotifyMessage

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIMessage

org.richfaces.ui.message.notifyMessage.AbstractNotifyMessage

org.richfaces.ui.message.notifyMessage.UINotifyMessage

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, AjaxOutput, ClientSideMessage, NotifyAttributes

@Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"})
public class UINotifyMessage
extends AbstractNotifyMessage
implements javax.faces.component.behavior.ClientBehaviorHolder, AjaxOutput, ClientSideMessage, NotifyAttributes

The <r:notifyMessage> component is built on top of <r:notify>, the difference is in usage. The <r:notifyMessage> component displays FacesMessages associated with a given component, similar to <r: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	getDefaultEventName()
String	getDir()
Collection<String>	getEventNames()
String	getFamily()
String	getLang()
Double	getNonblockingOpacity()
String	getOnclick()
String	getOndblclick()
String	getOnkeydown()
String	getOnkeypress()
String	getOnkeyup()
String	getOnmousedown()
String	getOnmousemove()
String	getOnmouseout()
String	getOnmouseover()
String	getOnmouseup()
String	getStack()
Integer	getStayTime()
String	getStyle()
String	getStyleClass()
String	getTitle()
boolean	isAjaxRendered() getter for ajax-rendered flag property.
boolean	isEscape()
boolean	isKeepTransient() getter for ajax-rendered flag property.
boolean	isNonblocking()
boolean	isShowCloseButton()
boolean	isShowShadow()
boolean	isSticky()
void	setAjaxRendered(boolean ajaxRendered) Setter for ajax rendered property.
void	setDir(String dir)
void	setEscape(boolean escape)
void	setKeepTransient(boolean keepTransient) Setter for ajax rendered property.
void	setLang(String lang)
void	setNonblocking(boolean nonblocking)
void	setNonblockingOpacity(Double nonblockingOpacity)
void	setOnclick(String onclick)
void	setOndblclick(String ondblclick)
void	setOnkeydown(String onkeydown)
void	setOnkeypress(String onkeypress)
void	setOnkeyup(String onkeyup)
void	setOnmousedown(String onmousedown)
void	setOnmousemove(String onmousemove)
void	setOnmouseout(String onmouseout)
void	setOnmouseover(String onmouseover)
void	setOnmouseup(String onmouseup)
void	setShowCloseButton(boolean showCloseButton)
void	setShowShadow(boolean showShadow)
void	setStack(String stack)
void	setStayTime(Integer stayTime)
void	setSticky(boolean sticky)
void	setStyle(String style)
void	setStyleClass(String styleClass)
void	setTitle(String title)

Methods inherited from class org.richfaces.ui.message.notifyMessage.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, 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 javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors

Methods inherited from interface org.richfaces.ui.message.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

getEventNames

public Collection<String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

getDefaultEventName

public String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class javax.faces.component.UIComponentBase

isAjaxRendered

public boolean isAjaxRendered()

Description copied from interface: AjaxOutput

getter for ajax-rendered flag property.

Specified by:

isAjaxRendered in interface AjaxOutput

Specified by:

isAjaxRendered in class AbstractNotifyMessage

Returns:

setAjaxRendered

public void setAjaxRendered(boolean ajaxRendered)

Description copied from interface: AjaxOutput

Setter for ajax rendered property.

Specified by:

setAjaxRendered in interface AjaxOutput

getDir

public String getDir()

setDir

public void setDir(String dir)

isEscape

public boolean isEscape()

Specified by:

isEscape in class AbstractNotifyMessage

setEscape

public void setEscape(boolean escape)

isKeepTransient

public boolean isKeepTransient()

Description copied from interface: AjaxOutput

getter for ajax-rendered flag property.

Specified by:

isKeepTransient in interface AjaxOutput

Specified by:

isKeepTransient in class AbstractNotifyMessage

Returns:

setKeepTransient

public void setKeepTransient(boolean keepTransient)

Description copied from interface: AjaxOutput

Setter for ajax rendered property.

Specified by:

setKeepTransient in interface AjaxOutput

getLang

public String getLang()

setLang

public void setLang(String lang)

isNonblocking

public boolean isNonblocking()

Specified by:

isNonblocking in interface NotifyAttributes

setNonblocking

public void setNonblocking(boolean nonblocking)

Specified by:

setNonblocking in interface NotifyAttributes

getNonblockingOpacity

public Double getNonblockingOpacity()

Specified by:

getNonblockingOpacity in interface NotifyAttributes

setNonblockingOpacity

public void setNonblockingOpacity(Double nonblockingOpacity)

Specified by:

setNonblockingOpacity in interface NotifyAttributes

getOnclick

public String getOnclick()

setOnclick

public void setOnclick(String onclick)

getOndblclick

public String getOndblclick()

setOndblclick

public void setOndblclick(String ondblclick)

getOnkeydown

public String getOnkeydown()

setOnkeydown

public void setOnkeydown(String onkeydown)

getOnkeypress

public String getOnkeypress()

setOnkeypress

public void setOnkeypress(String onkeypress)

getOnkeyup

public String getOnkeyup()

setOnkeyup

public void setOnkeyup(String onkeyup)

getOnmousedown

public String getOnmousedown()

setOnmousedown

public void setOnmousedown(String onmousedown)

getOnmousemove

public String getOnmousemove()

setOnmousemove

public void setOnmousemove(String onmousemove)

getOnmouseout

public String getOnmouseout()

setOnmouseout

public void setOnmouseout(String onmouseout)

getOnmouseover

public String getOnmouseover()

setOnmouseover

public void setOnmouseover(String onmouseover)

getOnmouseup

public String getOnmouseup()

setOnmouseup

public void setOnmouseup(String onmouseup)

isShowCloseButton

public boolean isShowCloseButton()

Specified by:

isShowCloseButton in interface NotifyAttributes

setShowCloseButton

public void setShowCloseButton(boolean showCloseButton)

Specified by:

setShowCloseButton in interface NotifyAttributes

isShowShadow

public boolean isShowShadow()

Specified by:

isShowShadow in interface NotifyAttributes

setShowShadow

public void setShowShadow(boolean showShadow)

Specified by:

setShowShadow in interface NotifyAttributes

getStack

public String getStack()

Specified by:

getStack in interface NotifyAttributes

setStack

public void setStack(String stack)

Specified by:

setStack in interface NotifyAttributes

getStayTime

public Integer getStayTime()

Specified by:

getStayTime in interface NotifyAttributes

setStayTime

public void setStayTime(Integer stayTime)

Specified by:

setStayTime in interface NotifyAttributes

isSticky

public boolean isSticky()

Specified by:

isSticky in interface NotifyAttributes

setSticky

public void setSticky(boolean sticky)

Specified by:

setSticky in interface NotifyAttributes

getStyle

public String getStyle()

setStyle

public void setStyle(String style)

getStyleClass

public String getStyleClass()

Specified by:

getStyleClass in interface NotifyAttributes

setStyleClass

public void setStyleClass(String styleClass)

Specified by:

setStyleClass in interface NotifyAttributes

getTitle

public String getTitle()

setTitle

public void setTitle(String title)