ui/views/controls/button/label_button.cc

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "ui/views/controls/button/label_button.h"
   6
   7 #include "base/logging.h"
   8 #include "grit/ui_resources.h"
   9 #include "ui/base/resource/resource_bundle.h"
  10 #include "ui/gfx/animation/throb_animation.h"
  11 #include "ui/gfx/canvas.h"
  12 #include "ui/gfx/font_list.h"
  13 #include "ui/gfx/sys_color_change_listener.h"
  14 #include "ui/native_theme/native_theme.h"
  15 #include "ui/views/background.h"
  16 #include "ui/views/controls/button/label_button_border.h"
  17 #include "ui/views/painter.h"
  18 #include "ui/views/window/dialog_delegate.h"
  19
  20 #if defined(OS_LINUX) && !defined(OS_CHROMEOS)
  21 #include "ui/views/linux_ui/linux_ui.h"
  22 #endif
  23
  24 namespace {
  25
  26 // The spacing between the icon and text.
  27 const int kSpacing = 5;
  28
  29 #if !(defined(OS_LINUX) && !defined(OS_CHROMEOS))
  30 // Default text and shadow colors for STYLE_BUTTON.
  31 const SkColor kStyleButtonTextColor = SK_ColorBLACK;
  32 const SkColor kStyleButtonShadowColor = SK_ColorWHITE;
  33 #endif
  34
  35 }  // namespace
  36
  37 namespace views {
  38
  39 // static
  40 const int LabelButton::kHoverAnimationDurationMs = 170;
  41
  42 // static
  43 const char LabelButton::kViewClassName[] = "LabelButton";
  44
  45 LabelButton::LabelButton(ButtonListener* listener, const base::string16& text)
  46     : CustomButton(listener),
  47       image_(new ImageView()),
  48       label_(new Label()),
  49       button_state_images_(),
  50       button_state_colors_(),
  51       explicitly_set_colors_(),
  52       is_default_(false),
  53       style_(STYLE_TEXTBUTTON),
  54       border_is_themed_border_(true) {
  55   SetAnimationDuration(kHoverAnimationDurationMs);
  56   SetText(text);
  57   SetFontList(gfx::FontList());
  58
  59   AddChildView(image_);
  60   image_->set_interactive(false);
  61
  62   AddChildView(label_);
  63   label_->SetAutoColorReadabilityEnabled(false);
  64   label_->SetHorizontalAlignment(gfx::ALIGN_LEFT);
  65
  66   // Initialize the colors, border, and layout.
  67   SetStyle(style_);
  68
  69   SetAccessibleName(text);
  70 }
  71
  72 LabelButton::~LabelButton() {}
  73
  74 const gfx::ImageSkia& LabelButton::GetImage(ButtonState for_state) {
  75   if (for_state != STATE_NORMAL && button_state_images_[for_state].isNull())
  76     return button_state_images_[STATE_NORMAL];
  77   return button_state_images_[for_state];
  78 }
  79
  80 void LabelButton::SetImage(ButtonState for_state, const gfx::ImageSkia& image) {
  81   button_state_images_[for_state] = image;
  82   UpdateImage();
  83 }
  84
  85 const base::string16& LabelButton::GetText() const {
  86   return label_->text();
  87 }
  88
  89 void LabelButton::SetText(const base::string16& text) {
  90   SetAccessibleName(text);
  91   label_->SetText(text);
  92 }
  93
  94 void LabelButton::SetTextColor(ButtonState for_state, SkColor color) {
  95   button_state_colors_[for_state] = color;
  96   if (for_state == STATE_DISABLED)
  97     label_->SetDisabledColor(color);
  98   else if (for_state == state())
  99     label_->SetEnabledColor(color);
 100   explicitly_set_colors_[for_state] = true;
 101 }
 102
 103 bool LabelButton::GetTextMultiLine() const {
 104   return label_->is_multi_line();
 105 }
 106
 107 void LabelButton::SetTextMultiLine(bool text_multi_line) {
 108   label_->SetMultiLine(text_multi_line);
 109 }
 110
 111 const gfx::FontList& LabelButton::GetFontList() const {
 112   return label_->font_list();
 113 }
 114
 115 void LabelButton::SetFontList(const gfx::FontList& font_list) {
 116   cached_normal_font_list_ = font_list;
 117   cached_bold_font_list_ = font_list.DeriveWithStyle(
 118       font_list.GetFontStyle() | gfx::Font::BOLD);
 119
 120   // STYLE_BUTTON uses bold text to indicate default buttons.
 121   label_->SetFontList(
 122       style_ == STYLE_BUTTON && is_default_ ?
 123       cached_bold_font_list_ : cached_normal_font_list_);
 124 }
 125
 126 void LabelButton::SetElideBehavior(Label::ElideBehavior elide_behavior) {
 127   label_->SetElideBehavior(elide_behavior);
 128 }
 129
 130 gfx::HorizontalAlignment LabelButton::GetHorizontalAlignment() const {
 131   return label_->horizontal_alignment();
 132 }
 133
 134 void LabelButton::SetHorizontalAlignment(gfx::HorizontalAlignment alignment) {
 135   label_->SetHorizontalAlignment(alignment);
 136   InvalidateLayout();
 137 }
 138
 139 void LabelButton::SetIsDefault(bool is_default) {
 140   if (is_default == is_default_)
 141     return;
 142   is_default_ = is_default;
 143   ui::Accelerator accel(ui::VKEY_RETURN, ui::EF_NONE);
 144   is_default_ ? AddAccelerator(accel) : RemoveAccelerator(accel);
 145
 146   // STYLE_BUTTON uses bold text to indicate default buttons.
 147   if (style_ == STYLE_BUTTON) {
 148     label_->SetFontList(
 149         is_default ? cached_bold_font_list_ : cached_normal_font_list_);
 150   }
 151 }
 152
 153 void LabelButton::SetStyle(ButtonStyle style) {
 154   style_ = style;
 155   // Inset the button focus rect from the actual border; roughly match Windows.
 156   if (style == STYLE_BUTTON) {
 157     SetFocusPainter(scoped_ptr<Painter>());
 158   } else {
 159     SetFocusPainter(Painter::CreateDashedFocusPainterWithInsets(
 160                         gfx::Insets(3, 3, 3, 3)));
 161   }
 162   if (style == STYLE_BUTTON) {
 163     label_->SetHorizontalAlignment(gfx::ALIGN_CENTER);
 164     SetFocusable(true);
 165   }
 166   if (style == STYLE_BUTTON)
 167     set_min_size(gfx::Size(70, 33));
 168
 169   OnNativeThemeChanged(GetNativeTheme());
 170 }
 171
 172 void LabelButton::SetFocusPainter(scoped_ptr<Painter> focus_painter) {
 173   focus_painter_ = focus_painter.Pass();
 174 }
 175
 176 gfx::Size LabelButton::GetPreferredSize() const {
 177   // Use a temporary label copy for sizing to avoid calculation side-effects.
 178   Label label(GetText(), cached_normal_font_list_);
 179   label.SetMultiLine(GetTextMultiLine());
 180
 181   if (style() == STYLE_BUTTON) {
 182     // Some text appears wider when rendered normally than when rendered bold.
 183     // Accommodate the widest, as buttons may show bold and shouldn't resize.
 184     const int current_width = label.GetPreferredSize().width();
 185     label.SetFontList(cached_bold_font_list_);
 186     if (label.GetPreferredSize().width() < current_width)
 187       label.SetFontList(cached_normal_font_list_);
 188   }
 189
 190   // Resize multi-line labels given the current limited available width.
 191   const gfx::Size image_size(image_->GetPreferredSize());
 192   const int image_width = image_size.width();
 193   if (GetTextMultiLine() && (width() > image_width + kSpacing))
 194     label.SizeToFit(width() - image_width - (image_width > 0 ? kSpacing : 0));
 195
 196   // Calculate the required size.
 197   gfx::Size size(label.GetPreferredSize());
 198   if (image_width > 0 && size.width() > 0)
 199     size.Enlarge(kSpacing, 0);
 200   size.SetToMax(gfx::Size(0, image_size.height()));
 201   const gfx::Insets insets(GetInsets());
 202   size.Enlarge(image_size.width() + insets.width(), insets.height());
 203
 204   // Make the size at least as large as the minimum size needed by the border.
 205   size.SetToMax(border() ? border()->GetMinimumSize() : gfx::Size());
 206
 207   // Increase the minimum size monotonically with the preferred size.
 208   size.SetToMax(min_size_);
 209   min_size_ = size;
 210
 211   // Return the largest known size clamped to the maximum size (if valid).
 212   if (max_size_.width() > 0)
 213     size.set_width(std::min(max_size_.width(), size.width()));
 214   if (max_size_.height() > 0)
 215     size.set_height(std::min(max_size_.height(), size.height()));
 216   return size;
 217 }
 218
 219 void LabelButton::Layout() {
 220   gfx::HorizontalAlignment adjusted_alignment = GetHorizontalAlignment();
 221   if (base::i18n::IsRTL() && adjusted_alignment != gfx::ALIGN_CENTER)
 222     adjusted_alignment = (adjusted_alignment == gfx::ALIGN_LEFT) ?
 223         gfx::ALIGN_RIGHT : gfx::ALIGN_LEFT;
 224
 225   gfx::Rect child_area(GetLocalBounds());
 226   child_area.Inset(GetInsets());
 227
 228   gfx::Size image_size(image_->GetPreferredSize());
 229   image_size.SetToMin(child_area.size());
 230
 231   // The label takes any remaining width after sizing the image, unless both
 232   // views are centered. In that case, using the tighter preferred label width
 233   // avoids wasted space within the label that would look like awkward padding.
 234   gfx::Size label_size(child_area.size());
 235   if (!image_size.IsEmpty() && !label_size.IsEmpty()) {
 236     label_size.set_width(
 237         std::max(child_area.width() - image_size.width() - kSpacing, 0));
 238     if (adjusted_alignment == gfx::ALIGN_CENTER) {
 239       // Ensure multi-line labels paired with images use their available width.
 240       if (GetTextMultiLine())
 241         label_->SizeToFit(label_size.width());
 242       label_size.set_width(
 243           std::min(label_size.width(), label_->GetPreferredSize().width()));
 244     }
 245   }
 246
 247   gfx::Point image_origin(child_area.origin());
 248   image_origin.Offset(0, (child_area.height() - image_size.height()) / 2);
 249   if (adjusted_alignment == gfx::ALIGN_CENTER) {
 250     const int total_width = image_size.width() + label_size.width() +
 251         ((image_size.width() > 0 && label_size.width() > 0) ? kSpacing : 0);
 252     image_origin.Offset((child_area.width() - total_width) / 2, 0);
 253   } else if (adjusted_alignment == gfx::ALIGN_RIGHT) {
 254     image_origin.Offset(child_area.width() - image_size.width(), 0);
 255   }
 256
 257   gfx::Point label_origin(child_area.origin());
 258   if (!image_size.IsEmpty() &&adjusted_alignment != gfx::ALIGN_RIGHT)
 259     label_origin.set_x(image_origin.x() + image_size.width() + kSpacing);
 260
 261   image_->SetBoundsRect(gfx::Rect(image_origin, image_size));
 262   label_->SetBoundsRect(gfx::Rect(label_origin, label_size));
 263 }
 264
 265 const char* LabelButton::GetClassName() const {
 266   return kViewClassName;
 267 }
 268
 269 scoped_ptr<LabelButtonBorder> LabelButton::CreateDefaultBorder() const {
 270   return scoped_ptr<LabelButtonBorder>(new LabelButtonBorder(style_));
 271 }
 272
 273 void LabelButton::SetBorder(scoped_ptr<Border> border) {
 274   border_is_themed_border_ = false;
 275   View::SetBorder(border.Pass());
 276 }
 277
 278 void LabelButton::OnPaint(gfx::Canvas* canvas) {
 279   View::OnPaint(canvas);
 280   Painter::PaintFocusPainter(this, canvas, focus_painter_.get());
 281 }
 282
 283 void LabelButton::OnFocus() {
 284   View::OnFocus();
 285   // Typically the border renders differently when focused.
 286   SchedulePaint();
 287 }
 288
 289 void LabelButton::OnBlur() {
 290   View::OnBlur();
 291   // Typically the border renders differently when focused.
 292   SchedulePaint();
 293 }
 294
 295 void LabelButton::GetExtraParams(ui::NativeTheme::ExtraParams* params) const {
 296   params->button.checked = false;
 297   params->button.indeterminate = false;
 298   params->button.is_default = is_default_;
 299   params->button.is_focused = HasFocus() && IsAccessibilityFocusable();
 300   params->button.has_border = false;
 301   params->button.classic_state = 0;
 302   params->button.background_color = label_->background_color();
 303 }
 304
 305 void LabelButton::ResetColorsFromNativeTheme() {
 306   const ui::NativeTheme* theme = GetNativeTheme();
 307   SkColor colors[STATE_COUNT] = {
 308     theme->GetSystemColor(ui::NativeTheme::kColorId_ButtonEnabledColor),
 309     theme->GetSystemColor(ui::NativeTheme::kColorId_ButtonHoverColor),
 310     theme->GetSystemColor(ui::NativeTheme::kColorId_ButtonHoverColor),
 311     theme->GetSystemColor(ui::NativeTheme::kColorId_ButtonDisabledColor),
 312   };
 313
 314   // Certain styles do not change text color when hovered or pressed.
 315   bool constant_text_color = false;
 316   // Use hardcoded colors for inverted color scheme support and STYLE_BUTTON.
 317   if (gfx::IsInvertedColorScheme()) {
 318     constant_text_color = true;
 319     colors[STATE_NORMAL] = SK_ColorWHITE;
 320     label_->SetBackgroundColor(SK_ColorBLACK);
 321     label_->set_background(Background::CreateSolidBackground(SK_ColorBLACK));
 322     label_->SetAutoColorReadabilityEnabled(true);
 323     label_->ClearEmbellishing();
 324   } else if (style() == STYLE_BUTTON) {
 325     // TODO(erg): This is disabled on desktop linux because of the binary asset
 326     // confusion. These details should either be pushed into ui::NativeThemeWin
 327     // or should be obsoleted by rendering buttons with paint calls instead of
 328     // with static assets. http://crbug.com/350498
 329 #if !(defined(OS_LINUX) && !defined(OS_CHROMEOS))
 330     constant_text_color = true;
 331     colors[STATE_NORMAL] = kStyleButtonTextColor;
 332     label_->SetBackgroundColor(theme->GetSystemColor(
 333         ui::NativeTheme::kColorId_ButtonBackgroundColor));
 334     label_->SetAutoColorReadabilityEnabled(false);
 335     label_->SetShadowColors(kStyleButtonShadowColor, kStyleButtonShadowColor);
 336     label_->SetShadowOffset(0, 1);
 337 #endif
 338     label_->set_background(NULL);
 339   } else {
 340     label_->set_background(NULL);
 341   }
 342
 343   if (constant_text_color)
 344     colors[STATE_HOVERED] = colors[STATE_PRESSED] = colors[STATE_NORMAL];
 345
 346   for (size_t state = STATE_NORMAL; state < STATE_COUNT; ++state) {
 347     if (!explicitly_set_colors_[state]) {
 348       SetTextColor(static_cast<ButtonState>(state), colors[state]);
 349       explicitly_set_colors_[state] = false;
 350     }
 351   }
 352 }
 353
 354 void LabelButton::UpdateImage() {
 355   image_->SetImage(GetImage(state()));
 356 }
 357
 358 void LabelButton::UpdateThemedBorder() {
 359   // Don't override borders set by others.
 360   if (!border_is_themed_border_)
 361     return;
 362
 363   scoped_ptr<LabelButtonBorder> label_button_border = CreateDefaultBorder();
 364
 365 #if defined(OS_LINUX) && !defined(OS_CHROMEOS)
 366   views::LinuxUI* linux_ui = views::LinuxUI::instance();
 367   if (linux_ui) {
 368     SetBorder(linux_ui->CreateNativeBorder(
 369         this, label_button_border.PassAs<Border>()));
 370   } else
 371 #endif
 372   {
 373     SetBorder(label_button_border.PassAs<Border>());
 374   }
 375
 376   border_is_themed_border_ = true;
 377 }
 378
 379 void LabelButton::StateChanged() {
 380   const gfx::Size previous_image_size(image_->GetPreferredSize());
 381   UpdateImage();
 382   const SkColor color = button_state_colors_[state()];
 383   if (state() != STATE_DISABLED && label_->enabled_color() != color)
 384     label_->SetEnabledColor(color);
 385   label_->SetEnabled(state() != STATE_DISABLED);
 386   if (image_->GetPreferredSize() != previous_image_size)
 387     Layout();
 388 }
 389
 390 void LabelButton::ChildPreferredSizeChanged(View* child) {
 391   PreferredSizeChanged();
 392 }
 393
 394 void LabelButton::OnNativeThemeChanged(const ui::NativeTheme* theme) {
 395   ResetColorsFromNativeTheme();
 396   UpdateThemedBorder();
 397   // Invalidate the layout to pickup the new insets from the border.
 398   InvalidateLayout();
 399 }
 400
 401 ui::NativeTheme::Part LabelButton::GetThemePart() const {
 402   return ui::NativeTheme::kPushButton;
 403 }
 404
 405 gfx::Rect LabelButton::GetThemePaintRect() const {
 406   return GetLocalBounds();
 407 }
 408
 409 ui::NativeTheme::State LabelButton::GetThemeState(
 410     ui::NativeTheme::ExtraParams* params) const {
 411   GetExtraParams(params);
 412   switch (state()) {
 413     case STATE_NORMAL:   return ui::NativeTheme::kNormal;
 414     case STATE_HOVERED:  return ui::NativeTheme::kHovered;
 415     case STATE_PRESSED:  return ui::NativeTheme::kPressed;
 416     case STATE_DISABLED: return ui::NativeTheme::kDisabled;
 417     case STATE_COUNT:    NOTREACHED() << "Unknown state: " << state();
 418   }
 419   return ui::NativeTheme::kNormal;
 420 }
 421
 422 const gfx::Animation* LabelButton::GetThemeAnimation() const {
 423   return hover_animation_.get();
 424 }
 425
 426 ui::NativeTheme::State LabelButton::GetBackgroundThemeState(
 427     ui::NativeTheme::ExtraParams* params) const {
 428   GetExtraParams(params);
 429   return ui::NativeTheme::kNormal;
 430 }
 431
 432 ui::NativeTheme::State LabelButton::GetForegroundThemeState(
 433     ui::NativeTheme::ExtraParams* params) const {
 434   GetExtraParams(params);
 435   return ui::NativeTheme::kHovered;
 436 }
 437
 438 }  // namespace views