BorderUIResource.java 33.4 KB
Newer Older
Tom Tromey committed
1 2 3 4 5 6 7 8 9
/* BorderUIResource.java
   Copyright (C) 2002, 2003, 2004  Free Software Foundation, Inc.

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
10

Tom Tromey committed
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */


package javax.swing.plaf;

import java.awt.Color;
import java.awt.Component;
import java.awt.Font;
import java.awt.Graphics;
import java.awt.Insets;
import java.io.Serializable;

import javax.swing.Icon;
import javax.swing.border.BevelBorder;
import javax.swing.border.Border;
import javax.swing.border.CompoundBorder;
import javax.swing.border.EmptyBorder;
import javax.swing.border.EtchedBorder;
import javax.swing.border.LineBorder;
import javax.swing.border.MatteBorder;
import javax.swing.border.TitledBorder;

/**
 * A wrapper for {@link javax.swing.border.Border} that also
 * implements the {@link UIResource} marker interface.  This is useful
 * for implementing pluggable look-and-feels: When switching the
 * current LookAndFeel, only those borders are replaced that are
 * marked as {@link UIResource}.  For this reason, a look-and-feel
 * should always install borders that implement
 * <code>UIResource</code>, such as the borders provided by this
 * class.
 *
 * @serial
 * @serialField delegate Border the <code>Border</code> wrapped
 *
 * @author Brian Jones (cbj@gnu.org)
 * @author Sascha Brawer (brawer@dandelis.ch)
 */
74
public class BorderUIResource implements Border, UIResource, Serializable
Tom Tromey committed
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
{
  /**
   * Verified using the <code>serialver</code> tool
   * of Apple/Sun JDK 1.3.1 on MacOS X 10.1.5.
   */
  static final long serialVersionUID = -3440553684010079691L;


  /**
   * A shared instance of an {@link EtchedBorderUIResource}, or
   * <code>null</code> if the {@link #getEtchedBorderUIResource()}
   * method has not yet been called.
   */
  private static Border etchedBorderUIResource;


  /**
   * A shared instance of a {@link BevelBorderUIResource} whose
   * <code>bevelType</code> is {@link
   * javax.swing.border.BevelBorder#LOWERED}, or <code>null</code> if
   * the {@link #getLoweredBevelBorderUIResource()} has not yet been
   * called.
   */
  private static Border loweredBevelBorderUIResource;
99 100


Tom Tromey committed
101 102 103 104 105 106 107 108
  /**
   * A shared instance of a {@link BevelBorderUIResource} whose
   * <code>bevelType</code> is {@link
   * javax.swing.border.BevelBorder#RAISED}, or <code>null</code> if
   * the {@link #getRaisedBevelBorderUIResource()} has not yet been
   * called.
   */
  private static Border raisedBevelBorderUIResource;
109 110


Tom Tromey committed
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
  /**
   * A shared instance of a {@link LineBorderUIResource} for
   * a one-pixel thick black line, or <code>null</code> if
   * the {@link #getBlackLineBorderUIResource()} has not yet been
   * called.
   */
  private static Border blackLineBorderUIResource;


  /**
   * Returns a shared instance of an etched border which also
   * is marked as an {@link UIResource}.
   *
   * @see javax.swing.border.EtchedBorder
   */
  public static Border getEtchedBorderUIResource()
  {
    /* Swing is not designed to be thread-safe, so there is no
     * need to synchronize the access to the global variable.
     */
    if (etchedBorderUIResource == null)
      etchedBorderUIResource = new EtchedBorderUIResource();
    return etchedBorderUIResource;
  }
135

Tom Tromey committed
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172

  /**
   * Returns a shared instance of {@link BevelBorderUIResource} whose
   * <code>bevelType</code> is {@link
   * javax.swing.border.BevelBorder#LOWERED}.
   *
   * @see javax.swing.border.BevelBorder
   */
  public static Border getLoweredBevelBorderUIResource()
  {
    /* Swing is not designed to be thread-safe, so there is no
     * need to synchronize the access to the global variable.
     */
    if (loweredBevelBorderUIResource == null)
      loweredBevelBorderUIResource = new BevelBorderUIResource(
        BevelBorder.LOWERED);
    return loweredBevelBorderUIResource;
  }


  /**
   * Returns a shared instance of {@link BevelBorderUIResource} whose
   * <code>bevelType</code> is {@link
   * javax.swing.border.BevelBorder#RAISED}.
   *
   * @see javax.swing.border.BevelBorder
   */
  public static Border getRaisedBevelBorderUIResource()
  {
    /* Swing is not designed to be thread-safe, so there is no
     * need to synchronize the access to the global variable.
     */
    if (raisedBevelBorderUIResource == null)
      raisedBevelBorderUIResource = new BevelBorderUIResource(
        BevelBorder.RAISED);
    return raisedBevelBorderUIResource;
  }
173 174


Tom Tromey committed
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
  /**
   * Returns a shared instance of {@link LineBorderUIResource} for
   * a black, one-pixel width border.
   *
   * @see javax.swing.border.LineBorder
   */
  public static Border getBlackLineBorderUIResource()
  {
    /* Swing is not designed to be thread-safe, so there is no
     * need to synchronize the access to the global variable.
     */
    if (blackLineBorderUIResource == null)
      blackLineBorderUIResource = new LineBorderUIResource(Color.black);
    return blackLineBorderUIResource;
  }


  /**
   * The wrapped border.
   */
  private Border delegate;
196 197


Tom Tromey committed
198 199 200
  /**
   * Constructs a <code>BorderUIResource</code> for wrapping
   * a <code>Border</code> object.
201
   *
Tom Tromey committed
202 203 204 205 206 207
   * @param delegate the border to be wrapped.
   */
  public BorderUIResource(Border delegate)
  {
    if (delegate == null)
      throw new IllegalArgumentException();
208

Tom Tromey committed
209 210 211
    this.delegate = delegate;
  }

212

Tom Tromey committed
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
  /**
   * Paints the border around an enclosed component by calling
   * the <code>paintBorder</code> method of the wrapped delegate.
   *
   * @param c the component whose border is to be painted.
   * @param g the graphics for painting.
   * @param x the horizontal position for painting the border.
   * @param y the vertical position for painting the border.
   * @param width the width of the available area for painting the border.
   * @param height the height of the available area for painting the border.
   */
  public void paintBorder(Component c, Graphics g,
                          int x, int y, int width, int height)
  {
    delegate.paintBorder(c, g, x, y, width, height);
  }
229 230


Tom Tromey committed
231 232 233 234 235 236 237 238 239 240 241 242
  /**
   * Measures the width of this border by calling the
   * <code>getBorderInsets</code> method of the wrapped
   * delegate.
   *
   * @param c the component whose border is to be measured.
   *
   * @return an Insets object whose <code>left</code>, <code>right</code>,
   *         <code>top</code> and <code>bottom</code> fields indicate the
   *         width of the border at the respective edge.
   */
  public Insets getBorderInsets(Component c)
243
  {
Tom Tromey committed
244 245
    return delegate.getBorderInsets(c);
  }
246 247


Tom Tromey committed
248 249 250 251 252 253 254 255 256 257
  /**
   * Determines whether this border fills every pixel in its area
   * when painting by calling the <code>isBorderOpaque</code>
   * method of the wrapped delegate.
   *
   * @return <code>true</code> if the border is fully opaque, or
   *         <code>false</code> if some pixels of the background
   *         can shine through the border.
   */
  public boolean isBorderOpaque()
258
  {
Tom Tromey committed
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
    return delegate.isBorderOpaque();
  }


  /**
   * A {@link javax.swing.border.BevelBorder} that also implements the
   * {@link UIResource} marker interface.  This is useful for
   * implementing pluggable look-and-feels: When switching the current
   * LookAndFeel, only those borders are replaced that are marked as
   * {@link UIResource}.  For this reason, a look-and-feel should
   * always install borders that implement <code>UIResource</code>,
   * such as the borders provided by this class.
   *
   * @author Brian Jones (cbj@gnu.org)
   * @author Sascha Brawer (brawer@dandelis.ch)
   */
275
  public static class BevelBorderUIResource
Tom Tromey committed
276 277 278 279
    extends BevelBorder
    implements UIResource, Serializable
  {
    private static final long serialVersionUID = -1275542891108351642L;
280

Tom Tromey committed
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
    /**
     * Constructs a BevelBorderUIResource whose colors will be derived
     * from the background of the enclosed component. The background
     * color is retrieved each time the border is painted, so a border
     * constructed by this method will automatically reflect a change
     * to the component&#x2019;s background color.
     *
     * <p><img src="../border/doc-files/BevelBorder-1.png"
     * width="500" height="150"
     * alt="[An illustration showing raised and lowered BevelBorders]" /></p>
     *
     * @param bevelType the desired appearance of the border. The value
     *        must be either {@link javax.swing.border.BevelBorder#RAISED}
     *        or {@link javax.swing.border.BevelBorder#LOWERED}.
     *
     * @throws IllegalArgumentException if <code>bevelType</code> has
     *         an unsupported value.
     */
299 300
    public BevelBorderUIResource(int bevelType)
    {
Tom Tromey committed
301 302
      super(bevelType);
    }
303 304


Tom Tromey committed
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
    /**
     * Constructs a BevelBorderUIResource given its appearance type
     * and two colors for its highlight and shadow.
     *
     * <p><img src="../border/doc-files/BevelBorder-2.png" width="500"
     * height="150" alt="[An illustration showing BevelBorders that were
     * constructed with this method]" /></p>
     *
     * @param bevelType the desired appearance of the border. The value
     *        must be either {@link javax.swing.border.BevelBorder#RAISED}
     *        or {@link javax.swing.border.BevelBorder#LOWERED}.
     *
     * @param highlight the color that will be used for the inner side
     *        of the highlighted edges (top and left if if
     *        <code>bevelType</code> is {@link
     *        javax.swing.border.BevelBorder#RAISED}; bottom and right
     *        otherwise). The color for the outer side is a brightened
     *        version of this color.
     *
     * @param shadow the color that will be used for the outer side of
     *        the shadowed edges (bottom and right if
     *        <code>bevelType</code> is {@link
     *        javax.swing.border.BevelBorder#RAISED}; top and left
     *        otherwise). The color for the inner side is a brightened
     *        version of this color.
     *
     * @throws IllegalArgumentException if <code>bevelType</code> has
     *         an unsupported value.
     *
     * @throws NullPointerException if <code>highlight</code> or
     *         <code>shadow</code> is <code>null</code>.
     */
337 338 339
    public BevelBorderUIResource(int bevelType,
                                 Color highlight,
                                 Color shadow)
Tom Tromey committed
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
    {
      super(bevelType, highlight, shadow);
    }


    /**
     * Constructs a BevelBorderUIResource given its appearance type
     * and all its colors.
     *
     * <p><img src="../border/doc-files/BevelBorder-3.png" width="500"
     * height="150" alt="[An illustration showing BevelBorders that
     * were constructed with this method]" /></p>
     *
     * @param bevelType the desired appearance of the border. The value
     *        must be either {@link javax.swing.border.BevelBorder#RAISED}
     *        or {@link javax.swing.border.BevelBorder#LOWERED}.
     *
     * @param highlightOuter the color that will be used for the outer
     *        side of the highlighted edges (top and left if
     *        <code>bevelType</code> is {@link
     *        javax.swing.border.BevelBorder#RAISED}; bottom and right
     *        otherwise).
     *
     * @param highlightInner the color that will be used for the inner
     *        side of the highlighted edges.
     *
     * @param shadowOuter the color that will be used for the outer
     *        side of the shadowed edges (bottom and right if
     *        <code>bevelType</code> is {@link
     *        javax.swing.border.BevelBorder#RAISED}; top and left
     *        otherwise).
     *
     * @param shadowInner the color that will be used for the inner
     *        side of the shadowed edges.
     *
     * @throws IllegalArgumentException if <code>bevelType</code> has
     *         an unsupported value.
     *
     * @throws NullPointerException if one of the passed colors
     *         is <code>null</code>.
     */
    public BevelBorderUIResource(int bevelType,
                                 Color highlightOuter,
                                 Color highlightInner,
                                 Color shadowOuter,
385
                                 Color shadowInner)
Tom Tromey committed
386 387 388 389 390 391
    {
      super(bevelType,
            highlightOuter, highlightInner,
            shadowOuter, shadowInner);
    }
  }
392 393


Tom Tromey committed
394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
  /**
   * A {@link javax.swing.border.CompoundBorder} that also implements the
   * {@link UIResource} marker interface.  This is useful for
   * implementing pluggable look-and-feels: When switching the current
   * LookAndFeel, only those borders are replaced that are marked as
   * {@link UIResource}.  For this reason, a look-and-feel should
   * always install borders that implement <code>UIResource</code>,
   * such as the borders provided by this class.
   *
   * @author Brian Jones (cbj@gnu.org)
   * @author Sascha Brawer (brawer@dandelis.ch)
   */
  public static class CompoundBorderUIResource
    extends CompoundBorder
    implements UIResource, Serializable
  {
    private static final long serialVersionUID = 7550017084975167341L;
411

Tom Tromey committed
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
    /**
     * Constructs a CompoundBorderUIResource with the specified inside
     * and outside borders.
     *
     * @param outsideBorder the outside border, which is painted to the
     *        outside of both <code>insideBorder</code> and the enclosed
     *        component. It is acceptable to pass <code>null</code>, in
     *        which case no outside border is painted.
     *
     * @param insideBorder the inside border, which is painted to
     *        between <code>outsideBorder</code> and the enclosed
     *        component. It is acceptable to pass <code>null</code>, in
     *        which case no inside border is painted.
     */
    public CompoundBorderUIResource(Border outsideBorder,
                                    Border insideBorder)
    {
      super(outsideBorder, insideBorder);
    }
  }
432 433


Tom Tromey committed
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
  /**
   * An {@link javax.swing.border.EmptyBorder} that also implements the
   * {@link UIResource} marker interface.  This is useful for
   * implementing pluggable look-and-feels: When switching the current
   * LookAndFeel, only those borders are replaced that are marked as
   * {@link UIResource}.  For this reason, a look-and-feel should
   * always install borders that implement <code>UIResource</code>,
   * such as the borders provided by this class.
   *
   * <p><img src="../border/doc-files/EmptyBorder-1.png"
   * width="290" height="200"
   * alt="[An illustration of EmptyBorder]" /></p>
   *
   * @author Brian Jones (cbj@gnu.org)
   * @author Sascha Brawer (brawer@dandelis.ch)
   */
450
  public static class EmptyBorderUIResource
Tom Tromey committed
451 452 453 454
    extends EmptyBorder
    implements UIResource, Serializable
  {
    private static final long serialVersionUID = -4914187529340071708L;
455

Tom Tromey committed
456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
    /**
     * Constructs an empty border given the number of pixels required
     * on each side.
     *
     * @param top the number of pixels that the border will need
     *        for its top edge.
     *
     * @param left the number of pixels that the border will need
     *        for its left edge.
     *
     * @param bottom the number of pixels that the border will need
     *        for its bottom edge.
     *
     * @param right the number of pixels that the border will need
     *        for its right edge.
     */
    public EmptyBorderUIResource(int top, int left, int bottom, int right)
    {
      super(top, left, bottom, right);
    }
476 477


Tom Tromey committed
478 479 480 481 482 483 484 485 486 487 488
    /**
     * Constructs an empty border given the number of pixels required
     * on each side, passed in an Insets object.
     *
     * @param insets the Insets for the new border.
     */
    public EmptyBorderUIResource(Insets insets)
    {
      super(insets);
    }
  }
489 490


Tom Tromey committed
491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
  /**
   * An {@link javax.swing.border.EtchedBorder} that also implements the
   * {@link UIResource} marker interface.  This is useful for
   * implementing pluggable look-and-feels: When switching the current
   * LookAndFeel, only those borders are replaced that are marked as
   * {@link UIResource}.  For this reason, a look-and-feel should
   * always install borders that implement <code>UIResource</code>,
   * such as the borders provided by this class.
   *
   * <p><img src="../border/doc-files/EtchedBorder-1.png" width="500"
   * height="200" alt="[An illustration of the two EtchedBorder
   * variants]" /></p>
   *
   * @author Brian Jones (cbj@gnu.org)
   * @author Sascha Brawer (brawer@dandelis.ch)
   */
  public static class EtchedBorderUIResource
    extends EtchedBorder
    implements UIResource, Serializable
  {
    private static final long serialVersionUID = -8186391754165296656L;
512

Tom Tromey committed
513 514 515 516 517 518 519 520 521
    /**
     * Constructs an EtchedBorderUIResource that appears lowered into
     * the surface. The colors will be derived from the background
     * color of the enclosed Component when the border gets painted.
     */
    public EtchedBorderUIResource()
    {
      super();
    }
522 523


Tom Tromey committed
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
    /**
     * Constructs an EtchedBorderUIResource with the specified
     * appearance. The colors will be derived from the background
     * color of the enclosed Component when the border gets painted.
     *
     * <p><img src="../border/doc-files/EtchedBorder-1.png"
     * width="500" height="200" alt="[An illustration of the two
     * EtchedBorder variants]" /></p>
     *
     * @param etchType the desired appearance of the border. The value
     *        must be either {@link javax.swing.border.EtchedBorder#RAISED}
     *        or {@link javax.swing.border.EtchedBorder#LOWERED}.
     *
     * @throws IllegalArgumentException if <code>etchType</code> has
     *         an unsupported value.
     */
540
    public EtchedBorderUIResource(int etchType)
Tom Tromey committed
541 542 543
    {
      super(etchType);
    }
544 545


Tom Tromey committed
546 547 548 549 550 551 552 553 554 555 556
    /**
     * Constructs a lowered EtchedBorderUIResource, explicitly
     * selecting the colors that will be used for highlight and
     * shadow.
     *
     * @param highlight the color that will be used for painting
     *        the highlight part of the border.
     *
     * @param shadow the color that will be used for painting
     *        the shadow part of the border.
     *
Tom Tromey committed
557
     * @see EtchedBorderUIResource#EtchedBorderUIResource(int, Color, Color)
Tom Tromey committed
558 559 560 561 562
     */
    public EtchedBorderUIResource(Color highlight, Color shadow)
    {
      super(highlight, shadow);
    }
563 564


Tom Tromey committed
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
    /**
     * Constructs an EtchedBorderUIResource with the specified
     * appearance, explicitly selecting the colors that will be used
     * for highlight and shadow.
     *
     * <p><img src="../border/doc-files/EtchedBorder-2.png" width="500"
     * height="200" alt="[An illustration that shows which pixels get
     * painted in what color]" /></p>
     *
     * @param etchType the desired appearance of the border. The value
     *        must be either {@link javax.swing.border.EtchedBorder#RAISED}
     *        or {@link javax.swing.border.EtchedBorder#LOWERED}.
     *
     * @param highlight the color that will be used for painting
     *        the highlight part of the border.
     *
     * @param shadow the color that will be used for painting
     *        the shadow part of the border.
     *
     * @throws IllegalArgumentException if <code>etchType</code> has
     *         an unsupported value.
     */
    public EtchedBorderUIResource(int etchType,
                                  Color highlight, Color shadow)
    {
      super(etchType, highlight, shadow);
    }
  }
593 594


Tom Tromey committed
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
  /**
   * A {@link javax.swing.border.LineBorder} that also implements the
   * {@link UIResource} marker interface.  This is useful for
   * implementing pluggable look-and-feels: When switching the current
   * LookAndFeel, only those borders are replaced that are marked as
   * {@link UIResource}.  For this reason, a look-and-feel should
   * always install borders that implement <code>UIResource</code>,
   * such as the borders provided by this class.
   *
   * <p><img src="../border/doc-files/LineBorder-1.png" width="500"
   * height="200" alt="[An illustration of two LineBorders]" /></p>
   *
   * @author Brian Jones (cbj@gnu.org)
   * @author Sascha Brawer (brawer@dandelis.ch)
   */
  public static class LineBorderUIResource
    extends LineBorder
    implements UIResource, Serializable
  {
    private static final long serialVersionUID = -6171232338180172310L;
615

Tom Tromey committed
616 617 618 619 620 621 622 623
    /**
     * Constructs a LineBorderUIResource given its color.  The border
     * will be one pixel thick and have plain corners.
     *
     * @param color the color for drawing the border.
     */
    public LineBorderUIResource(Color color)
    {
624
      super(color);
Tom Tromey committed
625
    }
626 627


Tom Tromey committed
628 629 630 631 632 633 634 635 636 637 638
    /**
     * Constructs a LineBorder given its color and thickness.  The
     * border will have plain corners.
     *
     * @param color the color for drawing the border.
     * @param thickness the width of the line in pixels.
     */
    public LineBorderUIResource(Color color, int thickness)
    {
      super(color, thickness);
    }
639 640


Tom Tromey committed
641 642 643 644
    /* Note: Since JDK1.3, javax.swing.border.LineBorder also has a
     * constructor which accepts a value for the roundedCorners
     * property. However, as of JDK1.4.1, the LineBorderUIResource
     * subclass does not have a corresponding constructor.
645
     *
Tom Tromey committed
646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671
     * A request for enhancing the Swing API has been filed with Sun:
     * http://developer.java.sun.com/developer/bugParade/bugs/4879999.html
     */
  }


  /**
   * A {@link javax.swing.border.MatteBorder} that also implements the
   * {@link UIResource} marker interface.  This is useful for
   * implementing pluggable look-and-feels: When switching the current
   * LookAndFeel, only those borders are replaced that are marked as
   * {@link UIResource}.  For this reason, a look-and-feel should
   * always install borders that implement <code>UIResource</code>,
   * such as the borders provided by this class.
   *
   * <p><img src="../border/doc-files/MatteBorder-1.png" width="500"
   * height="150" alt="[An illustration of two MatteBorders]" /></p>
   *
   * @author Brian Jones (cbj@gnu.org)
   * @author Sascha Brawer (brawer@dandelis.ch)
   */
  public static class MatteBorderUIResource
    extends MatteBorder
    implements UIResource, Serializable
  {
    private static final long serialVersionUID = -8107923147541851122L;
672

Tom Tromey committed
673 674 675 676 677 678 679 680 681 682 683 684
    /**
     * Constructs a MatteBorderUIResource given the width on each side
     * and a fill color.
     *
     * <p><img src="../border/doc-files/MatteBorder-2.png" width="500"
     * height="150" alt="[A picture of a MatteBorder made by this
     * constructor]" /></p>
     *
     * @param top the width of the border at its top edge.
     * @param left the width of the border at its left edge.
     * @param bottom the width of the border at its bottom edge.
     * @param right the width of the border at its right edge.
Tom Tromey committed
685
     * @param color the color for filling the border.
Tom Tromey committed
686 687 688 689 690 691 692
     */
    public MatteBorderUIResource(int top, int left,
                                 int bottom, int right,
                                 Color color)
    {
      super(top, left, bottom, right, color);
    }
693 694


Tom Tromey committed
695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
    /**
     * Constructs a MatteBorderUIResource given the width on each side
     * and an icon for tiling the border area.
     *
     * <p><img src="../border/doc-files/MatteBorder-4.png" width="500"
     * height="150" alt="[A picture of a MatteBorder made by this
     * constructor]" /></p>
     *
     * @param top the width of the border at its top edge.
     * @param left the width of the border at its left edge.
     * @param bottom the width of the border at its bottom edge.
     * @param right the width of the border at its right edge.
     * @param tileIcon an icon for tiling the border area.
     */
    public MatteBorderUIResource(int top, int left,
                                 int bottom, int right,
                                 Icon tileIcon)
    {
      super(top, left, bottom, right, tileIcon);
    }
715 716


Tom Tromey committed
717 718 719 720 721 722 723 724 725 726
    /**
     * Constructs a MatteBorderUIResource given an icon for tiling the
     * border area. The icon width is used for the border insets at
     * the left and right edge, the icon height for the top and bottom
     * edge.
     *
     * <p><img src="../border/doc-files/MatteBorder-6.png" width="500"
     * height="150" alt="[A picture of a MatteBorder made by this
     * constructor]" /></p>
     *
727
     * @param tileIcon an icon for tiling the border area.
Tom Tromey committed
728 729 730 731 732 733
     */
    public MatteBorderUIResource(Icon tileIcon)
    {
      super(tileIcon);
    }
  }
734 735


Tom Tromey committed
736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752
  /**
   * A {@link javax.swing.border.TitledBorder} that also implements the
   * {@link UIResource} marker interface.  This is useful for
   * implementing pluggable look-and-feels: When switching the current
   * LookAndFeel, only those borders are replaced that are marked as
   * {@link UIResource}.  For this reason, a look-and-feel should
   * always install borders that implement <code>UIResource</code>,
   * such as the borders provided by this class.
   *
   * @author Brian Jones (cbj@gnu.org)
   * @author Sascha Brawer (brawer@dandelis.ch)
   */
  public static class TitledBorderUIResource
    extends TitledBorder
    implements UIResource, Serializable
  {
    private static final long serialVersionUID = 7667113547406407427L;
753

Tom Tromey committed
754 755 756 757 758 759 760 761 762 763
    /**
     * Constructs a TitledBorderUIResource given the text of its title.
     *
     * @param title the title text, or <code>null</code> to use no
     *        title text.
     */
    public TitledBorderUIResource(String title)
    {
      super(title);
    }
764 765


Tom Tromey committed
766 767 768 769 770 771 772 773 774 775 776 777
    /**
     * Constructs an initially untitled TitledBorderUIResource
     * given another border.
     *
     * @param border the border underneath the title, or
     *        <code>null</code> to use a default from
     *        the current look and feel.
     */
    public TitledBorderUIResource(Border border)
    {
      super(border);
    }
778 779


Tom Tromey committed
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880
    /**
     * Constructs a TitledBorder given its border and title text.
     *
     * @param border the border underneath the title, or
     *        <code>null</code> to use a default from
     *        the current look and feel.
     *
     * @param title the title text, or <code>null</code>
     *        to use no title text.
     */
    public TitledBorderUIResource(Border border, String title)
    {
      super(border, title);
    }


    /**
     * Constructs a TitledBorderUIResource given its border, title
     * text, horizontal alignment, and vertical position.
     *
     * @param border the border underneath the title, or
     *        <code>null</code> to use a default
     *        from the current look and feel.
     *
     * @param title the title text, or <code>null</code>
     *        to use no title text.
     *
     * @param titleJustification the horizontal alignment of the title
     *        text in relation to the border. The value must be one of
     *        {@link javax.swing.border.TitledBorder#LEFT},
     *        {@link javax.swing.border.TitledBorder#CENTER},
     *        {@link javax.swing.border.TitledBorder#RIGHT},
     *        {@link javax.swing.border.TitledBorder#LEADING},
     *        {@link javax.swing.border.TitledBorder#TRAILING}, or
     *        {@link javax.swing.border.TitledBorder#DEFAULT_JUSTIFICATION}.
     *
     * @param titlePosition the vertical position of the title text
     *        in relation to the border. The value must be one of
     *        {@link javax.swing.border.TitledBorder#ABOVE_TOP},
     *        {@link javax.swing.border.TitledBorder#TOP},
     *        {@link javax.swing.border.TitledBorder#BELOW_TOP},
     *        {@link javax.swing.border.TitledBorder#ABOVE_BOTTOM},
     *        {@link javax.swing.border.TitledBorder#BOTTOM},
     *        {@link javax.swing.border.TitledBorder#BELOW_BOTTOM},
     *        or {@link javax.swing.border.TitledBorder#DEFAULT_POSITION}.
     *
     * @throws IllegalArgumentException if <code>titleJustification</code>
     *         or <code>titlePosition</code> have an unsupported value.
     */
    public TitledBorderUIResource(Border border, String title,
                                  int titleJustification,
                                  int titlePosition)
    {
      super(border, title, titleJustification, titlePosition);
    }


    /**
     * Constructs a TitledBorder given its border, title text,
     * horizontal alignment, vertical position, and font.
     *
     * @param border the border underneath the title, or
     *        <code>null</code> to use a default
     *        from the current look and feel.
     *
     * @param title the title text, or <code>null</code>
     *        to use no title text.
     *
     * @param titleJustification the horizontal alignment of the title
     *        text in relation to the border. The value must be one of
     *        {@link javax.swing.border.TitledBorder#LEFT},
     *        {@link javax.swing.border.TitledBorder#CENTER},
     *        {@link javax.swing.border.TitledBorder#RIGHT},
     *        {@link javax.swing.border.TitledBorder#LEADING},
     *        {@link javax.swing.border.TitledBorder#TRAILING}, or
     *        {@link javax.swing.border.TitledBorder#DEFAULT_JUSTIFICATION}.
     *
     * @param titlePosition the vertical position of the title text
     *        in relation to the border. The value must be one of
     *        {@link javax.swing.border.TitledBorder#ABOVE_TOP},
     *        {@link javax.swing.border.TitledBorder#TOP},
     *        {@link javax.swing.border.TitledBorder#BELOW_TOP},
     *        {@link javax.swing.border.TitledBorder#ABOVE_BOTTOM},
     *        {@link javax.swing.border.TitledBorder#BOTTOM},
     *        {@link javax.swing.border.TitledBorder#BELOW_BOTTOM},
     *        or {@link javax.swing.border.TitledBorder#DEFAULT_POSITION}.
     *
     * @param titleFont the font for the title text, or <code>null</code>
     *        to use a default from the current look and feel.
     *
     * @throws IllegalArgumentException if <code>titleJustification</code>
     *         or <code>titlePosition</code> have an unsupported value.
     */
    public TitledBorderUIResource(Border border, String title,
                                  int titleJustification,
                                  int titlePosition,
                                  Font titleFont)
    {
      super(border, title, titleJustification, titlePosition,
            titleFont);
    }
881 882


Tom Tromey committed
883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
    /**
     * Constructs a TitledBorder given its border, title text,
     * horizontal alignment, vertical position, font, and color.
     *
     * @param border the border underneath the title, or
     *        <code>null</code> to use a default
     *        from the current look and feel.
     *
     * @param title the title text, or <code>null</code>
     *        to use no title text.
     *
     * @param titleJustification the horizontal alignment of the title
     *        text in relation to the border. The value must be one of
     *        {@link javax.swing.border.TitledBorder#LEFT},
     *        {@link javax.swing.border.TitledBorder#CENTER},
     *        {@link javax.swing.border.TitledBorder#RIGHT},
     *        {@link javax.swing.border.TitledBorder#LEADING},
     *        {@link javax.swing.border.TitledBorder#TRAILING}, or
     *        {@link javax.swing.border.TitledBorder#DEFAULT_JUSTIFICATION}.
     *
     * @param titlePosition the vertical position of the title text
     *        in relation to the border. The value must be one of
     *        {@link javax.swing.border.TitledBorder#ABOVE_TOP},
     *        {@link javax.swing.border.TitledBorder#TOP},
     *        {@link javax.swing.border.TitledBorder#BELOW_TOP},
     *        {@link javax.swing.border.TitledBorder#ABOVE_BOTTOM},
     *        {@link javax.swing.border.TitledBorder#BOTTOM},
     *        {@link javax.swing.border.TitledBorder#BELOW_BOTTOM},
     *        or {@link javax.swing.border.TitledBorder#DEFAULT_POSITION}.
     *
     * @param titleFont the font for the title text, or <code>null</code>
     *        to use a default from the current look and feel.
     *
     * @param titleColor the color for the title text, or <code>null</code>
     *        to use a default from the current look and feel.
     *
     * @throws IllegalArgumentException if <code>titleJustification</code>
     *         or <code>titlePosition</code> have an unsupported value.
     */
    public TitledBorderUIResource(Border border, String title,
                                  int titleJustification, int titlePosition,
                                  Font titleFont, Color titleColor)
    {
      super(border, title, titleJustification, titlePosition,
            titleFont, titleColor);
    }
  }
}