jdk/src/share/classes/javax/swing/plaf/metal/MetalProgressBarUI.java
author yan
Mon, 30 Jun 2014 16:32:36 +0400
changeset 25178 dbab904451e9
parent 22574 7f8ce0c8c20a
permissions -rw-r--r--
8046434: Fix doclint warnings from javax.swing.plaf.metal package Reviewed-by: alexsch Contributed-by: Andrei Eremeev <andrei.eremeev@oracle.com>
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
22574
7f8ce0c8c20a 8032627: Add @SuppressWarnings("serial") to appropriate javax.swing classes
darcy
parents: 20458
diff changeset
     2
 * Copyright (c) 1998, 2014, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package javax.swing.plaf.metal;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
import javax.swing.*;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
import javax.swing.plaf.*;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
import javax.swing.plaf.basic.*;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
import java.awt.*;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * The Metal implementation of ProgressBarUI.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * <strong>Warning:</strong>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * Serialized objects of this class will not be compatible with
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * future Swing releases. The current serialization support is
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * appropriate for short term storage or RMI between applications running
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * the same version of Swing.  As of 1.4, support for long term storage
20458
f2423fb3fd19 8025840: Fix all the doclint warnings about trademark
cl
parents: 5506
diff changeset
    41
 * of all JavaBeans&trade;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * has been added to the <code>java.beans</code> package.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * Please see {@link java.beans.XMLEncoder}.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 * @author Michael C. Albers
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 */
22574
7f8ce0c8c20a 8032627: Add @SuppressWarnings("serial") to appropriate javax.swing classes
darcy
parents: 20458
diff changeset
    47
@SuppressWarnings("serial") // Same-version serialization only
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
public class MetalProgressBarUI extends BasicProgressBarUI {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
    private Rectangle innards;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
    private Rectangle box;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
25178
dbab904451e9 8046434: Fix doclint warnings from javax.swing.plaf.metal package
yan
parents: 22574
diff changeset
    53
    /**
dbab904451e9 8046434: Fix doclint warnings from javax.swing.plaf.metal package
yan
parents: 22574
diff changeset
    54
     * Constructs an instance of {@code MetalProgressBarUI}.
dbab904451e9 8046434: Fix doclint warnings from javax.swing.plaf.metal package
yan
parents: 22574
diff changeset
    55
     *
dbab904451e9 8046434: Fix doclint warnings from javax.swing.plaf.metal package
yan
parents: 22574
diff changeset
    56
     * @param c a component
dbab904451e9 8046434: Fix doclint warnings from javax.swing.plaf.metal package
yan
parents: 22574
diff changeset
    57
     * @return an instance of {@code MetalProgressBarUI}
dbab904451e9 8046434: Fix doclint warnings from javax.swing.plaf.metal package
yan
parents: 22574
diff changeset
    58
     */
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
    public static ComponentUI createUI(JComponent c) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
        return new MetalProgressBarUI();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
     * Draws a bit of special highlighting on the progress bar.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
     * The core painting is deferred to the BasicProgressBar's
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
     * <code>paintDeterminate</code> method.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
     * @since 1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
    public void paintDeterminate(Graphics g, JComponent c) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
        super.paintDeterminate(g,c);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
        if (!(g instanceof Graphics2D)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
            return;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
        if (progressBar.isBorderPainted()) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
            Insets b = progressBar.getInsets(); // area for border
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
            int barRectWidth = progressBar.getWidth() - (b.left + b.right);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
            int barRectHeight = progressBar.getHeight() - (b.top + b.bottom);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
            int amountFull = getAmountFull(b, barRectWidth, barRectHeight);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
            boolean isLeftToRight = MetalUtils.isLeftToRight(c);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
            int startX, startY, endX, endY;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
            // The progress bar border is painted according to a light source.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
            // This light source is stationary and does not change when the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
            // component orientation changes.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
            startX = b.left;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
            startY = b.top;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
            endX = b.left + barRectWidth - 1;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
            endY = b.top + barRectHeight - 1;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
            Graphics2D g2 = (Graphics2D)g;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
            g2.setStroke(new BasicStroke(1.f));
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
            if (progressBar.getOrientation() == JProgressBar.HORIZONTAL) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
                // Draw light line lengthwise across the progress bar.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
                g2.setColor(MetalLookAndFeel.getControlShadow());
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
                g2.drawLine(startX, startY, endX, startY);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
                if (amountFull > 0) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
                    // Draw darker lengthwise line over filled area.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
                    g2.setColor(MetalLookAndFeel.getPrimaryControlDarkShadow());
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
                    if (isLeftToRight) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
                        g2.drawLine(startX, startY,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
                                startX + amountFull - 1, startY);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
                    } else {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
                        g2.drawLine(endX, startY,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
                                endX - amountFull + 1, startY);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
                        if (progressBar.getPercentComplete() != 1.f) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
                            g2.setColor(MetalLookAndFeel.getControlShadow());
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
                        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
                    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
                }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
                // Draw a line across the width.  The color is determined by
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
                // the code above.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
                g2.drawLine(startX, startY, startX, endY);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
            } else { // VERTICAL
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
                // Draw light line lengthwise across the progress bar.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
                g2.setColor(MetalLookAndFeel.getControlShadow());
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
                g2.drawLine(startX, startY, startX, endY);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
90ce3da70b43 Initial load
duke
parents:
diff changeset
   124
                if (amountFull > 0) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
                    // Draw darker lengthwise line over filled area.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   126
                    g2.setColor(MetalLookAndFeel.getPrimaryControlDarkShadow());
90ce3da70b43 Initial load
duke
parents:
diff changeset
   127
                    g2.drawLine(startX, endY,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   128
                            startX, endY - amountFull + 1);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   129
                }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   130
                // Draw a line across the width.  The color is determined by
90ce3da70b43 Initial load
duke
parents:
diff changeset
   131
                // the code above.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   132
                g2.setColor(MetalLookAndFeel.getControlShadow());
90ce3da70b43 Initial load
duke
parents:
diff changeset
   133
90ce3da70b43 Initial load
duke
parents:
diff changeset
   134
                if (progressBar.getPercentComplete() == 1.f) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   135
                    g2.setColor(MetalLookAndFeel.getPrimaryControlDarkShadow());
90ce3da70b43 Initial load
duke
parents:
diff changeset
   136
                }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   137
                g2.drawLine(startX, startY, endX, startY);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   138
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   139
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   140
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   141
90ce3da70b43 Initial load
duke
parents:
diff changeset
   142
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   143
     * Draws a bit of special highlighting on the progress bar
90ce3da70b43 Initial load
duke
parents:
diff changeset
   144
     * and bouncing box.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   145
     * The core painting is deferred to the BasicProgressBar's
90ce3da70b43 Initial load
duke
parents:
diff changeset
   146
     * <code>paintIndeterminate</code> method.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   147
     * @since 1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
   148
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   149
    public void paintIndeterminate(Graphics g, JComponent c) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   150
        super.paintIndeterminate(g, c);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   151
90ce3da70b43 Initial load
duke
parents:
diff changeset
   152
        if (!progressBar.isBorderPainted() || (!(g instanceof Graphics2D))) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   153
            return;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   154
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   155
90ce3da70b43 Initial load
duke
parents:
diff changeset
   156
        Insets b = progressBar.getInsets(); // area for border
90ce3da70b43 Initial load
duke
parents:
diff changeset
   157
        int barRectWidth = progressBar.getWidth() - (b.left + b.right);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   158
        int barRectHeight = progressBar.getHeight() - (b.top + b.bottom);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   159
        int amountFull = getAmountFull(b, barRectWidth, barRectHeight);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   160
        boolean isLeftToRight = MetalUtils.isLeftToRight(c);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   161
        int startX, startY, endX, endY;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   162
        Rectangle box = null;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   163
        box = getBox(box);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   164
90ce3da70b43 Initial load
duke
parents:
diff changeset
   165
        // The progress bar border is painted according to a light source.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   166
        // This light source is stationary and does not change when the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   167
        // component orientation changes.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   168
        startX = b.left;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   169
        startY = b.top;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   170
        endX = b.left + barRectWidth - 1;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   171
        endY = b.top + barRectHeight - 1;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   172
90ce3da70b43 Initial load
duke
parents:
diff changeset
   173
        Graphics2D g2 = (Graphics2D)g;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   174
        g2.setStroke(new BasicStroke(1.f));
90ce3da70b43 Initial load
duke
parents:
diff changeset
   175
90ce3da70b43 Initial load
duke
parents:
diff changeset
   176
        if (progressBar.getOrientation() == JProgressBar.HORIZONTAL) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   177
            // Draw light line lengthwise across the progress bar.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   178
            g2.setColor(MetalLookAndFeel.getControlShadow());
90ce3da70b43 Initial load
duke
parents:
diff changeset
   179
            g2.drawLine(startX, startY, endX, startY);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   180
            g2.drawLine(startX, startY, startX, endY);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   181
90ce3da70b43 Initial load
duke
parents:
diff changeset
   182
            // Draw darker lengthwise line over filled area.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   183
            g2.setColor(MetalLookAndFeel.getPrimaryControlDarkShadow());
90ce3da70b43 Initial load
duke
parents:
diff changeset
   184
            g2.drawLine(box.x, startY, box.x + box.width - 1, startY);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   185
90ce3da70b43 Initial load
duke
parents:
diff changeset
   186
        } else { // VERTICAL
90ce3da70b43 Initial load
duke
parents:
diff changeset
   187
            // Draw light line lengthwise across the progress bar.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   188
            g2.setColor(MetalLookAndFeel.getControlShadow());
90ce3da70b43 Initial load
duke
parents:
diff changeset
   189
            g2.drawLine(startX, startY, startX, endY);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   190
            g2.drawLine(startX, startY, endX, startY);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   191
90ce3da70b43 Initial load
duke
parents:
diff changeset
   192
            // Draw darker lengthwise line over filled area.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   193
            g2.setColor(MetalLookAndFeel.getPrimaryControlDarkShadow());
90ce3da70b43 Initial load
duke
parents:
diff changeset
   194
            g2.drawLine(startX, box.y, startX, box.y + box.height - 1);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   195
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   196
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   197
}