javax.swing.BorderFactory

BorderFactory

Java SE 6

Factory class for vending standard Border objects. Wherever possible, this factory will hand out references to shared Border instances. For further information and examples see How to Use Borders, a section in The Java Tutorial.

version

1.35 11/17/05

Methods

public static Border

createBevelBorder(int type)
Creates 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.)

type	an integer specifying either `BevelBorder.LOWERED` or `BevelBorder.RAISED`
return	the `Border` object

public static Border

createBevelBorder(int type, Color highlight, Color shadow)
Creates 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 shadow color.

type	an integer specifying either `BevelBorder.LOWERED` or `BevelBorder.RAISED`
highlight	a `Color` object for highlights
shadow	a `Color` object for shadows
return	the `Border` object

public static Border

createBevelBorder(int type, Color highlightOuter, Color highlightInner, Color shadowOuter, Color shadowInner)
Creates a beveled border of the specified type, using the specified colors for the inner and outer highlight and shadow areas.

Note: The shadow inner and outer colors are switched for a lowered bevel border.

type an integer 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

return the Border object

public static CompoundBorder

createCompoundBorder()
Creates a compound border with a null inside edge and a null outside edge.

return the CompoundBorder object

public static CompoundBorder

createCompoundBorder(Border outsideBorder, Border insideBorder)
Creates a compound border specifying the border objects to use for the outside and inside edges.

outsideBorder	a `Border` object for the outer edge of the compound border
insideBorder	a `Border` object for the inner edge of the compound border
return	the `CompoundBorder` object

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.)

return the Border object

public static Border

createEmptyBorder(int top, int left, int bottom, int right)
Creates an empty border that takes up space but which does no drawing, specifying the width of the top, left, bottom, and right sides.

top	an integer specifying the width of the top, in pixels
left	an integer specifying the width of the left side, in pixels
bottom	an integer specifying the width of the bottom, in pixels
right	an integer specifying the width of the right side, in pixels
return	the `Border` object

public static Border

createEtchedBorder()
Creates a border with an "etched" look using the component's current background color for highlighting and shading.

return the Border object

public static Border

createEtchedBorder(Color highlight, Color shadow)
Creates a border with an "etched" look using the specified highlighting and shading colors.

highlight	a `Color` object for the border highlights
shadow	a `Color` object for the border shadows
return	the `Border` object

public static Border

createEtchedBorder(int type)
Creates a border with an "etched" look using the component's current background color for highlighting and shading.

type	one of `EtchedBorder.RAISED`, or `EtchedBorder.LOWERED`
return	the `Border` object
Throws	IllegalArgumentException: if type is not either `EtchedBorder.RAISED` or `EtchedBorder.LOWERED`
since	1.3

public static Border

createEtchedBorder(int type, Color highlight, Color shadow)
Creates a border with an "etched" look using the specified highlighting and shading colors.

type	one of `EtchedBorder.RAISED`, or `EtchedBorder.LOWERED`
highlight	a `Color` object for the border highlights
shadow	a `Color` object for the border shadows
return	the `Border` object
since	1.3

public static Border

createLineBorder(Color color)
Creates a line border withe the specified color.

color	a `Color` to use for the line
return	the `Border` object

public static Border

createLineBorder(Color color, int thickness)
Creates a line border with the specified color and width. The width applies to all four sides of the border. To specify widths individually for the top, bottom, left, and right, use #createMatteBorder(int,int,int,int,Color).

color	a `Color` to use for the line
thickness	an integer specifying the width in pixels
return	the `Border` object

public static Border

createLoweredBevelBorder()
Creates 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.)

return the Border object

public static MatteBorder

createMatteBorder(int top, int left, int bottom, int right, Color color)
Creates 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.)

top	an integer specifying the width of the top, in pixels
left	an integer specifying the width of the left side, in pixels
bottom	an integer specifying the width of the right side, in pixels
right	an integer specifying the width of the bottom, in pixels
color	a `Color` to use for the border
return	the `MatteBorder` object

public static MatteBorder

createMatteBorder(int top, int left, int bottom, int right, Icon tileIcon)
Creates 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.

top an integer specifying the width of the top, in pixels

left an integer specifying the width of the left side, in pixels

bottom an integer specifying the width of the right side, in pixels

right an integer specifying the width of the bottom, in pixels

tileIcon the Icon object used for the border tiles

return the MatteBorder object

public static Border

createRaisedBevelBorder()
Creates 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.)

return the Border object

public static TitledBorder

createTitledBorder(String title)
Creates a new titled border with the specified title, the default border type (determined by the current look and feel), the default text position (sitting on the top line), the default justification (leading), and the default font and text color (determined by the current look and feel).

title	a `String` containing the text of the title
return	the `TitledBorder` object

public static TitledBorder

createTitledBorder(Border border)
Creates a new titled border with an empty title, the specified border object, the default text position (sitting on the top line), the default justification (leading), and the default font and text color (determined by the current look and feel).

border	the `Border` object to add the title to; if `null` the `Border` is determined by the current look and feel.
return	the `TitledBorder` object

public static TitledBorder

createTitledBorder(Border border, String title)
Adds a title to an existing border, with default positioning (sitting on the top line), default justification (leading) and the default font and text color (determined by the current look and feel).

border	the `Border` object to add the title to
title	a `String` containing the text of the title
return	the `TitledBorder` object

public static TitledBorder

createTitledBorder(Border border, String title, int titleJustification, int titlePosition)
Adds a title to an existing border, with the specified positioning and using the default font and text color (determined by the current look and feel).

border	the `Border` object to add the title to
title	a `String` containing the text of the title
titleJustification	an integer specifying the justification of the title -- one of the following: `TitledBorder.LEFT` `TitledBorder.CENTER` `TitledBorder.RIGHT` `TitledBorder.LEADING` `TitledBorder.TRAILING` `TitledBorder.DEFAULT_JUSTIFICATION` (leading)
titlePosition	an integer specifying the vertical position of the text in relation to the border -- one of the following: `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` `TitledBorder.DEFAULT_POSITION` (top)
return	the `TitledBorder` object

public static TitledBorder

createTitledBorder(Border border, String title, int titleJustification, int titlePosition, Font titleFont)
Adds a title to an existing border, with the specified positioning and font, and using the default text color (determined by the current look and feel).

border	the `Border` object to add the title to
title	a `String` containing the text of the title
titleJustification	an integer specifying the justification of the title -- one of the following: `TitledBorder.LEFT` `TitledBorder.CENTER` `TitledBorder.RIGHT` `TitledBorder.LEADING` `TitledBorder.TRAILING` `TitledBorder.DEFAULT_JUSTIFICATION` (leading)
titlePosition	an integer specifying the vertical position of the text in relation to the border -- one of the following: `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` `TitledBorder.DEFAULT_POSITION` (top)
titleFont	a Font object specifying the title font
return	the TitledBorder object

public static TitledBorder

createTitledBorder(Border border, String title, int titleJustification, int titlePosition, Font titleFont, Color titleColor)
Adds a title to an existing border, with the specified positioning, font and color.

border	the `Border` object to add the title to
title	a `String` containing the text of the title
titleJustification	an integer specifying the justification of the title -- one of the following: `TitledBorder.LEFT` `TitledBorder.CENTER` `TitledBorder.RIGHT` `TitledBorder.LEADING` `TitledBorder.TRAILING` `TitledBorder.DEFAULT_JUSTIFICATION` (leading)
titlePosition	an integer specifying the vertical position of the text in relation to the border -- one of the following: `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` `TitledBorder.DEFAULT_POSITION` (top)
titleFont	a `Font` object specifying the title font
titleColor	a `Color` object specifying the title color
return	the `TitledBorder` object

About DocWeb · Bundles · Export · Export All

Top 10 · Statistics · Login

About Sun · Contact · Privacy · Terms of Use · Trademarks

Java SE 6