javax.swing.border

Class EtchedBorder

java.lang.Object

javax.swing.border.AbstractBorder

javax.swing.border.EtchedBorder

All Implemented Interfaces:

Serializable, Border

Direct Known Subclasses:

BorderUIResource.EtchedBorderUIResource

public class EtchedBorder
extends AbstractBorder

A border that looks like an engraving etched into the background surface, or (in its raised variant) coming out of the surface plane. Using different constructors, it is possible to either explicitly specify the border colors, or to let the colors derive from the background color of the enclosed Component.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	etchType The type of this EtchedBorder, which is either RAISED or LOWERED.
protected Color	highlight The highlight color, or null to indicate that the color shall be derived from the background of the enclosed component.
static int	LOWERED Indicates that the border appears as engraved into the background.
static int	RAISED Indicates that the border appears as coming out of the background.
protected Color	shadow The shadow color, or null to indicate that the color shall be derived from the background of the enclosed component.

Constructor Summary

Constructors

Constructor and Description
EtchedBorder() Constructs a lowered EtchedBorder.
EtchedBorder(Color highlight, Color shadow) Constructs a lowered EtchedBorder, explicitly selecting the colors that will be used for highlight and shadow.
EtchedBorder(int etchType) Constructs an EtchedBorder with the specified appearance.
EtchedBorder(int etchType, Color highlight, Color shadow) Constructs an EtchedBorder with the specified appearance, explicitly selecting the colors that will be used for highlight and shadow.

Method Summary

Methods

Modifier and Type	Method and Description
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.
int	getEtchType() Returns the appearance of this EtchedBorder, which is either RAISED or LOWERED.
Color	getHighlightColor() Returns the color that will be used for highlighted parts when painting the border, or null if that color will be derived from the background of the enclosed Component.
Color	getHighlightColor(Component c) Determines the color that will be used for highlighted parts when painting the border around a given component.
Color	getShadowColor() Returns the color that will be used for shadowed parts when painting the border, or null if that color will be derived from the background of the enclosed Component.
Color	getShadowColor(Component c) Determines the color that will be used for shadowed parts when painting the border around a given component.
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.AbstractBorder

getInteriorRectangle, getInteriorRectangle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RAISED

public static final int RAISED

Indicates that the border appears as coming out of the background.

See Also:

Constant Field Values

LOWERED

public static final int LOWERED

Indicates that the border appears as engraved into the background.

See Also:

Constant Field Values

etchType

protected int etchType

The type of this EtchedBorder, which is either RAISED or LOWERED.

highlight

protected Color highlight

The highlight color, or null to indicate that the color shall be derived from the background of the enclosed component.

shadow

protected Color shadow

The shadow color, or null to indicate that the color shall be derived from the background of the enclosed component.

Constructor Detail

EtchedBorder

public EtchedBorder()

Constructs a lowered EtchedBorder. The colors will be derived from the background color of the enclosed Component when the border gets painted.

EtchedBorder

public EtchedBorder(int etchType)

Constructs an EtchedBorder with the specified appearance. The colors will be derived from the background color of the enclosed Component when the border gets painted.

Parameters:

etchType - the desired appearance of the border. The value must be either RAISED or LOWERED.

Throws:

IllegalArgumentException - if etchType has an unsupported value.

EtchedBorder

public EtchedBorder(Color highlight,
            Color shadow)

Constructs a lowered EtchedBorder, explicitly selecting the colors that will be used for highlight and shadow.

Parameters:

highlight - the color that will be used for painting the highlight part of the border.

shadow - the color that will be used for painting the shadow part of the border.

See Also:

EtchedBorder(int, Color, Color)

EtchedBorder

public EtchedBorder(int etchType,
            Color highlight,
            Color shadow)

Constructs an EtchedBorder with the specified appearance, explicitly selecting the colors that will be used for highlight and shadow.

Parameters:

etchType - the desired appearance of the border. The value must be either RAISED or LOWERED.

highlight - the color that will be used for painting the highlight part of the border.

shadow - the color that will be used for painting the shadow part of the border.

Throws:

IllegalArgumentException - if etchType has an unsupported value.

Method Detail

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

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.

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:

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.

c - the component that the border applies to (ignored here, subclasses may use it).

Returns:

the same object that was passed for insets.

See Also:

getBorderInsets(Component)

isBorderOpaque

public boolean isBorderOpaque()

Determines whether this border fills every pixel in its area when painting.

If the border colors are derived from the background color of the enclosed component, the result is true because the derivation method always returns opaque colors. Otherwise, the result depends on the opacity of the individual colors.

Specified by:

isBorderOpaque in interface Border

Overrides:

isBorderOpaque in class AbstractBorder

Returns:

true if the border is fully opaque, or false if some pixels of the background can shine through the border.

getEtchType

public int getEtchType()

Returns the appearance of this EtchedBorder, which is either RAISED or LOWERED.

Returns:

The type (RAISED or LOWERED).

getHighlightColor

public Color getHighlightColor(Component c)

Determines the color that will be used for highlighted parts when painting the border around a given component. If a highlight color has been specified upon constructing the border, that color is returned. Otherwise, the background color of the enclosed component is brightened.

Parameters:

c - the component enclosed by this border.

Returns:

The color.

See Also:

Component.getBackground(), Color.brighter()

getHighlightColor

public Color getHighlightColor()

Returns the color that will be used for highlighted parts when painting the border, or null if that color will be derived from the background of the enclosed Component.

Returns:

The highlight color (possibly null).

getShadowColor

public Color getShadowColor(Component c)

Determines the color that will be used for shadowed parts when painting the border around a given component. If a shadow color has been specified upon constructing the border, that color is returned. Otherwise, the background color of the enclosed component is darkened.

Parameters:

c - the component enclosed by this border.

Returns:

The shadow color.

See Also:

Component.getBackground(), Color.darker()

getShadowColor

public Color getShadowColor()

Returns the color that will be used for shadowed parts when painting the border, or null if that color will be derived from the background of the enclosed Component.

Returns:

The shadow color (possibly null).