|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjavax.swing.border.AbstractBorder
javax.swing.border.EtchedBorder
public class EtchedBorder
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.
| Field Summary | |
|---|---|
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 | |
|---|---|
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 | |
|---|---|
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 |
|---|
public static final int RAISED
public static final int LOWERED
protected int etchType
RAISED
or LOWERED.
protected Color highlight
null to indicate that the
color shall be derived from the background of the enclosed
component.
protected Color shadow
null to indicate that the
color shall be derived from the background of the enclosed
component.
| Constructor Detail |
|---|
public EtchedBorder()
public EtchedBorder(int etchType)
etchType - the desired appearance of the border. The value
must be either RAISED or LOWERED.
IllegalArgumentException - if etchType has
an unsupported value.
public EtchedBorder(Color highlight,
Color shadow)
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.EtchedBorder(int, Color, Color)
public EtchedBorder(int etchType,
Color highlight,
Color shadow)
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.
IllegalArgumentException - if etchType has
an unsupported value.| Method Detail |
|---|
public void paintBorder(Component c,
Graphics g,
int x,
int y,
int width,
int height)
paintBorder in interface BorderpaintBorder in class AbstractBorderc - 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.public Insets getBorderInsets(Component c)
getBorderInsets in interface BordergetBorderInsets in class AbstractBorderc - the component whose border is to be measured.
left, right,
top and bottom fields indicate the
width of the border at the respective edge.getBorderInsets(java.awt.Component, java.awt.Insets)
public Insets getBorderInsets(Component c,
Insets insets)
getBorderInsets in class AbstractBorderinsets - 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).
insets.getBorderInsets(Component)public boolean isBorderOpaque()
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.
isBorderOpaque in interface BorderisBorderOpaque in class AbstractBordertrue if the border is fully opaque, or
false if some pixels of the background
can shine through the border.public int getEtchType()
RAISED or LOWERED.
RAISED or LOWERED).public Color getHighlightColor(Component c)
c - the component enclosed by this border.
Component.getBackground(),
Color.brighter()public Color getHighlightColor()
null if that color will be
derived from the background of the enclosed Component.
null).public Color getShadowColor(Component c)
c - the component enclosed by this border.
Component.getBackground(),
Color.darker()public Color getShadowColor()
null if that color will be
derived from the background of the enclosed Component.
null).
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||