javax.swing.border: public class: CompoundBorder

javax.swing.border
public class: CompoundBorder [javadoc | source]

java.lang.Object
   javax.swing.border.AbstractBorder
      javax.swing.border.CompoundBorder

All Implemented Interfaces:
Border, Serializable

Direct Known Subclasses:
CompoundBorderUIResource

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

author: David - Kloba

Field Summary
protected Border	outsideBorder
protected Border	insideBorder

Constructor:

Constructor:
public CompoundBorder() { this.outsideBorder = null; this.insideBorder = null; } Creates a compound border with null outside and inside borders.
public CompoundBorder(Border outsideBorder, Border insideBorder) { this.outsideBorder = outsideBorder; this.insideBorder = 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

 public CompoundBorder() {
        this.outsideBorder = null;
        this.insideBorder = null;
}

Creates a compound border with null outside and inside borders.

 public CompoundBorder(Border outsideBorder,
    Border insideBorder) {
        this.outsideBorder = outsideBorder;
        this.insideBorder = 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 from javax.swing.border.CompoundBorder Summary:
getBorderInsets, getInsideBorder, getOutsideBorder, isBorderOpaque, paintBorder

Methods from javax.swing.border.AbstractBorder:
getBaseline, getBaselineResizeBehavior, getBorderInsets, getBorderInsets, getInteriorRectangle, getInteriorRectangle, isBorderOpaque, isLeftToRight, paintBorder

Methods from java.lang.Object:
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from javax.swing.border.CompoundBorder Detail:
public Insets getBorderInsets(Component c, Insets insets) { Insets nextInsets; insets.top = insets.left = insets.right = insets.bottom = 0; if(outsideBorder != null) { nextInsets = outsideBorder.getBorderInsets(c); insets.top += nextInsets.top; insets.left += nextInsets.left; insets.right += nextInsets.right; insets.bottom += nextInsets.bottom; } if(insideBorder != null) { nextInsets = insideBorder.getBorderInsets(c); insets.top += nextInsets.top; insets.left += nextInsets.left; insets.right += nextInsets.right; insets.bottom += nextInsets.bottom; } return insets; } Reinitialize the insets parameter with this Border's current Insets.
public Border getInsideBorder() { return insideBorder; } Returns the inside border object.
public Border getOutsideBorder() { return outsideBorder; } Returns the outside border object.
public boolean isBorderOpaque() { return (outsideBorder == null \|\| outsideBorder.isBorderOpaque()) && (insideBorder == null \|\| insideBorder.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.
public void paintBorder(Component c, Graphics g, int x, int y, int width, int height) { Insets nextInsets; int px, py, pw, ph; px = x; py = y; pw = width; ph = height; if(outsideBorder != null) { outsideBorder.paintBorder(c, g, px, py, pw, ph); nextInsets = outsideBorder.getBorderInsets(c); px += nextInsets.left; py += nextInsets.top; pw = pw - nextInsets.right - nextInsets.left; ph = ph - nextInsets.bottom - nextInsets.top; } if(insideBorder != null) insideBorder.paintBorder(c, g, px, py, pw, ph); } 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.

Method from javax.swing.border.CompoundBorder Detail:

 public Insets getBorderInsets(Component c,
    Insets insets) {
        Insets  nextInsets;
        insets.top = insets.left = insets.right = insets.bottom = 0;
        if(outsideBorder != null) {
            nextInsets = outsideBorder.getBorderInsets(c);
            insets.top += nextInsets.top;
            insets.left += nextInsets.left;
            insets.right += nextInsets.right;
            insets.bottom += nextInsets.bottom;
        }
        if(insideBorder != null) {
            nextInsets = insideBorder.getBorderInsets(c);
            insets.top += nextInsets.top;
            insets.left += nextInsets.left;
            insets.right += nextInsets.right;
            insets.bottom += nextInsets.bottom;
        }
        return insets;
}

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

 public Border getInsideBorder() {
        return insideBorder;
}

Returns the inside border object.

 public Border getOutsideBorder() {
        return outsideBorder;
}

Returns the outside border object.

 public boolean isBorderOpaque() {
        return (outsideBorder == null || outsideBorder.isBorderOpaque()) &&
               (insideBorder == null || insideBorder.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.

 public  void paintBorder(Component c,
    Graphics g,
    int x,
    int y,
    int width,
    int height) {
        Insets  nextInsets;
        int px, py, pw, ph;
        px = x;
        py = y;
        pw = width;
        ph = height;
        if(outsideBorder != null) {
            outsideBorder.paintBorder(c, g, px, py, pw, ph);
            nextInsets = outsideBorder.getBorderInsets(c);
            px += nextInsets.left;
            py += nextInsets.top;
            pw = pw - nextInsets.right - nextInsets.left;
            ph = ph - nextInsets.bottom - nextInsets.top;
        }
        if(insideBorder != null)
            insideBorder.paintBorder(c, g, px, py, pw, ph);
}

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.