javax.swing.border

Class EmptyBorder

Implemented Interfaces:
Border, Serializable
Known Direct Subclasses:
BorderUIResource.EmptyBorderUIResource, MatteBorder

public class EmptyBorder
extends AbstractBorder

A border for leaving a specifiable number of pixels empty around the enclosed component. An EmptyBorder requires some space on each edge, but does not perform any drawing.

[An illustration of EmptyBorder]

See Also:
Serialized Form

Field Summary

protected int
bottom
The number of pixels required at the bottom edge.
protected int
left
The number of pixels required at the left edge.
protected int
right
The number of pixels required at the right edge.
protected int
top
The number of pixels required at the top edge.

Constructor Summary

EmptyBorder(int top, int left, int bottom, int right)
Constructs an empty border given the number of pixels required on each side.
EmptyBorder(Insets borderInsets)
Constructs an empty border given the number of pixels required on each side, passed in an Insets object.

Method Summary

Insets
getBorderInsets()
Measures the width of this border.
Insets
getBorderInsets(Component c)
Measures the width of this border.
Insets
getBorderInsets(Component c, Insets insets)
Measures the width of this border, storing the results into a pre-existing Insets object.
boolean
isBorderOpaque()
Determines whether this border fills every pixel in its area when painting.
void
paintBorder(Component c, Graphics g, int x, int y, int width, int height)
Performs nothing because an EmptyBorder does not paint any pixels.

Methods inherited from class javax.swing.border.AbstractBorder

getBorderInsets, getBorderInsets, getInteriorRectangle, getInteriorRectangle, isBorderOpaque, paintBorder

Methods inherited from class java.lang.Object

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

Field Details

bottom

protected int bottom
The number of pixels required at the bottom edge.

left

protected int left
The number of pixels required at the left edge.

right

protected int right
The number of pixels required at the right edge.

top

protected int top
The number of pixels required at the top edge.

Constructor Details

EmptyBorder

public EmptyBorder(int top,
                   int left,
                   int bottom,
                   int right)
Constructs an empty border given the number of pixels required on each side.
Parameters:
top - the number of pixels that the border will need for its top edge.
left - the number of pixels that the border will need for its left edge.
bottom - the number of pixels that the border will need for its bottom edge.
right - the number of pixels that the border will need for its right edge.

EmptyBorder

public EmptyBorder(Insets borderInsets)
Constructs an empty border given the number of pixels required on each side, passed in an Insets object.
Parameters:
borderInsets - the Insets for the new border.

Method Details

getBorderInsets

public Insets getBorderInsets()
Measures the width of this border.
Returns:
an Insets object whose left, right, top and bottom fields indicate the width of the border at the respective edge.

getBorderInsets

public Insets getBorderInsets(Component c)
Measures the width of this border.
Specified by:
getBorderInsets in interface Border
Overrides:
getBorderInsets in interface AbstractBorder
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.

getBorderInsets

public Insets getBorderInsets(Component c,
                              Insets insets)
Measures the width of this border, storing the results into a pre-existing Insets object.
Overrides:
getBorderInsets in interface AbstractBorder
Parameters:
insets - an Insets object for holding the result values. After invoking this method, the left, right, top and bottom fields indicate the width of the border at the respective edge.
Returns:
the same object that was passed for insets.

isBorderOpaque

public boolean isBorderOpaque()
Determines whether this border fills every pixel in its area when painting. Since an empty border does not paint any pixels whatsoever, the result is false.
Specified by:
isBorderOpaque in interface Border
Overrides:
isBorderOpaque in interface AbstractBorder
Returns:
false.

paintBorder

public void paintBorder(Component c,
                        Graphics g,
                        int x,
                        int y,
                        int width,
                        int height)
Performs nothing because an EmptyBorder does not paint any pixels. While the inherited implementation provided by AbstractBorder.paintBorder(Component,Graphics,int,int,int,int) is a no-op as well, it is overwritten in order to match the API of the Sun reference implementation.
Specified by:
paintBorder in interface Border
Overrides:
paintBorder in interface AbstractBorder
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.

EmptyBorder.java -- Copyright (C) 2003 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.