This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 

javax.swing.border
class EtchedBorder

java.lang.Object extended by javax.swing.border.AbstractBorder extended by javax.swing.border.EtchedBorder
All Implemented Interfaces:
Serializable, Border
Direct Known Subclasses:
BorderUIResource.EtchedBorderUIResource
Most common way to construct:

EtchedBorder etchedBorder1 = new EtchedBorder();

Based on 10 examples 

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 JavaBeansTM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}.

Field Summary
protected int etchType
          
protected Color highlight
          
static int LOWERED
          Lowered etched type.
static int RAISED
          Raised etched type.
protected Color shadow
          
 
Constructor Summary
EtchedBorder()

          Creates a lowered etched border whose colors will be derived from the background color of the component passed into the paintBorder method.
EtchedBorder(Color highlight, Color shadow)

          Creates a lowered etched border with the specified highlight and shadow colors.
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.
 
Method Summary
 Insets
getBorderInsets(Component c)

          Returns the insets of the border.
 Insets
getBorderInsets(Component c, Insets insets)

          Reinitialize the insets parameter with this Border's current Insets.
 int
getEtchType()

          Returns which etch-type is set on the etched border.
 Color
getHighlightColor()

          Returns the highlight color of the etched border.
 Color
getHighlightColor(Component c)

          Returns the highlight color of the etched border when rendered on the specified component.
 Color
getShadowColor()

          Returns the shadow color of the etched border.
 Color
getShadowColor(Component c)

          Returns the shadow color of the etched border when rendered on the specified component.
 boolean
isBorderOpaque()

          Returns whether or not the border is opaque.
 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.
 
Methods inherited from class javax.swing.border.AbstractBorder
getBaseline, getBaselineResizeBehavior, getBorderInsets, getBorderInsets, getInteriorRectangle, getInteriorRectangle, isBorderOpaque, paintBorder
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

etchType

protected int etchType

highlight

protected Color highlight

LOWERED

public static final int LOWERED
Lowered etched type.

RAISED

public static final int RAISED
Raised etched type.

shadow

protected Color shadow
Constructor Detail

EtchedBorder

public EtchedBorder()
Creates a lowered etched border whose colors will be derived from the background color of the component passed into the paintBorder method.

EtchedBorder

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

EtchedBorder

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

EtchedBorder

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

getBorderInsets

public Insets getBorderInsets(Component c)
Returns the insets of the border.

Overrides:
getBorderInsets in class AbstractBorder
Parameters:
c - the component for which this border insets value applies

getBorderInsets

public Insets getBorderInsets(Component c,
                              Insets insets)
Reinitialize the insets parameter with this Border's current Insets.

Overrides:
getBorderInsets in class AbstractBorder
Parameters:
c - the component for which this border insets value applies
insets - the object to be reinitialized

getEtchType

public int getEtchType()
Returns which etch-type is set on the etched border.

getHighlightColor

public Color getHighlightColor()
Returns the highlight color of the etched border. Will return null if no highlight color was specified at instantiation.

getHighlightColor

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

getShadowColor

public Color getShadowColor()
Returns the shadow color of the etched border. Will return null if no shadow color was specified at instantiation.

getShadowColor

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

isBorderOpaque

public boolean isBorderOpaque()
Returns whether or not the border is opaque.

Overrides:
isBorderOpaque in class AbstractBorder

paintBorder

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.

Overrides:
paintBorder in 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
Overview  Package   Class 
 PREV CLASS   NEXT CLASS FRAMES   NO FRAMES 
SUMMARY: NESTED | FIELD | CONSTR | METHOD  DETAIL: FIELD | CONSTR | METHOD 
This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.