javax.swing.plaf.basic

Class BasicBorders.FieldBorder

java.lang.Object

javax.swing.border.AbstractBorder

javax.swing.plaf.basic.BasicBorders.FieldBorder

All Implemented Interfaces:

java.io.Serializable, javax.swing.border.Border, javax.swing.plaf.UIResource

Enclosing class:

BasicBorders

public static class BasicBorders.FieldBorder
extends javax.swing.border.AbstractBorder
implements javax.swing.plaf.UIResource

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

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

Fields

Modifier and Type	Field and Description
protected java.awt.Color	darkShadow The color for drawing the inner half of the top and left edges.
protected java.awt.Color	highlight The color for drawing the inner half of the bottom and right edges.
protected java.awt.Color	lightHighlight The color for drawing the outer half of the bottom and right edges.
protected java.awt.Color	shadow The color for drawing the outer half of the top and left edges.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.awt.Insets	getBorderInsets(java.awt.Component c) Measures the width of this border.
java.awt.Insets	getBorderInsets(java.awt.Component c, java.awt.Insets insets) Measures the width of this border, storing the results into a pre-existing Insets object.
void	paintBorder(java.awt.Component c, java.awt.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 java.awt.Color shadow

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

darkShadow

protected java.awt.Color darkShadow

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

highlight

protected java.awt.Color highlight

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

lightHighlight

protected java.awt.Color lightHighlight

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

Constructor Detail

BasicBorders.FieldBorder

public BasicBorders.FieldBorder(java.awt.Color shadow,
                        java.awt.Color darkShadow,
                        java.awt.Color highlight,
                        java.awt.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(java.awt.Component c,
               java.awt.Graphics g,
               int x,
               int y,
               int width,
               int height)

Paints the FieldBorder around a given component.

Specified by:

paintBorder in interface javax.swing.border.Border

Overrides:

paintBorder in class javax.swing.border.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 java.awt.Insets getBorderInsets(java.awt.Component c)

Measures the width of this border.

Specified by:

getBorderInsets in interface javax.swing.border.Border

Overrides:

getBorderInsets in class javax.swing.border.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 java.awt.Insets getBorderInsets(java.awt.Component c,
                              java.awt.Insets insets)

Measures the width of this border, storing the results into a pre-existing Insets object.

Overrides:

getBorderInsets in class javax.swing.border.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)