01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41: package org.netbeans.api.visual.border;
42:
43: import java.awt.*;
44:
45: /**
46: * The class is responsible for defining and rendering borders. Border size is defined by insets.
47: * <p>
48: * Borders can be opaque. If true, then the border has to care about painting all pixels in borders.
49: * If false, then the widget background is painted under borders too.
50: * <p>
51: * This can be used for non-rectagular shapes of borders e.g. returning true from isOpaque and drawing a filled rounded rectangle.
52: *
53: * @author David Kaspar
54: */
55: // TODO - change abstract class to assure immutable insets?
56: public interface Border {
57:
58: /**
59: * Returns layout insets. Insets has to be the same during whole life-cycle of the border.
60: * @return the insets
61: */
62: // WARNING - must be immutable during whole lifecycle
63: public Insets getInsets();
64:
65: /**
66: * Paints the border to the Graphics2D instance within specific bounds.
67: * Borders are always painted immediately after the widget background and before the widget painting itself.
68: * @param gr the Graphics2D instance
69: * @param bounds the boundary
70: */
71: public void paint(Graphics2D gr, Rectangle bounds);
72:
73: /**
74: * Returns whether the border is opaque. The result of the method controls whether a widget background is painted
75: * under the border insets too.
76: * @return true, if background is painted under the border insets.
77: */
78: public boolean isOpaque();
79:
80: }
|