1 /*
2 * Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25 package javax.swing.border;
26
27 import java.awt.Graphics;
28 import java.awt.Insets;
29 import java.awt.Rectangle;
30 import java.awt.Color;
31 import java.awt.Component;
32 import java.beans.ConstructorProperties;
33
34 /**
35 * A class which implements a simple etched border which can
36 * either be etched-in or etched-out. If no highlight/shadow
37 * colors are initialized when the border is created, then
38 * these colors will be dynamically derived from the background
39 * color of the component argument passed into the paintBorder()
40 * method.
41 * <p>
42 * <strong>Warning:</strong>
43 * Serialized objects of this class will not be compatible with
44 * future Swing releases. The current serialization support is
45 * appropriate for short term storage or RMI between applications running
46 * the same version of Swing. As of 1.4, support for long term storage
47 * of all JavaBeans™
48 * has been added to the <code>java.beans</code> package.
49 * Please see {@link java.beans.XMLEncoder}.
50 *
51 * @author David Kloba
52 * @author Amy Fowler
53 */
54 @SuppressWarnings("serial") // Same-version serialization only
55 public class EtchedBorder extends AbstractBorder
56 {
57 /** Raised etched type. */
58 public static final int RAISED = 0;
59 /** Lowered etched type. */
60 public static final int LOWERED = 1;
61
62 protected int etchType;
63 protected Color highlight;
64 protected Color shadow;
65
66 /**
67 * Creates a lowered etched border whose colors will be derived
68 * from the background color of the component passed into
69 * the paintBorder method.
70 */
71 public EtchedBorder() {
72 this(LOWERED);
73 }
74
75 /**
76 * Creates an etched border with the specified etch-type
77 * whose colors will be derived
78 * from the background color of the component passed into
79 * the paintBorder method.
80 *
81 * @param etchType the type of etch to be drawn by the border
82 */
83 public EtchedBorder(int etchType) {
84 this(etchType, null, null);
85 }
86
87 /**
88 * Creates a lowered etched border with the specified highlight and
89 * shadow colors.
90 *
91 * @param highlight the color to use for the etched highlight
92 * @param shadow the color to use for the etched shadow
93 */
94 public EtchedBorder(Color highlight, Color shadow) {
95 this(LOWERED, highlight, shadow);
96 }
97
98 /**
99 * Creates an etched border with the specified etch-type,
100 * highlight and shadow colors.
101 *
102 * @param etchType the type of etch to be drawn by the border
103 * @param highlight the color to use for the etched highlight
104 * @param shadow the color to use for the etched shadow
105 */
106 @ConstructorProperties({"etchType", "highlightColor", "shadowColor"})
107 public EtchedBorder(int etchType, Color highlight, Color shadow) {
108 this.etchType = etchType;
109 this.highlight = highlight;
110 this.shadow = shadow;
111 }
112
113 /**
114 * Paints the border for the specified component with the
115 * specified position and size.
116 *
117 * @param c the component for which this border is being painted
118 * @param g the paint graphics
119 * @param x the x position of the painted border
120 * @param y the y position of the painted border
121 * @param width the width of the painted border
122 * @param height the height of the painted border
123 */
124 public void paintBorder(Component c, Graphics g, int x, int y, int width, int height) {
125 int w = width;
126 int h = height;
127
128 g.translate(x, y);
129
130 g.setColor(etchType == LOWERED? getShadowColor(c) : getHighlightColor(c));
131 g.drawRect(0, 0, w-2, h-2);
132
133 g.setColor(etchType == LOWERED? getHighlightColor(c) : getShadowColor(c));
134 g.drawLine(1, h-3, 1, 1);
135 g.drawLine(1, 1, w-3, 1);
136
137 g.drawLine(0, h-1, w-1, h-1);
138 g.drawLine(w-1, h-1, w-1, 0);
139
140 g.translate(-x, -y);
141 }
142
143 /**
144 * Reinitialize the insets parameter with this Border's current Insets.
145 *
146 * @param c the component for which this border insets value applies
147 * @param insets the object to be reinitialized
148 */
149 public Insets getBorderInsets(Component c, Insets insets) {
150 insets.set(2, 2, 2, 2);
151 return insets;
152 }
153
154 /**
155 * Returns whether or not the border is opaque.
156 * This implementation returns true.
157 *
158 * @return true
159 */
160 public boolean isBorderOpaque() { return true; }
161
162 /**
163 * Returns which etch-type is set on the etched border.
164 *
165 * @return the etched border type, either {@code RAISED} or {@code LOWERED}
166 */
167 public int getEtchType() {
168 return etchType;
169 }
170
171 /**
172 * Returns the highlight color of the etched border
173 * when rendered on the specified component. If no highlight
174 * color was specified at instantiation, the highlight color
175 * is derived from the specified component's background color.
176 *
177 * @param c the component for which the highlight may be derived
178 * @return the highlight {@code Color} of this {@code EtchedBorder}
179 * @since 1.3
180 */
181 public Color getHighlightColor(Component c) {
182 return highlight != null? highlight :
183 c.getBackground().brighter();
184 }
185
186 /**
187 * Returns the highlight color of the etched border.
188 * Will return null if no highlight color was specified
189 * at instantiation.
190 *
191 * @return the highlight {@code Color} of this {@code EtchedBorder} or null
192 * if none was specified
193 * @since 1.3
194 */
195 public Color getHighlightColor() {
196 return highlight;
197 }
198
199 /**
200 * Returns the shadow color of the etched border
201 * when rendered on the specified component. If no shadow
202 * color was specified at instantiation, the shadow color
203 * is derived from the specified component's background color.
204 *
205 * @param c the component for which the shadow may be derived
206 * @return the shadow {@code Color} of this {@code EtchedBorder}
207 * @since 1.3
208 */
209 public Color getShadowColor(Component c) {
210 return shadow != null? shadow : c.getBackground().darker();
211 }
212
213 /**
214 * Returns the shadow color of the etched border.
215 * Will return null if no shadow color was specified
216 * at instantiation.
217 *
218 * @return the shadow {@code Color} of this {@code EtchedBorder} or null
219 * if none was specified
220 * @since 1.3
221 */
222 public Color getShadowColor() {
223 return shadow;
224 }
225
226 }