javax.swing.plaf

Class BorderUIResource

Implemented Interfaces:
Border, Serializable, UIResource

public class BorderUIResource
extends Object
implements Border, UIResource, Serializable

A wrapper for Border that also implements the UIResource marker interface. This is useful for implementing pluggable look-and-feels: When switching the current LookAndFeel, only those borders are replaced that are marked as UIResource. For this reason, a look-and-feel should always install borders that implement UIResource, such as the borders provided by this class.
See Also:
Serialized Form

Nested Class Summary

static class
BorderUIResource.BevelBorderUIResource
A BevelBorder that also implements the UIResource marker interface.
static class
BorderUIResource.CompoundBorderUIResource
A CompoundBorder that also implements the UIResource marker interface.
static class
BorderUIResource.EmptyBorderUIResource
An EmptyBorder that also implements the UIResource marker interface.
static class
BorderUIResource.EtchedBorderUIResource
An EtchedBorder that also implements the UIResource marker interface.
static class
BorderUIResource.LineBorderUIResource
A LineBorder that also implements the UIResource marker interface.
static class
BorderUIResource.MatteBorderUIResource
A MatteBorder that also implements the UIResource marker interface.
static class
BorderUIResource.TitledBorderUIResource
A TitledBorder that also implements the UIResource marker interface.

Constructor Summary

BorderUIResource(Border delegate)
Constructs a BorderUIResource for wrapping a Border object.

Method Summary

static Border
getBlackLineBorderUIResource()
Returns a shared instance of BorderUIResource.LineBorderUIResource for a black, one-pixel width border.
Insets
getBorderInsets(Component c)
Measures the width of this border by calling the getBorderInsets method of the wrapped delegate.
static Border
getEtchedBorderUIResource()
Returns a shared instance of an etched border which also is marked as an UIResource.
static Border
getLoweredBevelBorderUIResource()
Returns a shared instance of BorderUIResource.BevelBorderUIResource whose bevelType is BevelBorder.LOWERED.
static Border
getRaisedBevelBorderUIResource()
Returns a shared instance of BorderUIResource.BevelBorderUIResource whose bevelType is BevelBorder.RAISED.
boolean
isBorderOpaque()
Determines whether this border fills every pixel in its area when painting by calling the isBorderOpaque method of the wrapped delegate.
void
paintBorder(Component c, Graphics g, int x, int y, int width, int height)
Paints the border around an enclosed component by calling the paintBorder method of the wrapped delegate.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BorderUIResource

public BorderUIResource(Border delegate)
Constructs a BorderUIResource for wrapping a Border object.
Parameters:
delegate - the border to be wrapped.

Method Details

getBlackLineBorderUIResource

public static Border getBlackLineBorderUIResource()
Returns a shared instance of BorderUIResource.LineBorderUIResource for a black, one-pixel width border.
See Also:
LineBorder

getBorderInsets

public Insets getBorderInsets(Component c)
Measures the width of this border by calling the getBorderInsets method of the wrapped delegate.
Specified by:
getBorderInsets in interface Border
Parameters:
c - the component whose border is to be measured.
Returns:
an Insets object whose left, right, top and bottom fields indicate the width of the border at the respective edge.

getEtchedBorderUIResource

public static Border getEtchedBorderUIResource()
Returns a shared instance of an etched border which also is marked as an UIResource.
See Also:
EtchedBorder

getLoweredBevelBorderUIResource

public static Border getLoweredBevelBorderUIResource()
Returns a shared instance of BorderUIResource.BevelBorderUIResource whose bevelType is BevelBorder.LOWERED.
See Also:
BevelBorder

getRaisedBevelBorderUIResource

public static Border getRaisedBevelBorderUIResource()
Returns a shared instance of BorderUIResource.BevelBorderUIResource whose bevelType is BevelBorder.RAISED.
See Also:
BevelBorder

isBorderOpaque

public boolean isBorderOpaque()
Determines whether this border fills every pixel in its area when painting by calling the isBorderOpaque method of the wrapped delegate.
Specified by:
isBorderOpaque in interface Border
Returns:
true if the border is fully opaque, or false if some pixels of the background can shine through the border.

paintBorder

public void paintBorder(Component c,
                        Graphics g,
                        int x,
                        int y,
                        int width,
                        int height)
Paints the border around an enclosed component by calling the paintBorder method of the wrapped delegate.
Specified by:
paintBorder in interface Border
Parameters:
c - the component whose border is to be painted.
g - the graphics for painting.
x - the horizontal position for painting the border.
y - the vertical position for painting the border.
width - the width of the available area for painting the border.
height - the height of the available area for painting the border.

BorderUIResource.java Copyright (C) 2002, 2003, 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath 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 for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.