javax.swing.border: public class: EtchedBorder

javax.swing.border
public class: EtchedBorder [javadoc | source]

java.lang.Object
   javax.swing.border.AbstractBorder
      javax.swing.border.EtchedBorder

All Implemented Interfaces:
Border, Serializable

Direct Known Subclasses:
EtchedBorderUIResource

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^TM has been added to the java.beans package. Please see java.beans.XMLEncoder .

author: David - Kloba

author: Amy - Fowler

Field Summary
public static final int	RAISED	Raised etched type.
public static final int	LOWERED	Lowered etched type.
protected int	etchType
protected Color	highlight
protected Color	shadow

Constructor:

Constructor:
public EtchedBorder() { this(LOWERED); } 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) { this(etchType, null, null); } 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) { this(LOWERED, highlight, 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) { this.etchType = etchType; this.highlight = highlight; this.shadow = 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 EtchedBorder() {
                               
        this(LOWERED);
}

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) {
        this(etchType, null, null);
}

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) {
        this(LOWERED, highlight, 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) {
        this.etchType = etchType;
        this.highlight = highlight;
        this.shadow = 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 from javax.swing.border.EtchedBorder Summary:
getBorderInsets, getEtchType, getHighlightColor, getHighlightColor, getShadowColor, getShadowColor, isBorderOpaque, paintBorder

Methods from javax.swing.border.AbstractBorder:
getBaseline, getBaselineResizeBehavior, getBorderInsets, getBorderInsets, getInteriorRectangle, getInteriorRectangle, isBorderOpaque, isLeftToRight, paintBorder

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.swing.border.EtchedBorder Detail:
public Insets getBorderInsets(Component c, Insets insets) { insets.set(2, 2, 2, 2); return insets; } Reinitialize the insets parameter with this Border's current Insets.
public int getEtchType() { return etchType; } Returns which etch-type is set on the etched border.
public Color getHighlightColor() { return highlight; } Returns the highlight color of the etched border. Will return null if no highlight color was specified at instantiation.
public Color getHighlightColor(Component c) { return highlight != null? highlight : c.getBackground().brighter(); } 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.
public Color getShadowColor() { return shadow; } Returns the shadow color of the etched border. Will return null if no shadow color was specified at instantiation.
public Color getShadowColor(Component c) { return shadow != null? shadow : c.getBackground().darker(); } 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.
public boolean isBorderOpaque() { return true; } Returns whether or not the border is opaque.
public void paintBorder(Component c, Graphics g, int x, int y, int width, int height) { int w = width; int h = height; g.translate(x, y); g.setColor(etchType == LOWERED? getShadowColor(c) : getHighlightColor(c)); g.drawRect(0, 0, w-2, h-2); g.setColor(etchType == LOWERED? getHighlightColor(c) : getShadowColor(c)); g.drawLine(1, h-3, 1, 1); g.drawLine(1, 1, w-3, 1); g.drawLine(0, h-1, w-1, h-1); g.drawLine(w-1, h-1, w-1, 0); g.translate(-x, -y); } Paints the border for the specified component with the specified position and size.

Method from javax.swing.border.EtchedBorder Detail:

 public Insets getBorderInsets(Component c,
    Insets insets) {
        insets.set(2, 2, 2, 2);
        return insets;
}

Reinitialize the insets parameter with this Border's current Insets.

 public int getEtchType() {
        return etchType;
}

Returns which etch-type is set on the etched border.

 public Color getHighlightColor() {
        return highlight;
}

Returns the highlight color of the etched border. Will return null if no highlight color was specified at instantiation.

 public Color getHighlightColor(Component c) {
        return highlight != null? highlight :
                                       c.getBackground().brighter();
}

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.

 public Color getShadowColor() {
        return shadow;
}

Returns the shadow color of the etched border. Will return null if no shadow color was specified at instantiation.

 public Color getShadowColor(Component c) {
        return shadow != null? shadow : c.getBackground().darker();
}

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.

 public boolean isBorderOpaque() {
 return true;
}

Returns whether or not the border is opaque.

 public  void paintBorder(Component c,
    Graphics g,
    int x,
    int y,
    int width,
    int height) {
        int w = width;
        int h = height;
        g.translate(x, y);
        g.setColor(etchType == LOWERED? getShadowColor(c) : getHighlightColor(c));
        g.drawRect(0, 0, w-2, h-2);
        g.setColor(etchType == LOWERED? getHighlightColor(c) : getShadowColor(c));
        g.drawLine(1, h-3, 1, 1);
        g.drawLine(1, 1, w-3, 1);
        g.drawLine(0, h-1, w-1, h-1);
        g.drawLine(w-1, h-1, w-1, 0);
        g.translate(-x, -y);
}

Paints the border for the specified component with the specified position and size.