| java.lang.Object | ||
| ↳ | javax.swing.border.AbstractBorder | |
| ↳ | javax.swing.border.EtchedBorder | |
 Known Direct Subclasses
|
Class Overview
A class which implements a simple etched border which can either be etched-in or etched-out. If no highlight/shadow colors are initialized when the border is created, then these colors will be dynamically derived from the background color of the component argument passed into the paintBorder() method.
Warning:
Serialized objects of this class will not be compatible with
future Swing releases. The current serialization support is
appropriate for short term storage or RMI between applications running
the same version of Swing. As of 1.4, support for long term storage
of all JavaBeansTM
has been added to the java.beans package.
Please see XMLEncoder.
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | LOWERED | Lowered etched type. | |||||||||
| int | RAISED | Raised etched type. | |||||||||
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| etchType | |||||||||||
| highlight | |||||||||||
| shadow | |||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Creates a lowered etched border whose colors will be derived
from the background color of the component passed into
the paintBorder method.
| |||||||||||
Creates an etched border with the specified etch-type
whose colors will be derived
from the background color of the component passed into
the paintBorder method.
| |||||||||||
Creates a lowered etched border with the specified highlight and
shadow colors.
| |||||||||||
Creates an etched border with the specified etch-type,
highlight and shadow colors.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Reinitialize the insets parameter with this Border's current Insets.
| |||||||||||
Returns the insets of the border.
| |||||||||||
Returns which etch-type is set on the etched border.
| |||||||||||
Returns the highlight color of the etched border
when rendered on the specified component.
| |||||||||||
Returns the highlight color of the etched border.
| |||||||||||
Returns the shadow color of the etched border.
| |||||||||||
Returns the shadow color of the etched border
when rendered on the specified component.
| |||||||||||
Returns whether or not the border is opaque.
| |||||||||||
Paints the border for the specified component with the
specified position and size.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
javax.swing.border.AbstractBorder
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
|
From interface
javax.swing.border.Border
| |||||||||||
Constants
public static final int LOWERED
Lowered etched type.
public static final int RAISED
Raised etched type.
Fields
protected int etchType
Public Constructors
public EtchedBorder ()
Creates a lowered etched border whose colors will be derived from the background color of the component passed into the paintBorder method.
public EtchedBorder (int etchType)
Creates an etched border with the specified etch-type whose colors will be derived from the background color of the component passed into the paintBorder method.
Parameters
| etchType | the type of etch to be drawn by the border |
|---|
public EtchedBorder (Color highlight, Color shadow)
Creates a lowered etched border with the specified highlight and shadow colors.
Parameters
| highlight | the color to use for the etched highlight |
|---|---|
| shadow | the color to use for the etched shadow |
public EtchedBorder (int etchType, Color highlight, Color shadow)
Creates an etched border with the specified etch-type, highlight and shadow colors.
Parameters
| etchType | the type of etch to be drawn by the border |
|---|---|
| highlight | the color to use for the etched highlight |
| shadow | the color to use for the etched shadow |
Public Methods
public Insets getBorderInsets (Component c, Insets insets)
Reinitialize the insets parameter with this Border's current Insets.
Parameters
| c | the component for which this border insets value applies |
|---|---|
| insets | the object to be reinitialized |
Returns
- the
insetsobject
public Insets getBorderInsets (Component c)
Returns the insets of the border.
Parameters
| c | the component for which this border insets value applies |
|---|
Returns
- the new
Insetsobject initialized to 0
public int getEtchType ()
Returns which etch-type is set on the etched border.
public Color getHighlightColor (Component c)
Returns the highlight color of the etched border when rendered on the specified component. If no highlight color was specified at instantiation, the highlight color is derived from the specified component's background color.
Parameters
| c | the component for which the highlight may be derived |
|---|
public Color getHighlightColor ()
Returns the highlight color of the etched border. Will return null if no highlight color was specified at instantiation.
public Color getShadowColor ()
Returns the shadow color of the etched border. Will return null if no shadow color was specified at instantiation.
public Color getShadowColor (Component c)
Returns the shadow color of the etched border when rendered on the specified component. If no shadow color was specified at instantiation, the shadow color is derived from the specified component's background color.
Parameters
| c | the component for which the shadow may be derived |
|---|
public boolean isBorderOpaque ()
Returns whether or not the border is opaque.
Returns
- false
public void paintBorder (Component c, Graphics g, int x, int y, int width, int height)
Paints the border for the specified component with the specified position and size.
Parameters
| c | the component for which this border is being painted |
|---|---|
| g | the paint graphics |
| x | the x position of the painted border |
| y | the y position of the painted border |
| width | the width of the painted border |
| height | the height of the painted border |