- 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 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 JavaBeans™ has been added to the java.beanspackage. Please seeXMLEncoder.- See Also:
- Serialized Form
 
- 
- 
Field SummaryFields Modifier and Type Field Description protected intetchTypeThe type of etch to be drawn by the border.protected ColorhighlightThe color to use for the etched highlight.static intLOWEREDLowered etched type.static intRAISEDRaised etched type.protected ColorshadowThe color to use for the etched shadow.
 - 
Constructor SummaryConstructors Constructor Description EtchedBorder()Creates a lowered etched border whose colors will be derived from the background color of the component passed into the paintBorder method.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.EtchedBorder(int etchType, Color highlight, Color shadow)Creates an etched border with the specified etch-type, highlight and shadow colors.EtchedBorder(Color highlight, Color shadow)Creates a lowered etched border with the specified highlight and shadow colors.
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description InsetsgetBorderInsets(Component c, Insets insets)Reinitialize the insets parameter with this Border's current Insets.intgetEtchType()Returns which etch-type is set on the etched border.ColorgetHighlightColor()Returns the highlight color of the etched border.ColorgetHighlightColor(Component c)Returns the highlight color of the etched border when rendered on the specified component.ColorgetShadowColor()Returns the shadow color of the etched border.ColorgetShadowColor(Component c)Returns the shadow color of the etched border when rendered on the specified component.booleanisBorderOpaque()Returns whether or not the border is opaque.voidpaintBorder(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.- 
Methods declared in class javax.swing.border.AbstractBordergetBaseline, getBaselineResizeBehavior, getBorderInsets, getInteriorRectangle, getInteriorRectangle
 
- 
 
- 
- 
- 
Field Detail- 
RAISEDpublic static final int RAISED Raised etched type.- See Also:
- Constant Field Values
 
 - 
LOWEREDpublic static final int LOWERED Lowered etched type.- See Also:
- Constant Field Values
 
 - 
etchTypeprotected int etchType The type of etch to be drawn by the border.
 - 
highlightprotected Color highlight The color to use for the etched highlight.
 - 
shadowprotected Color shadow The color to use for the etched shadow.
 
- 
 - 
Constructor Detail- 
EtchedBorderpublic EtchedBorder() Creates a lowered etched border whose colors will be derived from the background color of the component passed into the paintBorder method.
 - 
EtchedBorderpublic 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
 
 - 
EtchedBorderpublic 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
 
 - 
EtchedBorder@ConstructorProperties({"etchType","highlightColor","shadowColor"}) 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
 
 
- 
 - 
Method Detail- 
paintBorderpublic 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.- Specified by:
- paintBorderin interface- Border
- Overrides:
- paintBorderin class- AbstractBorder
- 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
 
 - 
getBorderInsetspublic Insets getBorderInsets(Component c, Insets insets) Reinitialize the insets parameter with this Border's current Insets.- Overrides:
- getBorderInsetsin class- AbstractBorder
- Parameters:
- c- the component for which this border insets value applies
- insets- the object to be reinitialized
- Returns:
- the insetsobject
 
 - 
isBorderOpaquepublic boolean isBorderOpaque() Returns whether or not the border is opaque. This implementation returns true.- Specified by:
- isBorderOpaquein interface- Border
- Overrides:
- isBorderOpaquein class- AbstractBorder
- Returns:
- true
 
 - 
getEtchTypepublic int getEtchType() Returns which etch-type is set on the etched border.- Returns:
- the etched border type, either RAISEDorLOWERED
 
 - 
getHighlightColorpublic 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
- Returns:
- the highlight Colorof thisEtchedBorder
- Since:
- 1.3
 
 - 
getHighlightColorpublic Color getHighlightColor() Returns the highlight color of the etched border. Will return null if no highlight color was specified at instantiation.- Returns:
- the highlight Colorof thisEtchedBorderor null if none was specified
- Since:
- 1.3
 
 - 
getShadowColorpublic 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
- Returns:
- the shadow Colorof thisEtchedBorder
- Since:
- 1.3
 
 - 
getShadowColorpublic Color getShadowColor() Returns the shadow color of the etched border. Will return null if no shadow color was specified at instantiation.- Returns:
- the shadow Colorof thisEtchedBorderor null if none was specified
- Since:
- 1.3
 
 
- 
 
-