javax.swing.border
Class EtchedBorder

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.swing.border.AbstractBorder sample code for javax.swing.border.AbstractBorder definition code for javax.swing.border.AbstractBorder 
      extended by javax.swing.border.EtchedBorder
All Implemented Interfaces:
Serializable sample code for java.io.Serializable definition code for java.io.Serializable , Border sample code for javax.swing.border.Border definition code for javax.swing.border.Border
Direct Known Subclasses:
BorderUIResource.EtchedBorderUIResource sample code for javax.swing.plaf.BorderUIResource.EtchedBorderUIResource definition code for javax.swing.plaf.BorderUIResource.EtchedBorderUIResource

public class EtchedBorder
extends AbstractBorder sample code for javax.swing.border.AbstractBorder definition code for javax.swing.border.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 XMLEncoder sample code for java.beans.XMLEncoder definition code for java.beans.XMLEncoder .

See Also:
Serialized Form

Field Summary
protected  int etchType sample code for javax.swing.border.EtchedBorder.etchType definition code for javax.swing.border.EtchedBorder.etchType
           
protected  Color sample code for java.awt.Color definition code for java.awt.Color highlight sample code for javax.swing.border.EtchedBorder.highlight definition code for javax.swing.border.EtchedBorder.highlight
           
static int LOWERED sample code for javax.swing.border.EtchedBorder.LOWERED definition code for javax.swing.border.EtchedBorder.LOWERED
          Lowered etched type.
static int RAISED sample code for javax.swing.border.EtchedBorder.RAISED definition code for javax.swing.border.EtchedBorder.RAISED
          Raised etched type.
protected  Color sample code for java.awt.Color definition code for java.awt.Color shadow sample code for javax.swing.border.EtchedBorder.shadow definition code for javax.swing.border.EtchedBorder.shadow
           
 
Constructor Summary
EtchedBorder sample code for javax.swing.border.EtchedBorder.EtchedBorder() definition code for javax.swing.border.EtchedBorder.EtchedBorder() ()
          Creates a lowered etched border whose colors will be derived from the background color of the component passed into the paintBorder method.
EtchedBorder sample code for javax.swing.border.EtchedBorder.EtchedBorder(java.awt.Color, java.awt.Color) definition code for javax.swing.border.EtchedBorder.EtchedBorder(java.awt.Color, java.awt.Color) (Color sample code for java.awt.Color definition code for java.awt.Color  highlight, Color sample code for java.awt.Color definition code for java.awt.Color  shadow)
          Creates a lowered etched border with the specified highlight and shadow colors.
EtchedBorder sample code for javax.swing.border.EtchedBorder.EtchedBorder(int) definition code for javax.swing.border.EtchedBorder.EtchedBorder(int) (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 sample code for javax.swing.border.EtchedBorder.EtchedBorder(int, java.awt.Color, java.awt.Color) definition code for javax.swing.border.EtchedBorder.EtchedBorder(int, java.awt.Color, java.awt.Color) (int etchType, Color sample code for java.awt.Color definition code for java.awt.Color  highlight, Color sample code for java.awt.Color definition code for java.awt.Color  shadow)
          Creates an etched border with the specified etch-type, highlight and shadow colors.
 
Method Summary
 Insets sample code for java.awt.Insets definition code for java.awt.Insets getBorderInsets sample code for javax.swing.border.EtchedBorder.getBorderInsets(java.awt.Component) definition code for javax.swing.border.EtchedBorder.getBorderInsets(java.awt.Component) (Component sample code for java.awt.Component definition code for java.awt.Component  c)
          Returns the insets of the border.
 Insets sample code for java.awt.Insets definition code for java.awt.Insets getBorderInsets sample code for javax.swing.border.EtchedBorder.getBorderInsets(java.awt.Component, java.awt.Insets) definition code for javax.swing.border.EtchedBorder.getBorderInsets(java.awt.Component, java.awt.Insets) (Component sample code for java.awt.Component definition code for java.awt.Component  c, Insets sample code for java.awt.Insets definition code for java.awt.Insets  insets)
          Reinitialize the insets parameter with this Border's current Insets.
 int getEtchType sample code for javax.swing.border.EtchedBorder.getEtchType() definition code for javax.swing.border.EtchedBorder.getEtchType() ()
          Returns which etch-type is set on the etched border.
 Color sample code for java.awt.Color definition code for java.awt.Color getHighlightColor sample code for javax.swing.border.EtchedBorder.getHighlightColor() definition code for javax.swing.border.EtchedBorder.getHighlightColor() ()
          Returns the highlight color of the etched border.
 Color sample code for java.awt.Color definition code for java.awt.Color getHighlightColor sample code for javax.swing.border.EtchedBorder.getHighlightColor(java.awt.Component) definition code for javax.swing.border.EtchedBorder.getHighlightColor(java.awt.Component) (Component sample code for java.awt.Component definition code for java.awt.Component  c)
          Returns the highlight color of the etched border when rendered on the specified component.
 Color sample code for java.awt.Color definition code for java.awt.Color getShadowColor sample code for javax.swing.border.EtchedBorder.getShadowColor() definition code for javax.swing.border.EtchedBorder.getShadowColor() ()
          Returns the shadow color of the etched border.
 Color sample code for java.awt.Color definition code for java.awt.Color getShadowColor sample code for javax.swing.border.EtchedBorder.getShadowColor(java.awt.Component) definition code for javax.swing.border.EtchedBorder.getShadowColor(java.awt.Component) (Component sample code for java.awt.Component definition code for java.awt.Component  c)
          Returns the shadow color of the etched border when rendered on the specified component.
 boolean isBorderOpaque sample code for javax.swing.border.EtchedBorder.isBorderOpaque() definition code for javax.swing.border.EtchedBorder.isBorderOpaque() ()
          Returns whether or not the border is opaque.
 void paintBorder sample code for javax.swing.border.EtchedBorder.paintBorder(java.awt.Component, java.awt.Graphics, int, int, int, int) definition code for javax.swing.border.EtchedBorder.paintBorder(java.awt.Component, java.awt.Graphics, int, int, int, int) (Component sample code for java.awt.Component definition code for java.awt.Component  c, Graphics sample code for java.awt.Graphics definition code for java.awt.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 sample code for javax.swing.border.AbstractBorder definition code for javax.swing.border.AbstractBorder
getInteriorRectangle sample code for javax.swing.border.AbstractBorder.getInteriorRectangle(java.awt.Component, javax.swing.border.Border, int, int, int, int) definition code for javax.swing.border.AbstractBorder.getInteriorRectangle(java.awt.Component, javax.swing.border.Border, int, int, int, int) , getInteriorRectangle sample code for javax.swing.border.AbstractBorder.getInteriorRectangle(java.awt.Component, int, int, int, int) definition code for javax.swing.border.AbstractBorder.getInteriorRectangle(java.awt.Component, int, int, int, int)
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

RAISED sample code for javax.swing.border.EtchedBorder.RAISED

public static final int RAISED
Raised etched type.

See Also:
Constant Field Values

LOWERED sample code for javax.swing.border.EtchedBorder.LOWERED

public static final int LOWERED
Lowered etched type.

See Also:
Constant Field Values

etchType sample code for javax.swing.border.EtchedBorder.etchType

protected int etchType

highlight sample code for javax.swing.border.EtchedBorder.highlight

protected Color sample code for java.awt.Color definition code for java.awt.Color  highlight

shadow sample code for javax.swing.border.EtchedBorder.shadow

protected Color sample code for java.awt.Color definition code for java.awt.Color  shadow
Constructor Detail

EtchedBorder sample code for javax.swing.border.EtchedBorder() definition code for javax.swing.border.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 sample code for javax.swing.border.EtchedBorder(int) definition code for javax.swing.border.EtchedBorder(int)

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 sample code for javax.swing.border.EtchedBorder(java.awt.Color, java.awt.Color) definition code for javax.swing.border.EtchedBorder(java.awt.Color, java.awt.Color)

public EtchedBorder(Color sample code for java.awt.Color definition code for java.awt.Color  highlight,
                    Color sample code for java.awt.Color definition code for java.awt.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 sample code for javax.swing.border.EtchedBorder(int, java.awt.Color, java.awt.Color) definition code for javax.swing.border.EtchedBorder(int, java.awt.Color, java.awt.Color)

public EtchedBorder(int etchType,
                    Color sample code for java.awt.Color definition code for java.awt.Color  highlight,
                    Color sample code for java.awt.Color definition code for java.awt.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

paintBorder sample code for javax.swing.border.EtchedBorder.paintBorder(java.awt.Component, java.awt.Graphics, int, int, int, int) definition code for javax.swing.border.EtchedBorder.paintBorder(java.awt.Component, java.awt.Graphics, int, int, int, int)

public void paintBorder(Component sample code for java.awt.Component definition code for java.awt.Component  c,
                        Graphics sample code for java.awt.Graphics definition code for java.awt.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:
paintBorder sample code for javax.swing.border.Border.paintBorder(java.awt.Component, java.awt.Graphics, int, int, int, int) definition code for javax.swing.border.Border.paintBorder(java.awt.Component, java.awt.Graphics, int, int, int, int) in interface Border sample code for javax.swing.border.Border definition code for javax.swing.border.Border
Overrides:
paintBorder sample code for javax.swing.border.AbstractBorder.paintBorder(java.awt.Component, java.awt.Graphics, int, int, int, int) definition code for javax.swing.border.AbstractBorder.paintBorder(java.awt.Component, java.awt.Graphics, int, int, int, int) in class AbstractBorder sample code for javax.swing.border.AbstractBorder definition code for javax.swing.border.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

getBorderInsets sample code for javax.swing.border.EtchedBorder.getBorderInsets(java.awt.Component) definition code for javax.swing.border.EtchedBorder.getBorderInsets(java.awt.Component)

public Insets sample code for java.awt.Insets definition code for java.awt.Insets  getBorderInsets(Component sample code for java.awt.Component definition code for java.awt.Component  c)
Returns the insets of the border.

Specified by:
getBorderInsets sample code for javax.swing.border.Border.getBorderInsets(java.awt.Component) definition code for javax.swing.border.Border.getBorderInsets(java.awt.Component) in interface Border sample code for javax.swing.border.Border definition code for javax.swing.border.Border
Overrides:
getBorderInsets sample code for javax.swing.border.AbstractBorder.getBorderInsets(java.awt.Component) definition code for javax.swing.border.AbstractBorder.getBorderInsets(java.awt.Component) in class AbstractBorder sample code for javax.swing.border.AbstractBorder definition code for javax.swing.border.AbstractBorder
Parameters:
c - the component for which this border insets value applies
Returns:
the new Insets object initialized to 0

getBorderInsets sample code for javax.swing.border.EtchedBorder.getBorderInsets(java.awt.Component, java.awt.Insets) definition code for javax.swing.border.EtchedBorder.getBorderInsets(java.awt.Component, java.awt.Insets)

public Insets sample code for java.awt.Insets definition code for java.awt.Insets  getBorderInsets(Component sample code for java.awt.Component definition code for java.awt.Component  c,
                              Insets sample code for java.awt.Insets definition code for java.awt.Insets  insets)
Reinitialize the insets parameter with this Border's current Insets.

Overrides:
getBorderInsets sample code for javax.swing.border.AbstractBorder.getBorderInsets(java.awt.Component, java.awt.Insets) definition code for javax.swing.border.AbstractBorder.getBorderInsets(java.awt.Component, java.awt.Insets) in class AbstractBorder sample code for javax.swing.border.AbstractBorder definition code for javax.swing.border.AbstractBorder
Parameters:
c - the component for which this border insets value applies
insets - the object to be reinitialized
Returns:
the insets object

isBorderOpaque sample code for javax.swing.border.EtchedBorder.isBorderOpaque() definition code for javax.swing.border.EtchedBorder.isBorderOpaque()

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

Specified by:
isBorderOpaque sample code for javax.swing.border.Border.isBorderOpaque() definition code for javax.swing.border.Border.isBorderOpaque() in interface Border sample code for javax.swing.border.Border definition code for javax.swing.border.Border
Overrides:
isBorderOpaque sample code for javax.swing.border.AbstractBorder.isBorderOpaque() definition code for javax.swing.border.AbstractBorder.isBorderOpaque() in class AbstractBorder sample code for javax.swing.border.AbstractBorder definition code for javax.swing.border.AbstractBorder
Returns:
false

getEtchType sample code for javax.swing.border.EtchedBorder.getEtchType() definition code for javax.swing.border.EtchedBorder.getEtchType()

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


getHighlightColor sample code for javax.swing.border.EtchedBorder.getHighlightColor(java.awt.Component) definition code for javax.swing.border.EtchedBorder.getHighlightColor(java.awt.Component)

public Color sample code for java.awt.Color definition code for java.awt.Color  getHighlightColor(Component sample code for java.awt.Component definition code for java.awt.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

getHighlightColor sample code for javax.swing.border.EtchedBorder.getHighlightColor() definition code for javax.swing.border.EtchedBorder.getHighlightColor()

public Color sample code for java.awt.Color definition code for java.awt.Color  getHighlightColor()
Returns the highlight color of the etched border. Will return null if no highlight color was specified at instantiation.


getShadowColor sample code for javax.swing.border.EtchedBorder.getShadowColor(java.awt.Component) definition code for javax.swing.border.EtchedBorder.getShadowColor(java.awt.Component)

public Color sample code for java.awt.Color definition code for java.awt.Color  getShadowColor(Component sample code for java.awt.Component definition code for java.awt.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

getShadowColor sample code for javax.swing.border.EtchedBorder.getShadowColor() definition code for javax.swing.border.EtchedBorder.getShadowColor()

public Color sample code for java.awt.Color definition code for java.awt.Color  getShadowColor()
Returns the shadow color of the etched border. Will return null if no shadow color was specified at instantiation.