/* * @(#)AbstractBorder.java 1.33 03/12/19 * * Copyright 2004 Sun Microsystems, Inc. All rights reserved. * SUN 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; import java.io.Serializable; /** * A class that implements an empty border with no size. * This provides a convenient base class from which other border * classes can be easily derived. *
* 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 JavaBeansTM
* has been added to the java.beans
package.
* Please see {@link java.beans.XMLEncoder}.
*
* @version 1.33 12/19/03
* @author David Kloba
*/
public abstract class AbstractBorder implements Border, Serializable
{
/**
* This default implementation does no painting.
* @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
*/
public void paintBorder(Component c, Graphics g, int x, int y, int width, int height) {
}
/**
* This default implementation returns a new Insets
* instance where the top
, left
,
* bottom
, and
* right
fields are set to 0
.
* @param c the component for which this border insets value applies
* @return the new Insets
object initialized to 0
*/
public Insets getBorderInsets(Component c) {
return new Insets(0, 0, 0, 0);
}
/**
* Reinitializes the insets parameter with this Border's current Insets.
* @param c the component for which this border insets value applies
* @param insets the object to be reinitialized
* @return the insets
object
*/
public Insets getBorderInsets(Component c, Insets insets) {
insets.left = insets.top = insets.right = insets.bottom = 0;
return insets;
}
/**
* This default implementation returns false.
* @return false
*/
public boolean isBorderOpaque() { return false; }
/**
* This convenience method calls the static method.
* @param c the component for which this border is being computed
* @param x the x position of the border
* @param y the y position of the border
* @param width the width of the border
* @param height the height of the border
* @return a Rectangle
containing the interior coordinates
*/
public Rectangle getInteriorRectangle(Component c, int x, int y, int width, int height) {
return getInteriorRectangle(c, this, x, y, width, height);
}
/**
* Returns a rectangle using the arguments minus the
* insets of the border. This is useful for determining the area
* that components should draw in that will not intersect the border.
* @param c the component for which this border is being computed
* @param b the Border
object
* @param x the x position of the border
* @param y the y position of the border
* @param width the width of the border
* @param height the height of the border
* @return a Rectangle
containing the interior coordinates
*/
public static Rectangle getInteriorRectangle(Component c, Border b, int x, int y, int width, int height) {
Insets insets;
if(b != null)
insets = b.getBorderInsets(c);
else
insets = new Insets(0, 0, 0, 0);
return new Rectangle(x + insets.left,
y + insets.top,
width - insets.right - insets.left,
height - insets.top - insets.bottom);
}
/*
* Convenience function for determining ComponentOrientation.
* Helps us avoid having Munge directives throughout the code.
*/
static boolean isLeftToRight( Component c ) {
return c.getComponentOrientation().isLeftToRight();
}
}