javax.swing.plaf.basic

Class BasicBorders.FieldBorder

Enclosing Class:
BasicBorders
Implemented Interfaces:
Border, Serializable, UIResource

public static class BasicBorders.FieldBorder
extends AbstractBorder
implements UIResource

A border that makes its enclosed component appear as lowered into the surface. Typically used for text fields.

[A screen shot of this border]

See Also:
BasicGraphicsUtils.drawEtchedRect(Graphics,int,int,int,int,Color,Color,Color,Color), Serialized Form

Field Summary

protected Color
darkShadow
The color for drawing the inner half of the top and left edges.
protected Color
highlight
The color for drawing the inner half of the bottom and right edges.
protected Color
lightHighlight
The color for drawing the outer half of the bottom and right edges.
protected Color
shadow
The color for drawing the outer half of the top and left edges.

Constructor Summary

FieldBorder(Color shadow, Color darkShadow, Color highlight, Color lightHighlight)
Constructs a new border for drawing a text field in the Basic look and feel.

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.
void
paintBorder(Component c, Graphics g, int x, int y, int width, int height)
Paints the FieldBorder around a given component.

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

darkShadow

protected Color darkShadow
The color for drawing the inner half of the top and left edges.

highlight

protected Color highlight
The color for drawing the inner half of the bottom and right edges.

lightHighlight

protected Color lightHighlight
The color for drawing the outer half of the bottom and right edges.

shadow

protected Color shadow
The color for drawing the outer half of the top and left edges.

Constructor Details

FieldBorder

public FieldBorder(Color shadow,
                   Color darkShadow,
                   Color highlight,
                   Color lightHighlight)
Constructs a new border for drawing a text field in the Basic look and feel.
Parameters:
shadow - the color for drawing the outer half of the top and left edges.
darkShadow - the color for drawing the inner half of the top and left edges.
highlight - the color for drawing the inner half of the bottom and right edges.
lightHighlight - the color for drawing the outer half of the bottom and right edges.

Method Details

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. If c is an instance of JTextComponent, its margin is added to the border size.
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:
c - the component whose border is to be measured. If c is an instance of JTextComponent, its margin is added to the border size.
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.

paintBorder

public void paintBorder(Component c,
                        Graphics g,
                        int x,
                        int y,
                        int width,
                        int height)
Paints the FieldBorder around a given component.
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.

BasicBorders.java -- Copyright (C) 2003, 2004, 2005 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.