juce/source/src/gui/components/controls/juce_Label.cpp

   1 /*
   2   ==============================================================================
   3
   4    This file is part of the JUCE library - "Jules' Utility Class Extensions"
   5    Copyright 2004-11 by Raw Material Software Ltd.
   6
   7   ------------------------------------------------------------------------------
   8
   9    JUCE can be redistributed and/or modified under the terms of the GNU General
  10    Public License (Version 2), as published by the Free Software Foundation.
  11    A copy of the license is included in the JUCE distribution, or can be found
  12    online at www.gnu.org/licenses.
  13
  14    JUCE is distributed in the hope that it will be useful, but WITHOUT ANY
  15    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16    A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17
  18   ------------------------------------------------------------------------------
  19
  20    To release a closed-source product which uses JUCE, commercial licenses are
  21    available: visit www.rawmaterialsoftware.com/juce for more information.
  22
  23   ==============================================================================
  24 */
  25
  26 #include "../../../core/juce_StandardHeader.h"
  27
  28 BEGIN_JUCE_NAMESPACE
  29
  30 #include "juce_Label.h"
  31 #include "../lookandfeel/juce_LookAndFeel.h"
  32 #include "../windows/juce_ComponentPeer.h"
  33 #include "../keyboard/juce_CaretComponent.h"
  34
  35
  36 //==============================================================================
  37 Label::Label (const String& name,
  38               const String& labelText)
  39     : Component (name),
  40       textValue (labelText),
  41       lastTextValue (labelText),
  42       font (15.0f),
  43       justification (Justification::centredLeft),
  44       horizontalBorderSize (5),
  45       verticalBorderSize (1),
  46       minimumHorizontalScale (0.7f),
  47       editSingleClick (false),
  48       editDoubleClick (false),
  49       lossOfFocusDiscardsChanges (false)
  50 {
  51     setColour (TextEditor::textColourId, Colours::black);
  52     setColour (TextEditor::backgroundColourId, Colours::transparentBlack);
  53     setColour (TextEditor::outlineColourId, Colours::transparentBlack);
  54
  55     textValue.addListener (this);
  56 }
  57
  58 Label::~Label()
  59 {
  60     textValue.removeListener (this);
  61
  62     if (ownerComponent != nullptr)
  63         ownerComponent->removeComponentListener (this);
  64
  65     editor = nullptr;
  66 }
  67
  68 //==============================================================================
  69 void Label::setText (const String& newText,
  70                      const bool broadcastChangeMessage)
  71 {
  72     hideEditor (true);
  73
  74     if (lastTextValue != newText)
  75     {
  76         lastTextValue = newText;
  77         textValue = newText;
  78         repaint();
  79
  80         textWasChanged();
  81
  82         if (ownerComponent != nullptr)
  83             componentMovedOrResized (*ownerComponent, true, true);
  84
  85         if (broadcastChangeMessage)
  86             callChangeListeners();
  87     }
  88 }
  89
  90 String Label::getText (const bool returnActiveEditorContents) const
  91 {
  92     return (returnActiveEditorContents && isBeingEdited())
  93                 ? editor->getText()
  94                 : textValue.toString();
  95 }
  96
  97 void Label::valueChanged (Value&)
  98 {
  99     if (lastTextValue != textValue.toString())
 100         setText (textValue.toString(), true);
 101 }
 102
 103 //==============================================================================
 104 void Label::setFont (const Font& newFont)
 105 {
 106     if (font != newFont)
 107     {
 108         font = newFont;
 109         repaint();
 110     }
 111 }
 112
 113 const Font& Label::getFont() const noexcept
 114 {
 115     return font;
 116 }
 117
 118 void Label::setEditable (const bool editOnSingleClick,
 119                          const bool editOnDoubleClick,
 120                          const bool lossOfFocusDiscardsChanges_)
 121 {
 122     editSingleClick = editOnSingleClick;
 123     editDoubleClick = editOnDoubleClick;
 124     lossOfFocusDiscardsChanges = lossOfFocusDiscardsChanges_;
 125
 126     setWantsKeyboardFocus (editOnSingleClick || editOnDoubleClick);
 127     setFocusContainer (editOnSingleClick || editOnDoubleClick);
 128 }
 129
 130 void Label::setJustificationType (const Justification& newJustification)
 131 {
 132     if (justification != newJustification)
 133     {
 134         justification = newJustification;
 135         repaint();
 136     }
 137 }
 138
 139 void Label::setBorderSize (int h, int v)
 140 {
 141     if (horizontalBorderSize != h || verticalBorderSize != v)
 142     {
 143         horizontalBorderSize = h;
 144         verticalBorderSize = v;
 145         repaint();
 146     }
 147 }
 148
 149 //==============================================================================
 150 Component* Label::getAttachedComponent() const
 151 {
 152     return static_cast<Component*> (ownerComponent);
 153 }
 154
 155 void Label::attachToComponent (Component* owner,
 156                                const bool onLeft)
 157 {
 158     if (ownerComponent != nullptr)
 159         ownerComponent->removeComponentListener (this);
 160
 161     ownerComponent = owner;
 162
 163     leftOfOwnerComp = onLeft;
 164
 165     if (ownerComponent != nullptr)
 166     {
 167         setVisible (owner->isVisible());
 168         ownerComponent->addComponentListener (this);
 169         componentParentHierarchyChanged (*ownerComponent);
 170         componentMovedOrResized (*ownerComponent, true, true);
 171     }
 172 }
 173
 174 void Label::componentMovedOrResized (Component& component, bool /*wasMoved*/, bool /*wasResized*/)
 175 {
 176     if (leftOfOwnerComp)
 177     {
 178         setSize (jmin (getFont().getStringWidth (textValue.toString()) + 8, component.getX()),
 179                  component.getHeight());
 180
 181         setTopRightPosition (component.getX(), component.getY());
 182     }
 183     else
 184     {
 185         setSize (component.getWidth(),
 186                  8 + roundToInt (getFont().getHeight()));
 187
 188         setTopLeftPosition (component.getX(), component.getY() - getHeight());
 189     }
 190 }
 191
 192 void Label::componentParentHierarchyChanged (Component& component)
 193 {
 194     if (component.getParentComponent() != nullptr)
 195         component.getParentComponent()->addChildComponent (this);
 196 }
 197
 198 void Label::componentVisibilityChanged (Component& component)
 199 {
 200     setVisible (component.isVisible());
 201 }
 202
 203 //==============================================================================
 204 void Label::textWasEdited()
 205 {
 206 }
 207
 208 void Label::textWasChanged()
 209 {
 210 }
 211
 212 void Label::showEditor()
 213 {
 214     if (editor == nullptr)
 215     {
 216         addAndMakeVisible (editor = createEditorComponent());
 217         editor->setText (getText(), false);
 218         editor->addListener (this);
 219         editor->grabKeyboardFocus();
 220         editor->setHighlightedRegion (Range<int> (0, textValue.toString().length()));
 221         editor->addListener (this);
 222
 223         resized();
 224         repaint();
 225
 226         editorShown (editor);
 227
 228         enterModalState (false);
 229         editor->grabKeyboardFocus();
 230     }
 231 }
 232
 233 void Label::editorShown (TextEditor*)
 234 {
 235 }
 236
 237 void Label::editorAboutToBeHidden (TextEditor*)
 238 {
 239 }
 240
 241 bool Label::updateFromTextEditorContents (TextEditor& ed)
 242 {
 243     const String newText (ed.getText());
 244
 245     if (textValue.toString() != newText)
 246     {
 247         lastTextValue = newText;
 248         textValue = newText;
 249         repaint();
 250
 251         textWasChanged();
 252
 253         if (ownerComponent != nullptr)
 254             componentMovedOrResized (*ownerComponent, true, true);
 255
 256         return true;
 257     }
 258
 259     return false;
 260 }
 261
 262 void Label::hideEditor (const bool discardCurrentEditorContents)
 263 {
 264     if (editor != nullptr)
 265     {
 266         WeakReference<Component> deletionChecker (this);
 267
 268         ScopedPointer<TextEditor> outgoingEditor (editor);
 269
 270         editorAboutToBeHidden (outgoingEditor);
 271
 272         const bool changed = (! discardCurrentEditorContents)
 273                                && updateFromTextEditorContents (*outgoingEditor);
 274         outgoingEditor = nullptr;
 275         repaint();
 276
 277         if (changed)
 278             textWasEdited();
 279
 280         if (deletionChecker != nullptr)
 281             exitModalState (0);
 282
 283         if (changed && deletionChecker != nullptr)
 284             callChangeListeners();
 285     }
 286 }
 287
 288 void Label::inputAttemptWhenModal()
 289 {
 290     if (editor != nullptr)
 291     {
 292         if (lossOfFocusDiscardsChanges)
 293             textEditorEscapeKeyPressed (*editor);
 294         else
 295             textEditorReturnKeyPressed (*editor);
 296     }
 297 }
 298
 299 bool Label::isBeingEdited() const noexcept
 300 {
 301     return editor != nullptr;
 302 }
 303
 304 TextEditor* Label::createEditorComponent()
 305 {
 306     TextEditor* const ed = new TextEditor (getName());
 307     ed->setFont (font);
 308
 309     // copy these colours from our own settings..
 310     const int cols[] = { TextEditor::backgroundColourId,
 311                          TextEditor::textColourId,
 312                          TextEditor::highlightColourId,
 313                          TextEditor::highlightedTextColourId,
 314                          TextEditor::outlineColourId,
 315                          TextEditor::focusedOutlineColourId,
 316                          TextEditor::shadowColourId,
 317                          CaretComponent::caretColourId };
 318
 319     for (int i = 0; i < numElementsInArray (cols); ++i)
 320         ed->setColour (cols[i], findColour (cols[i]));
 321
 322     return ed;
 323 }
 324
 325 //==============================================================================
 326 void Label::paint (Graphics& g)
 327 {
 328     getLookAndFeel().drawLabel (g, *this);
 329 }
 330
 331 void Label::mouseUp (const MouseEvent& e)
 332 {
 333     if (editSingleClick
 334          && e.mouseWasClicked()
 335          && contains (e.getPosition())
 336          && ! e.mods.isPopupMenu())
 337     {
 338         showEditor();
 339     }
 340 }
 341
 342 void Label::mouseDoubleClick (const MouseEvent& e)
 343 {
 344     if (editDoubleClick && ! e.mods.isPopupMenu())
 345         showEditor();
 346 }
 347
 348 void Label::resized()
 349 {
 350     if (editor != nullptr)
 351         editor->setBoundsInset (BorderSize<int> (0));
 352 }
 353
 354 void Label::focusGained (FocusChangeType cause)
 355 {
 356     if (editSingleClick && cause == focusChangedByTabKey)
 357         showEditor();
 358 }
 359
 360 void Label::enablementChanged()
 361 {
 362     repaint();
 363 }
 364
 365 void Label::colourChanged()
 366 {
 367     repaint();
 368 }
 369
 370 void Label::setMinimumHorizontalScale (const float newScale)
 371 {
 372     if (minimumHorizontalScale != newScale)
 373     {
 374         minimumHorizontalScale = newScale;
 375         repaint();
 376     }
 377 }
 378
 379 //==============================================================================
 380 // We'll use a custom focus traverser here to make sure focus goes from the
 381 // text editor to another component rather than back to the label itself.
 382 class LabelKeyboardFocusTraverser   : public KeyboardFocusTraverser
 383 {
 384 public:
 385     LabelKeyboardFocusTraverser() {}
 386
 387     Component* getNextComponent (Component* current)
 388     {
 389         return KeyboardFocusTraverser::getNextComponent (dynamic_cast <TextEditor*> (current) != nullptr
 390                                                             ? current->getParentComponent() : current);
 391     }
 392
 393     Component* getPreviousComponent (Component* current)
 394     {
 395         return KeyboardFocusTraverser::getPreviousComponent (dynamic_cast <TextEditor*> (current) != nullptr
 396                                                                 ? current->getParentComponent() : current);
 397     }
 398 };
 399
 400 KeyboardFocusTraverser* Label::createFocusTraverser()
 401 {
 402     return new LabelKeyboardFocusTraverser();
 403 }
 404
 405 //==============================================================================
 406 void Label::addListener (LabelListener* const listener)
 407 {
 408     listeners.add (listener);
 409 }
 410
 411 void Label::removeListener (LabelListener* const listener)
 412 {
 413     listeners.remove (listener);
 414 }
 415
 416 void Label::callChangeListeners()
 417 {
 418     Component::BailOutChecker checker (this);
 419     listeners.callChecked (checker, &LabelListener::labelTextChanged, this);  // (can't use Label::Listener due to idiotic VC2005 bug)
 420 }
 421
 422 //==============================================================================
 423 void Label::textEditorTextChanged (TextEditor& ed)
 424 {
 425     if (editor != nullptr)
 426     {
 427         jassert (&ed == editor);
 428
 429         if (! (hasKeyboardFocus (true) || isCurrentlyBlockedByAnotherModalComponent()))
 430         {
 431             if (lossOfFocusDiscardsChanges)
 432                 textEditorEscapeKeyPressed (ed);
 433             else
 434                 textEditorReturnKeyPressed (ed);
 435         }
 436     }
 437 }
 438
 439 void Label::textEditorReturnKeyPressed (TextEditor& ed)
 440 {
 441     if (editor != nullptr)
 442     {
 443         jassert (&ed == editor);
 444
 445         const bool changed = updateFromTextEditorContents (ed);
 446         hideEditor (true);
 447
 448         if (changed)
 449         {
 450             WeakReference<Component> deletionChecker (this);
 451             textWasEdited();
 452
 453             if (deletionChecker != nullptr)
 454                 callChangeListeners();
 455         }
 456     }
 457 }
 458
 459 void Label::textEditorEscapeKeyPressed (TextEditor& ed)
 460 {
 461     if (editor != nullptr)
 462     {
 463         jassert (&ed == editor);
 464         (void) ed;
 465
 466         editor->setText (textValue.toString(), false);
 467         hideEditor (true);
 468     }
 469 }
 470
 471 void Label::textEditorFocusLost (TextEditor& ed)
 472 {
 473     textEditorTextChanged (ed);
 474 }
 475
 476
 477 END_JUCE_NAMESPACE