From 8e779e627a2185320ab168fdce09477a73bf5f22 Mon Sep 17 00:00:00 2001
From: Jorge Lugo <jlugo@google.com>
Date: Thu, 23 Jun 2011 14:51:19 -0700
Subject: [PATCH] Accessibility improvements

TalkBack functions properly with MessageList items, as well as
"reply," "reply-all," and "forward" buttons while viewing messages.
It is now also possible to switch accounts using only a dpad
or trackball. Finally, EditText fields in account setup also work
with TalkBack now.

Checkmarks don't work with Talkback, but this I have confirmed and
reported it as frameworks bug.

Change-Id: I7f72682a517eef4fa122241c675026fe7997ac64
---
 .../account_setup_basics_common.xml           |  2 +
 .../account_setup_names_common.xml            |  5 ++-
 res/layout-sw600dp/message_view_fragment.xml  |  3 ++
 res/layout/account_setup_basics_common.xml    |  2 +
 res/layout/account_setup_names.xml            | 26 ++++++-----
 res/layout/action_bar_spinner.xml             |  1 +
 res/layout/message_view_header_actions.xml    |  1 +
 res/values/strings.xml                        |  5 +++
 .../email/activity/MessageListItem.java       | 45 ++++++++++++++++++-
 .../email/activity/MessagesAdapter.java       |  2 +-
 10 files changed, 76 insertions(+), 16 deletions(-)

diff --git a/res/layout-sw600dp/account_setup_basics_common.xml b/res/layout-sw600dp/account_setup_basics_common.xml
index 376a55783..aed76a6ec 100644
--- a/res/layout-sw600dp/account_setup_basics_common.xml
+++ b/res/layout-sw600dp/account_setup_basics_common.xml
@@ -50,6 +50,7 @@
                 android:id="@+id/account_email"
                 android:layout_width="@dimen/setup_credentials_input_width"
                 android:layout_height="wrap_content"
+                android:contentDescription="@string/account_setup_basics_email_label"
                 android:inputType="textEmailAddress"
                 android:imeOptions="actionNext" />
         </TableRow>
@@ -64,6 +65,7 @@
                 android:id="@+id/account_password"
                 android:layout_height="wrap_content"
                 android:layout_width="@dimen/setup_credentials_input_width"
+                android:contentDescription="@string/account_setup_basics_password_label"
                 android:inputType="textPassword"
                 android:imeOptions="actionDone"
                 android:nextFocusDown="@+id/next" />
diff --git a/res/layout-sw600dp/account_setup_names_common.xml b/res/layout-sw600dp/account_setup_names_common.xml
index c7667dd4b..4f4c7c9c7 100644
--- a/res/layout-sw600dp/account_setup_names_common.xml
+++ b/res/layout-sw600dp/account_setup_names_common.xml
@@ -21,8 +21,7 @@
     android:layout_width="match_parent"
     android:layout_height="wrap_content"
     android:paddingLeft="@dimen/setup_item_inset_left"
-    android:paddingRight="@dimen/setup_item_inset_right"
-    >
+    android:paddingRight="@dimen/setup_item_inset_right" >
     <TextView
         android:id="@+id/account_description_label"
         android:layout_alignParentTop="true"
@@ -35,6 +34,7 @@
         android:layout_below="@+id/account_description_label"
         android:layout_height="wrap_content"
         android:layout_width="match_parent"
+        android:contentDescription="@string/account_setup_names_account_name_label"
         android:inputType="textCapWords"
         android:imeOptions="actionDone" />
     <TextView
@@ -50,6 +50,7 @@
         android:layout_below="@+id/account_name_label"
         android:layout_height="wrap_content"
         android:layout_width="match_parent"
+        android:contentDescription="@string/account_setup_names_user_name_label"
         android:inputType="textPersonName"
         android:imeOptions="actionDone" />
 </RelativeLayout>
diff --git a/res/layout-sw600dp/message_view_fragment.xml b/res/layout-sw600dp/message_view_fragment.xml
index 9162a9365..0af6f71ea 100644
--- a/res/layout-sw600dp/message_view_fragment.xml
+++ b/res/layout-sw600dp/message_view_fragment.xml
@@ -95,6 +95,7 @@
             <ImageButton
                 android:id="@+id/reply"
                 android:layout_marginRight="16dip"
+                android:contentDescription="@string/reply_action"
                 android:src="@drawable/ic_reply"
                 android:visibility="gone"
                 style="@style/message_view_action_buttons"
@@ -102,6 +103,7 @@
             <ImageButton
                 android:id="@+id/reply_all"
                 android:layout_marginRight="16dip"
+                android:contentDescription="@string/reply_all_action"
                 android:src="@drawable/ic_reply_all"
                 android:visibility="gone"
                 style="@style/message_view_action_buttons"
@@ -109,6 +111,7 @@
             <ImageButton
                 android:id="@+id/forward"
                 android:layout_marginRight="16dip"
+                android:contentDescription="@string/forward_action"
                 android:src="@drawable/ic_forward"
                 android:visibility="gone"
                 style="@style/message_view_action_buttons"
diff --git a/res/layout/account_setup_basics_common.xml b/res/layout/account_setup_basics_common.xml
index f5aeaf4f2..2d9cabf8c 100644
--- a/res/layout/account_setup_basics_common.xml
+++ b/res/layout/account_setup_basics_common.xml
@@ -36,6 +36,7 @@
     <EditText
         android:id="@+id/account_email"
         android:hint="@string/account_setup_basics_email_label"
+        android:contentDescription="@string/account_setup_basics_email_label"
         android:inputType="textEmailAddress"
         android:imeOptions="actionNext"
         android:layout_below="@+id/instructions"
@@ -44,6 +45,7 @@
     <EditText
         android:id="@+id/account_password"
         android:hint="@string/account_setup_basics_password_label"
+        android:contentDescription="@string/account_setup_basics_password_label"
         android:inputType="textPassword"
         android:imeOptions="actionDone"
         android:layout_below="@+id/account_email"
diff --git a/res/layout/account_setup_names.xml b/res/layout/account_setup_names.xml
index 803c4a5b7..d13ff84d3 100644
--- a/res/layout/account_setup_names.xml
+++ b/res/layout/account_setup_names.xml
@@ -25,36 +25,38 @@
         android:layout_weight="1"
         android:orientation="vertical" >
         <TextView
-            android:text="@string/account_setup_names_headline"
             android:layout_height="wrap_content"
             android:layout_width="match_parent"
+            android:text="@string/account_setup_names_headline"
             android:textAppearance="?android:attr/textAppearanceMedium"
             android:textColor="?android:attr/textColorPrimary" />
         <TextView
-            android:text="@string/account_setup_names_account_name_label"
             android:layout_height="wrap_content"
             android:layout_width="match_parent"
+            android:text="@string/account_setup_names_account_name_label"
             android:textAppearance="?android:attr/textAppearanceSmall"
             android:textColor="?android:attr/textColorPrimary" />
         <EditText
             android:id="@+id/account_description"
-            android:inputType="textCapWords"
-            android:imeOptions="actionDone"
-            android:layout_height="wrap_content"
-            android:layout_width="match_parent" />
-        <TextView
-            android:id="@+id/account_name_label"
-            android:text="@string/account_setup_names_user_name_label"
             android:layout_height="wrap_content"
             android:layout_width="match_parent"
+            android:contentDescription="@string/account_setup_names_account_name_label"
+            android:inputType="textCapWords"
+            android:imeOptions="actionDone" />
+        <TextView
+            android:id="@+id/account_name_label"
+            android:layout_height="wrap_content"
+            android:layout_width="match_parent"
+            android:text="@string/account_setup_names_user_name_label"
             android:textAppearance="?android:attr/textAppearanceSmall"
             android:textColor="?android:attr/textColorPrimary" />
         <EditText
             android:id="@+id/account_name"
-            android:inputType="textPersonName"
-            android:imeOptions="actionDone"
             android:layout_height="wrap_content"
-            android:layout_width="match_parent" />
+            android:layout_width="match_parent"
+            android:contentDescription="@string/account_setup_names_user_name_label"
+            android:inputType="textPersonName"
+            android:imeOptions="actionDone" />
 
         <!-- TODO - quick placeholder - phone UX still TBD -->
         <Button
diff --git a/res/layout/action_bar_spinner.xml b/res/layout/action_bar_spinner.xml
index f7183c71a..8c9f15e92 100644
--- a/res/layout/action_bar_spinner.xml
+++ b/res/layout/action_bar_spinner.xml
@@ -18,6 +18,7 @@
     xmlns:android="http://schemas.android.com/apk/res/android"
     android:layout_width="@dimen/account_spinner_width"
     android:layout_height="match_parent"
+    android:focusable="true"
     style="@android:style/Widget.Holo.Spinner"
     >
     <TextView
diff --git a/res/layout/message_view_header_actions.xml b/res/layout/message_view_header_actions.xml
index e95d43a95..6ff4bdcf8 100644
--- a/res/layout/message_view_header_actions.xml
+++ b/res/layout/message_view_header_actions.xml
@@ -29,6 +29,7 @@
         android:layout_height="24dip"
         android:layout_margin="6dip"
         android:baselineAlignBottom="true"
+        android:contentDescription="@string/reply_action"
         />
     <View
         android:layout_width="1dip"
diff --git a/res/values/strings.xml b/res/values/strings.xml
index 511868e52..add96ad4f 100644
--- a/res/values/strings.xml
+++ b/res/values/strings.xml
@@ -299,6 +299,11 @@
     <!-- Mailbox list header for recent folders [CHAR LIMIT=30] -->
     <string name="mailbox_list_recent_mailboxes">Recent folders</string>
 
+    <!-- Announces the subject field for a message for users with accessibility requirements -->
+    <string name="message_subject_description">Subject</string>
+    <!-- Announces that a message has no sender or subject
+            to users with accessibility requirements -->
+    <string name="message_is_empty_description">No subject</string>
     <!-- Appears at the bottom of list of messages; user selects to load more messages from that folder. -->
     <string name="message_list_load_more_messages_action">Load more messages</string>
     <!--  The number of messages that are currently selected for various operations such as
diff --git a/src/com/android/email/activity/MessageListItem.java b/src/com/android/email/activity/MessageListItem.java
index 97a133853..3c013bded 100644
--- a/src/com/android/email/activity/MessageListItem.java
+++ b/src/com/android/email/activity/MessageListItem.java
@@ -40,6 +40,7 @@ import android.text.style.StyleSpan;
 import android.util.AttributeSet;
 import android.view.MotionEvent;
 import android.view.View;
+import android.view.accessibility.AccessibilityEvent;
 
 /**
  * This custom View is the list item for the MessageList activity, and serves two purposes:
@@ -96,11 +97,14 @@ public class MessageListItem extends View {
     private static Bitmap sStateForwarded;
     private static Bitmap sStateRepliedAndForwarded;
     private static String sSubjectSnippetDivider;
+    private static String sSubjectDescription;
+    private static String sSubjectEmptyDescription;
 
     public String mSender;
     public CharSequence mText;
     public CharSequence mSnippet;
-    public String mSubject;
+    private String mSubject;
+    private String mSubjectAndDescription;
     private StaticLayout mSubjectLayout;
     public boolean mRead;
     public long mTimestamp;
@@ -135,6 +139,8 @@ public class MessageListItem extends View {
         mContext = context;
         if (!sInit) {
             Resources r = context.getResources();
+            sSubjectDescription = r.getString(R.string.message_subject_description).concat(", ");
+            sSubjectEmptyDescription = r.getString(R.string.message_is_empty_description);
             sSubjectSnippetDivider = r.getString(R.string.message_list_subject_snippet_divider);
             sTextSize =
                 r.getDimensionPixelSize(R.dimen.message_list_item_text_size);
@@ -175,6 +181,16 @@ public class MessageListItem extends View {
         }
     }
 
+    /**
+     * Sets message subject safely, ensuring the cache is invalidated.
+     */
+    public void setSubject(String subject) {
+        if (!subject.equals(mSubject)) {
+            mSubject = subject;
+            mSubjectAndDescription = null;
+        }
+    }
+
     /**
      * Determine the mode of this view (WIDE or NORMAL)
      *
@@ -457,4 +473,31 @@ public class MessageListItem extends View {
 
         return handled;
     }
+
+    @Override
+    public boolean dispatchPopulateAccessibilityEvent(AccessibilityEvent event) {
+        CharSequence contentDescription = getContentDescription(mContext);
+        if (!TextUtils.isEmpty(contentDescription)) {
+            event.setClassName(getClass().getName());
+            event.setPackageName(getContext().getPackageName());
+            event.setEnabled(true);
+            event.setContentDescription(contentDescription);
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * Get message information to use for accessibility.
+     */
+    private CharSequence getContentDescription(Context context) {
+        if (mSubjectAndDescription == null) {
+            if (!TextUtils.isEmpty(mSubject)) {
+                mSubjectAndDescription = sSubjectDescription + mSubject;
+            } else {
+                mSubjectAndDescription = sSubjectEmptyDescription;
+            }
+        }
+        return mSubjectAndDescription;
+    }
 }
diff --git a/src/com/android/email/activity/MessagesAdapter.java b/src/com/android/email/activity/MessagesAdapter.java
index 961de207a..dc0b6e1ae 100644
--- a/src/com/android/email/activity/MessagesAdapter.java
+++ b/src/com/android/email/activity/MessagesAdapter.java
@@ -199,7 +199,7 @@ import java.util.Set;
         itemView.mTimestamp = cursor.getLong(COLUMN_DATE);
         itemView.mSender = cursor.getString(COLUMN_DISPLAY_NAME);
         itemView.mSnippet = cursor.getString(COLUMN_SNIPPET);
-        itemView.mSubject = cursor.getString(COLUMN_SUBJECT);
+        itemView.setSubject(cursor.getString(COLUMN_SUBJECT));
         itemView.mSnippetLineCount = MessageListItem.NEEDS_LAYOUT;
         itemView.mColorChipPaint =
             mShowColorChips ? mResourceHelper.getAccountColorPaint(accountId) : null;