Accessibility for Notification (#11820)

Change-Id: Ic9c1a417fa791927897b6fcdf35a1fb4444dfd70

4 files changed, 422 insertions, 7 deletions

diff --git a/server/src/com/vaadin/server/SystemMessages.java b/server/src/com/vaadin/server/SystemMessages.java
index 5e0fde1d4a..299c725207 100644
--- a/server/src/com/vaadin/server/SystemMessages.java
+++ b/server/src/com/vaadin/server/SystemMessages.java
@@ -63,32 +63,32 @@ public class SystemMessages implements Serializable {
     protected String sessionExpiredURL = null;
     protected boolean sessionExpiredNotificationEnabled = true;
     protected String sessionExpiredCaption = "Session Expired";
-    protected String sessionExpiredMessage = "Take note of any unsaved data, and <u>click here</u> to continue.";
+    protected String sessionExpiredMessage = "Take note of any unsaved data, and <u>click here</u> or press ESC key to continue.";
 
     protected String communicationErrorURL = null;
     protected boolean communicationErrorNotificationEnabled = true;
     protected String communicationErrorCaption = "Communication problem";
-    protected String communicationErrorMessage = "Take note of any unsaved data, and <u>click here</u> to continue.";
+    protected String communicationErrorMessage = "Take note of any unsaved data, and <u>click here</u> or press ESC to continue.";
 
     protected String authenticationErrorURL = null;
     protected boolean authenticationErrorNotificationEnabled = true;
     protected String authenticationErrorCaption = "Authentication problem";
-    protected String authenticationErrorMessage = "Take note of any unsaved data, and <u>click here</u> to continue.";
+    protected String authenticationErrorMessage = "Take note of any unsaved data, and <u>click here</u> or press ESC to continue.";
 
     protected String internalErrorURL = null;
     protected boolean internalErrorNotificationEnabled = true;
     protected String internalErrorCaption = "Internal error";
-    protected String internalErrorMessage = "Please notify the administrator.<br/>Take note of any unsaved data, and <u>click here</u> to continue.";
+    protected String internalErrorMessage = "Please notify the administrator.<br/>Take note of any unsaved data, and <u>click here</u> or press ESC to continue.";
 
     protected String outOfSyncURL = null;
     protected boolean outOfSyncNotificationEnabled = true;
     protected String outOfSyncCaption = "Out of sync";
-    protected String outOfSyncMessage = "Something has caused us to be out of sync with the server.<br/>Take note of any unsaved data, and <u>click here</u> to re-sync.";
+    protected String outOfSyncMessage = "Something has caused us to be out of sync with the server.<br/>Take note of any unsaved data, and <u>click here</u> or press ESC to re-sync.";
 
     protected String cookiesDisabledURL = null;
     protected boolean cookiesDisabledNotificationEnabled = true;
     protected String cookiesDisabledCaption = "Cookies disabled";
-    protected String cookiesDisabledMessage = "This application requires cookies to function.<br/>Please enable cookies in your browser and <u>click here</u> to try again.";
+    protected String cookiesDisabledMessage = "This application requires cookies to function.<br/>Please enable cookies in your browser and <u>click here</u> or press ESC to try again.";
 
     /**
      * Use {@link CustomizedSystemMessages} to customize
diff --git a/server/src/com/vaadin/ui/Notification.java b/server/src/com/vaadin/ui/Notification.java
index cf1d03ab5c..f9bb1521e7 100644
--- a/server/src/com/vaadin/ui/Notification.java
+++ b/server/src/com/vaadin/ui/Notification.java
@@ -21,6 +21,7 @@ import java.io.Serializable;
 import com.vaadin.server.Page;
 import com.vaadin.server.Resource;
 import com.vaadin.shared.Position;
+import com.vaadin.shared.ui.ui.NotificationConfigurationBean.Role;
 
 /**
  * A notification message, used to display temporary messages to the user - for
@@ -190,21 +191,32 @@ public class Notification implements Serializable {
         case WARNING_MESSAGE:
             delayMsec = 1500;
             styleName = "warning";
+            setNavigationConfiguration("Warning: ", "", Role.ALERT);
             break;
         case ERROR_MESSAGE:
             delayMsec = -1;
             styleName = "error";
+            setNavigationConfiguration("Error: ", " - close with ESC",
+                    Role.ALERT);
             break;
         case TRAY_NOTIFICATION:
             delayMsec = 3000;
             position = Position.BOTTOM_RIGHT;
             styleName = "tray";
-
+            setNavigationConfiguration("Info: ", "", Role.STATUS);
+            break;
         case HUMANIZED_MESSAGE:
         default:
+            styleName = "humanized";
+            setNavigationConfiguration("Info: ", "", Role.ALERT);
             break;
         }
+    }
 
+    private void setNavigationConfiguration(String prefix, String postfix,
+            Role ariaRole) {
+        UI.getCurrent().getNotificationConfiguration()
+                .setStyleConfiguration(styleName, prefix, postfix, ariaRole);
     }
 
     /**
@@ -322,6 +334,128 @@ public class Notification implements Serializable {
     }
 
     /**
+     * Sets the accessibility prefix for a notification type.
+     * 
+     * This prefix is read to assistive device users before the content of the
+     * notification, but not visible on the page.
+     * 
+     * @param type
+     *            Type of the notification
+     * @param prefix
+     *            String that is placed before the notification content
+     */
+    public void setAssistivePrefixForType(Type type, String prefix) {
+        UI.getCurrent().getNotificationConfiguration()
+                .setAssistivePrefixForStyle(getStyle(type), prefix);
+    }
+
+    /**
+     * Gets the accessibility prefix for a notification type.
+     * 
+     * This prefix is read to assistive device users before the content of the
+     * notification, but not visible on the page.
+     * 
+     * @param type
+     *            Type of the notification
+     * @return The accessibility prefix for the provided notification type
+     */
+    public String getAssistivePrefixForType(Type type) {
+        return UI.getCurrent().getNotificationConfiguration()
+                .getAssistivePrefixForStyle(getStyle(type));
+    }
+
+    /**
+     * Sets the accessibility postfix for a notification type.
+     * 
+     * This postfix is read to assistive device users after the content of the
+     * notification, but not visible on the page.
+     * 
+     * @param type
+     *            Type of the notification
+     * @param postfix
+     *            String that is placed after the notification content
+     */
+    public void setAssistivePostfixForType(Type type, String postfix) {
+        UI.getCurrent().getNotificationConfiguration()
+                .setAssistivePostfixForStyle(getStyle(type), postfix);
+    }
+
+    /**
+     * Gets the accessibility postfix for a notification type.
+     * 
+     * This postfix is read to assistive device users after the content of the
+     * notification, but not visible on the page.
+     * 
+     * @param type
+     *            Type of the notification
+     * @return The accessibility postfix for the provided notification type
+     */
+    public String getAssistivePostfixForType(Type type) {
+        return UI.getCurrent().getNotificationConfiguration()
+                .getAssistivePostfixForStyle(getStyle(type));
+    }
+
+    /**
+     * Sets the WAI-ARIA role for a notification type.
+     * 
+     * This role defines how an assistive device handles a notification.
+     * Available roles are alert and status (@see <a
+     * href="http://www.w3.org/TR/2011/CR-wai-aria-20110118/roles">Roles
+     * Model</a>).
+     * 
+     * The default role is alert.
+     * 
+     * @param type
+     *            Type of the notification
+     * @param role
+     *            Role to set for the notification type
+     */
+    public void setAssistiveRoleForType(Type type, Role role) {
+        UI.getCurrent().getNotificationConfiguration()
+                .setAssistiveRoleForStyle(getStyle(type), role);
+    }
+
+    /**
+     * Gets the WAI-ARIA role for a notification type.
+     * 
+     * This role defines how an assistive device handles a notification.
+     * Available roles are alert and status (@see <a
+     * href="http://www.w3.org/TR/2011/CR-wai-aria-20110118/roles">Roles
+     * Model</a>)
+     * 
+     * The default role is alert.
+     * 
+     * @param type
+     *            Type of the notification
+     * @return Role to set for the notification type
+     */
+    public Role getAssistiveRoleForType(Type type) {
+        return UI.getCurrent().getNotificationConfiguration()
+                .getAssistiveRoleForStyle(getStyle(type));
+    }
+
+    private String getStyle(Type type) {
+        String style = "";
+
+        switch (type) {
+        case WARNING_MESSAGE:
+            style = "warning";
+            break;
+        case ERROR_MESSAGE:
+            style = "error";
+            break;
+        case TRAY_NOTIFICATION:
+            style = "tray";
+        case HUMANIZED_MESSAGE:
+        default:
+            style = "humanized";
+            break;
+        }
+
+        return style;
+    }
+
+    /**
      * Sets whether html is allowed in the caption and description. If set to
      * true, the texts are passed to the browser as html and the developer is
      * responsible for ensuring no harmful html is used. If set to false, the
diff --git a/server/src/com/vaadin/ui/NotificationConfiguration.java b/server/src/com/vaadin/ui/NotificationConfiguration.java
new file mode 100644
index 0000000000..52d3e76d63
--- /dev/null
+++ b/server/src/com/vaadin/ui/NotificationConfiguration.java
@@ -0,0 +1,269 @@
+/*
+ * Copyright 2000-2013 Vaadin Ltd.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ * 
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+
+/**
+ * 
+ */
+package com.vaadin.ui;
+
+import java.io.Serializable;
+
+import com.vaadin.shared.ui.ui.NotificationConfigurationBean;
+import com.vaadin.shared.ui.ui.NotificationConfigurationBean.Role;
+import com.vaadin.shared.ui.ui.UIState.NotificationConfigurationState;
+
+/**
+ * Provides methods for configuring the notification.
+ * 
+ * @author Vaadin Ltd
+ * @since 7.1
+ */
+public interface NotificationConfiguration extends Serializable {
+    public void setStyleConfiguration(String style, String prefix,
+            String postfix, Role ariaRole);
+
+    /**
+     * Returns the complete configuration object for the given notification
+     * style.
+     * 
+     * @param style
+     *            String of the notification style to return
+     * @return The notification configuration object
+     */
+    public NotificationConfigurationBean getStyleConfiguration(String style);
+
+    /**
+     * Sets the accessibility prefix for the given notification style.
+     * 
+     * This prefix is read to assistive device users in front of the content of
+     * the notification, but not visible on the page.
+     * 
+     * @param style
+     *            String of the notification style
+     * @param prefix
+     *            String that is placed before the notification content
+     */
+    public void setAssistivePrefixForStyle(String style, String prefix);
+
+    /**
+     * Returns the accessibility prefix for the given notification style.
+     * 
+     * This prefix is read to assistive device users in front of the content of
+     * the notification, but not visible on the page.
+     * 
+     * @param style
+     *            String of the notification style
+     * @return The prefix of the provided notification style
+     */
+    public String getAssistivePrefixForStyle(String style);
+
+    /**
+     * Sets the accessibility postfix for the given notification style.
+     * 
+     * This postfix is read to assistive device users after the content of the
+     * notification, but not visible on the page.
+     * 
+     * @param style
+     *            String of the notification style
+     * @param postfix
+     *            String that is placed after the notification content
+     */
+    public void setAssistivePostfixForStyle(String style, String postfix);
+
+    /**
+     * Returns the accessibility postfix for the given notification style.
+     * 
+     * This postfix is read to assistive device users after the content of the
+     * notification, but not visible on the page.
+     * 
+     * @param style
+     *            String of the notification style
+     * @return The postfix of the provided notification style
+     */
+    public String getAssistivePostfixForStyle(String style);
+
+    /**
+     * Sets the WAI-ARIA role for a notification style.
+     * 
+     * This role defines how an assistive device handles a notification.
+     * Available roles are alert, alertdialog and status (@see <a
+     * href="http://www.w3.org/TR/2011/CR-wai-aria-20110118/roles">Roles
+     * Model</a>)
+     * 
+     * The default role is alert.
+     * 
+     * @param style
+     *            String of the notification style
+     * @param role
+     *            Role to set for the notification type
+     */
+    public void setAssistiveRoleForStyle(String style, Role role);
+
+    /**
+     * Returns the WAI-ARIA role for a notification style.
+     * 
+     * This role defines how an assistive device handles a notification.
+     * Available roles are alert, alertdialog and status (@see <a
+     * href="http://www.w3.org/TR/2011/CR-wai-aria-20110118/roles">Roles
+     * Model</a> )
+     * 
+     * The default role is alert.
+     * 
+     * @param style
+     *            String of the notification style
+     * @return The current Role for the notification type
+     */
+    public Role getAssistiveRoleForStyle(String style);
+}
+
+class NotificationConfigurationImpl implements NotificationConfiguration {
+
+    private UI ui;
+
+    public NotificationConfigurationImpl(UI ui) {
+        this.ui = ui;
+    }
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see
+     * com.vaadin.ui.NotificationConfiguration#setStyleConfiguration(java.lang
+     * .String, java.lang.String, java.lang.String,
+     * com.vaadin.ui.NotificationConfiguration.Role)
+     */
+    @Override
+    public void setStyleConfiguration(String style, String prefix,
+            String postfix, Role ariaRole) {
+        getState().setup.put(style, new NotificationConfigurationBean(prefix,
+                postfix, ariaRole));
+    }
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see
+     * com.vaadin.ui.NotificationConfiguration#getStyleConfiguration(java.lang
+     * .String)
+     */
+    @Override
+    public NotificationConfigurationBean getStyleConfiguration(String style) {
+        return getState(false).setup.get(style);
+    }
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see
+     * com.vaadin.ui.NotificationConfiguration#setStylePrefix(java.lang.String,
+     * java.lang.String)
+     */
+    @Override
+    public void setAssistivePrefixForStyle(String style, String prefix) {
+        getConfigurationBean(style).setAssistivePrefix(prefix);
+    }
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see
+     * com.vaadin.ui.NotificationConfiguration#getStylePrefix(java.lang.String)
+     */
+    @Override
+    public String getAssistivePrefixForStyle(String style) {
+        NotificationConfigurationBean styleSetup = getState().setup.get(style);
+        if (styleSetup != null) {
+            return styleSetup.getAssistivePrefix();
+        }
+
+        return null;
+    }
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see
+     * com.vaadin.ui.NotificationConfiguration#setStylePostfix(com.vaadin.ui
+     * .Notification.Type, java.lang.String)
+     */
+    @Override
+    public void setAssistivePostfixForStyle(String style, String postfix) {
+        getConfigurationBean(style).setAssistivePostfix(postfix);
+    }
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see
+     * com.vaadin.ui.NotificationConfiguration#getStylePostfix(com.vaadin.ui
+     * .Notification.Type)
+     */
+    @Override
+    public String getAssistivePostfixForStyle(String style) {
+        NotificationConfigurationBean styleSetup = getState().setup.get(style);
+        if (styleSetup != null) {
+            return styleSetup.getAssistivePostfix();
+        }
+
+        return null;
+    }
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see com.vaadin.ui.NotificationConfiguration#setStyleRole(com.vaadin.ui.
+     * Notification.Type, com.vaadin.ui.NotificationConfiguration.Role)
+     */
+    @Override
+    public void setAssistiveRoleForStyle(String style, Role role) {
+        getConfigurationBean(style).setAssistiveRole(role);
+    }
+
+    /*
+     * (non-Javadoc)
+     * 
+     * @see com.vaadin.ui.NotificationConfiguration#getStyleRole(com.vaadin.ui.
+     * Notification.Type)
+     */
+    @Override
+    public Role getAssistiveRoleForStyle(String style) {
+        NotificationConfigurationBean styleSetup = getState().setup.get(style);
+        if (styleSetup != null) {
+            return styleSetup.getAssistiveRole();
+        }
+
+        return null;
+    }
+
+    private NotificationConfigurationBean getConfigurationBean(String style) {
+        NotificationConfigurationBean styleSetup = getState().setup.get(style);
+        if (styleSetup == null) {
+            styleSetup = new NotificationConfigurationBean();
+            getState().setup.put(style, styleSetup);
+        }
+
+        return styleSetup;
+    }
+
+    private NotificationConfigurationState getState() {
+        return ui.getState().notificationConfiguration;
+    }
+
+    private NotificationConfigurationState getState(boolean markAsDirty) {
+        return ui.getState(markAsDirty).notificationConfiguration;
+    }
+
+}
diff --git a/server/src/com/vaadin/ui/UI.java b/server/src/com/vaadin/ui/UI.java
index e0811e51f7..2138edd6ac 100644
--- a/server/src/com/vaadin/ui/UI.java
+++ b/server/src/com/vaadin/ui/UI.java
@@ -218,6 +218,9 @@ public abstract class UI extends AbstractSingleComponentContainer implements
     private PushConfiguration pushConfiguration = new PushConfigurationImpl(
             this);
 
+    private NotificationConfiguration notificationConfiguration = new NotificationConfigurationImpl(
+            this);
+
     /**
      * Creates a new empty UI without a caption. The content of the UI must be
      * set by calling {@link #setContent(Component)} before using the UI.
@@ -1282,6 +1285,15 @@ public abstract class UI extends AbstractSingleComponentContainer implements
     }
 
     /**
+     * Retrieves the object used for configuring notifications.
+     * 
+     * @return The instance used for notification configuration
+     */
+    public NotificationConfiguration getNotificationConfiguration() {
+        return notificationConfiguration;
+    }
+
+    /**
      * Retrieves the object used for configuring the loading indicator.
      * 
      * @return The instance used for configuring the loading indicator