W3cubDocs

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

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

Constructor Summary

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 javax.swing.border.AbstractBorder

getBaseline, getBaselineResizeBehavior, getBorderInsets, getInteriorRectangle, getInteriorRectangle

Methods declared in class java.lang.Object

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

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

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/border/CompoundBorder.html