jdk/src/share/classes/javax/swing/border/EtchedBorder.java
changeset 2 90ce3da70b43
child 5506 202f599c92aa
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/jdk/src/share/classes/javax/swing/border/EtchedBorder.java	Sat Dec 01 00:00:00 2007 +0000
@@ -0,0 +1,205 @@
+/*
+ * Copyright 1997-2007 Sun Microsystems, Inc.  All Rights Reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Sun designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Sun in the LICENSE file that accompanied this code.
+ *
+ * This code 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
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
+ * CA 95054 USA or visit www.sun.com if you need additional information or
+ * have any questions.
+ */
+package javax.swing.border;
+
+import java.awt.Graphics;
+import java.awt.Insets;
+import java.awt.Rectangle;
+import java.awt.Color;
+import java.awt.Component;
+import java.beans.ConstructorProperties;
+
+/**
+ * A class which implements a simple etched border which can
+ * either be etched-in or etched-out.  If no highlight/shadow
+ * colors are initialized when the border is created, then
+ * these colors will be dynamically derived from the background
+ * color of the component argument passed into the paintBorder()
+ * method.
+ * <p>
+ * <strong>Warning:</strong>
+ * Serialized objects of this class will not be compatible with
+ * future Swing releases. The current serialization support is
+ * appropriate for short term storage or RMI between applications running
+ * the same version of Swing.  As of 1.4, support for long term storage
+ * of all JavaBeans<sup><font size="-2">TM</font></sup>
+ * has been added to the <code>java.beans</code> package.
+ * Please see {@link java.beans.XMLEncoder}.
+ *
+ * @author David Kloba
+ * @author Amy Fowler
+ */
+public class EtchedBorder extends AbstractBorder
+{
+    /** Raised etched type. */
+    public static final int RAISED  = 0;
+    /** Lowered etched type. */
+    public static final int LOWERED = 1;
+
+    protected int etchType;
+    protected Color highlight;
+    protected Color shadow;
+
+    /**
+     * Creates a lowered etched border whose colors will be derived
+     * from the background color of the component passed into
+     * the paintBorder method.
+     */
+    public EtchedBorder()    {
+        this(LOWERED);
+    }
+
+    /**
+     * Creates an etched border with the specified etch-type
+     * whose colors will be derived
+     * from the background color of the component passed into
+     * the paintBorder method.
+     * @param etchType the type of etch to be drawn by the border
+     */
+    public EtchedBorder(int etchType)    {
+        this(etchType, null, null);
+    }
+
+    /**
+     * Creates a lowered etched border with the specified highlight and
+     * shadow colors.
+     * @param highlight the color to use for the etched highlight
+     * @param shadow the color to use for the etched shadow
+     */
+    public EtchedBorder(Color highlight, Color shadow)    {
+        this(LOWERED, highlight, shadow);
+    }
+
+    /**
+     * Creates an etched border with the specified etch-type,
+     * highlight and shadow colors.
+     * @param etchType the type of etch to be drawn by the border
+     * @param highlight the color to use for the etched highlight
+     * @param shadow the color to use for the etched shadow
+     */
+    @ConstructorProperties({"etchType", "highlightColor", "shadowColor"})
+    public EtchedBorder(int etchType, Color highlight, Color shadow)    {
+        this.etchType = etchType;
+        this.highlight = highlight;
+        this.shadow = shadow;
+    }
+
+    /**
+     * Paints the border for the specified component with the
+     * specified position and size.
+     * @param c the component for which this border is being painted
+     * @param g the paint graphics
+     * @param x the x position of the painted border
+     * @param y the y position of the painted border
+     * @param width the width of the painted border
+     * @param height the height of the painted border
+     */
+    public void paintBorder(Component c, Graphics g, int x, int y, int width, int height) {
+        int w = width;
+        int h = height;
+
+        g.translate(x, y);
+
+        g.setColor(etchType == LOWERED? getShadowColor(c) : getHighlightColor(c));
+        g.drawRect(0, 0, w-2, h-2);
+
+        g.setColor(etchType == LOWERED? getHighlightColor(c) : getShadowColor(c));
+        g.drawLine(1, h-3, 1, 1);
+        g.drawLine(1, 1, w-3, 1);
+
+        g.drawLine(0, h-1, w-1, h-1);
+        g.drawLine(w-1, h-1, w-1, 0);
+
+        g.translate(-x, -y);
+    }
+
+    /**
+     * Reinitialize the insets parameter with this Border's current Insets.
+     * @param c the component for which this border insets value applies
+     * @param insets the object to be reinitialized
+     */
+    public Insets getBorderInsets(Component c, Insets insets) {
+        insets.set(2, 2, 2, 2);
+        return insets;
+    }
+
+    /**
+     * Returns whether or not the border is opaque.
+     */
+    public boolean isBorderOpaque() { return true; }
+
+    /**
+     * Returns which etch-type is set on the etched border.
+     */
+    public int getEtchType() {
+        return etchType;
+    }
+
+    /**
+     * Returns the highlight color of the etched border
+     * when rendered on the specified component.  If no highlight
+     * color was specified at instantiation, the highlight color
+     * is derived from the specified component's background color.
+     * @param c the component for which the highlight may be derived
+     * @since 1.3
+     */
+    public Color getHighlightColor(Component c)   {
+        return highlight != null? highlight :
+                                       c.getBackground().brighter();
+    }
+
+    /**
+     * Returns the highlight color of the etched border.
+     * Will return null if no highlight color was specified
+     * at instantiation.
+     * @since 1.3
+     */
+    public Color getHighlightColor()   {
+        return highlight;
+    }
+
+    /**
+     * Returns the shadow color of the etched border
+     * when rendered on the specified component.  If no shadow
+     * color was specified at instantiation, the shadow color
+     * is derived from the specified component's background color.
+     * @param c the component for which the shadow may be derived
+     * @since 1.3
+     */
+    public Color getShadowColor(Component c)   {
+        return shadow != null? shadow : c.getBackground().darker();
+    }
+
+    /**
+     * Returns the shadow color of the etched border.
+     * Will return null if no shadow color was specified
+     * at instantiation.
+     * @since 1.3
+     */
+    public Color getShadowColor()   {
+        return shadow;
+    }
+
+}