/*
* Copyright (c) 1997, 1999, Oracle and/or its affiliates. All rights reserved.
* ORACLE PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
package javax.swing.border;
import java.awt.Graphics;
import java.awt.Insets;
import java.awt.Rectangle;
import java.awt.Component;
/**
* Interface describing an object capable of rendering a border
* around the edges of a swing component.
* For examples of using borders see
* <a href="http://java.sun.com/docs/books/tutorial/uiswing/misc/border.html">How to Use Borders</a>,
* a section in <em>The Java Tutorial.</em>
* <p>
* In the Swing component set, borders supercede Insets as the
* mechanism for creating a (decorated or plain) area around the
* edge of a component.
* <p>
* Usage Notes:
* <ul>
* <li>Use EmptyBorder to create a plain border (this mechanism
* replaces its predecessor, <code>setInsets</code>).
* <li>Use CompoundBorder to nest multiple border objects, creating
* a single, combined border.
* <li>Border instances are designed to be shared. Rather than creating
* a new border object using one of border classes, use the
* BorderFactory methods, which produces a shared instance of the
* common border types.
* <li>Additional border styles include BevelBorder, SoftBevelBorder,
* EtchedBorder, LineBorder, TitledBorder, and MatteBorder.
* <li>To create a new border class, subclass AbstractBorder.
* </ul>
*
* @author David Kloba
* @author Amy Fowler
* @see javax.swing.BorderFactory
* @see EmptyBorder
* @see CompoundBorder
*/
public interface Border
{
/**
* Paints the border for the specified component with the specified
* position and size.
* @param c the component for which this border is being painted
* @param g the paint graphics
* @param x the x position of the painted border
* @param y the y position of the painted border
* @param width the width of the painted border
* @param height the height of the painted border
*/
void paintBorder(Component c, Graphics g, int x, int y, int width, int height);
/**
* Returns the insets of the border.
* @param c the component for which this border insets value applies
*/
Insets getBorderInsets(Component c);
/**
* Returns whether or not the border is opaque. If the border
* is opaque, it is responsible for filling in it's own
* background when painting.
*/
boolean isBorderOpaque();
}