001/* Border.java --
002   Copyright (C) 2003 Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package javax.swing.border;
040
041import java.awt.Component;
042import java.awt.Graphics;
043import java.awt.Insets;
044
045
046/**
047 * An public interface for decorative or spacing borders around a Component.
048 *
049 * <p>To reduce memory consumption, several Components may share a
050 * single Border instance. {@link javax.swing.BorderFactory} is a
051 * factory class for producing commonly used shared borders.
052 *
053 * @see javax.swing.BorderFactory
054 * @see EmptyBorder
055 * @see CompoundBorder
056 * @see BevelBorder
057 * @see EtchedBorder
058 * @see LineBorder
059 * @see MatteBorder
060 * @see SoftBevelBorder
061 * @see TitledBorder
062 * @see AbstractBorder
063 *
064 * @author Ronald Veldema (rveldema@cs.vu.nl)
065 * @author Michael Koch (konqueror@gmx.de)
066 * @author Sascha Brawer (brawer@dandelis.ch)
067 */
068public interface Border
069{
070  /**
071   * Paints the border for a given component.
072   *
073   * @param c the component whose border is to be painted.
074   * @param g the graphics for painting.
075   * @param x the horizontal position for painting the border.
076   * @param y the vertical position for painting the border.
077   * @param width the width of the available area for painting the border.
078   * @param height the height of the available area for painting the border.
079   */
080  void paintBorder(Component c, Graphics g, int x, int y, int width,
081                   int height);
082
083  /**
084   * Measures the width of this border.
085   *
086   * @param c the component whose border is to be measured.
087   *
088   * @return an Insets object whose <code>left</code>, <code>right</code>,
089   *         <code>top</code> and <code>bottom</code> fields indicate the
090   *         width of the border at the respective edge.
091   */
092  Insets getBorderInsets(Component c);
093
094  /**
095   * Determines whether this border fills every pixel in its area
096   * when painting.
097   *
098   * @return <code>true</code> if the border is fully opaque, or
099   *         <code>false</code> if some pixels of the background
100   *         can shine through the border.
101   */
102  boolean isBorderOpaque();
103}