javax.swing.border

Class SoftBevelBorder

Implemented Interfaces:
Border, Serializable

public class SoftBevelBorder
extends BevelBorder

A rectangular, three pixel thick border that looks like a BevelBorder with slightly softened corners.

Like BevelBorder, SoftBevelBorder has a highlight and a shadow color. In the raised variant, the highlight color is used for the top and left edges, and the shadow color is used for the bottom and right edge. In the lowered variant, color usage is reversed. For an image, see the documentation of the individual constructors.

See Also:
Serialized Form

Field Summary

Fields inherited from class javax.swing.border.BevelBorder

LOWERED, RAISED, bevelType, highlightInner, highlightOuter, shadowInner, shadowOuter

Constructor Summary

SoftBevelBorder(int bevelType)
Constructs a SoftBevelBorder whose colors will be derived from the background of the enclosed component.
SoftBevelBorder(int bevelType, Color highlight, Color shadow)
Constructs a SoftBevelBorder given its appearance type and two colors for its highlight and shadow.
SoftBevelBorder(int bevelType, Color highlightOuter, Color highlightInner, Color shadowOuter, Color shadowInner)
Constructs a SoftBevelBorder given its appearance type and all colors.

Method Summary

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)
Paints the border for a given component.

Methods inherited from class javax.swing.border.BevelBorder

getBevelType, getBorderInsets, getBorderInsets, getHighlightInnerColor, getHighlightInnerColor, getHighlightOuterColor, getHighlightOuterColor, getShadowInnerColor, getShadowInnerColor, getShadowOuterColor, getShadowOuterColor, isBorderOpaque, paintBorder, paintLoweredBevel, paintRaisedBevel

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

Constructor Details

SoftBevelBorder

public SoftBevelBorder(int bevelType)
Constructs a SoftBevelBorder whose colors will be derived from the background of the enclosed component. The background color is retrieved each time the border is painted, so a SoftBevelBorder constructed by this method will automatically reflect a change to the component’s background color.

[An illustration showing raised and lowered SoftBevelBorders]

Parameters:
bevelType - the desired appearance of the border. The value must be either BevelBorder.RAISED or BevelBorder.LOWERED.
Throws:
IllegalArgumentException - if bevelType has an unsupported value.

SoftBevelBorder

public SoftBevelBorder(int bevelType,
                       Color highlight,
                       Color shadow)
Constructs a SoftBevelBorder given its appearance type and two colors for its highlight and shadow.

[An illustration showing SoftBevelBorders that were
 constructed with this method]

Parameters:
bevelType - the desired appearance of the border. The value must be either BevelBorder.RAISED or BevelBorder.LOWERED.
highlight - the color that will be used for the inner side of the highlighted edges (top and left if if bevelType is BevelBorder.RAISED; bottom and right otherwise). The color for the outer side is a brightened version of this color.
shadow - the color that will be used for the outer side of the shadowed edges (bottom and right if bevelType is BevelBorder.RAISED; top and left otherwise). The color for the inner side is a brightened version of this color.
Throws:
IllegalArgumentException - if bevelType has an unsupported value.
NullPointerException - if highlight or shadow is null.

SoftBevelBorder

public SoftBevelBorder(int bevelType,
                       Color highlightOuter,
                       Color highlightInner,
                       Color shadowOuter,
                       Color shadowInner)
Constructs a SoftBevelBorder given its appearance type and all colors.

[An illustration showing SoftBevelBorders that were
 constructed with this method]

Parameters:
bevelType - the desired appearance of the border. The value must be either BevelBorder.RAISED or BevelBorder.LOWERED.
highlightOuter - the color that will be used for the outer side of the highlighted edges (top and left if bevelType is BevelBorder.RAISED; bottom and right otherwise).
highlightInner - the color that will be used for the inner side of the highlighted edges.
shadowOuter - the color that will be used for the outer side of the shadowed edges (bottom and right if bevelType is BevelBorder.RAISED; top and left otherwise).
shadowInner - the color that will be used for the inner side of the shadowed edges.
Throws:
IllegalArgumentException - if bevelType has an unsupported value.
NullPointerException - if one of the passed colors is null.

Method Details

getBorderInsets

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

The enlarged view (see documentation for constructors) shows that a SoftBevelBorder does not paint all pixels. Therefore, this method always returns false.

Specified by:
isBorderOpaque in interface Border
Overrides:
isBorderOpaque in interface BevelBorder
Returns:
false.

paintBorder

public void paintBorder(Component c,
                        Graphics g,
                        int x,
                        int y,
                        int width,
                        int height)
Paints the border for a given component.
Specified by:
paintBorder in interface Border
Overrides:
paintBorder in interface BevelBorder
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.

SoftBevelBorder.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.