libjava/javax/swing/BorderFactory.java

   1 /* BorderFactory.java --
   2    Copyright (C) 2002, 2004  Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package javax.swing;
  40
  41 import java.awt.Color;
  42 import java.awt.Font;
  43
  44 import javax.swing.border.BevelBorder;
  45 import javax.swing.border.Border;
  46 import javax.swing.border.CompoundBorder;
  47 import javax.swing.border.EmptyBorder;
  48 import javax.swing.border.EtchedBorder;
  49 import javax.swing.border.LineBorder;
  50 import javax.swing.border.MatteBorder;
  51 import javax.swing.border.TitledBorder;
  52
  53 public class BorderFactory
  54 {
  55   private BorderFactory()
  56   {
  57     // Do nothing.
  58   }
  59
  60   /**
  61    * Creates a line border withe the specified color.
  62    *
  63    * @param color A color to use for the line.
  64    *
  65    * @return The Border object
  66    */
  67   public static Border createLineBorder(Color color)
  68   {
  69     return null;
  70   }
  71
  72   /**
  73    * Creates a line border withe the specified color and width. The width
  74    * applies to all 4 sides of the border. To specify widths individually for
  75    * the top, bottom, left, and right, use
  76    * createMatteBorder(int,int,int,int,Color).
  77    *
  78    * @param color A color to use for the line.
  79    * @param thickness An int specifying the width in pixels.
  80    *
  81    * @return The Border object
  82    */
  83   public static Border createLineBorder (Color color, int thickness)
  84   {
  85     return new LineBorder (color, thickness);
  86   }
  87
  88   /**
  89    * Created a border with a raised beveled edge, using brighter shades of
  90    * the component's current background color for highlighting, and darker
  91    * shading for shadows. (In a raised border, highlights are on top and
  92    * shadows are underneath.)
  93    *
  94    * @return The Border object
  95    */
  96   public static Border createRaisedBevelBorder ()
  97   {
  98     return new BevelBorder (BevelBorder.RAISED);
  99   }
 100
 101   /**
 102    * Created a border with a lowered beveled edge, using brighter shades of
 103    * the component's current background color for highlighting, and darker
 104    * shading for shadows. (In a lowered border, shadows are on top and
 105    * highlights are underneath.)
 106    *
 107    * @return The Border object
 108    */
 109   public static Border createLoweredBevelBorder ()
 110   {
 111     return new BevelBorder (BevelBorder.LOWERED);
 112   }
 113
 114   /**
 115    * Create a beveled border of the specified type, using brighter shades of
 116    * the component's current background color for highlighting, and darker
 117    * shading for shadows. (In a lowered border, shadows are on top and
 118    * highlights are underneath.).
 119    *
 120    * @param type An int specifying either BevelBorder.LOWERED or
 121    * BevelBorder.RAISED
 122    *
 123    * @Return The Border object
 124    */
 125   public static Border createBevelBorder (int type)
 126   {
 127     return new BevelBorder (type);
 128   }
 129
 130   /**
 131    * Create a beveled border of the specified type, using the specified
 132    * highlighting and shadowing. The outer edge of the highlighted area uses
 133    * a brighter shade of the highlight color. The inner edge of the shadow
 134    * area uses a brighter shade of the shadaw color.
 135    *
 136    * @param type An int specifying either BevelBorder.LOWERED or
 137    * BevelBorder.RAISED
 138    * @param highlight A Color object for highlights
 139    * @param shadow A Color object for shadows
 140    *
 141    * @return The Border object
 142   */
 143   public static Border createBevelBorder (int type, Color highlight,
 144                                           Color shadow)
 145   {
 146     return new BevelBorder (type, highlight, shadow);
 147   }
 148
 149   /**
 150    * Create a beveled border of the specified type, using the specified colors
 151    * for the inner and outer highlight and shadow areas.
 152    *
 153    * @param type An int specifying either BevelBorder.LOWERED or
 154    * BevelBorder.RAISED
 155    * @param highlightOuter A Color object for the outer edge of the
 156    * highlight area
 157    * @param highlightInner A Color object for the inner edge of the
 158    * highlight area
 159    * @param shadowOuter A Color object for the outer edge of the shadow area
 160    * @param shadowInner A Color object for the inner edge of the shadow area
 161    *
 162    * @return The Border object
 163    */
 164   public static Border createBevelBorder (int type, Color highlightOuter,
 165                                           Color highlightInner,
 166                                           Color shadowOuter, Color shadowInner)
 167   {
 168     return new BevelBorder (type, highlightOuter, highlightInner, shadowOuter,
 169                             shadowInner);
 170   }
 171
 172   /**
 173    * Create a border with an "etched" look using the component's current
 174    * background color for highlighting and shading.
 175    *
 176    * @return The Border object
 177    */
 178   public static Border createEtchedBorder ()
 179   {
 180     return new EtchedBorder ();
 181   }
 182
 183   /**
 184    * Create a border with an "etched" look using the component's current
 185    * background color for highlighting and shading.
 186    *
 187    * @return The Border object
 188    */
 189   public static Border createEtchedBorder (int etchType)
 190   {
 191     return new EtchedBorder (etchType);
 192   }
 193
 194   /**
 195    * Create a border with an "etched" look using the specified highlighting and
 196    * shading colors.
 197    *
 198    * @param highlight A Color object for the border highlights
 199    * @param shadow A Color object for the border shadows
 200    *
 201    * @return The Border object
 202    */
 203   public static Border createEtchedBorder (Color highlight, Color shadow)
 204   {
 205     return new EtchedBorder (highlight, shadow);
 206   }
 207
 208   /**
 209    * Create a border with an "etched" look using the specified highlighting and
 210    * shading colors.
 211    *
 212    * @param highlight A Color object for the border highlights
 213    * @param shadow A Color object for the border shadows
 214    *
 215    * @return The Border object
 216    */
 217   public static Border createEtchedBorder (int etchType, Color highlight,
 218                                            Color shadow)
 219   {
 220     return new EtchedBorder (etchType, highlight, shadow);
 221   }
 222
 223   /**
 224    * Create a new title border specifying the text of the title, using the
 225    * default border (etched), using the default text position (sitting on the
 226    * top line) and default justification (left) and using the default font and
 227    * text color determined by the current look and feel.
 228    *
 229    * @param title A String containing the text of the title
 230    *
 231    * @return The TitledBorder object
 232    */
 233   public static TitledBorder createTitledBorder (String title)
 234   {
 235     return new TitledBorder (title);
 236   }
 237
 238   /**
 239    * Create a new title border with an empty title specifying the border
 240    * object, using the default text position (sitting on the top line) and
 241    * default justification (left) and using the default font, text color,
 242    * and border determined by the current look and feel. (The Motif and Windows
 243    * look and feels use an etched border; The Java look and feel use a
 244    * gray border.)
 245    *
 246    * @param border The Border object to add the title to
 247    *
 248    * @return The TitledBorder object
 249    */
 250   public static TitledBorder createTitledBorder (Border border)
 251   {
 252     return new TitledBorder (border);
 253   }
 254
 255   /**
 256    * Add a title to an existing border, specifying the text of the title, using
 257    * the default positioning (sitting on the top line) and default
 258    * justification (left) and using the default font and text color determined
 259    * by the current look and feel.
 260    *
 261    * @param order The Border object to add the title to
 262    * @param title A String containing the text of the title
 263    *
 264    * @return The TitledBorder object
 265    */
 266   public static TitledBorder createTitledBorder (Border border, String title)
 267   {
 268     return new TitledBorder (border, title);
 269   }
 270
 271   /**
 272    * Add a title to an existing border, specifying the text of the title along
 273    * with its positioning, using the default font and text color determined by
 274    * the current look and feel.
 275    *
 276    * @param border The Border object to add the title to
 277    * @param title A String containing the text of the title
 278    * @param titleJustification An int specifying the left/right position of
 279    * the title -- one of TitledBorder.LEFT, TitledBorder.CENTER, or
 280    * TitledBorder.RIGHT, TitledBorder.DEFAULT_JUSTIFICATION (left).
 281    * @param titlePosition An int specifying the vertical position of the text
 282    * in relation to the border -- one of: TitledBorder.ABOVE_TOP,
 283    * TitledBorder.TOP (sitting on the top line), TitledBorder.BELOW_TOP,
 284    * TitledBorder.ABOVE_BOTTOM, TitledBorder.BOTTOM (sitting on the bottom
 285    * line), TitledBorder.BELOW_BOTTOM, or TitledBorder.DEFAULT_POSITION (top).
 286    *
 287    * @return The TitledBorder object
 288    */
 289   public static TitledBorder createTitledBorder (Border border, String title,
 290                                                 int titleJustification,
 291                                                 int titlePosition)
 292   {
 293     return new TitledBorder (border, title, titleJustification, titlePosition);
 294   }
 295
 296   /**
 297    * Add a title to an existing border, specifying the text of the title along
 298    * with its positioning and font, using the default text color determined by
 299    * the current look and feel.
 300    *
 301    * @param border - the Border object to add the title to
 302    * @param title - a String containing the text of the title
 303    * @param titleJustification - an int specifying the left/right position of
 304    * the title -- one of TitledBorder.LEFT, TitledBorder.CENTER, or
 305    * TitledBorder.RIGHT, TitledBorder.DEFAULT_JUSTIFICATION (left).
 306    * @param titlePosition - an int specifying the vertical position of the
 307    * text in relation to the border -- one of: TitledBorder.ABOVE_TOP,
 308    * TitledBorder.TOP (sitting on the top line), TitledBorder.BELOW_TOP,
 309    * TitledBorder.ABOVE_BOTTOM, TitledBorder.BOTTOM (sitting on the bottom
 310    * line), TitledBorder.BELOW_BOTTOM, or TitledBorder.DEFAULT_POSITION (top).
 311    * @param titleFont - a Font object specifying the title font
 312    *
 313    * @return The TitledBorder object
 314    */
 315   public static TitledBorder createTitledBorder (Border border, String title,
 316                                                  int titleJustification,
 317                                                  int titlePosition,
 318                                                  Font titleFont)
 319   {
 320     return new TitledBorder (border, title, titleJustification, titlePosition,
 321                              titleFont);
 322   }
 323
 324   /**
 325    * Add a title to an existing border, specifying the text of the title along
 326    * with its positioning, font, and color.
 327    *
 328    * @param border - the Border object to add the title to
 329    * @param title - a String containing the text of the title
 330    * @param titleJustification - an int specifying the left/right position of
 331    * the title -- one of TitledBorder.LEFT, TitledBorder.CENTER, or
 332    * TitledBorder.RIGHT, TitledBorder.DEFAULT_JUSTIFICATION (left).
 333    * @param titlePosition - an int specifying the vertical position of the text
 334    * in relation to the border -- one of: TitledBorder.ABOVE_TOP,
 335    * TitledBorder.TOP (sitting on the top line), TitledBorder.BELOW_TOP,
 336    * TitledBorder.ABOVE_BOTTOM, TitledBorder.BOTTOM (sitting on the bottom
 337    * line), TitledBorder.BELOW_BOTTOM, or TitledBorder.DEFAULT_POSITION (top).
 338    * @param titleFont - a Font object specifying the title font
 339    * @param titleColor - a Color object specifying the title color
 340    *
 341    * @return The TitledBorder object
 342    */
 343   public static TitledBorder createTitledBorder (Border border,
 344                                                  String title,
 345                                                  int titleJustification,
 346                                                  int titlePosition,
 347                                                  Font titleFont,
 348                                                  Color titleColor)
 349   {
 350     return new TitledBorder (border, title, titleJustification, titlePosition,
 351                              titleFont, titleColor);
 352   }
 353
 354   /**
 355    * Creates an empty border that takes up no space. (The width of the top,
 356    * bottom, left, and right sides are all zero.)
 357    *
 358    * @return The Border object
 359    */
 360   public static Border createEmptyBorder ()
 361   {
 362     return new EmptyBorder (0, 0, 0, 0);
 363   }
 364
 365   /**
 366    * Creates an empty border that takes up no space but which does no drawing,
 367    * specifying the width of the top, left, bottom, and right sides.
 368    *
 369    * @param top An int specifying the width of the top in pixels
 370    * @param left An int specifying the width of the left side in pixels
 371    * @param bottom An int specifying the width of the right side in pixels
 372    * @param right An int specifying the width of the bottom in pixels
 373    *
 374    * @return The Border object
 375    */
 376   public static Border createEmptyBorder (int top, int left, int bottom,
 377                                           int right)
 378   {
 379     return new EmptyBorder (top, left, bottom, right);
 380   }
 381
 382   /**
 383    * Create a compound border with a null inside edge and a null outside edge.
 384    *
 385    * @return The CompoundBorder object
 386    */
 387   public static CompoundBorder createCompoundBorder ()
 388   {
 389     return new CompoundBorder ();
 390   }
 391
 392   /**
 393    * Create a compound border specifying the border objects to use for the
 394    * outside and inside edges.
 395    *
 396    * @param outsideBorder A Border object for the outer edge of the
 397    * compound border
 398    * @param insideBorder A Border object for the inner edge of the
 399    * compound border
 400    *
 401    * @return The CompoundBorder object
 402    */
 403   public static CompoundBorder createCompoundBorder (Border outsideBorder,
 404                                                      Border insideBorder)
 405   {
 406     return new CompoundBorder (outsideBorder, insideBorder);
 407   }
 408
 409   /**
 410    * Create a matte-look border using a solid color. (The difference between
 411    * this border and a line border is that you can specify the individual
 412    * border dimensions.)
 413    *
 414    * @param top An int specifying the width of the top in pixels
 415    * @param left An int specifying the width of the left side in pixels
 416    * @param bottom An int specifying the width of the right side in pixels
 417    * @param right An int specifying the width of the bottom in pixels
 418    * @param color A Color to use for the border
 419    *
 420    * @return The MatteBorder object
 421    */
 422   public static MatteBorder createMatteBorder (int top, int left, int bottom,
 423                                                int right, Color color)
 424   {
 425     return new MatteBorder (top, left, bottom, right, color);
 426   }
 427
 428   /**
 429    * Create a matte-look border that consists of multiple tiles of a specified
 430    * icon. Multiple copies of the icon are placed side-by-side to fill up the
 431    * border area.
 432    *
 433    * Note:
 434    * If the icon doesn't load, the border area is painted gray.
 435    *
 436    * @param top An int specifying the width of the top in pixels
 437    * @param left An int specifying the width of the left side in pixels
 438    * @param bottom An int specifying the width of the right side in pixels
 439    * @param right An int specifying the width of the bottom in pixels
 440    * @param tileIcon The Icon object used for the border tiles
 441    *
 442    * @return The MatteBorder object
 443    */
 444   public static MatteBorder createMatteBorder (int top, int left, int bottom,
 445                                                int right, Icon tileIcon)
 446   {
 447     return new MatteBorder (top, left, bottom, right, tileIcon);
 448   }
 449 }