Accessibility for Notification (#11820)

Change-Id: Ic9c1a417fa791927897b6fcdf35a1fb4444dfd70

1 files changed, 135 insertions, 1 deletions

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