Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.swing

Class BorderFactory

public class BorderFactory
extends Object
A factory for commonly used borders.

Method Summary

static Border
createBevelBorder(int type)
Create a beveled border of the specified type, using brighter shades of the component's current background color for highlighting, and darker shading for shadows.
static Border
createBevelBorder(int type, Color highlight, Color shadow)
Create a beveled border of the specified type, using the specified highlighting and shadowing.
static Border
createBevelBorder(int type, Color highlightOuter, Color highlightInner, Color shadowOuter, Color shadowInner)
Create a beveled border of the specified type, using the specified colors for the inner and outer highlight and shadow areas.
static CompoundBorder
createCompoundBorder()
Create a compound border with a null inside edge and a null outside edge.
static CompoundBorder
createCompoundBorder(Border outsideBorder, Border insideBorder)
Create a compound border specifying the border objects to use for the outside and inside edges.
static Border
createEmptyBorder()
Creates an empty border that takes up no space.
static Border
createEmptyBorder(int top, int left, int bottom, int right)
Creates an empty border that takes up no space but which does no drawing, specifying the width of the top, left, bottom, and right sides.
static Border
createEtchedBorder()
Create a border with an "etched" look using the component's current background color for highlighting and shading.
static Border
createEtchedBorder(int etchType)
Create a border with an "etched" look using the component's current background color for highlighting and shading.
static Border
createEtchedBorder(int etchType, Color highlight, Color shadow)
Create a border with an "etched" look using the specified highlighting and shading colors.
static Border
createEtchedBorder(Color highlight, Color shadow)
Create a border with an "etched" look using the specified highlighting and shading colors.
static Border
createLineBorder(Color color)
Creates a line border withe the specified color.
static Border
createLineBorder(Color color, int thickness)
Creates a line border withe the specified color and width.
static Border
createLoweredBevelBorder()
Created a border with a lowered beveled edge, using brighter shades of the component's current background color for highlighting, and darker shading for shadows.
static MatteBorder
createMatteBorder(int top, int left, int bottom, int right, Color color)
Create a matte-look border using a solid color.
static MatteBorder
createMatteBorder(int top, int left, int bottom, int right, Icon tileIcon)
Create a matte-look border that consists of multiple tiles of a specified icon.
static Border
createRaisedBevelBorder()
Created a border with a raised beveled edge, using brighter shades of the component's current background color for highlighting, and darker shading for shadows.
static TitledBorder
createTitledBorder(String title)
Create a new title border specifying the text of the title, using the default border (etched), using the default text position (sitting on the top line) and default justification (left) and using the default font and text color determined by the current look and feel.
static TitledBorder
createTitledBorder(Border border)
Create a new title border with an empty title specifying the border object, using the default text position (sitting on the top line) and default justification (left) and using the default font, text color, and border determined by the current look and feel.
static TitledBorder
createTitledBorder(Border border, String title)
Add a title to an existing border, specifying the text of the title, using the default positioning (sitting on the top line) and default justification (left) and using the default font and text color determined by the current look and feel.
static TitledBorder
createTitledBorder(Border border, String title, int titleJustification, int titlePosition)
Add a title to an existing border, specifying the text of the title along with its positioning, using the default font and text color determined by the current look and feel.
static TitledBorder
createTitledBorder(Border border, String title, int titleJustification, int titlePosition, Font titleFont)
Add a title to an existing border, specifying the text of the title along with its positioning and font, using the default text color determined by the current look and feel.
static TitledBorder
createTitledBorder(Border border, String title, int titleJustification, int titlePosition, Font titleFont, Color titleColor)
Add a title to an existing border, specifying the text of the title along with its positioning, font, and color.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

createBevelBorder

public static Border createBevelBorder(int type)
Create a beveled border of the specified type, using brighter shades of the component's current background color for highlighting, and darker shading for shadows. (In a lowered border, shadows are on top and highlights are underneath.).
Parameters:
type - An int specifying either BevelBorder.LOWERED or BevelBorder.RAISED
Returns:
The Border object

createBevelBorder

public static Border createBevelBorder(int type,
                                       Color highlight,
                                       Color shadow)
Create a beveled border of the specified type, using the specified highlighting and shadowing. The outer edge of the highlighted area uses a brighter shade of the highlight color. The inner edge of the shadow area uses a brighter shade of the shadaw color.
Parameters:
type - An int specifying either BevelBorder.LOWERED or BevelBorder.RAISED
highlight - A Color object for highlights
shadow - A Color object for shadows
Returns:
The Border object

createBevelBorder

public static Border createBevelBorder(int type,
                                       Color highlightOuter,
                                       Color highlightInner,
                                       Color shadowOuter,
                                       Color shadowInner)
Create a beveled border of the specified type, using the specified colors for the inner and outer highlight and shadow areas.
Parameters:
type - An int specifying either BevelBorder.LOWERED or BevelBorder.RAISED
highlightOuter - A Color object for the outer edge of the highlight area
highlightInner - A Color object for the inner edge of the highlight area
shadowOuter - A Color object for the outer edge of the shadow area
shadowInner - A Color object for the inner edge of the shadow area
Returns:
The Border object

createCompoundBorder

public static CompoundBorder createCompoundBorder()
Create a compound border with a null inside edge and a null outside edge.
Returns:
The CompoundBorder object

createCompoundBorder

public static CompoundBorder createCompoundBorder(Border outsideBorder,
                                                  Border insideBorder)
Create a compound border specifying the border objects to use for the outside and inside edges.
Parameters:
outsideBorder - A Border object for the outer edge of the compound border
insideBorder - A Border object for the inner edge of the compound border
Returns:
The CompoundBorder object

createEmptyBorder

public static Border createEmptyBorder()
Creates an empty border that takes up no space. (The width of the top, bottom, left, and right sides are all zero.)
Returns:
The Border object

createEmptyBorder

public static Border createEmptyBorder(int top,
                                       int left,
                                       int bottom,
                                       int right)
Creates an empty border that takes up no space but which does no drawing, specifying the width of the top, left, bottom, and right sides.
Parameters:
top - An int specifying the width of the top in pixels
left - An int specifying the width of the left side in pixels
bottom - An int specifying the width of the right side in pixels
right - An int specifying the width of the bottom in pixels
Returns:
The Border object

createEtchedBorder

public static Border createEtchedBorder()
Create a border with an "etched" look using the component's current background color for highlighting and shading.
Returns:
The Border object

createEtchedBorder

public static Border createEtchedBorder(int etchType)
Create a border with an "etched" look using the component's current background color for highlighting and shading.
Returns:
The Border object

createEtchedBorder

public static Border createEtchedBorder(int etchType,
                                        Color highlight,
                                        Color shadow)
Create a border with an "etched" look using the specified highlighting and shading colors.
Parameters:
highlight - A Color object for the border highlights
shadow - A Color object for the border shadows
Returns:
The Border object

createEtchedBorder

public static Border createEtchedBorder(Color highlight,
                                        Color shadow)
Create a border with an "etched" look using the specified highlighting and shading colors.
Parameters:
highlight - A Color object for the border highlights
shadow - A Color object for the border shadows
Returns:
The Border object

createLineBorder

public static Border createLineBorder(Color color)
Creates a line border withe the specified color.
Parameters:
color - A color to use for the line.
Returns:
The Border object

createLineBorder

public static Border createLineBorder(Color color,
                                      int thickness)
Creates a line border withe the specified color and width. The width applies to all 4 sides of the border. To specify widths individually for the top, bottom, left, and right, use createMatteBorder(int,int,int,int,Color).
Parameters:
color - A color to use for the line.
thickness - An int specifying the width in pixels.
Returns:
The Border object

createLoweredBevelBorder

public static Border createLoweredBevelBorder()
Created a border with a lowered beveled edge, using brighter shades of the component's current background color for highlighting, and darker shading for shadows. (In a lowered border, shadows are on top and highlights are underneath.)
Returns:
The Border object

createMatteBorder

public static MatteBorder createMatteBorder(int top,
                                            int left,
                                            int bottom,
                                            int right,
                                            Color color)
Create a matte-look border using a solid color. (The difference between this border and a line border is that you can specify the individual border dimensions.)
Parameters:
top - An int specifying the width of the top in pixels
left - An int specifying the width of the left side in pixels
bottom - An int specifying the width of the right side in pixels
right - An int specifying the width of the bottom in pixels
color - A Color to use for the border
Returns:
The MatteBorder object

createMatteBorder

public static MatteBorder createMatteBorder(int top,
                                            int left,
                                            int bottom,
                                            int right,
                                            Icon tileIcon)
Create a matte-look border that consists of multiple tiles of a specified icon. Multiple copies of the icon are placed side-by-side to fill up the border area. Note: If the icon doesn't load, the border area is painted gray.
Parameters:
top - An int specifying the width of the top in pixels
left - An int specifying the width of the left side in pixels
bottom - An int specifying the width of the right side in pixels
right - An int specifying the width of the bottom in pixels
tileIcon - The Icon object used for the border tiles
Returns:
The MatteBorder object

createRaisedBevelBorder

public static Border createRaisedBevelBorder()
Created a border with a raised beveled edge, using brighter shades of the component's current background color for highlighting, and darker shading for shadows. (In a raised border, highlights are on top and shadows are underneath.)
Returns:
The Border object

createTitledBorder

public static TitledBorder createTitledBorder(String title)
Create a new title border specifying the text of the title, using the default border (etched), using the default text position (sitting on the top line) and default justification (left) and using the default font and text color determined by the current look and feel.
Parameters:
title - A String containing the text of the title
Returns:
The TitledBorder object

createTitledBorder

public static TitledBorder createTitledBorder(Border border)
Create a new title border with an empty title specifying the border object, using the default text position (sitting on the top line) and default justification (left) and using the default font, text color, and border determined by the current look and feel. (The Motif and Windows look and feels use an etched border; The Java look and feel use a gray border.)
Parameters:
border - The Border object to add the title to
Returns:
The TitledBorder object

createTitledBorder

public static TitledBorder createTitledBorder(Border border,
                                              String title)
Add a title to an existing border, specifying the text of the title, using the default positioning (sitting on the top line) and default justification (left) and using the default font and text color determined by the current look and feel.
Parameters:
border - The Border object to add the title to
title - A String containing the text of the title
Returns:
The TitledBorder object

createTitledBorder

public static TitledBorder createTitledBorder(Border border,
                                              String title,
                                              int titleJustification,
                                              int titlePosition)
Add a title to an existing border, specifying the text of the title along with its positioning, using the default font and text color determined by the current look and feel.
Parameters:
border - The Border object to add the title to
title - A String containing the text of the title
titleJustification - An int specifying the left/right position of the title -- one of TitledBorder.LEFT, TitledBorder.CENTER, or TitledBorder.RIGHT, TitledBorder.DEFAULT_JUSTIFICATION (left).
titlePosition - An int specifying the vertical position of the text in relation to the border -- one of: TitledBorder.ABOVE_TOP, TitledBorder.TOP (sitting on the top line), TitledBorder.BELOW_TOP, TitledBorder.ABOVE_BOTTOM, TitledBorder.BOTTOM (sitting on the bottom line), TitledBorder.BELOW_BOTTOM, or TitledBorder.DEFAULT_POSITION (top).
Returns:
The TitledBorder object

createTitledBorder

public static TitledBorder createTitledBorder(Border border,
                                              String title,
                                              int titleJustification,
                                              int titlePosition,
                                              Font titleFont)
Add a title to an existing border, specifying the text of the title along with its positioning and font, using the default text color determined by the current look and feel.
Parameters:
border - - the Border object to add the title to
title - - a String containing the text of the title
titleJustification - - an int specifying the left/right position of the title -- one of TitledBorder.LEFT, TitledBorder.CENTER, or TitledBorder.RIGHT, TitledBorder.DEFAULT_JUSTIFICATION (left).
titlePosition - - an int specifying the vertical position of the text in relation to the border -- one of: TitledBorder.ABOVE_TOP, TitledBorder.TOP (sitting on the top line), TitledBorder.BELOW_TOP, TitledBorder.ABOVE_BOTTOM, TitledBorder.BOTTOM (sitting on the bottom line), TitledBorder.BELOW_BOTTOM, or TitledBorder.DEFAULT_POSITION (top).
titleFont - - a Font object specifying the title font
Returns:
The TitledBorder object

createTitledBorder

public static TitledBorder createTitledBorder(Border border,
                                              String title,
                                              int titleJustification,
                                              int titlePosition,
                                              Font titleFont,
                                              Color titleColor)
Add a title to an existing border, specifying the text of the title along with its positioning, font, and color.
Parameters:
border - - the Border object to add the title to
title - - a String containing the text of the title
titleJustification - - an int specifying the left/right position of the title -- one of TitledBorder.LEFT, TitledBorder.CENTER, or TitledBorder.RIGHT, TitledBorder.DEFAULT_JUSTIFICATION (left).
titlePosition - - an int specifying the vertical position of the text in relation to the border -- one of: TitledBorder.ABOVE_TOP, TitledBorder.TOP (sitting on the top line), TitledBorder.BELOW_TOP, TitledBorder.ABOVE_BOTTOM, TitledBorder.BOTTOM (sitting on the bottom line), TitledBorder.BELOW_BOTTOM, or TitledBorder.DEFAULT_POSITION (top).
titleFont - - a Font object specifying the title font
titleColor - - a Color object specifying the title color
Returns:
The TitledBorder object
BorderFactory.java -- Copyright (C) 2002, 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. 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.

Overview Package Class Use Source Tree Index Deprecated About