summaryrefslogtreecommitdiff
path: root/libjava/classpath/javax/swing/plaf/basic/BasicButtonUI.java
blob: 1697c24d926aa56601b85ca9a45233341386f66d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
/* BasicButtonUI.java --
   Copyright (C) 2002, 2004, 2005  Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */


package javax.swing.plaf.basic;

import java.awt.Dimension;
import java.awt.Font;
import java.awt.FontMetrics;
import java.awt.Graphics;
import java.awt.Insets;
import java.awt.Rectangle;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;

import javax.swing.AbstractButton;
import javax.swing.ButtonModel;
import javax.swing.Icon;
import javax.swing.JButton;
import javax.swing.JComponent;
import javax.swing.LookAndFeel;
import javax.swing.SwingUtilities;
import javax.swing.UIManager;
import javax.swing.plaf.ButtonUI;
import javax.swing.plaf.ComponentUI;
import javax.swing.plaf.UIResource;
import javax.swing.text.View;

/**
 * A UI delegate for the {@link JButton} component.
 */
public class BasicButtonUI extends ButtonUI
{
  /**
   * Cached rectangle for layouting the label. Used in paint() and
   * BasicGraphicsUtils.getPreferredButtonSize().
   */
  static Rectangle viewR = new Rectangle();

  /**
   * Cached rectangle for layouting the label. Used in paint() and
   * BasicGraphicsUtils.getPreferredButtonSize().
   */
  static Rectangle iconR = new Rectangle();

  /**
   * Cached rectangle for layouting the label. Used in paint() and
   * BasicGraphicsUtils.getPreferredButtonSize().
   */
  static Rectangle textR = new Rectangle();

  /**
   * Cached Insets instance, used in paint().
   */
  static Insets cachedInsets;

  /**
   * The shared button UI.
   */
  private static BasicButtonUI sharedUI;

  /**
   * The shared BasicButtonListener.
   */
  private static BasicButtonListener sharedListener;

  /**
   * A constant used to pad out elements in the button's layout and
   * preferred size calculations.
   */
  protected int defaultTextIconGap = 4;

  /**
   * A constant added to the defaultTextIconGap to adjust the text
   * within this particular button.
   */
  protected int defaultTextShiftOffset;

  private int textShiftOffset;

  /**
   * Factory method to create an instance of BasicButtonUI for a given
   * {@link JComponent}, which should be an {@link AbstractButton}.
   *
   * @param c The component.
   *
   * @return A new UI capable of drawing the component
   */
  public static ComponentUI createUI(final JComponent c)
  {
    if (sharedUI == null)
      sharedUI = new BasicButtonUI();
    return sharedUI;
  }

  /**
   * Returns the default gap between the button's text and icon (in pixels).
   *
   * @param b  the button (ignored).
   *
   * @return The gap.
   */
  public int getDefaultTextIconGap(AbstractButton b)
  {
    return defaultTextIconGap;
  }

  /**
   * Sets the text shift offset to zero.
   *
   * @see #setTextShiftOffset()
   */
  protected void clearTextShiftOffset()
  {
    textShiftOffset = 0;
  }

  /**
   * Returns the text shift offset.
   *
   * @return The text shift offset.
   *
   * @see #clearTextShiftOffset()
   * @see #setTextShiftOffset()
   */
  protected int getTextShiftOffset()
  {
    return textShiftOffset;
  }

  /**
   * Sets the text shift offset to the value in {@link #defaultTextShiftOffset}.
   *
   * @see #clearTextShiftOffset()
   */
  protected void setTextShiftOffset()
  {
    textShiftOffset = defaultTextShiftOffset;
  }

  /**
   * Returns the prefix for the UI defaults property for this UI class.
   * This is 'Button' for this class.
   *
   * @return the prefix for the UI defaults property
   */
  protected String getPropertyPrefix()
  {
    return "Button.";
  }

  /**
   * Installs the default settings.
   *
   * @param b  the button (<code>null</code> not permitted).
   */
  protected void installDefaults(AbstractButton b)
  {
    String prefix = getPropertyPrefix();
    // Install colors and font.
    LookAndFeel.installColorsAndFont(b, prefix + "background",
                                     prefix + "foreground", prefix + "font");
    // Install border.
    LookAndFeel.installBorder(b, prefix + "border");

    // Install margin property.
    if (b.getMargin() == null || b.getMargin() instanceof UIResource)
      b.setMargin(UIManager.getInsets(prefix + "margin"));

    // Install rollover property.
    Object rollover = UIManager.get(prefix + "rollover");
    if (rollover != null)
      LookAndFeel.installProperty(b, "rolloverEnabled", rollover);

    // Fetch default textShiftOffset.
    defaultTextShiftOffset = UIManager.getInt(prefix + "textShiftOffset");

    // Make button opaque if needed.
    if (b.isContentAreaFilled())
      LookAndFeel.installProperty(b, "opaque", Boolean.TRUE);
    else
      LookAndFeel.installProperty(b, "opaque", Boolean.FALSE);
  }

  /**
   * Removes the defaults added by {@link #installDefaults(AbstractButton)}.
   *
   * @param b  the button (<code>null</code> not permitted).
   */
  protected void uninstallDefaults(AbstractButton b)
  {
    // The other properties aren't uninstallable.
    LookAndFeel.uninstallBorder(b);
  }

  /**
   * Creates and returns a new instance of {@link BasicButtonListener}.  This
   * method provides a hook to make it easy for subclasses to install a
   * different listener.
   *
   * @param b  the button.
   *
   * @return A new listener.
   */
  protected BasicButtonListener createButtonListener(AbstractButton b)
  {
    // Note: The RI always returns a new instance here. However,
    // the BasicButtonListener class is perfectly suitable to be shared
    // between multiple buttons, so we return a shared instance here
    // for efficiency.
    if (sharedListener == null)
      sharedListener = new BasicButtonListener(b);
    return sharedListener;
  }

  /**
   * Installs listeners for the button.
   *
   * @param b  the button (<code>null</code> not permitted).
   */
  protected void installListeners(AbstractButton b)
  {
    BasicButtonListener listener = createButtonListener(b);
    if (listener != null)
      {
        b.addChangeListener(listener);
        b.addPropertyChangeListener(listener);
        b.addFocusListener(listener);
        b.addMouseListener(listener);
        b.addMouseMotionListener(listener);
      }
    // Fire synthetic property change event to let the listener update
    // the TextLayout cache.
    listener.propertyChange(new PropertyChangeEvent(b, "font", null,
                                                    b.getFont()));
  }

  /**
   * Uninstalls listeners for the button.
   *
   * @param b  the button (<code>null</code> not permitted).
   */
  protected void uninstallListeners(AbstractButton b)
  {
    BasicButtonListener listener = getButtonListener(b);
    if (listener != null)
      {
        b.removeChangeListener(listener);
        b.removePropertyChangeListener(listener);
        b.removeFocusListener(listener);
        b.removeMouseListener(listener);
        b.removeMouseMotionListener(listener);
      }
  }

  protected void installKeyboardActions(AbstractButton b)
  {
    BasicButtonListener listener = getButtonListener(b);
    if (listener != null)
      listener.installKeyboardActions(b);
  }

  protected void uninstallKeyboardActions(AbstractButton b)
  {
    BasicButtonListener listener = getButtonListener(b);
    if (listener != null)
      listener.uninstallKeyboardActions(b);
  }

  /**
   * Install the BasicButtonUI as the UI for a particular component.
   * This means registering all the UI's listeners with the component,
   * and setting any properties of the button which are particular to
   * this look and feel.
   *
   * @param c The component to install the UI into
   */
  public void installUI(final JComponent c)
  {
    super.installUI(c);
    if (c instanceof AbstractButton)
      {
        AbstractButton b = (AbstractButton) c;
        installDefaults(b);
        // It is important to install the listeners before installing
        // the keyboard actions, because the keyboard actions
        // are actually installed on the listener instance.
        installListeners(b);
        installKeyboardActions(b);
        BasicHTML.updateRenderer(b, b.getText());
      }
  }

  /**
   * Uninstalls the UI from the component.
   *
   * @param c the component from which to uninstall the UI
   */
  public void uninstallUI(JComponent c)
  {
    if (c instanceof AbstractButton)
      {
        AbstractButton b = (AbstractButton) c;
        uninstallKeyboardActions(b);
        uninstallListeners(b);
        uninstallDefaults(b);
        BasicHTML.updateRenderer(b, "");
        b.putClientProperty(BasicGraphicsUtils.CACHED_TEXT_LAYOUT, null);
      }
  }

  /**
   * Calculates the minimum size for the specified component.
   *
   * @param c the component for which to compute the minimum size
   *
   * @return the minimum size for the specified component
   */
  public Dimension getMinimumSize(JComponent c)
  {
    Dimension size = getPreferredSize(c);
    // When the HTML view has a minimum width different from the preferred
    // width, then substract this here accordingly. The height is not
    // affected by that.
    View html = (View) c.getClientProperty(BasicHTML.propertyKey);
    if (html != null)
      {
        size.width -= html.getPreferredSpan(View.X_AXIS)
                      - html.getPreferredSpan(View.X_AXIS);
      }
    return size;
  }

  /**
   * Calculates the maximum size for the specified component.
   *
   * @param c the component for which to compute the maximum size
   *
   * @return the maximum size for the specified component
   */
  public Dimension getMaximumSize(JComponent c)
  {
    Dimension size = getPreferredSize(c);
    // When the HTML view has a maximum width different from the preferred
    // width, then add this here accordingly. The height is not
    // affected by that.
    View html = (View) c.getClientProperty(BasicHTML.propertyKey);
    if (html != null)
      {
        size.width += html.getMaximumSpan(View.X_AXIS)
                      - html.getPreferredSpan(View.X_AXIS);
      }
    return size;
  }

  /**
   * Calculate the preferred size of this component, by delegating to
   * {@link BasicGraphicsUtils#getPreferredButtonSize}.
   *
   * @param c The component to measure
   *
   * @return The preferred dimensions of the component
   */
  public Dimension getPreferredSize(JComponent c)
  {
    AbstractButton b = (AbstractButton) c;
    Dimension d = BasicGraphicsUtils.getPreferredButtonSize(b,
                                                           b.getIconTextGap());
    return d;
  }

  static Icon currentIcon(AbstractButton b)
  {
    Icon i = b.getIcon();
    ButtonModel model = b.getModel();

    if (model.isPressed() && b.getPressedIcon() != null && b.isEnabled())
      i = b.getPressedIcon();

    else if (model.isRollover())
      {
        if (b.isSelected() && b.getRolloverSelectedIcon() != null)
          i = b.getRolloverSelectedIcon();
        else if (b.getRolloverIcon() != null)
          i = b.getRolloverIcon();
      }

    else if (b.isSelected() && b.isEnabled())
      {
        if (b.isEnabled() && b.getSelectedIcon() != null)
          i = b.getSelectedIcon();
        else if (b.getDisabledSelectedIcon() != null)
          i = b.getDisabledSelectedIcon();
      }

    else if (! b.isEnabled() && b.getDisabledIcon() != null)
      i = b.getDisabledIcon();

    return i;
  }

  /**
   * Paint the component, which is an {@link AbstractButton}, according to
   * its current state.
   *
   * @param g The graphics context to paint with
   * @param c The component to paint the state of
   */
  public void paint(Graphics g, JComponent c)
  {
    AbstractButton b = (AbstractButton) c;

    Insets i = c.getInsets(cachedInsets);
    viewR.x = i.left;
    viewR.y = i.top;
    viewR.width = c.getWidth() - i.left - i.right;
    viewR.height = c.getHeight() - i.top - i.bottom;
    textR.x = 0;
    textR.y = 0;
    textR.width = 0;
    textR.height = 0;
    iconR.x = 0;
    iconR.y = 0;
    iconR.width = 0;
    iconR.height = 0;

    Font f = c.getFont();
    g.setFont(f);
    Icon icon = b.getIcon();
    String text = b.getText();
    text = SwingUtilities.layoutCompoundLabel(c, g.getFontMetrics(f),
                                              text, icon,
                                              b.getVerticalAlignment(),
                                              b.getHorizontalAlignment(),
                                              b.getVerticalTextPosition(),
                                              b.getHorizontalTextPosition(),
                                              viewR, iconR, textR,
                                              text == null ? 0
                                                         : b.getIconTextGap());

    ButtonModel model = b.getModel();
    if (model.isArmed() && model.isPressed())
      paintButtonPressed(g, b);

    if (icon != null)
      paintIcon(g, c, iconR);
    if (text != null)
      {
        View html = (View) b.getClientProperty(BasicHTML.propertyKey);
        if (html != null)
          html.paint(g, textR);
        else
          paintText(g, b, textR, text);
      }
    if (b.isFocusOwner() && b.isFocusPainted())
      paintFocus(g, b, viewR, textR, iconR);
  }

  /**
   * Paint any focus decoration this {@link JComponent} might have.  The
   * component, which in this case will be an {@link AbstractButton},
   * should only have focus decoration painted if it has the focus, and its
   * "focusPainted" property is <code>true</code>.
   *
   * @param g Graphics context to paint with
   * @param b Button to paint the focus of
   * @param vr Visible rectangle, the area in which to paint
   * @param tr Text rectangle, contained in visible rectangle
   * @param ir Icon rectangle, contained in visible rectangle
   *
   * @see AbstractButton#isFocusPainted()
   * @see JComponent#hasFocus()
   */
  protected void paintFocus(Graphics g, AbstractButton b, Rectangle vr,
                            Rectangle tr, Rectangle ir)
  {
    // In the BasicLookAndFeel no focus border is drawn. This can be
    // overridden in subclasses to implement such behaviour.
  }

  /**
   * Paint the icon for this component. Depending on the state of the
   * component and the availability of the button's various icon
   * properties, this might mean painting one of several different icons.
   *
   * @param g Graphics context to paint with
   * @param c Component to paint the icon of
   * @param iconRect Rectangle in which the icon should be painted
   */
  protected void paintIcon(Graphics g, JComponent c, Rectangle iconRect)
  {
    AbstractButton b = (AbstractButton) c;
    Icon i = currentIcon(b);

    if (i != null)
      {
        ButtonModel m = b.getModel();
        if (m.isPressed() && m.isArmed())
          {
            int offs = getTextShiftOffset();
            i.paintIcon(c, g, iconRect.x + offs, iconRect.y + offs);
          }
        else
          i.paintIcon(c, g, iconRect.x, iconRect.y);
      }
  }

  /**
   * Paints the background area of an {@link AbstractButton} in the pressed
   * state.  This means filling the supplied area with a darker than normal
   * background.
   *
   * @param g The graphics context to paint with
   * @param b The button to paint the state of
   */
  protected void paintButtonPressed(Graphics g, AbstractButton b)
  {
    if (b.isContentAreaFilled() && b.isOpaque())
      {
        Rectangle area = new Rectangle();
        SwingUtilities.calculateInnerArea(b, area);
        g.setColor(UIManager.getColor(getPropertyPrefix() + "shadow"));
        g.fillRect(area.x, area.y, area.width, area.height);
      }
  }

  /**
   * Paints the "text" property of an {@link AbstractButton}.
   *
   * @param g The graphics context to paint with
   * @param c The component to paint the state of
   * @param textRect The area in which to paint the text
   * @param text The text to paint
   */
  protected void paintText(Graphics g, JComponent c, Rectangle textRect,
                           String text)
  {
    AbstractButton b = (AbstractButton) c;
    Font f = b.getFont();
    g.setFont(f);
    FontMetrics fm = g.getFontMetrics(f);

    if (b.isEnabled())
      {
        g.setColor(b.getForeground());
        // FIXME: Underline mnemonic.
        BasicGraphicsUtils.drawString(b, g, text, -1, textRect.x,
                                      textRect.y + fm.getAscent());
      }
    else
      {
        String prefix = getPropertyPrefix();
        g.setColor(UIManager.getColor(prefix + "disabledText"));
        // FIXME: Underline mnemonic.
        BasicGraphicsUtils.drawString(b, g, text, -1, textRect.x,
                                      textRect.y + fm.getAscent());
      }
  }

  /**
   * Paints the "text" property of an {@link AbstractButton}.
   *
   * @param g The graphics context to paint with
   * @param b The button to paint the state of
   * @param textRect The area in which to paint the text
   * @param text The text to paint
   *
   * @since 1.4
   */
  protected void paintText(Graphics g, AbstractButton b, Rectangle textRect,
                           String text)
  {
    paintText(g, (JComponent) b, textRect, text);
  }

  /**
   * A helper method that finds the BasicButtonListener for the specified
   * button. This is there because this UI class is stateless and
   * shared for all buttons, and thus can't store the listener
   * as instance field. (We store our shared instance in sharedListener,
   * however, subclasses may override createButtonListener() and we would
   * be lost in this case).
   *
   * @param b the button
   *
   * @return the UI event listener
   */
  private BasicButtonListener getButtonListener(AbstractButton b)
  {
    // The listener gets installed as PropertyChangeListener,
    // so look for it in the list of property change listeners.
    PropertyChangeListener[] listeners = b.getPropertyChangeListeners();
    BasicButtonListener l = null;
    for (int i = 0; listeners != null && l == null && i < listeners.length;
           i++)
      {
        if (listeners[i] instanceof BasicButtonListener)
          l = (BasicButtonListener) listeners[i];
      }
    return l;
  }
}