link.cc revision d0247b1b59f9c528cb6df88b4f2b9afaf80d181e
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved.
25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be
35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file.
45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/views/controls/link.h"
65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "build/build_config.h"
85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/logging.h"
10868fa2fe829687343ffae624259930155e16dbd8Torne (Richard Coles)#include "base/strings/utf_string_conversions.h"
115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/base/accessibility/accessible_view_state.h"
12d0247b1b59f9c528cb6df88b4f2b9afaf80d181eTorne (Richard Coles)#include "ui/events/event.h"
13d0247b1b59f9c528cb6df88b4f2b9afaf80d181eTorne (Richard Coles)#include "ui/events/keycodes/keyboard_codes.h"
145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/gfx/color_utils.h"
155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/gfx/font.h"
165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/views/controls/link_listener.h"
175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(USE_AURA)
195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "ui/base/cursor/cursor.h"
205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif
215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace views {
235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
24b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles)const char Link::kViewClassName[] = "Link";
255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)Link::Link() : Label(string16()) {
275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  Init();
285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)Link::Link(const string16& title) : Label(title) {
315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  Init();
325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)Link::~Link() {
355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
377dbb3d5cf0c15f500944d211057644d6a2f37371Ben MurdochSkColor Link::GetDefaultEnabledColor() {
387dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch#if defined(OS_WIN)
397dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch  return color_utils::GetSysSkColor(COLOR_HOTLIGHT);
407dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch#else
417dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch  return SkColorSetRGB(0, 51, 153);
427dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch#endif
437dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch}
447dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch
455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void Link::OnEnabledChanged() {
465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  RecalculateFont();
475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  View::OnEnabledChanged();
485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
50b2df76ea8fec9e32f6f3718986dba0d95315b29cTorne (Richard Coles)const char* Link::GetClassName() const {
515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  return kViewClassName;
525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)gfx::NativeCursor Link::GetCursor(const ui::MouseEvent& event) {
555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (!enabled())
565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    return gfx::kNullCursor;
575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(USE_AURA)
585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  return ui::kCursorHand;
595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#elif defined(OS_WIN)
605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  static HCURSOR g_hand_cursor = LoadCursor(NULL, IDC_HAND);
615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  return g_hand_cursor;
625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif
635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)bool Link::HitTestRect(const gfx::Rect& rect) const {
665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // We need to allow clicks on the link. So we override the implementation in
675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Label and use the default implementation of View.
685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  return View::HitTestRect(rect);
695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)bool Link::OnMousePressed(const ui::MouseEvent& event) {
725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (!enabled() ||
735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      (!event.IsLeftMouseButton() && !event.IsMiddleMouseButton()))
745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    return false;
755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  SetPressed(true);
765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  return true;
775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)bool Link::OnMouseDragged(const ui::MouseEvent& event) {
805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  SetPressed(enabled() &&
815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)             (event.IsLeftMouseButton() || event.IsMiddleMouseButton()) &&
825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)             HitTestPoint(event.location()));
835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  return true;
845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void Link::OnMouseReleased(const ui::MouseEvent& event) {
875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Change the highlight first just in case this instance is deleted
885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // while calling the controller
895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  OnMouseCaptureLost();
905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (enabled() &&
915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      (event.IsLeftMouseButton() || event.IsMiddleMouseButton()) &&
925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      HitTestPoint(event.location())) {
935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    // Focus the link on click.
945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    RequestFocus();
955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    if (listener_)
975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      listener_->LinkClicked(this, event.flags());
985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void Link::OnMouseCaptureLost() {
1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  SetPressed(false);
1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)bool Link::OnKeyPressed(const ui::KeyEvent& event) {
1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  bool activate = ((event.key_code() == ui::VKEY_SPACE) ||
1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)                   (event.key_code() == ui::VKEY_RETURN));
1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (!activate)
1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    return false;
1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  SetPressed(false);
1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Focus the link on key pressed.
1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  RequestFocus();
1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (listener_)
1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    listener_->LinkClicked(this, event.flags());
1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  return true;
1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)bool Link::SkipDefaultKeyEventProcessing(const ui::KeyEvent& event) {
1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  // Make sure we don't process space or enter as accelerators.
1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  return (event.key_code() == ui::VKEY_SPACE) ||
1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      (event.key_code() == ui::VKEY_RETURN);
1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void Link::GetAccessibleState(ui::AccessibleViewState* state) {
1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  Label::GetAccessibleState(state);
1305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  state->role = ui::AccessibilityTypes::ROLE_LINK;
1315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1332a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)void Link::OnGestureEvent(ui::GestureEvent* event) {
1345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (!enabled())
1352a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)    return;
1365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (event->type() == ui::ET_GESTURE_TAP_DOWN) {
1385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    SetPressed(true);
1395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  } else if (event->type() == ui::ET_GESTURE_TAP) {
1405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    RequestFocus();
1415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    if (listener_)
1425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)      listener_->LinkClicked(this, event->flags());
1435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  } else {
1445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    SetPressed(false);
1452a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)    return;
1465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
1472a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  event->SetHandled();
1485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void Link::SetFont(const gfx::Font& font) {
1515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  Label::SetFont(font);
1525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  RecalculateFont();
1535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void Link::SetEnabledColor(SkColor color) {
1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  requested_enabled_color_ = color;
1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (!pressed_)
1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    Label::SetEnabledColor(requested_enabled_color_);
1595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void Link::SetPressedColor(SkColor color) {
1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  requested_pressed_color_ = color;
1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (pressed_)
1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    Label::SetEnabledColor(requested_pressed_color_);
1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1672a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)void Link::SetUnderline(bool underline) {
1682a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  if (underline_ == underline)
1692a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)    return;
1702a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  underline_ = underline;
1712a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  RecalculateFont();
1722a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)}
1732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)
1745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void Link::Init() {
1755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  listener_ = NULL;
1765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  pressed_ = false;
1772a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  underline_ = true;
1787dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch  SetEnabledColor(GetDefaultEnabledColor());
1797dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch#if defined(OS_WIN)
1807dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch  SetDisabledColor(color_utils::GetSysSkColor(COLOR_WINDOWTEXT));
1817dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch  SetPressedColor(SkColorSetRGB(200, 0, 0));
1827dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch#else
1837dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch  // TODO(beng): source from theme provider.
1847dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch  SetDisabledColor(SK_ColorBLACK);
1857dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch  SetPressedColor(SK_ColorRED);
1867dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch#endif
1875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  RecalculateFont();
1885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  set_focusable(true);
1895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
1905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
1915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void Link::SetPressed(bool pressed) {
1925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  if (pressed_ != pressed) {
1935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    pressed_ = pressed;
1945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    Label::SetEnabledColor(pressed_ ?
1955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)        requested_pressed_color_ : requested_enabled_color_);
1965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    RecalculateFont();
1975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)    SchedulePaint();
1985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)  }
1995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
2005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
2015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void Link::RecalculateFont() {
2022a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  // Underline the link iff it is enabled and |underline_| is true.
2032a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  const int style = font().GetStyle();
2042a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  const int intended_style = (enabled() && underline_) ?
2052a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)      (style | gfx::Font::UNDERLINE) : (style & ~gfx::Font::UNDERLINE);
2062a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)  if (style != intended_style)
2072a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)    Label::SetFont(font().DeriveFont(0, intended_style));
2085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}
2095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)
2105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}  // namespace views
211