javax.swing.border

Class BevelBorder

public class BevelBorder extends AbstractBorder

A rectangular, two pixel thick border that causes the enclosed area to appear as if it was raising out of or lowered into the screen. Some LookAndFeels use this kind of border for rectangular buttons.

A BevelBorder 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. For an image, see the documentation of the individual constructors.

Field Summary
protected int	bevelType The type of this BevelBorder, which is either {@link #RAISED} or {@link #LOWERED}.
protected Color	highlightInner The inner highlight color, or `null` to indicate that the color shall be derived from the background of the component whose border is being painted.
protected Color	highlightOuter The outer highlight color, or `null` to indicate that the color shall be derived from the background of the component whose border is being painted.
static int	LOWERED Indicates that the BevelBorder looks like if the enclosed area was pressed into the screen.
static int	RAISED Indicates that the BevelBorder looks like if the enclosed area was raising out of the screen.
protected Color	shadowInner The inner shadow color, or `null` to indicate that the color shall be derived from the background of the component whose border is being painted.
protected Color	shadowOuter The outer shadow color, or `null` to indicate that the color shall be derived from the background of the component whose border is being painted.

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

Method Summary
int	getBevelType() Returns the appearance of this border, which is either {@link #RAISED} or {@link #LOWERED}.
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.
Color	getHighlightInnerColor(Component c) Determines the color that will be used for the inner side of highlighted edges when painting the border.
Color	getHighlightInnerColor() Returns the color that will be used for the inner side of highlighted edges when painting the border, or `null` if that color will be derived from the background of the enclosed Component.
Color	getHighlightOuterColor(Component c) Determines the color that will be used for the outer side of highlighted edges when painting the border.
Color	getHighlightOuterColor() Returns the color that will be used for the outer side of highlighted edges when painting the border, or `null` if that color will be derived from the background of the enclosed Component.
Color	getShadowInnerColor(Component c) Determines the color that will be used for the inner side of shadowed edges when painting the border.
Color	getShadowInnerColor() Returns the color that will be used for the inner side of shadowed edges when painting the border, or `null` if that color will be derived from the background of the enclosed Component.
Color	getShadowOuterColor(Component c) Determines the color that will be used for the outer side of shadowed edges when painting the border.
Color	getShadowOuterColor() Returns the color that will be used for the outer side of shadowed edges when painting the border, or `null` if that color will be derived from the background of the enclosed 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.
protected void	paintLoweredBevel(Component c, Graphics g, int x, int y, int width, int height) Paints a lowered bevel border around a component.
protected void	paintRaisedBevel(Component c, Graphics g, int x, int y, int width, int height) Paints a raised bevel border around a component.

Field Detail

bevelType

protected int bevelType

The type of this BevelBorder, which is either {@link #RAISED} or {@link #LOWERED}.

highlightInner

protected Color highlightInner

The inner highlight color, or null to indicate that the color shall be derived from the background of the component whose border is being painted.

highlightOuter

protected Color highlightOuter

The outer highlight color, or null to indicate that the color shall be derived from the background of the component whose border is being painted.

LOWERED

public static final int LOWERED

Indicates that the BevelBorder looks like if the enclosed area was pressed into the screen.

RAISED

public static final int RAISED

Indicates that the BevelBorder looks like if the enclosed area was raising out of the screen.

shadowInner

protected Color shadowInner

The inner shadow color, or null to indicate that the color shall be derived from the background of the component whose border is being painted.

shadowOuter

protected Color shadowOuter

The outer shadow color, or null to indicate that the color shall be derived from the background of the component whose border is being painted.

Constructor Detail

BevelBorder

public BevelBorder(int bevelType)

Constructs a BevelBorder 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 BevelBorder constructed by this method will automatically reflect a change to the component’s background color.

[An illustration showing raised and lowered BevelBorders]

Parameters: bevelType the desired appearance of the border. The value must be either {@link #RAISED} or {@link #LOWERED}.

Throws: IllegalArgumentException if bevelType has an unsupported value.

BevelBorder

public BevelBorder(int bevelType, Color highlight, Color shadow)

Constructs a BevelBorder given its appearance type and two colors for its highlight and shadow.

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

Parameters: bevelType the desired appearance of the border. The value must be either {@link #RAISED} or {@link #LOWERED}. highlight the color that will be used for the inner side of the highlighted edges (top and left if if bevelType is {@link #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 {@link #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.

BevelBorder

public BevelBorder(int bevelType, Color highlightOuter, Color highlightInner, Color shadowOuter, Color shadowInner)

Constructs a BevelBorder given its appearance type and all colors.

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

Parameters: bevelType the desired appearance of the border. The value must be either {@link #RAISED} or {@link #LOWERED}. highlightOuter the color that will be used for the outer side of the highlighted edges (top and left if bevelType is {@link #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 {@link #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 Detail

getBevelType

public int getBevelType()

Returns the appearance of this border, which is either {@link #RAISED} or {@link #LOWERED}.

Returns: The bevel type ({@link #RAISED} or {@link #LOWERED}).

getBorderInsets

public Insets getBorderInsets(Component c)

Measures the width of this border.

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.

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.

getHighlightInnerColor

public Color getHighlightInnerColor(Component c)

Determines the color that will be used for the inner side of highlighted edges when painting the border. 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.

getHighlightInnerColor

public Color getHighlightInnerColor()

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

Returns: The color (possibly null).

getHighlightOuterColor

public Color getHighlightOuterColor(Component c)

Determines the color that will be used for the outer side of highlighted edges when painting the border. If a highlight color has been specified upon constructing the border, that color is returned. Otherwise, the inner highlight color is brightened.

Parameters: c the component enclosed by this border.

Returns: The color.

getHighlightOuterColor

public Color getHighlightOuterColor()

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

Returns: The color (possibly null).

getShadowInnerColor

public Color getShadowInnerColor(Component c)

Determines the color that will be used for the inner side of shadowed edges when painting the border. 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 color.

getShadowInnerColor

public Color getShadowInnerColor()

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

Returns: The color (possibly null).

getShadowOuterColor

public Color getShadowOuterColor(Component c)

Determines the color that will be used for the outer side of shadowed edges when painting the border. If a shadow color has been specified upon constructing the border, that color is returned. Otherwise, the inner shadow color is darkened.

Parameters: c the component enclosed by this border.

Returns: The color.

getShadowOuterColor

public Color getShadowOuterColor()

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

Returns: The color (possibly null).

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.

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

paintBorder

public void paintBorder(Component c, Graphics g, int x, int y, int width, int height)

Paints the border for a given component.

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.

paintLoweredBevel

protected void paintLoweredBevel(Component c, Graphics g, int x, int y, int width, int height)

Paints a lowered bevel border around a component.

paintRaisedBevel

protected void paintRaisedBevel(Component c, Graphics g, int x, int y, int width, int height)

Paints a raised bevel border around a component.