org.icefaces.ace.component.growlmessages

Class GrowlMessagesBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIMessages

org.icefaces.ace.component.growlmessages.GrowlMessagesBase

All Implemented Interfaces:

java.util.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, IGrowlMessages

Direct Known Subclasses:

GrowlMessages

public abstract class GrowlMessagesBase
extends javax.faces.component.UIMessages
implements IGrowlMessages

Display Faces messages in a Growl container positioned on one of the four corners of the browser window.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	GrowlMessagesBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_TYPE
static java.lang.String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIMessages

COMPONENT_FAMILY

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
GrowlMessagesBase()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAutoHide() Return the value of the autoHide property.
int	getDisplayDuration() Return the value of the displayDuration property.
java.lang.String	getFamily()
java.lang.String	getHeader() Return the value of the header property.
java.lang.String	getHideEffectDuration() Return the value of the hideEffectDuration property.
int	getMaxVisibleMessages() Return the value of the maxVisibleMessages property.
java.lang.String	getMessageOrder() Return the value of the messageOrder property.
java.lang.String	getMessageStyleClass() Return the value of the messageStyleClass property.
java.lang.String	getPosition() Return the value of the position property.
java.lang.String	getShowEffectDuration() Return the value of the showEffectDuration property.
boolean	isCloseAll() Return the value of the closeAll property.
boolean	isEscape() Return the value of the escape property.
protected boolean	isPropertySet(java.lang.String finder)
void	setAutoHide(java.lang.String autoHide) Set the value of the autoHide property.
void	setCloseAll(boolean closeAll) Set the value of the closeAll property.
void	setDisplayDuration(int displayDuration) Set the value of the displayDuration property.
void	setEscape(boolean escape) Set the value of the escape property.
void	setHeader(java.lang.String header) Set the value of the header property.
void	setHideEffectDuration(java.lang.String hideEffectDuration) Set the value of the hideEffectDuration property.
void	setMaxVisibleMessages(int maxVisibleMessages) Set the value of the maxVisibleMessages property.
void	setMessageOrder(java.lang.String messageOrder) Set the value of the messageOrder property.
void	setMessageStyleClass(java.lang.String messageStyleClass) Set the value of the messageStyleClass property.
void	setPosition(java.lang.String position) Set the value of the position property.
void	setShowEffectDuration(java.lang.String showEffectDuration) Set the value of the showEffectDuration property.
void	setValueExpression(java.lang.String name, javax.el.ValueExpression binding)

Methods inherited from class javax.faces.component.UIMessages

getFor, isGlobalOnly, isRedisplay, isShowDetail, isShowSummary, setFor, setGlobalOnly, 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, getPassThroughAttributes, 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, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, 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

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

GrowlMessagesBase

public GrowlMessagesBase()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIMessages

setAutoHide

public void setAutoHide(java.lang.String autoHide)

Set the value of the autoHide property.

Contents: Types of messages to auto hide after display: "true" (auto hide all messages), "false" (don't auto hide any message), "info", "warn", "error", or "fatal" (auto hide messages at or below specified severity.)

Specified by:

setAutoHide in interface IGrowlMessages

getAutoHide

public java.lang.String getAutoHide()

Return the value of the autoHide property.

Contents: Types of messages to auto hide after display: "true" (auto hide all messages), "false" (don't auto hide any message), "info", "warn", "error", or "fatal" (auto hide messages at or below specified severity.) Default = 'true'.

Specified by:

getAutoHide in interface IGrowlMessages

setCloseAll

public void setCloseAll(boolean closeAll)

Set the value of the closeAll property.

Contents: Whether or not the close-all button should be used when more than one notification appears on the screen. (Close visible messages only, not hidden messages.)

Specified by:

setCloseAll in interface IGrowlMessages

isCloseAll

public boolean isCloseAll()

Return the value of the closeAll property.

Contents: Whether or not the close-all button should be used when more than one notification appears on the screen. (Close visible messages only, not hidden messages.) Default = 'true'.

Specified by:

isCloseAll in interface IGrowlMessages

setDisplayDuration

public void setDisplayDuration(int displayDuration)

Set the value of the displayDuration property.

Contents: The lifespan (milliseconds) of an auto-hide message on the screen.

Specified by:

setDisplayDuration in interface IGrowlMessages

getDisplayDuration

public int getDisplayDuration()

Return the value of the displayDuration property.

Contents: The lifespan (milliseconds) of an auto-hide message on the screen. Default = '3000'.

Specified by:

getDisplayDuration in interface IGrowlMessages

setEscape

public void setEscape(boolean escape)

Set the value of the escape property.

Contents: Flag indicating that characters that are sensitive in HTML and XML markup must be escaped. Note: setting this to false may open up security issues. See XSS (Cross Site Scripting) Prevention Cheat Sheet.

Specified by:

setEscape in interface IGrowlMessages

isEscape

public boolean isEscape()

Return the value of the escape property.

Contents: Flag indicating that characters that are sensitive in HTML and XML markup must be escaped. Note: setting this to false may open up security issues. See XSS (Cross Site Scripting) Prevention Cheat Sheet. Default = 'true'.

Specified by:

isEscape in interface IGrowlMessages

setHeader

public void setHeader(java.lang.String header)

Set the value of the header property.

Contents: Header to prefix a message. Default = ''.

Specified by:

setHeader in interface IGrowlMessages

getHeader

public java.lang.String getHeader()

Return the value of the header property.

Contents: Header to prefix a message. Default = ''.

Specified by:

getHeader in interface IGrowlMessages

setHideEffectDuration

public void setHideEffectDuration(java.lang.String hideEffectDuration)

Set the value of the hideEffectDuration property.

Contents: Duration (also called "speed" in jQuery) of hide effect. Values and default same as for showEffectDuration.

Specified by:

setHideEffectDuration in interface IGrowlMessages

getHideEffectDuration

public java.lang.String getHideEffectDuration()

Return the value of the hideEffectDuration property.

Contents: Duration (also called "speed" in jQuery) of hide effect. Values and default same as for showEffectDuration. Default = '_default'.

Specified by:

getHideEffectDuration in interface IGrowlMessages

setMaxVisibleMessages

public void setMaxVisibleMessages(int maxVisibleMessages)

Set the value of the maxVisibleMessages property.

Contents: Limit the number of messages appearing at a given time to this number. Default is 0, no limit.

Specified by:

setMaxVisibleMessages in interface IGrowlMessages

getMaxVisibleMessages

public int getMaxVisibleMessages()

Return the value of the maxVisibleMessages property.

Contents: Limit the number of messages appearing at a given time to this number. Default is 0, no limit. Default = '0'.

Specified by:

getMaxVisibleMessages in interface IGrowlMessages

setMessageOrder

public void setMessageOrder(java.lang.String messageOrder)

Set the value of the messageOrder property.

Contents: Designates whether a notification should be appended to the container after all notifications, or whether it should be prepended to the container before all notifications. Options are "after" or "before".

Specified by:

setMessageOrder in interface IGrowlMessages

getMessageOrder

public java.lang.String getMessageOrder()

Return the value of the messageOrder property.

Contents: Designates whether a notification should be appended to the container after all notifications, or whether it should be prepended to the container before all notifications. Options are "after" or "before". Default = 'after'.

Specified by:

getMessageOrder in interface IGrowlMessages

setMessageStyleClass

public void setMessageStyleClass(java.lang.String messageStyleClass)

Set the value of the messageStyleClass property.

Contents: A CSS class to be applied to each notification when they are created. Default = ''.

Specified by:

setMessageStyleClass in interface IGrowlMessages

getMessageStyleClass

public java.lang.String getMessageStyleClass()

Return the value of the messageStyleClass property.

Contents: A CSS class to be applied to each notification when they are created. Default = ''.

Specified by:

getMessageStyleClass in interface IGrowlMessages

setPosition

public void setPosition(java.lang.String position)

Set the value of the position property.

Contents: Designates a class which is applied to the growl container and controls its position on the screen. Options: top-left, top-right, bottom-left, bottom-right.

Specified by:

setPosition in interface IGrowlMessages

getPosition

public java.lang.String getPosition()

Return the value of the position property.

Contents: Designates a class which is applied to the growl container and controls its position on the screen. Options: top-left, top-right, bottom-left, bottom-right. Default = 'top-right'.

Specified by:

getPosition in interface IGrowlMessages

setShowEffectDuration

public void setShowEffectDuration(java.lang.String showEffectDuration)

Set the value of the showEffectDuration property.

Contents: Duration (also called "speed" in jQuery) of show effect. One of "slow", "_default", "fast", or an integer of milliseconds. ("slow", "_default", "fast" currently equated to 600, 400 and 200 respectively in jQuery.)

Specified by:

setShowEffectDuration in interface IGrowlMessages

getShowEffectDuration

public java.lang.String getShowEffectDuration()

Return the value of the showEffectDuration property.

Contents: Duration (also called "speed" in jQuery) of show effect. One of "slow", "_default", "fast", or an integer of milliseconds. ("slow", "_default", "fast" currently equated to 600, 400 and 200 respectively in jQuery.) Default = '_default'.

Specified by:

getShowEffectDuration in interface IGrowlMessages

isPropertySet

protected boolean isPropertySet(java.lang.String finder)

setValueExpression

public void setValueExpression(java.lang.String name,
                      javax.el.ValueExpression binding)

Overrides:

setValueExpression in class javax.faces.component.UIComponent