| // Copyright 2013 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/wm/overview/window_selector.h" |
| |
| #include <algorithm> |
| |
| #include "ash/accessibility_delegate.h" |
| #include "ash/ash_switches.h" |
| #include "ash/metrics/user_metrics_recorder.h" |
| #include "ash/root_window_controller.h" |
| #include "ash/shell.h" |
| #include "ash/shell_window_ids.h" |
| #include "ash/switchable_windows.h" |
| #include "ash/wm/overview/scoped_transform_overview_window.h" |
| #include "ash/wm/overview/window_grid.h" |
| #include "ash/wm/overview/window_selector_delegate.h" |
| #include "ash/wm/overview/window_selector_item.h" |
| #include "ash/wm/window_state.h" |
| #include "base/auto_reset.h" |
| #include "base/command_line.h" |
| #include "base/metrics/histogram.h" |
| #include "third_party/skia/include/core/SkPaint.h" |
| #include "third_party/skia/include/core/SkPath.h" |
| #include "ui/aura/client/focus_client.h" |
| #include "ui/aura/window.h" |
| #include "ui/aura/window_event_dispatcher.h" |
| #include "ui/aura/window_observer.h" |
| #include "ui/base/resource/resource_bundle.h" |
| #include "ui/compositor/scoped_layer_animation_settings.h" |
| #include "ui/events/event.h" |
| #include "ui/gfx/canvas.h" |
| #include "ui/gfx/screen.h" |
| #include "ui/gfx/skia_util.h" |
| #include "ui/views/border.h" |
| #include "ui/views/controls/textfield/textfield.h" |
| #include "ui/views/layout/box_layout.h" |
| #include "ui/wm/core/window_util.h" |
| #include "ui/wm/public/activation_client.h" |
| |
| namespace ash { |
| |
| namespace { |
| |
| // The proportion of screen width that the text filter takes. |
| const float kTextFilterScreenProportion = 0.25; |
| |
| // The amount of padding surrounding the text in the text filtering textbox. |
| const int kTextFilterHorizontalPadding = 8; |
| |
| // The distance between the top of the screen and the top edge of the |
| // text filtering textbox. |
| const int kTextFilterDistanceFromTop = 32; |
| |
| // The height of the text filtering textbox. |
| const int kTextFilterHeight = 32; |
| |
| // The font style used for text filtering. |
| static const ::ui::ResourceBundle::FontStyle kTextFilterFontStyle = |
| ::ui::ResourceBundle::FontStyle::MediumFont; |
| |
| // The alpha value for the background of the text filtering textbox. |
| const unsigned char kTextFilterOpacity = 180; |
| |
| // The radius used for the rounded corners on the text filtering textbox. |
| const int kTextFilterCornerRadius = 1; |
| |
| // A comparator for locating a grid with a given root window. |
| struct RootWindowGridComparator |
| : public std::unary_function<WindowGrid*, bool> { |
| explicit RootWindowGridComparator(const aura::Window* root_window) |
| : root_window_(root_window) { |
| } |
| |
| bool operator()(WindowGrid* grid) const { |
| return (grid->root_window() == root_window_); |
| } |
| |
| const aura::Window* root_window_; |
| }; |
| |
| // A comparator for locating a selectable window given a targeted window. |
| struct WindowSelectorItemTargetComparator |
| : public std::unary_function<WindowSelectorItem*, bool> { |
| explicit WindowSelectorItemTargetComparator(const aura::Window* target_window) |
| : target(target_window) { |
| } |
| |
| bool operator()(WindowSelectorItem* window) const { |
| return window->Contains(target); |
| } |
| |
| const aura::Window* target; |
| }; |
| |
| // A comparator for locating a selector item for a given root. |
| struct WindowSelectorItemForRoot |
| : public std::unary_function<WindowSelectorItem*, bool> { |
| explicit WindowSelectorItemForRoot(const aura::Window* root) |
| : root_window(root) { |
| } |
| |
| bool operator()(WindowSelectorItem* item) const { |
| return item->GetRootWindow() == root_window; |
| } |
| |
| const aura::Window* root_window; |
| }; |
| |
| // A View having rounded corners and a specified background color which is |
| // only painted within the bounds defined by the rounded corners. |
| // TODO(tdanderson): This duplicates code from RoundedImageView. Refactor these |
| // classes and move into ui/views. |
| class RoundedContainerView : public views::View { |
| public: |
| RoundedContainerView(int corner_radius, SkColor background) |
| : corner_radius_(corner_radius), |
| background_(background) { |
| } |
| |
| virtual ~RoundedContainerView() {} |
| |
| virtual void OnPaint(gfx::Canvas* canvas) OVERRIDE { |
| views::View::OnPaint(canvas); |
| |
| SkScalar radius = SkIntToScalar(corner_radius_); |
| const SkScalar kRadius[8] = {radius, radius, radius, radius, |
| radius, radius, radius, radius}; |
| SkPath path; |
| gfx::Rect bounds(size()); |
| path.addRoundRect(gfx::RectToSkRect(bounds), kRadius); |
| |
| SkPaint paint; |
| paint.setAntiAlias(true); |
| canvas->ClipPath(path, true); |
| canvas->DrawColor(background_); |
| } |
| |
| private: |
| int corner_radius_; |
| SkColor background_; |
| |
| DISALLOW_COPY_AND_ASSIGN(RoundedContainerView); |
| }; |
| |
| // Triggers a shelf visibility update on all root window controllers. |
| void UpdateShelfVisibility() { |
| Shell::RootWindowControllerList root_window_controllers = |
| Shell::GetInstance()->GetAllRootWindowControllers(); |
| for (Shell::RootWindowControllerList::iterator iter = |
| root_window_controllers.begin(); |
| iter != root_window_controllers.end(); ++iter) { |
| (*iter)->UpdateShelfVisibility(); |
| } |
| } |
| |
| // Initializes the text filter on the top of the main root window and requests |
| // focus on its textfield. |
| views::Widget* CreateTextFilter(views::TextfieldController* controller, |
| aura::Window* root_window) { |
| views::Widget* widget = new views::Widget; |
| views::Widget::InitParams params; |
| params.type = views::Widget::InitParams::TYPE_WINDOW_FRAMELESS; |
| params.ownership = views::Widget::InitParams::WIDGET_OWNS_NATIVE_WIDGET; |
| params.opacity = views::Widget::InitParams::TRANSLUCENT_WINDOW; |
| params.parent = |
| Shell::GetContainer(root_window, ash::kShellWindowId_OverlayContainer); |
| params.accept_events = true; |
| params.bounds = gfx::Rect( |
| root_window->bounds().width() / 2 * (1 - kTextFilterScreenProportion), |
| kTextFilterDistanceFromTop, |
| root_window->bounds().width() * kTextFilterScreenProportion, |
| kTextFilterHeight); |
| widget->Init(params); |
| |
| // Use |container| to specify the padding surrounding the text and to give |
| // the textfield rounded corners. |
| views::View* container = new RoundedContainerView( |
| kTextFilterCornerRadius, SkColorSetARGB(kTextFilterOpacity, 0, 0, 0)); |
| ui::ResourceBundle& bundle = ui::ResourceBundle::GetSharedInstance(); |
| int text_height = bundle.GetFontList(kTextFilterFontStyle).GetHeight(); |
| DCHECK(text_height); |
| int vertical_padding = (kTextFilterHeight - text_height) / 2; |
| container->SetLayoutManager(new views::BoxLayout(views::BoxLayout::kVertical, |
| kTextFilterHorizontalPadding, |
| vertical_padding, |
| 0)); |
| |
| views::Textfield* textfield = new views::Textfield; |
| textfield->set_controller(controller); |
| textfield->SetBackgroundColor(SK_ColorTRANSPARENT); |
| textfield->SetBorder(views::Border::NullBorder()); |
| textfield->SetTextColor(SK_ColorWHITE); |
| textfield->SetFontList(bundle.GetFontList(kTextFilterFontStyle)); |
| |
| container->AddChildView(textfield); |
| widget->SetContentsView(container); |
| |
| // The textfield initially contains no text, so shift its position to be |
| // outside the visible bounds of the screen. |
| gfx::Transform transform; |
| transform.Translate(0, -WindowSelector::kTextFilterBottomEdge); |
| widget->GetNativeWindow()->SetTransform(transform); |
| widget->Show(); |
| textfield->RequestFocus(); |
| |
| return widget; |
| } |
| |
| } // namespace |
| |
| const int WindowSelector::kTextFilterBottomEdge = |
| kTextFilterDistanceFromTop + kTextFilterHeight; |
| |
| WindowSelector::WindowSelector(const WindowList& windows, |
| WindowSelectorDelegate* delegate) |
| : delegate_(delegate), |
| restore_focus_window_(aura::client::GetFocusClient( |
| Shell::GetPrimaryRootWindow())->GetFocusedWindow()), |
| ignore_activations_(false), |
| selected_grid_index_(0), |
| overview_start_time_(base::Time::Now()), |
| num_key_presses_(0), |
| num_items_(0), |
| showing_selection_widget_(false), |
| text_filter_string_length_(0), |
| num_times_textfield_cleared_(0) { |
| DCHECK(delegate_); |
| Shell* shell = Shell::GetInstance(); |
| shell->OnOverviewModeStarting(); |
| |
| if (restore_focus_window_) |
| restore_focus_window_->AddObserver(this); |
| |
| const aura::Window::Windows root_windows = Shell::GetAllRootWindows(); |
| for (aura::Window::Windows::const_iterator iter = root_windows.begin(); |
| iter != root_windows.end(); iter++) { |
| // Observed switchable containers for newly created windows on all root |
| // windows. |
| for (size_t i = 0; i < kSwitchableWindowContainerIdsLength; ++i) { |
| aura::Window* container = Shell::GetContainer(*iter, |
| kSwitchableWindowContainerIds[i]); |
| container->AddObserver(this); |
| observed_windows_.insert(container); |
| } |
| scoped_ptr<WindowGrid> grid(new WindowGrid(*iter, windows, this)); |
| if (grid->empty()) |
| continue; |
| num_items_ += grid->size(); |
| grid_list_.push_back(grid.release()); |
| } |
| |
| // Do not call PrepareForOverview until all items are added to window_list_ as |
| // we don't want to cause any window updates until all windows in overview |
| // are observed. See http://crbug.com/384495. |
| for (ScopedVector<WindowGrid>::iterator iter = grid_list_.begin(); |
| iter != grid_list_.end(); ++iter) { |
| (*iter)->PrepareForOverview(); |
| (*iter)->PositionWindows(true); |
| } |
| |
| DCHECK(!grid_list_.empty()); |
| UMA_HISTOGRAM_COUNTS_100("Ash.WindowSelector.Items", num_items_); |
| |
| text_filter_widget_.reset( |
| CreateTextFilter(this, Shell::GetPrimaryRootWindow())); |
| |
| shell->activation_client()->AddObserver(this); |
| |
| shell->GetScreen()->AddObserver(this); |
| shell->metrics()->RecordUserMetricsAction(UMA_WINDOW_OVERVIEW); |
| HideAndTrackNonOverviewWindows(); |
| // Send an a11y alert. |
| shell->accessibility_delegate()->TriggerAccessibilityAlert( |
| A11Y_ALERT_WINDOW_OVERVIEW_MODE_ENTERED); |
| |
| UpdateShelfVisibility(); |
| } |
| |
| WindowSelector::~WindowSelector() { |
| ash::Shell* shell = ash::Shell::GetInstance(); |
| |
| ResetFocusRestoreWindow(true); |
| for (std::set<aura::Window*>::iterator iter = observed_windows_.begin(); |
| iter != observed_windows_.end(); ++iter) { |
| (*iter)->RemoveObserver(this); |
| } |
| shell->activation_client()->RemoveObserver(this); |
| aura::Window::Windows root_windows = Shell::GetAllRootWindows(); |
| |
| const aura::WindowTracker::Windows hidden_windows(hidden_windows_.windows()); |
| for (aura::WindowTracker::Windows::const_iterator iter = |
| hidden_windows.begin(); iter != hidden_windows.end(); ++iter) { |
| ui::ScopedLayerAnimationSettings settings( |
| (*iter)->layer()->GetAnimator()); |
| settings.SetTransitionDuration(base::TimeDelta::FromMilliseconds( |
| ScopedTransformOverviewWindow::kTransitionMilliseconds)); |
| settings.SetPreemptionStrategy( |
| ui::LayerAnimator::IMMEDIATELY_ANIMATE_TO_NEW_TARGET); |
| (*iter)->layer()->SetOpacity(1); |
| (*iter)->Show(); |
| } |
| |
| shell->GetScreen()->RemoveObserver(this); |
| |
| size_t remaining_items = 0; |
| for (ScopedVector<WindowGrid>::iterator iter = grid_list_.begin(); |
| iter != grid_list_.end(); iter++) { |
| remaining_items += (*iter)->size(); |
| } |
| |
| DCHECK(num_items_ >= remaining_items); |
| UMA_HISTOGRAM_COUNTS_100("Ash.WindowSelector.OverviewClosedItems", |
| num_items_ - remaining_items); |
| UMA_HISTOGRAM_MEDIUM_TIMES("Ash.WindowSelector.TimeInOverview", |
| base::Time::Now() - overview_start_time_); |
| |
| // Record metrics related to text filtering. |
| UMA_HISTOGRAM_COUNTS_100("Ash.WindowSelector.TextFilteringStringLength", |
| text_filter_string_length_); |
| UMA_HISTOGRAM_COUNTS_100("Ash.WindowSelector.TextFilteringTextfieldCleared", |
| num_times_textfield_cleared_); |
| if (text_filter_string_length_) { |
| UMA_HISTOGRAM_MEDIUM_TIMES( |
| "Ash.WindowSelector.TimeInOverviewWithTextFiltering", |
| base::Time::Now() - overview_start_time_); |
| UMA_HISTOGRAM_COUNTS_100( |
| "Ash.WindowSelector.ItemsWhenTextFilteringUsed", |
| remaining_items); |
| } |
| |
| // TODO(flackr): Change this to OnOverviewModeEnded and move it to when |
| // everything is done. |
| shell->OnOverviewModeEnding(); |
| |
| // Clearing the window list resets the ignored_by_shelf flag on the windows. |
| grid_list_.clear(); |
| UpdateShelfVisibility(); |
| } |
| |
| void WindowSelector::CancelSelection() { |
| delegate_->OnSelectionEnded(); |
| } |
| |
| void WindowSelector::OnGridEmpty(WindowGrid* grid) { |
| ScopedVector<WindowGrid>::iterator iter = |
| std::find(grid_list_.begin(), grid_list_.end(), grid); |
| DCHECK(iter != grid_list_.end()); |
| grid_list_.erase(iter); |
| // TODO(flackr): Use the previous index for more than two displays. |
| selected_grid_index_ = 0; |
| if (grid_list_.empty()) |
| CancelSelection(); |
| } |
| |
| bool WindowSelector::HandleKeyEvent(views::Textfield* sender, |
| const ui::KeyEvent& key_event) { |
| if (key_event.type() != ui::ET_KEY_PRESSED) |
| return false; |
| |
| switch (key_event.key_code()) { |
| case ui::VKEY_ESCAPE: |
| CancelSelection(); |
| break; |
| case ui::VKEY_UP: |
| num_key_presses_++; |
| Move(WindowSelector::UP, true); |
| break; |
| case ui::VKEY_DOWN: |
| num_key_presses_++; |
| Move(WindowSelector::DOWN, true); |
| break; |
| case ui::VKEY_RIGHT: |
| case ui::VKEY_TAB: |
| num_key_presses_++; |
| Move(WindowSelector::RIGHT, true); |
| break; |
| case ui::VKEY_LEFT: |
| num_key_presses_++; |
| Move(WindowSelector::LEFT, true); |
| break; |
| case ui::VKEY_RETURN: |
| // Ignore if no item is selected. |
| if (!grid_list_[selected_grid_index_]->is_selecting()) |
| return false; |
| UMA_HISTOGRAM_COUNTS_100("Ash.WindowSelector.ArrowKeyPresses", |
| num_key_presses_); |
| UMA_HISTOGRAM_CUSTOM_COUNTS( |
| "Ash.WindowSelector.KeyPressesOverItemsRatio", |
| (num_key_presses_ * 100) / num_items_, 1, 300, 30); |
| Shell::GetInstance()->metrics()->RecordUserMetricsAction( |
| UMA_WINDOW_OVERVIEW_ENTER_KEY); |
| wm::GetWindowState(grid_list_[selected_grid_index_]-> |
| SelectedWindow()->SelectionWindow())->Activate(); |
| break; |
| default: |
| // Not a key we are interested in, allow the textfield to handle it. |
| return false; |
| } |
| return true; |
| } |
| |
| void WindowSelector::OnDisplayAdded(const gfx::Display& display) { |
| } |
| |
| void WindowSelector::OnDisplayRemoved(const gfx::Display& display) { |
| // TODO(flackr): Keep window selection active on remaining displays. |
| CancelSelection(); |
| } |
| |
| void WindowSelector::OnDisplayMetricsChanged(const gfx::Display& display, |
| uint32_t metrics) { |
| PositionWindows(/* animate */ false); |
| } |
| |
| void WindowSelector::OnWindowAdded(aura::Window* new_window) { |
| if (new_window->type() != ui::wm::WINDOW_TYPE_NORMAL && |
| new_window->type() != ui::wm::WINDOW_TYPE_PANEL) { |
| return; |
| } |
| |
| for (size_t i = 0; i < kSwitchableWindowContainerIdsLength; ++i) { |
| if (new_window->parent()->id() == kSwitchableWindowContainerIds[i] && |
| !::wm::GetTransientParent(new_window)) { |
| // The new window is in one of the switchable containers, abort overview. |
| CancelSelection(); |
| return; |
| } |
| } |
| } |
| |
| void WindowSelector::OnWindowDestroying(aura::Window* window) { |
| window->RemoveObserver(this); |
| observed_windows_.erase(window); |
| if (window == restore_focus_window_) |
| restore_focus_window_ = NULL; |
| } |
| |
| void WindowSelector::OnWindowActivated(aura::Window* gained_active, |
| aura::Window* lost_active) { |
| if (ignore_activations_ || |
| !gained_active || |
| gained_active == text_filter_widget_->GetNativeWindow()) { |
| return; |
| } |
| |
| ScopedVector<WindowGrid>::iterator grid = |
| std::find_if(grid_list_.begin(), grid_list_.end(), |
| RootWindowGridComparator(gained_active->GetRootWindow())); |
| if (grid == grid_list_.end()) |
| return; |
| const std::vector<WindowSelectorItem*> windows = (*grid)->window_list(); |
| |
| ScopedVector<WindowSelectorItem>::const_iterator iter = std::find_if( |
| windows.begin(), windows.end(), |
| WindowSelectorItemTargetComparator(gained_active)); |
| |
| if (iter != windows.end()) |
| (*iter)->RestoreWindowOnExit(gained_active); |
| |
| // Don't restore focus on exit if a window was just activated. |
| ResetFocusRestoreWindow(false); |
| CancelSelection(); |
| } |
| |
| void WindowSelector::OnAttemptToReactivateWindow(aura::Window* request_active, |
| aura::Window* actual_active) { |
| OnWindowActivated(request_active, actual_active); |
| } |
| |
| void WindowSelector::ContentsChanged(views::Textfield* sender, |
| const base::string16& new_contents) { |
| if (CommandLine::ForCurrentProcess()->HasSwitch( |
| switches::kAshDisableTextFilteringInOverviewMode)) { |
| return; |
| } |
| |
| text_filter_string_length_ = new_contents.length(); |
| if (!text_filter_string_length_) |
| num_times_textfield_cleared_++; |
| |
| bool should_show_selection_widget = !new_contents.empty(); |
| if (showing_selection_widget_ != should_show_selection_widget) { |
| ui::ScopedLayerAnimationSettings animation_settings( |
| text_filter_widget_->GetNativeWindow()->layer()->GetAnimator()); |
| animation_settings.SetPreemptionStrategy( |
| ui::LayerAnimator::IMMEDIATELY_ANIMATE_TO_NEW_TARGET); |
| animation_settings.SetTweenType(showing_selection_widget_ ? |
| gfx::Tween::FAST_OUT_LINEAR_IN : gfx::Tween::LINEAR_OUT_SLOW_IN); |
| |
| gfx::Transform transform; |
| if (should_show_selection_widget) { |
| transform.Translate(0, 0); |
| text_filter_widget_->GetNativeWindow()->layer()->SetOpacity(1); |
| } else { |
| transform.Translate(0, -kTextFilterBottomEdge); |
| text_filter_widget_->GetNativeWindow()->layer()->SetOpacity(0); |
| } |
| |
| text_filter_widget_->GetNativeWindow()->SetTransform(transform); |
| showing_selection_widget_ = should_show_selection_widget; |
| } |
| for (ScopedVector<WindowGrid>::iterator iter = grid_list_.begin(); |
| iter != grid_list_.end(); iter++) { |
| (*iter)->FilterItems(new_contents); |
| } |
| |
| // If the selection widget is not active, execute a Move() command so that it |
| // shows up on the first undimmed item. |
| if (grid_list_[selected_grid_index_]->is_selecting()) |
| return; |
| Move(WindowSelector::RIGHT, false); |
| } |
| |
| void WindowSelector::PositionWindows(bool animate) { |
| for (ScopedVector<WindowGrid>::iterator iter = grid_list_.begin(); |
| iter != grid_list_.end(); iter++) { |
| (*iter)->PositionWindows(animate); |
| } |
| } |
| |
| void WindowSelector::HideAndTrackNonOverviewWindows() { |
| // Add the windows to hidden_windows first so that if any are destroyed |
| // while hiding them they are tracked. |
| for (ScopedVector<WindowGrid>::iterator grid_iter = grid_list_.begin(); |
| grid_iter != grid_list_.end(); ++grid_iter) { |
| for (size_t i = 0; i < kSwitchableWindowContainerIdsLength; ++i) { |
| const aura::Window* container = |
| Shell::GetContainer((*grid_iter)->root_window(), |
| kSwitchableWindowContainerIds[i]); |
| for (aura::Window::Windows::const_iterator iter = |
| container->children().begin(); iter != container->children().end(); |
| ++iter) { |
| if (!(*iter)->IsVisible() || (*grid_iter)->Contains(*iter)) |
| continue; |
| hidden_windows_.Add(*iter); |
| } |
| } |
| } |
| |
| // Copy the window list as it can change during iteration. |
| const aura::WindowTracker::Windows hidden_windows(hidden_windows_.windows()); |
| for (aura::WindowTracker::Windows::const_iterator iter = |
| hidden_windows.begin(); iter != hidden_windows.end(); ++iter) { |
| if (!hidden_windows_.Contains(*iter)) |
| continue; |
| ui::ScopedLayerAnimationSettings settings( |
| (*iter)->layer()->GetAnimator()); |
| settings.SetTransitionDuration(base::TimeDelta::FromMilliseconds( |
| ScopedTransformOverviewWindow::kTransitionMilliseconds)); |
| settings.SetPreemptionStrategy( |
| ui::LayerAnimator::IMMEDIATELY_ANIMATE_TO_NEW_TARGET); |
| (*iter)->Hide(); |
| // Hiding the window can result in it being destroyed. |
| if (!hidden_windows_.Contains(*iter)) |
| continue; |
| (*iter)->layer()->SetOpacity(0); |
| } |
| } |
| |
| void WindowSelector::ResetFocusRestoreWindow(bool focus) { |
| if (!restore_focus_window_) |
| return; |
| if (focus) { |
| base::AutoReset<bool> restoring_focus(&ignore_activations_, true); |
| restore_focus_window_->Focus(); |
| } |
| // If the window is in the observed_windows_ list it needs to continue to be |
| // observed. |
| if (observed_windows_.find(restore_focus_window_) == |
| observed_windows_.end()) { |
| restore_focus_window_->RemoveObserver(this); |
| } |
| restore_focus_window_ = NULL; |
| } |
| |
| void WindowSelector::Move(Direction direction, bool animate) { |
| // Keep calling Move() on the grids until one of them reports no overflow or |
| // we made a full cycle on all the grids. |
| for (size_t i = 0; |
| i <= grid_list_.size() && |
| grid_list_[selected_grid_index_]->Move(direction, animate); i++) { |
| // TODO(flackr): If there are more than two monitors, move between grids |
| // in the requested direction. |
| selected_grid_index_ = (selected_grid_index_ + 1) % grid_list_.size(); |
| } |
| } |
| |
| } // namespace ash |