Class CompoundBorder

java.lang.Object

javax.swing.border.AbstractBorder

javax.swing.border.CompoundBorder

All Implemented Interfaces:

Serializable, Border

Direct Known Subclasses:

BorderUIResource.CompoundBorderUIResource

public class CompoundBorder
extends AbstractBorder

A composite Border class used to compose two Border objects into a single border by nesting an inside Border object within the insets of an outside Border object. For example, this class may be used to add blank margin space to a component with an existing decorative border:

   Border border = comp.getBorder();
   Border margin = new EmptyBorder(10,10,10,10);
   comp.setBorder(new CompoundBorder(border, margin));

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 JavaBeans has been added to the java.beans package. Please see XMLEncoder.

Field Summary

Fields

Modifier and Type	Field	Description
protected Border	insideBorder	The inside border.
protected Border	outsideBorder	The outside border.

Constructor Summary

Constructors

Constructor	Description
CompoundBorder()	Creates a compound border with null outside and inside borders.
CompoundBorder(Border outsideBorder, Border insideBorder)	Creates a compound border with the specified outside and inside borders.

Method Summary

Modifier and Type	Method	Description
Insets	getBorderInsets(Component c, Insets insets)	Reinitialize the insets parameter with this Border's current Insets.
Border	getInsideBorder()	Returns the inside border object.
Border	getOutsideBorder()	Returns the outside border object.
boolean	isBorderOpaque()	Returns whether or not the compound border is opaque.
void	paintBorder(Component c, Graphics g, int x, int y, int width, int height)	Paints the compound border by painting the outside border with the specified position and size and then painting the inside border at the specified position and size offset by the insets of the outside border.

Methods declared in class AbstractBorder

getBaseline, getBaselineResizeBehavior, getBorderInsets, getInteriorRectangle, getInteriorRectangle

Modifier and Type	Method	Description
int	getBaseline(Component c, int width, int height)	Returns the baseline.
Component.BaselineResizeBehavior	getBaselineResizeBehavior(Component c)	Returns an enum indicating how the baseline of a component changes as the size changes.
Insets	getBorderInsets(Component c)	This default implementation returns a new Insets object that is initialized by the AbstractBorder.getBorderInsets(Component,Insets) method.
Rectangle	getInteriorRectangle(Component c, int x, int y, int width, int height)	This convenience method calls the static method.
static Rectangle	getInteriorRectangle(Component c, Border b, int x, int y, int width, int height)	Returns a rectangle using the arguments minus the insets of the border.

Methods declared in class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Modifier and Type	Method	Description
protected Object	clone()	Creates and returns a copy of this object.
boolean	equals(Object obj)	Indicates whether some other object is "equal to" this one.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
final Class<?>	getClass()	Returns the runtime class of this Object.
int	hashCode()	Returns a hash code value for this object.
final void	notify()	Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll()	Wakes up all threads that are waiting on this object's monitor.
String	toString()	Returns a string representation of the object.
final void	wait()	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
final void	wait(long timeoutMillis)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
final void	wait(long timeoutMillis, int nanos)	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Field Details

outsideBorder

protected Border outsideBorder

The outside border.

insideBorder

protected Border insideBorder

The inside border.

Constructor Details

CompoundBorder

public CompoundBorder()

Creates a compound border with null outside and inside borders.

CompoundBorder

@ConstructorProperties({"outsideBorder","insideBorder"})
public CompoundBorder(Border outsideBorder,
 Border insideBorder)

Creates a compound border with the specified outside and inside borders. Either border may be null.

Parameters:

outsideBorder - the outside border

insideBorder - the inside border to be nested

Method Details

isBorderOpaque

public boolean isBorderOpaque()

Returns whether or not the compound border is opaque.

Specified by:

isBorderOpaque in interface Border

Overrides:

isBorderOpaque in class AbstractBorder

Returns:

true if the inside and outside borders are each either null or opaque; or false otherwise

paintBorder

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

Paints the compound border by painting the outside border with the specified position and size and then painting the inside border at the specified position and size offset by the insets of the outside border.

Specified by:

paintBorder in interface Border

Overrides:

paintBorder in class AbstractBorder

Parameters:

c - the component for which this border is being painted

g - the paint graphics

x - the x position of the painted border

y - the y position of the painted border

width - the width of the painted border

height - the height of the painted border

getBorderInsets

public Insets getBorderInsets(Component c,
 Insets insets)

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

Overrides:

getBorderInsets in class AbstractBorder

Parameters:

c - the component for which this border insets value applies

insets - the object to be reinitialized

Returns:

the insets object

Throws:

NullPointerException - if the specified insets is null

getOutsideBorder

public Border getOutsideBorder()

Returns the outside border object.

Returns:

the outside Border object

getInsideBorder

public Border getInsideBorder()

Returns the inside border object.

Returns:

the inside Border object