jdk/src/share/classes/javax/swing/border/CompoundBorder.java
author duke
Sat, 01 Dec 2007 00:00:00 +0000
changeset 2 90ce3da70b43
child 1286 2c43fda67ddf
permissions -rw-r--r--
Initial load
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
90ce3da70b43 Initial load
duke
parents:
diff changeset
     2
 * Copyright 1997-2007 Sun Microsystems, Inc.  All Rights Reserved.
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
90ce3da70b43 Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Sun designates this
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
90ce3da70b43 Initial load
duke
parents:
diff changeset
     9
 * by Sun in the LICENSE file that accompanied this code.
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
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    21
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    22
 * CA 95054 USA or visit www.sun.com if you need additional information or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    23
 * have any questions.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
package javax.swing.border;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
import java.awt.Graphics;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
import java.awt.Insets;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
import java.awt.Component;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
import java.beans.ConstructorProperties;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * A composite Border class used to compose two Border objects
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * into a single border by nesting an inside Border object within
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * the insets of an outside Border object.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * For example, this class may be used to add blank margin space
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * to a component with an existing decorative border:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * <code><pre>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 *    Border border = comp.getBorder();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 *    Border margin = new EmptyBorder(10,10,10,10);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 *    comp.setBorder(new CompoundBorder(border, margin));
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 * </pre></code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 * <strong>Warning:</strong>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
 * Serialized objects of this class will not be compatible with
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 * future Swing releases. The current serialization support is
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
 * appropriate for short term storage or RMI between applications running
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
 * the same version of Swing.  As of 1.4, support for long term storage
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
 * of all JavaBeans<sup><font size="-2">TM</font></sup>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
 * has been added to the <code>java.beans</code> package.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
 * Please see {@link java.beans.XMLEncoder}.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
 * @author David Kloba
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
public class CompoundBorder extends AbstractBorder {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
    protected Border outsideBorder;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
    protected Border insideBorder;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
     * Creates a compound border with null outside and inside borders.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
    public CompoundBorder() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
        this.outsideBorder = null;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
        this.insideBorder = null;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
     * Creates a compound border with the specified outside and
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
     * inside borders.  Either border may be null.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
     * @param outsideBorder the outside border
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
     * @param insideBorder the inside border to be nested
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
    @ConstructorProperties({"outsideBorder", "insideBorder"})
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
    public CompoundBorder(Border outsideBorder, Border insideBorder) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
        this.outsideBorder = outsideBorder;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
        this.insideBorder = insideBorder;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
     * Returns whether or not this compound border is opaque.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
     * Returns true if both the inside and outside borders are
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
     * non-null and opaque; returns false otherwise.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
    public boolean isBorderOpaque() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
        return (outsideBorder == null || outsideBorder.isBorderOpaque()) &&
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
               (insideBorder == null || insideBorder.isBorderOpaque());
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
     * Paints the compound border by painting the outside border
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
     * with the specified position and size and then painting the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
     * inside border at the specified position and size offset by
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
     * the insets of the outside border.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
     * @param c the component for which this border is being painted
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
     * @param g the paint graphics
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
     * @param x the x position of the painted border
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
     * @param y the y position of the painted border
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
     * @param width the width of the painted border
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
     * @param height the height of the painted border
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
    public void paintBorder(Component c, Graphics g, int x, int y, int width, int height) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
        Insets  nextInsets;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
        int px, py, pw, ph;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
        px = x;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
        py = y;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
        pw = width;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
        ph = height;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
        if(outsideBorder != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
            outsideBorder.paintBorder(c, g, px, py, pw, ph);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
            nextInsets = outsideBorder.getBorderInsets(c);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
            px += nextInsets.left;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
            py += nextInsets.top;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
            pw = pw - nextInsets.right - nextInsets.left;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
            ph = ph - nextInsets.bottom - nextInsets.top;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
        if(insideBorder != null)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
            insideBorder.paintBorder(c, g, px, py, pw, ph);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
90ce3da70b43 Initial load
duke
parents:
diff changeset
   124
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
90ce3da70b43 Initial load
duke
parents:
diff changeset
   126
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   127
     * Reinitialize the insets parameter with this Border's current Insets.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   128
     * @param c the component for which this border insets value applies
90ce3da70b43 Initial load
duke
parents:
diff changeset
   129
     * @param insets the object to be reinitialized
90ce3da70b43 Initial load
duke
parents:
diff changeset
   130
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   131
    public Insets getBorderInsets(Component c, Insets insets) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   132
        Insets  nextInsets;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   133
90ce3da70b43 Initial load
duke
parents:
diff changeset
   134
        insets.top = insets.left = insets.right = insets.bottom = 0;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   135
        if(outsideBorder != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   136
            nextInsets = outsideBorder.getBorderInsets(c);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   137
            insets.top += nextInsets.top;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   138
            insets.left += nextInsets.left;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   139
            insets.right += nextInsets.right;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   140
            insets.bottom += nextInsets.bottom;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   141
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   142
        if(insideBorder != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   143
            nextInsets = insideBorder.getBorderInsets(c);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   144
            insets.top += nextInsets.top;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   145
            insets.left += nextInsets.left;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   146
            insets.right += nextInsets.right;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   147
            insets.bottom += nextInsets.bottom;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   148
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   149
        return insets;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   150
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   151
90ce3da70b43 Initial load
duke
parents:
diff changeset
   152
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   153
     * Returns the outside border object.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   154
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   155
    public Border getOutsideBorder() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   156
        return outsideBorder;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   157
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   158
90ce3da70b43 Initial load
duke
parents:
diff changeset
   159
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   160
     * Returns the inside border object.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   161
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   162
    public Border getInsideBorder() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   163
        return insideBorder;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   164
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   165
}