Source for javax.swing.border.Border

   1: /* Border.java --
   2:    Copyright (C) 2003 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.swing.border;
  40: 
  41: import java.awt.Component;
  42: import java.awt.Graphics;
  43: import java.awt.Insets;
  44: 
  45: 
  46: /**
  47:  * An public interface for decorative or spacing borders around a Component.
  48:  *
  49:  * <p>To reduce memory consumption, several Components may share a
  50:  * single Border instance. {@link javax.swing.BorderFactory} is a
  51:  * factory class for producing commonly used shared borders.
  52:  *
  53:  * @see javax.swing.BorderFactory
  54:  * @see EmptyBorder
  55:  * @see CompoundBorder
  56:  * @see BevelBorder
  57:  * @see EtchedBorder
  58:  * @see LineBorder
  59:  * @see MatteBorder
  60:  * @see SoftBevelBorder
  61:  * @see TitledBorder
  62:  * @see AbstractBorder
  63:  *
  64:  * @author Ronald Veldema (rveldema@cs.vu.nl)
  65:  * @author Michael Koch (konqueror@gmx.de)
  66:  * @author Sascha Brawer (brawer@dandelis.ch)
  67:  */
  68: public interface Border
  69: {
  70:   /**
  71:    * Paints the border for a given component.
  72:    *
  73:    * @param c the component whose border is to be painted.
  74:    * @param g the graphics for painting.
  75:    * @param x the horizontal position for painting the border.
  76:    * @param y the vertical position for painting the border.
  77:    * @param width the width of the available area for painting the border.
  78:    * @param height the height of the available area for painting the border.
  79:    */
  80:   void paintBorder(Component c, Graphics g, int x, int y, int width,
  81:                    int height);
  82: 
  83:   /**
  84:    * Measures the width of this border.
  85:    *
  86:    * @param c the component whose border is to be measured.
  87:    *
  88:    * @return an Insets object whose <code>left</code>, <code>right</code>,
  89:    *         <code>top</code> and <code>bottom</code> fields indicate the
  90:    *         width of the border at the respective edge.
  91:    */
  92:   Insets getBorderInsets(Component c);
  93: 
  94:   /**
  95:    * Determines whether this border fills every pixel in its area
  96:    * when painting.
  97:    *
  98:    * @return <code>true</code> if the border is fully opaque, or
  99:    *         <code>false</code> if some pixels of the background
 100:    *         can shine through the border.
 101:    */
 102:   boolean isBorderOpaque();
 103: }