javax.swing

Class BorderFactory

public class BorderFactory extends Object

A factory for commonly used borders.
Method Summary
static BordercreateBevelBorder(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 BordercreateBevelBorder(int type, Color highlight, Color shadow)
Create a beveled border of the specified type, using the specified highlighting and shadowing.
static BordercreateBevelBorder(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 CompoundBordercreateCompoundBorder()
Create a compound border with a null inside edge and a null outside edge.
static CompoundBordercreateCompoundBorder(Border outsideBorder, Border insideBorder)
Create a compound border specifying the border objects to use for the outside and inside edges.
static BordercreateEmptyBorder()
Creates an empty border that takes up no space.
static BordercreateEmptyBorder(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 BordercreateEtchedBorder()
Create a border with an "etched" look using the component's current background color for highlighting and shading.
static BordercreateEtchedBorder(int etchType)
Create a border with an "etched" look using the component's current background color for highlighting and shading.
static BordercreateEtchedBorder(Color highlight, Color shadow)
Create a border with an "etched" look using the specified highlighting and shading colors.
static BordercreateEtchedBorder(int etchType, Color highlight, Color shadow)
Create a border with an "etched" look using the specified highlighting and shading colors.
static BordercreateLineBorder(Color color)
Creates a line border withe the specified color.
static BordercreateLineBorder(Color color, int thickness)
Creates a line border withe the specified color and width.
static BordercreateLoweredBevelBorder()
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 MatteBordercreateMatteBorder(int top, int left, int bottom, int right, Color color)
Create a matte-look border using a solid color.
static MatteBordercreateMatteBorder(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 BordercreateRaisedBevelBorder()
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 TitledBordercreateTitledBorder(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 TitledBordercreateTitledBorder(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 TitledBordercreateTitledBorder(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 TitledBordercreateTitledBorder(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 TitledBordercreateTitledBorder(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 TitledBordercreateTitledBorder(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.

Method Detail

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(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(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

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