javax.swing.plaf.basic
Class BasicBorders.FieldBorder

java.lang.Object
  extended by javax.swing.border.AbstractBorder
      extended by javax.swing.plaf.basic.BasicBorders.FieldBorder
All Implemented Interfaces:
Serializable, Border, UIResource
Enclosing class:
BasicBorders

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(java.awt.Graphics, int, int, int, int, java.awt.Color, java.awt.Color, java.awt.Color, java.awt.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
BasicBorders.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
getInteriorRectangle, getInteriorRectangle, isBorderOpaque
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

shadow

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


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.

Constructor Detail

BasicBorders.FieldBorder

public BasicBorders.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 Detail

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 class 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.
See Also:
BasicGraphicsUtils.drawEtchedRect(java.awt.Graphics, int, int, int, int, java.awt.Color, java.awt.Color, java.awt.Color, java.awt.Color)

getBorderInsets

public Insets getBorderInsets(Component c)
Measures the width of this border.

Specified by:
getBorderInsets in interface Border
Overrides:
getBorderInsets in class 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.
See Also:
getBorderInsets(java.awt.Component, java.awt.Insets)

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 class 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.
See Also:
getBorderInsets(Component)