Revise accessibility for Date/TimeView.

ash/system/date/date_view.cc

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "ash/system/date/date_view.h"
 
 #include "ash/shell.h"
 #include "ash/system/tray/system_tray_delegate.h"
 #include "ash/system/tray/tray_constants.h"
 #include "ash/system/tray/tray_utils.h"
 #include "base/command_line.h"
 #include "base/i18n/rtl.h"
 #include "base/i18n/time_formatting.h"
 #include "base/strings/utf_string_conversions.h"
 #include "base/time/time.h"
 #include "grit/ash_strings.h"
 #include "third_party/icu/source/i18n/unicode/datefmt.h"
 #include "third_party/icu/source/i18n/unicode/dtptngen.h"
 #include "third_party/icu/source/i18n/unicode/smpdtfmt.h"
+#include "ui/accessibility/ax_view_state.h"
 #include "ui/base/l10n/l10n_util.h"
 #include "ui/base/ui_base_switches_util.h"
 #include "ui/views/border.h"
 #include "ui/views/controls/label.h"
 #include "ui/views/layout/box_layout.h"
 #include "ui/views/layout/grid_layout.h"
 #include "ui/views/widget/widget.h"
 
 namespace ash {
 namespace tray {
@@ skipping 55 matching lines @@
   timer_.Stop();
 }
 
 void BaseDateTimeView::UpdateText() {
   base::Time now = base::Time::Now();
   UpdateTextInternal(now);
   SchedulePaint();
   SetTimer(now);
 }
 
-BaseDateTimeView::BaseDateTimeView() {
+void BaseDateTimeView::GetAccessibleState(ui::AXViewState* state) {
+  ActionableView::GetAccessibleState(state);
+  state->role = ui::AX_ROLE_TIME;

[dmazzoni, 2016/05/06 15:53:14]

FYI, there is a AX_ROLE_DATE_TIME, would that be better?

[David Tseng, 2016/05/06 20:40:14]

It's a toss up because this base class is really Base Date or Time View (given
the two subclasses). Leaving as is for brevity.

+}
+
+BaseDateTimeView::BaseDateTimeView()
+    : hour_type_(ash::Shell::GetInstance()
+                     ->system_tray_delegate()
+                     ->GetHourClockType()) {
   SetTimer(base::Time::Now());
   SetFocusBehavior(FocusBehavior::NEVER);
 }
 
 void BaseDateTimeView::SetTimer(const base::Time& now) {
   // Try to set the timer to go off at the next change of the minute. We don't
   // want to have the timer go off more than necessary since that will cause
   // the CPU to wake up and consume power.
   base::Time::Exploded exploded;
   now.LocalExplode(&exploded);
 
   // Often this will be called at minute boundaries, and we'll actually want
   // 60 seconds from now.
   int seconds_left = 60 - exploded.second;
   if (seconds_left == 0)
     seconds_left = 60;
 
   // Make sure that the timer fires on the next minute. Without this, if it is
   // called just a teeny bit early, then it will skip the next minute.
   seconds_left += kTimerSlopSeconds;
 
   timer_.Stop();
   timer_.Start(
       FROM_HERE, base::TimeDelta::FromSeconds(seconds_left),
       this, &BaseDateTimeView::UpdateText);
 }
 
+void BaseDateTimeView::UpdateTextInternal(const base::Time& now) {
+  SetAccessibleName(base::TimeFormatTimeOfDayWithHourClockType(
+                        now, hour_type_, base::kKeepAmPm) +
+                    base::ASCIIToUTF16(", ") +
+                    base::TimeFormatFriendlyDate(now));
+
+  NotifyAccessibilityEvent(ui::AX_EVENT_TEXT_CHANGED, true);
+}
+
 void BaseDateTimeView::ChildPreferredSizeChanged(views::View* child) {
   PreferredSizeChanged();
 }
 
 void BaseDateTimeView::OnLocaleChanged() {
   UpdateText();
 }
 
-DateView::DateView()
-    : hour_type_(ash::Shell::GetInstance()->system_tray_delegate()->
-                 GetHourClockType()),
-      action_(TrayDate::NONE) {
+DateView::DateView() : action_(TrayDate::NONE) {
   SetLayoutManager(
       new views::BoxLayout(
           views::BoxLayout::kVertical, 0, 0, 0));
   date_label_ = CreateLabel();
   date_label_->SetEnabledColor(kHeaderTextColorNormal);
   UpdateTextInternal(base::Time::Now());
   AddChildView(date_label_);
 }
 
 DateView::~DateView() {
@@ skipping 23 matching lines @@
   return hour_type_;
 }
 
 void DateView::SetActive(bool active) {
   date_label_->SetEnabledColor(active ? kHeaderTextColorHover
                                       : kHeaderTextColorNormal);
   SchedulePaint();
 }
 
 void DateView::UpdateTextInternal(const base::Time& now) {
-  SetAccessibleName(
-      base::TimeFormatFriendlyDate(now) +
-      base::ASCIIToUTF16(", ") +
-      base::TimeFormatTimeOfDayWithHourClockType(
-          now, hour_type_, base::kKeepAmPm));
+  BaseDateTimeView::UpdateTextInternal(now);
   date_label_->SetText(
       l10n_util::GetStringFUTF16(
           IDS_ASH_STATUS_TRAY_DATE, FormatDayOfWeek(now), FormatDate(now)));
 }
 
 bool DateView::PerformAction(const ui::Event& event) {
   if (action_ == TrayDate::NONE)
     return false;
   if (action_ == TrayDate::SHOW_DATE_SETTINGS)
     ash::Shell::GetInstance()->system_tray_delegate()->ShowDateSettings();
@@ skipping 21 matching lines @@
     } else if (event->type() == ui::ET_GESTURE_TAP_CANCEL ||
                event->type() == ui::ET_GESTURE_END) {
       SetActive(false);
     }
   }
   BaseDateTimeView::OnGestureEvent(event);
 }
 
 ///////////////////////////////////////////////////////////////////////////////
 
-TimeView::TimeView(TrayDate::ClockLayout clock_layout)
-    : hour_type_(ash::Shell::GetInstance()->system_tray_delegate()->
-                 GetHourClockType()) {
+TimeView::TimeView(TrayDate::ClockLayout clock_layout) {
   SetupLabels();
   UpdateTextInternal(base::Time::Now());
   UpdateClockLayout(clock_layout);
 }
 
 TimeView::~TimeView() {
 }
 
 void TimeView::UpdateTimeFormat() {
   hour_type_ =
       ash::Shell::GetInstance()->system_tray_delegate()->GetHourClockType();
   UpdateText();
 }
 
 base::HourClockType TimeView::GetHourTypeForTesting() const {
   return hour_type_;
 }
 
 void TimeView::UpdateTextInternal(const base::Time& now) {
   // Just in case |now| is null, do NOT update time; otherwise, it will
   // crash icu code by calling into base::TimeFormatTimeOfDayWithHourClockType,
   // see details in crbug.com/147570.
   if (now.is_null()) {
     LOG(ERROR) << "Received null value from base::Time |now| in argument";
     return;
   }
 
+  BaseDateTimeView::UpdateTextInternal(now);
   base::string16 current_time = base::TimeFormatTimeOfDayWithHourClockType(
       now, hour_type_, base::kDropAmPm);
   horizontal_label_->SetText(current_time);
   horizontal_label_->SetTooltipText(base::TimeFormatFriendlyDate(now));
 
   // Calculate vertical clock layout labels.
   size_t colon_pos = current_time.find(base::ASCIIToUTF16(":"));
   base::string16 hour = current_time.substr(0, colon_pos);
   base::string16 minute = current_time.substr(colon_pos + 1);
 
@@ skipping 69 matching lines @@
 }
 
 void TimeView::SetupLabel(views::Label* label) {
   label->set_owned_by_client();
   SetupLabelForTray(label);
   label->SetElideBehavior(gfx::NO_ELIDE);
 }
 
 }  // namespace tray
 }  // namespace ash