|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.itmill.toolkit.Application.SystemMessages
com.itmill.toolkit.Application.CustomizedSystemMessages
public static class Application.CustomizedSystemMessages
Contains the system messages used to notify the user about various critical situations that can occur.
Customize by overriding the static Application.getSystemMessages() and returning CustomizedSystemMessages. Note that getSystemMessages() is static - changing the system messages will by default change the message for all users of the application.
The default behavior is to show a notification, and restart the
application the the user clicks the message.
Instead of restarting the application, you can set a specific URL that
the user is taken to.
Setting both caption and message to null will restart the application (or
go to the specified URL) without displaying a notification.
set*NotificationEnabled(false) will achieve the same thing.
The situations are:
Field Summary |
---|
Constructor Summary | |
---|---|
Application.CustomizedSystemMessages()
|
Method Summary | |
---|---|
void |
setCommunicationErrorCaption(String communicationErrorCaption)
Sets the caption of the notification. |
void |
setCommunicationErrorMessage(String communicationErrorMessage)
Sets the message of the notification. |
void |
setCommunicationErrorNotificationEnabled(boolean communicationErrorNotificationEnabled)
Enables or disables the notification. |
void |
setCommunicationErrorURL(String communicationErrorURL)
Sets the URL to go to when there is a communication error. |
void |
setInternalErrorCaption(String internalErrorCaption)
Sets the caption of the notification. |
void |
setInternalErrorMessage(String internalErrorMessage)
Sets the message of the notification. |
void |
setInternalErrorNotificationEnabled(boolean internalErrorNotificationEnabled)
Enables or disables the notification. |
void |
setInternalErrorURL(String internalErrorURL)
Sets the URL to go to when an internal error occurs. |
void |
setOutOfSyncCaption(String outOfSyncCaption)
Sets the caption of the notification. |
void |
setOutOfSyncMessage(String outOfSyncMessage)
Sets the message of the notification. |
void |
setOutOfSyncNotificationEnabled(boolean outOfSyncNotificationEnabled)
Enables or disables the notification. |
void |
setOutOfSyncURL(String outOfSyncURL)
Sets the URL to go to when the client is out-of-sync. |
void |
setSessionExpiredCaption(String sessionExpiredCaption)
Sets the caption of the notification. |
void |
setSessionExpiredMessage(String sessionExpiredMessage)
Sets the message of the notification. |
void |
setSessionExpiredNotificationEnabled(boolean sessionExpiredNotificationEnabled)
Enables or disables the notification. |
void |
setSessionExpiredURL(String sessionExpiredURL)
Sets the URL to go to when the session has expired. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Application.CustomizedSystemMessages()
Method Detail |
---|
public void setSessionExpiredURL(String sessionExpiredURL)
sessionExpiredURL
- the URL to go to, or null to reload currentpublic void setSessionExpiredNotificationEnabled(boolean sessionExpiredNotificationEnabled)
sessionExpiredNotificationEnabled
- true = enabled, false = disabledpublic void setSessionExpiredCaption(String sessionExpiredCaption)
sessionExpiredCaption
- the captionpublic void setSessionExpiredMessage(String sessionExpiredMessage)
sessionExpiredMessage
- the messagepublic void setCommunicationErrorURL(String communicationErrorURL)
communicationErrorURL
- the URL to go to, or null to reload currentpublic void setCommunicationErrorNotificationEnabled(boolean communicationErrorNotificationEnabled)
communicationErrorNotificationEnabled
- true = enabled, false = disabledpublic void setCommunicationErrorCaption(String communicationErrorCaption)
communicationErrorCaption
- the captionpublic void setCommunicationErrorMessage(String communicationErrorMessage)
communicationErrorMessage
- the messagepublic void setInternalErrorURL(String internalErrorURL)
internalErrorURL
- the URL to go to, or null to reload currentpublic void setInternalErrorNotificationEnabled(boolean internalErrorNotificationEnabled)
internalErrorNotificationEnabled
- true = enabled, false = disabledpublic void setInternalErrorCaption(String internalErrorCaption)
internalErrorCaption
- the captionpublic void setInternalErrorMessage(String internalErrorMessage)
internalErrorMessage
- the messagepublic void setOutOfSyncURL(String outOfSyncURL)
outOfSyncURL
- the URL to go to, or null to reload currentpublic void setOutOfSyncNotificationEnabled(boolean outOfSyncNotificationEnabled)
outOfSyncNotificationEnabled
- true = enabled, false = disabledpublic void setOutOfSyncCaption(String outOfSyncCaption)
outOfSyncCaption
- the captionpublic void setOutOfSyncMessage(String outOfSyncMessage)
outOfSyncMessage
- the message
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |