0N/A/*
2362N/A * Copyright (c) 1997, 2007, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
2362N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
2362N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
2362N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
2362N/A * or visit www.oracle.com if you need additional information or have any
2362N/A * questions.
0N/A */
0N/Apackage javax.swing.border;
0N/A
0N/Aimport java.awt.Graphics;
0N/Aimport java.awt.Insets;
0N/Aimport java.awt.Rectangle;
0N/Aimport java.awt.Color;
0N/Aimport java.awt.Component;
0N/Aimport java.beans.ConstructorProperties;
0N/A
0N/A/**
0N/A * A class which implements a simple etched border which can
0N/A * either be etched-in or etched-out. If no highlight/shadow
0N/A * colors are initialized when the border is created, then
0N/A * these colors will be dynamically derived from the background
0N/A * color of the component argument passed into the paintBorder()
0N/A * method.
0N/A * <p>
0N/A * <strong>Warning:</strong>
0N/A * Serialized objects of this class will not be compatible with
0N/A * future Swing releases. The current serialization support is
0N/A * appropriate for short term storage or RMI between applications running
0N/A * the same version of Swing. As of 1.4, support for long term storage
0N/A * of all JavaBeans<sup><font size="-2">TM</font></sup>
0N/A * has been added to the <code>java.beans</code> package.
0N/A * Please see {@link java.beans.XMLEncoder}.
0N/A *
0N/A * @author David Kloba
0N/A * @author Amy Fowler
0N/A */
0N/Apublic class EtchedBorder extends AbstractBorder
0N/A{
0N/A /** Raised etched type. */
0N/A public static final int RAISED = 0;
0N/A /** Lowered etched type. */
0N/A public static final int LOWERED = 1;
0N/A
0N/A protected int etchType;
0N/A protected Color highlight;
0N/A protected Color shadow;
0N/A
0N/A /**
0N/A * Creates a lowered etched border whose colors will be derived
0N/A * from the background color of the component passed into
0N/A * the paintBorder method.
0N/A */
0N/A public EtchedBorder() {
0N/A this(LOWERED);
0N/A }
0N/A
0N/A /**
0N/A * Creates an etched border with the specified etch-type
0N/A * whose colors will be derived
0N/A * from the background color of the component passed into
0N/A * the paintBorder method.
0N/A * @param etchType the type of etch to be drawn by the border
0N/A */
0N/A public EtchedBorder(int etchType) {
0N/A this(etchType, null, null);
0N/A }
0N/A
0N/A /**
0N/A * Creates a lowered etched border with the specified highlight and
0N/A * shadow colors.
0N/A * @param highlight the color to use for the etched highlight
0N/A * @param shadow the color to use for the etched shadow
0N/A */
0N/A public EtchedBorder(Color highlight, Color shadow) {
0N/A this(LOWERED, highlight, shadow);
0N/A }
0N/A
0N/A /**
0N/A * Creates an etched border with the specified etch-type,
0N/A * highlight and shadow colors.
0N/A * @param etchType the type of etch to be drawn by the border
0N/A * @param highlight the color to use for the etched highlight
0N/A * @param shadow the color to use for the etched shadow
0N/A */
0N/A @ConstructorProperties({"etchType", "highlightColor", "shadowColor"})
0N/A public EtchedBorder(int etchType, Color highlight, Color shadow) {
0N/A this.etchType = etchType;
0N/A this.highlight = highlight;
0N/A this.shadow = shadow;
0N/A }
0N/A
0N/A /**
0N/A * Paints the border for the specified component with the
0N/A * specified position and size.
0N/A * @param c the component for which this border is being painted
0N/A * @param g the paint graphics
0N/A * @param x the x position of the painted border
0N/A * @param y the y position of the painted border
0N/A * @param width the width of the painted border
0N/A * @param height the height of the painted border
0N/A */
0N/A public void paintBorder(Component c, Graphics g, int x, int y, int width, int height) {
0N/A int w = width;
0N/A int h = height;
0N/A
0N/A g.translate(x, y);
0N/A
0N/A g.setColor(etchType == LOWERED? getShadowColor(c) : getHighlightColor(c));
0N/A g.drawRect(0, 0, w-2, h-2);
0N/A
0N/A g.setColor(etchType == LOWERED? getHighlightColor(c) : getShadowColor(c));
0N/A g.drawLine(1, h-3, 1, 1);
0N/A g.drawLine(1, 1, w-3, 1);
0N/A
0N/A g.drawLine(0, h-1, w-1, h-1);
0N/A g.drawLine(w-1, h-1, w-1, 0);
0N/A
0N/A g.translate(-x, -y);
0N/A }
0N/A
0N/A /**
0N/A * Reinitialize the insets parameter with this Border's current Insets.
0N/A * @param c the component for which this border insets value applies
0N/A * @param insets the object to be reinitialized
0N/A */
0N/A public Insets getBorderInsets(Component c, Insets insets) {
0N/A insets.set(2, 2, 2, 2);
0N/A return insets;
0N/A }
0N/A
0N/A /**
0N/A * Returns whether or not the border is opaque.
0N/A */
0N/A public boolean isBorderOpaque() { return true; }
0N/A
0N/A /**
0N/A * Returns which etch-type is set on the etched border.
0N/A */
0N/A public int getEtchType() {
0N/A return etchType;
0N/A }
0N/A
0N/A /**
0N/A * Returns the highlight color of the etched border
0N/A * when rendered on the specified component. If no highlight
0N/A * color was specified at instantiation, the highlight color
0N/A * is derived from the specified component's background color.
0N/A * @param c the component for which the highlight may be derived
0N/A * @since 1.3
0N/A */
0N/A public Color getHighlightColor(Component c) {
0N/A return highlight != null? highlight :
0N/A c.getBackground().brighter();
0N/A }
0N/A
0N/A /**
0N/A * Returns the highlight color of the etched border.
0N/A * Will return null if no highlight color was specified
0N/A * at instantiation.
0N/A * @since 1.3
0N/A */
0N/A public Color getHighlightColor() {
0N/A return highlight;
0N/A }
0N/A
0N/A /**
0N/A * Returns the shadow color of the etched border
0N/A * when rendered on the specified component. If no shadow
0N/A * color was specified at instantiation, the shadow color
0N/A * is derived from the specified component's background color.
0N/A * @param c the component for which the shadow may be derived
0N/A * @since 1.3
0N/A */
0N/A public Color getShadowColor(Component c) {
0N/A return shadow != null? shadow : c.getBackground().darker();
0N/A }
0N/A
0N/A /**
0N/A * Returns the shadow color of the etched border.
0N/A * Will return null if no shadow color was specified
0N/A * at instantiation.
0N/A * @since 1.3
0N/A */
0N/A public Color getShadowColor() {
0N/A return shadow;
0N/A }
0N/A
0N/A}