This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.swing.border
class CompoundBorder

java.lang.Object extended by javax.swing.border.AbstractBorder extended by javax.swing.border.CompoundBorder
All Implemented Interfaces:
Serializable, Border
Direct Known Subclasses:
BorderUIResource.CompoundBorderUIResource

Most common way to construct:

EmptyBorder eb = …;
BevelBorder bb = …;

CompoundBorder cb = new CompoundBorder(eb, bb);

Based on 30 examples


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 JavaBeansTM has been added to the java.beans package. Please see {@link java.beans.XMLEncoder}.


Field Summary
protected Border insideBorder
          
protected Border outsideBorder
          
 
Constructor Summary

          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
 Insets

          Returns the insets of the composite border by adding the insets of the outside border to the insets of the inside border.
 Insets

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

          Returns the inside border object.
 Border

          Returns the outside border object.
 boolean

          Returns whether or not this 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 inherited from class javax.swing.border.AbstractBorder
getBaseline, getBaselineResizeBehavior, getBorderInsets, getBorderInsets, getInteriorRectangle, getInteriorRectangle, isBorderOpaque, paintBorder
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

insideBorder

protected Border insideBorder

outsideBorder

protected Border outsideBorder
Constructor Detail

CompoundBorder

public CompoundBorder()
Creates a compound border with null outside and inside borders.


CompoundBorder

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 Detail

getBorderInsets

public Insets getBorderInsets(Component c)
Returns the insets of the composite border by adding the insets of the outside border to the insets of the inside border.

Overrides:
getBorderInsets in class AbstractBorder
Parameters:
c - the component for which this border insets value applies

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

getInsideBorder

public Border getInsideBorder()
Returns the inside border object.


getOutsideBorder

public Border getOutsideBorder()
Returns the outside border object.


isBorderOpaque

public boolean isBorderOpaque()
Returns whether or not this compound border is opaque. Returns true if both the inside and outside borders are non-null and opaque; returns false otherwise.

Overrides:
isBorderOpaque in class AbstractBorder

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.

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


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.