1. /*

  2.  * @(#)BevelBorder.java	1.14 00/02/02

  3.  *

  4.  * Copyright 1997-2000 Sun Microsystems, Inc. All Rights Reserved.

  5.  * 

  6.  * This software is the proprietary information of Sun Microsystems, Inc.  

  7.  * Use is subject to license terms.

  8.  * 

  9.  */

  10. package javax.swing.border;

  11. 

  12. import java.awt.Graphics;

  13. import java.awt.Insets;

  14. import java.awt.Rectangle;

  15. import java.awt.Color;

  16. import java.awt.Component;

  17. 

  18. 

  19. /**

  20.  * A class which implements a simple 2 line bevel border.

  21.  * <p>

  22.  * <strong>Warning:</strong>

  23.  * Serialized objects of this class will not be compatible with

  24.  * future Swing releases.  The current serialization support is appropriate

  25.  * for short term storage or RMI between applications running the same

  26.  * version of Swing.  A future release of Swing will provide support for

  27.  * long term persistence.

  28.  *

  29.  * @version 1.14 02/02/00

  30.  * @author David Kloba

  31.  */

  32. public class BevelBorder extends AbstractBorder

  33. {

  34.     /** Raised bevel type. */

  35.     public static final int RAISED  = 0;

  36.     /** Lowered bevel type. */

  37.     public static final int LOWERED = 1;

  38. 

  39.     protected int bevelType;

  40.     protected Color highlightOuter;

  41.     protected Color highlightInner;

  42.     protected Color shadowInner;

  43.     protected Color shadowOuter;

  44. 

  45.     /**

  46.      * Creates a bevel border with the specified type and whose

  47.      * colors will be derived from the background color of the

  48.      * component passed into the paintBorder method.

  49.      * @param bevelType the type of bevel for the border

  50.      */

  51.     public BevelBorder(int bevelType) {

  52.         this.bevelType = bevelType;

  53.     }

  54. 

  55.     /**

  56.      * Creates a bevel border with the specified type, highlight and

  57.      * shadow colors.

  58.      * @param bevelType the type of bevel for the border

  59.      * @param highlight the color to use for the bevel highlight

  60.      * @param shadow the color to use for the bevel shadow

  61.      */

  62.     public BevelBorder(int bevelType, Color highlight, Color shadow) {

  63.         this(bevelType, highlight.brighter(), highlight, shadow, shadow.brighter());

  64.     }

  65. 

  66.     /**

  67.      * Creates a bevel border with the specified type, highlight

  68.      * shadow colors.

  69.      * @param bevelType the type of bevel for the border

  70.      * @param highlightOuterColor the color to use for the bevel outer highlight

  71.      * @param highlightInnerColor the color to use for the bevel inner highlight

  72.      * @param shadowOuterColor the color to use for the bevel outer shadow

  73.      * @param shadowInnerColor the color to use for the bevel inner shadow

  74.      */

  75.     public BevelBorder(int bevelType, Color highlightOuterColor, 

  76.                        Color highlightInnerColor, Color shadowOuterColor, 

  77.                        Color shadowInnerColor) {

  78.         this(bevelType);

  79.         this.highlightOuter = highlightOuterColor;

  80.         this.highlightInner = highlightInnerColor;

  81.         this.shadowOuter = shadowOuterColor;

  82.         this.shadowInner = shadowInnerColor;

  83.     }

  84. 

  85.     /**

  86.      * Paints the border for the specified component with the specified

  87.      * position and size.

  88.      * @param c the component for which this border is being painted

  89.      * @param g the paint graphics

  90.      * @param x the x position of the painted border

  91.      * @param y the y position of the painted border

  92.      * @param width the width of the painted border

  93.      * @param height the height of the painted border

  94.      */

  95.     public void paintBorder(Component c, Graphics g, int x, int y, int width, int height) {

  96.         if (bevelType == RAISED) {

  97.              paintRaisedBevel(c, g, x, y, width, height);

  98. 

  99.         } else if (bevelType == LOWERED) {

  100.              paintLoweredBevel(c, g, x, y, width, height);

  101.         }

  102.     }

  103. 

  104.     /**

  105.      * Returns the insets of the border.

  106.      * @param c the component for which this border insets value applies

  107.      */

  108.     public Insets getBorderInsets(Component c)       {

  109. 	return new Insets(2, 2, 2, 2);

  110.     }

  111. 

  112.     /** 

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

  114.      * @param c the component for which this border insets value applies

  115.      * @param insets the object to be reinitialized

  116.      */

  117.     public Insets getBorderInsets(Component c, Insets insets) {

  118.         insets.left = insets.top = insets.right = insets.bottom = 2;

  119.         return insets;

  120.     }

  121. 

  122.     /**

  123.      * Returns the outer highlight color of the bevel border

  124.      * when rendered on the specified component.  If no highlight

  125.      * color was specified at instantiation, the highlight color

  126.      * is derived from the specified component's background color.

  127.      * @param c the component for which the highlight may be derived

  128.      */

  129.     public Color getHighlightOuterColor(Component c)   {

  130.         Color highlight = getHighlightOuterColor();

  131.         return highlight != null? highlight : 

  132.                                        c.getBackground().brighter().brighter();

  133.     }

  134. 

  135.     /**

  136.      * Returns the inner highlight color of the bevel border

  137.      * when rendered on the specified component.  If no highlight

  138.      * color was specified at instantiation, the highlight color

  139.      * is derived from the specified component's background color.

  140.      * @param c the component for which the highlight may be derived

  141.      */

  142.     public Color getHighlightInnerColor(Component c)   {

  143.         Color highlight = getHighlightInnerColor();

  144.         return highlight != null? highlight :

  145.                                        c.getBackground().brighter();

  146.     }

  147. 

  148.     /**

  149.      * Returns the inner shadow color of the bevel border

  150.      * when rendered on the specified component.  If no shadow

  151.      * color was specified at instantiation, the shadow color

  152.      * is derived from the specified component's background color.

  153.      * @param c the component for which the shadow may be derived

  154.      */

  155.     public Color getShadowInnerColor(Component c)      {

  156.         Color shadow = getShadowInnerColor();

  157.         return shadow != null? shadow :

  158.                                     c.getBackground().darker();

  159.     }

  160. 

  161.     /**

  162.      * Returns the outer shadow color of the bevel border

  163.      * when rendered on the specified component.  If no shadow

  164.      * color was specified at instantiation, the shadow color

  165.      * is derived from the specified component's background color.

  166.      * @param c the component for which the shadow may be derived

  167.      */

  168.     public Color getShadowOuterColor(Component c)      {

  169.         Color shadow = getShadowOuterColor();

  170.         return shadow != null? shadow :

  171.                                     c.getBackground().darker().darker();

  172.     }

  173. 

  174.     /**

  175.      * Returns the outer highlight color of the bevel border.

  176.      * Will return null if no highlight color was specified

  177.      * at instantiation.

  178.      */

  179.     public Color getHighlightOuterColor()   {

  180.         return highlightOuter;

  181.     }

  182. 

  183.     /**

  184.      * Returns the inner highlight color of the bevel border.

  185.      * Will return null if no highlight color was specified

  186.      * at instantiation.

  187.      */

  188.     public Color getHighlightInnerColor()   {

  189.         return highlightInner;

  190.     }

  191. 

  192.     /**

  193.      * Returns the inner shadow color of the bevel border.

  194.      * Will return null if no shadow color was specified

  195.      * at instantiation.

  196.      */

  197.     public Color getShadowInnerColor()      {

  198.         return shadowInner;

  199.     }

  200. 

  201.     /**

  202.      * Returns the outer shadow color of the bevel border.

  203.      * Will return null if no shadow color was specified

  204.      * at instantiation.

  205.      */

  206.     public Color getShadowOuterColor()      {

  207.         return shadowOuter;

  208.     }

  209. 

  210.     /**

  211.      * Returns the type of the bevel border.

  212.      */

  213.     public int getBevelType()       {

  214.         return bevelType;

  215.     }

  216. 

  217.     /**

  218.      * Returns whether or not the border is opaque.

  219.      */

  220.     public boolean isBorderOpaque() { return true; }

  221. 

  222.     protected void paintRaisedBevel(Component c, Graphics g, int x, int y,

  223.                                     int width, int height)  {

  224.         Color oldColor = g.getColor();

  225.         int h = height;

  226.         int w = width;

  227. 

  228.         g.translate(x, y);

  229. 

  230.         g.setColor(getHighlightOuterColor(c));

  231.         g.drawLine(0, 0, 0, h-1);

  232.         g.drawLine(1, 0, w-1, 0);

  233. 

  234.         g.setColor(getHighlightInnerColor(c));

  235.         g.drawLine(1, 1, 1, h-2);

  236.         g.drawLine(2, 1, w-2, 1);

  237. 

  238.         g.setColor(getShadowOuterColor(c));

  239.         g.drawLine(1, h-1, w-1, h-1);

  240.         g.drawLine(w-1, 1, w-1, h-2);

  241. 

  242.         g.setColor(getShadowInnerColor(c));

  243.         g.drawLine(2, h-2, w-2, h-2);

  244.         g.drawLine(w-2, 2, w-2, h-3);

  245. 

  246.         g.translate(-x, -y);

  247.         g.setColor(oldColor);

  248. 

  249.     }

  250. 

  251.     protected void paintLoweredBevel(Component c, Graphics g, int x, int y,

  252.                                         int width, int height)  {

  253.         Color oldColor = g.getColor();

  254.         int h = height;

  255.         int w = width;

  256. 

  257.         g.translate(x, y);

  258. 

  259.         g.setColor(getShadowInnerColor(c));

  260.         g.drawLine(0, 0, 0, h-1);

  261.         g.drawLine(1, 0, w-1, 0);

  262. 

  263.         g.setColor(getShadowOuterColor(c));

  264.         g.drawLine(1, 1, 1, h-2);

  265.         g.drawLine(2, 1, w-2, 1);

  266. 

  267.         g.setColor(getHighlightOuterColor(c));

  268.         g.drawLine(1, h-1, w-1, h-1);

  269.         g.drawLine(w-1, 1, w-1, h-2);

  270. 

  271.         g.setColor(getHighlightInnerColor(c));

  272.         g.drawLine(2, h-2, w-2, h-2);

  273.         g.drawLine(w-2, 2, w-2, h-3);

  274. 

  275.         g.translate(-x, -y);

  276.         g.setColor(oldColor);

  277. 

  278.     }

  279. 

  280. }