CustomizedSystemMessages (vaadin-all 8.6.1 API)

Constructor Summary

Constructors
Constructor and Description

CustomizedSystemMessages()

Constructors
Constructor and Description
`CustomizedSystemMessages()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`setAuthenticationErrorCaption(String authenticationErrorCaption)` Sets the caption of the notification.
`void`	`setAuthenticationErrorMessage(String authenticationErrorMessage)` Sets the message of the notification.
`void`	`setAuthenticationErrorNotificationEnabled(boolean authenticationErrorNotificationEnabled)` Enables or disables the notification.
`void`	`setAuthenticationErrorURL(String authenticationErrorURL)` Sets the URL to go to when there is a authentication error.
`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`	`setCookiesDisabledCaption(String cookiesDisabledCaption)` Sets the caption of the "cookies disabled" notification.
`void`	`setCookiesDisabledMessage(String cookiesDisabledMessage)` Sets the message of the "cookies disabled" notification.
`void`	`setCookiesDisabledNotificationEnabled(boolean cookiesDisabledNotificationEnabled)` Enables or disables the notification for "cookies disabled" messages.
`void`	`setCookiesDisabledURL(String cookiesDisabledURL)` Sets the URL to redirect to when the browser has cookies disabled.
`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`	`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
  - CustomizedSystemMessages
```
public CustomizedSystemMessages()
```
- Method Detail
  - setSessionExpiredURL
```
public void setSessionExpiredURL(String sessionExpiredURL)
```
    Sets the URL to go to when the session has expired.
    
    Parameters:
    
    sessionExpiredURL - the URL to go to, or null to reload current
  - setSessionExpiredNotificationEnabled
```
public void setSessionExpiredNotificationEnabled(boolean sessionExpiredNotificationEnabled)
```
    Enables or disables the notification. If disabled, the set URL (or current) is loaded directly when next transaction between server and client happens.
    
    Parameters:
    
    sessionExpiredNotificationEnabled - true = enabled, false = disabled
  - setSessionExpiredCaption
```
public void setSessionExpiredCaption(String sessionExpiredCaption)
```
    Sets the caption of the notification. Set to null for no caption. If both caption and message are null, client automatically forwards to sessionExpiredUrl after timeout timer expires. Timer uses value read from HTTPSession.getMaxInactiveInterval()
    
    Parameters:
    
    sessionExpiredCaption - the caption
  - setSessionExpiredMessage
```
public void setSessionExpiredMessage(String sessionExpiredMessage)
```
    Sets the message of the notification. Set to null for no message. If both caption and message are null, client automatically forwards to sessionExpiredUrl after timeout timer expires. Timer uses value read from HTTPSession.getMaxInactiveInterval()
    
    Parameters:
    
    sessionExpiredMessage - the message
  - setAuthenticationErrorURL
```
public void setAuthenticationErrorURL(String authenticationErrorURL)
```
    Sets the URL to go to when there is a authentication error.
    
    Parameters:
    
    authenticationErrorURL - the URL to go to, or null to reload current
  - setAuthenticationErrorNotificationEnabled
```
public void setAuthenticationErrorNotificationEnabled(boolean authenticationErrorNotificationEnabled)
```
    Enables or disables the notification. If disabled, the set URL (or current) is loaded directly.
    
    Parameters:
    
    authenticationErrorNotificationEnabled - true = enabled, false = disabled
  - setAuthenticationErrorCaption
```
public void setAuthenticationErrorCaption(String authenticationErrorCaption)
```
    Sets the caption of the notification. Set to null for no caption. If both caption and message is null, the notification is disabled;
    
    Parameters:
    
    authenticationErrorCaption - the caption
  - setAuthenticationErrorMessage
```
public void setAuthenticationErrorMessage(String authenticationErrorMessage)
```
    Sets the message of the notification. Set to null for no message. If both caption and message is null, the notification is disabled;
    
    Parameters:
    
    authenticationErrorMessage - the message
  - setCommunicationErrorURL
```
public void setCommunicationErrorURL(String communicationErrorURL)
```
    Sets the URL to go to when there is a communication error.
    
    Parameters:
    
    communicationErrorURL - the URL to go to, or null to reload current
  - setCommunicationErrorNotificationEnabled
```
public void setCommunicationErrorNotificationEnabled(boolean communicationErrorNotificationEnabled)
```
    Enables or disables the notification. If disabled, the set URL (or current) is loaded directly.
    
    Parameters:
    
    communicationErrorNotificationEnabled - true = enabled, false = disabled
  - setCommunicationErrorCaption
```
public void setCommunicationErrorCaption(String communicationErrorCaption)
```
    Sets the caption of the notification. Set to null for no caption. If both caption and message is null, the notification is disabled;
    
    Parameters:
    
    communicationErrorCaption - the caption
  - setCommunicationErrorMessage
```
public void setCommunicationErrorMessage(String communicationErrorMessage)
```
    Sets the message of the notification. Set to null for no message. If both caption and message is null, the notification is disabled;
    
    Parameters:
    
    communicationErrorMessage - the message
  - setInternalErrorURL
```
public void setInternalErrorURL(String internalErrorURL)
```
    Sets the URL to go to when an internal error occurs.
    
    Parameters:
    
    internalErrorURL - the URL to go to, or null to reload current
  - setInternalErrorNotificationEnabled
```
public void setInternalErrorNotificationEnabled(boolean internalErrorNotificationEnabled)
```
    Enables or disables the notification. If disabled, the set URL (or current) is loaded directly.
    
    Parameters:
    
    internalErrorNotificationEnabled - true = enabled, false = disabled
  - setInternalErrorCaption
```
public void setInternalErrorCaption(String internalErrorCaption)
```
    Sets the caption of the notification. Set to null for no caption. If both caption and message is null, the notification is disabled;
    
    Parameters:
    
    internalErrorCaption - the caption
  - setInternalErrorMessage
```
public void setInternalErrorMessage(String internalErrorMessage)
```
    Sets the message of the notification. Set to null for no message. If both caption and message is null, the notification is disabled;
    
    Parameters:
    
    internalErrorMessage - the message
  - setCookiesDisabledURL
```
public void setCookiesDisabledURL(String cookiesDisabledURL)
```
    Sets the URL to redirect to when the browser has cookies disabled.
    
    Parameters:
    
    cookiesDisabledURL - the URL to redirect to, or null to reload the current URL
  - setCookiesDisabledNotificationEnabled
```
public void setCookiesDisabledNotificationEnabled(boolean cookiesDisabledNotificationEnabled)
```
    Enables or disables the notification for "cookies disabled" messages. If disabled, the URL returned by SystemMessages.getCookiesDisabledURL() is loaded directly.
    
    Parameters:
    
    cookiesDisabledNotificationEnabled - true to enable "cookies disabled" messages, false otherwise
  - setCookiesDisabledCaption
```
public void setCookiesDisabledCaption(String cookiesDisabledCaption)
```
    Sets the caption of the "cookies disabled" notification. Set to null for no caption. If both caption and message is null, the notification is disabled.
    
    Parameters:
    
    cookiesDisabledCaption - the caption for the "cookies disabled" notification
  - setCookiesDisabledMessage
```
public void setCookiesDisabledMessage(String cookiesDisabledMessage)
```
    Sets the message of the "cookies disabled" notification. Set to null for no message. If both caption and message is null, the notification is disabled.
    
    Parameters:
    
    cookiesDisabledMessage - the message for the "cookies disabled" notification

Class CustomizedSystemMessages

Field Summary

Fields inherited from class com.vaadin.server.SystemMessages

Constructor Summary

Method Summary

Methods inherited from class com.vaadin.server.SystemMessages

Methods inherited from class java.lang.Object

Constructor Detail

CustomizedSystemMessages

Method Detail

setSessionExpiredURL

setSessionExpiredNotificationEnabled

setSessionExpiredCaption

setSessionExpiredMessage

setAuthenticationErrorURL

setAuthenticationErrorNotificationEnabled

setAuthenticationErrorCaption

setAuthenticationErrorMessage

setCommunicationErrorURL

setCommunicationErrorNotificationEnabled

setCommunicationErrorCaption

setCommunicationErrorMessage

setInternalErrorURL

setInternalErrorNotificationEnabled

setInternalErrorCaption

setInternalErrorMessage

setCookiesDisabledURL

setCookiesDisabledNotificationEnabled

setCookiesDisabledCaption

setCookiesDisabledMessage