org.kuali.rice.krad.util
Class GrowlMessage

java.lang.Object
  org.kuali.rice.krad.util.GrowlMessage

All Implemented Interfaces:

Serializable

public class GrowlMessage
extends Object
implements Serializable

Contains configuration for displaying a growl message

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Constructor Summary

GrowlMessage()

Method Summary

String	getMessageKey() Key for the growl message with the application resources
String[]	getMessageParameters() One or more parameters for complete the growl message
String	getTheme() Name of the growl theme to use (must be setup through the view growl property
String	getTitle() Title for growl message (displays on top bar of growl)
void	setMessageKey(String messageKey) Setter for the growl message key
void	setMessageParameters(String[] messageParameters) Setter for the message parameters array
void	setTheme(String theme) Setter for the growl theme to use
void	setTitle(String title) Setter for the growl title

Methods inherited from class java.lang.Object

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

Constructor Detail

GrowlMessage

public GrowlMessage()

Method Detail

getTitle

public String getTitle()

Title for growl message (displays on top bar of growl)

Returns:

String title text

setTitle

public void setTitle(String title)

Setter for the growl title

Parameters:

title -

getMessageKey

public String getMessageKey()

Key for the growl message with the application resources

Growl message text must be externalized into a properties file where the message is given a key. This gives the key for which the message can be retrieved

Returns:

String message key

setMessageKey

public void setMessageKey(String messageKey)

Setter for the growl message key

Parameters:

messageKey -

getMessageParameters

public String[] getMessageParameters()

One or more parameters for complete the growl message

An externally defined message can contain one or more placeholders which will get completed from runtime variables. This array of strings is used for completing the message. The message parameters are filled based on the order or parameters within the array

Returns:

String[] array of string values to fill message parameters

setMessageParameters

public void setMessageParameters(String[] messageParameters)

Setter for the message parameters array

Parameters:

messageParameters -

getTheme

public String getTheme()

Name of the growl theme to use (must be setup through the view growl property

Returns:

String name of growl theme

setTheme

public void setTheme(String theme)

Setter for the growl theme to use

Parameters:

theme -