BorderFactory (Java Platform SE 7 b138)

java.lang.Object
- javax.swing.BorderFactory

```
public class BorderFactory
extends Object
```
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.

Method Summary

Methods
Modifier and Type	Method and Description
`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.
`static Border`	`createBevelBorder(int type, Color highlight, Color shadow)` Creates 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)` Creates a beveled border of the specified type, using the specified colors for the inner and outer highlight and shadow areas.
`static CompoundBorder`	`createCompoundBorder()` Creates a compound border with a `null` inside edge and a `null` outside edge.
`static CompoundBorder`	`createCompoundBorder(Border outsideBorder, Border insideBorder)` Creates a compound border specifying the border objects to use for the outside and inside edges.
`static Border`	`createDashedBorder(Paint paint)` Creates a dashed border of the specified `paint`.
`static Border`	`createDashedBorder(Paint paint, float length, float spacing)` Creates a dashed border of the specified `paint`, relative `length`, and relative `spacing`.
`static Border`	`createDashedBorder(Paint paint, float thickness, float length, float spacing, boolean rounded)` Creates a dashed border of the specified `paint`, `thickness`, line shape, relative `length`, and relative `spacing`.
`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 space but which does no drawing, specifying the width of the top, left, bottom, and right sides.
`static Border`	`createEtchedBorder()` Creates a border with an "etched" look using the component's current background color for highlighting and shading.
`static Border`	`createEtchedBorder(Color highlight, Color shadow)` Creates a border with an "etched" look using the specified highlighting and shading colors.
`static Border`	`createEtchedBorder(int type)` Creates a border with an "etched" look using the component's current background color for highlighting and shading.
`static Border`	`createEtchedBorder(int type, Color highlight, Color shadow)` Creates 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 with the specified color and width.
`static Border`	`createLineBorder(Color color, int thickness, boolean rounded)` Creates a line border with the specified color, thickness, and corner shape.
`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.
`static Border`	`createLoweredSoftBevelBorder()` Creates a beveled border with a lowered edge and softened corners, 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)` Creates a matte-look border using a solid color.
`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.
`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.
`static Border`	`createRaisedSoftBevelBorder()` Creates a beveled border with a raised edge and softened corners, using brighter shades of the component's current background color for highlighting, and darker shading for shadows.
`static Border`	`createSoftBevelBorder(int type)` Creates a beveled border of the specified type with softened corners, using brighter shades of the component's current background color for highlighting, and darker shading for shadows.
`static Border`	`createSoftBevelBorder(int type, Color highlight, Color shadow)` Creates a beveled border of the specified type with softened corners, using the specified highlighting and shadowing.
`static Border`	`createSoftBevelBorder(int type, Color highlightOuter, Color highlightInner, Color shadowOuter, Color shadowInner)` Creates a beveled border of the specified type with softened corners, using the specified colors for the inner and outer edges of the highlight and the shadow areas.
`static Border`	`createStrokeBorder(BasicStroke stroke)` Creates a border of the specified `stroke`.
`static Border`	`createStrokeBorder(BasicStroke stroke, Paint paint)` Creates a border of the specified `stroke` and `paint`.
`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).
`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).
`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).
`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).
`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.
`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).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - 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 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).
    
    Parameters:
    color - a Color to use for the line
    thickness - an integer specifying the width in pixels
    
    Returns:
    the Border object
  - createLineBorder
```
public static Border createLineBorder(Color color,
                      int thickness,
                      boolean rounded)
```
    Creates a line border with the specified color, thickness, and corner shape.
    
    Parameters:
    color - the color of the border
    thickness - the thickness of the border
    rounded - whether or not border corners should be round
    
    Returns:
    the Border object
    Since:
    
    1.7
    
    See Also:
    LineBorder.LineBorder(Color, int, boolean)
  - createRaisedBevelBorder
```
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.)
    
    Returns:
    the Border object
  - createLoweredBevelBorder
```
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.)
    
    Returns:
    the Border object
  - createBevelBorder
```
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.)
    
    Parameters:
    type - an integer specifying either BevelBorder.LOWERED or BevelBorder.RAISED
    
    Returns:
    the Border object
  - createBevelBorder
```
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.
    
    Parameters:
    type - an integer 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)
```
    Creates a beveled border of the specified type, using the specified colors for the inner and outer highlight and shadow areas.
    
    Parameters:
    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
    
    Returns:
    the Border object
  - createRaisedSoftBevelBorder
```
public static Border createRaisedSoftBevelBorder()
```
    Creates a beveled border with a raised edge and softened corners, 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
    Since:
    
    1.7
  - createLoweredSoftBevelBorder
```
public static Border createLoweredSoftBevelBorder()
```
    Creates a beveled border with a lowered edge and softened corners, 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
    Since:
    
    1.7
  - createSoftBevelBorder
```
public static Border createSoftBevelBorder(int type)
```
    Creates a beveled border of the specified type with softened corners, using brighter shades of the component's current background color for highlighting, and darker shading for shadows. The type is either BevelBorder.RAISED or BevelBorder.LOWERED.
    
    Parameters:
    type - a type of a bevel
    
    Returns:
    the Border object or null if the specified type is not valid
    Since:
    
    1.7
    
    See Also:
    BevelBorder.BevelBorder(int)
  - createSoftBevelBorder
```
public static Border createSoftBevelBorder(int type,
                           Color highlight,
                           Color shadow)
```
    Creates a beveled border of the specified type with softened corners, using the specified highlighting and shadowing. The type is either BevelBorder.RAISED or BevelBorder.LOWERED. The outer edge of the highlight area uses a brighter shade of the highlight color. The inner edge of the shadow area uses a brighter shade of the shadow color.
    
    Parameters:
    type - a type of a bevel
    highlight - a basic color of the highlight area
    shadow - a basic color of the shadow area
    
    Returns:
    the Border object
    Since:
    
    1.7
    
    See Also:
    BevelBorder.BevelBorder(int, Color, Color)
  - createSoftBevelBorder
```
public static Border createSoftBevelBorder(int type,
                           Color highlightOuter,
                           Color highlightInner,
                           Color shadowOuter,
                           Color shadowInner)
```
    Creates a beveled border of the specified type with softened corners, using the specified colors for the inner and outer edges of the highlight and the shadow areas. The type is either BevelBorder.RAISED or BevelBorder.LOWERED. Note: The shadow inner and outer colors are switched for a lowered bevel border.
    
    Parameters:
    type - a type of a bevel
    highlightOuter - a color of the outer edge of the highlight area
    highlightInner - a color of the inner edge of the highlight area
    shadowOuter - a color of the outer edge of the shadow area
    shadowInner - a color of the inner edge of the shadow area
    
    Returns:
    the Border object
    Since:
    
    1.7
    
    See Also:
    BevelBorder.BevelBorder(int, Color, Color, Color, Color)
  - createEtchedBorder
```
public static Border createEtchedBorder()
```
    Creates 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)
```
    Creates 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 type)
```
    Creates a border with an "etched" look using the component's current background color for highlighting and shading.
    
    Parameters:
    type - one of EtchedBorder.RAISED, or EtchedBorder.LOWERED
    
    Returns:
    the Border object
    
    Throws:
    
    IllegalArgumentException - if type is not either EtchedBorder.RAISED or EtchedBorder.LOWERED
    Since:
    
    1.3
  - createEtchedBorder
```
public static Border createEtchedBorder(int type,
                        Color highlight,
                        Color shadow)
```
    Creates a border with an "etched" look using the specified highlighting and shading colors.
    
    Parameters:
    type - one of EtchedBorder.RAISED, or EtchedBorder.LOWERED
    highlight - a Color object for the border highlights
    shadow - a Color object for the border shadows
    
    Returns:
    the Border object
    Since:
    
    1.3
  - createTitledBorder
```
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).
    
    Parameters:
    title - a String containing the text of the title
    
    Returns:
    the TitledBorder object
  - createTitledBorder
```
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).
    
    Parameters:
    border - the Border object to add the title to; if null the Border is determined by the current look and feel.
    
    Returns:
    the TitledBorder object
  - createTitledBorder
```
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).
    
    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)
```
    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).
    Parameters:
    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)
    Returns:
    the TitledBorder object
  - createTitledBorder
```
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).
    Parameters:
    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
    
    Returns:
    the TitledBorder object
  - createTitledBorder
```
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.
    Parameters:
    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
    
    Returns:
    the TitledBorder 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 space but which does no drawing, specifying the width of the top, left, bottom, and right sides.
    
    Parameters:
    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
    
    Returns:
    the Border object
  - createCompoundBorder
```
public static CompoundBorder createCompoundBorder()
```
    Creates 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)
```
    Creates 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
  - createMatteBorder
```
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.)
    
    Parameters:
    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
    
    Returns:
    the MatteBorder object
  - createMatteBorder
```
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.
    
    Parameters:
    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
    
    Returns:
    the MatteBorder object
  - createStrokeBorder
```
public static Border createStrokeBorder(BasicStroke stroke)
```
    Creates a border of the specified stroke. The component's foreground color will be used to render the border.
    
    Parameters:
    stroke - the BasicStroke object used to stroke a shape
    
    Returns:
    the Border object
    
    Throws:
    
    NullPointerException - if the specified stroke is null
    Since:
    
    1.7
  - createStrokeBorder
```
public static Border createStrokeBorder(BasicStroke stroke,
                        Paint paint)
```
    Creates a border of the specified stroke and paint. If the specified paint is null, the component's foreground color will be used to render the border.
    
    Parameters:
    stroke - the BasicStroke object used to stroke a shape
    paint - the Paint object used to generate a color
    
    Returns:
    the Border object
    
    Throws:
    
    NullPointerException - if the specified stroke is null
    Since:
    
    1.7
  - createDashedBorder
```
public static Border createDashedBorder(Paint paint)
```
    Creates a dashed border of the specified paint. If the specified paint is null, the component's foreground color will be used to render the border. The width of a dash line is equal to 1. The relative length of a dash line and the relative spacing between dash lines are equal to 1. A dash line is not rounded.
    
    Parameters:
    paint - the Paint object used to generate a color
    
    Returns:
    the Border object
    Since:
    
    1.7
  - createDashedBorder
```
public static Border createDashedBorder(Paint paint,
                        float length,
                        float spacing)
```
    Creates a dashed border of the specified paint, relative length, and relative spacing. If the specified paint is null, the component's foreground color will be used to render the border. The width of a dash line is equal to 1. A dash line is not rounded.
    
    Parameters:
    paint - the Paint object used to generate a color
    length - the relative length of a dash line
    spacing - the relative spacing between dash lines
    
    Returns:
    the Border object
    
    Throws:
    
    IllegalArgumentException - if the specified length is less than 1, or if the specified spacing is less than 0
    Since:
    
    1.7
  - createDashedBorder
```
public static Border createDashedBorder(Paint paint,
                        float thickness,
                        float length,
                        float spacing,
                        boolean rounded)
```
    Creates a dashed border of the specified paint, thickness, line shape, relative length, and relative spacing. If the specified paint is null, the component's foreground color will be used to render the border.
    
    Parameters:
    paint - the Paint object used to generate a color
    thickness - the width of a dash line
    length - the relative length of a dash line
    spacing - the relative spacing between dash lines
    rounded - whether or not line ends should be round
    
    Returns:
    the Border object
    
    Throws:
    
    IllegalArgumentException - if the specified thickness is less than 1, or if the specified length is less than 1, or if the specified spacing is less than 0
    Since:
    
    1.7

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.
DRAFT ea-b138

Class BorderFactory

Method Summary

Methods inherited from class java.lang.Object

Method Detail

createLineBorder

createLineBorder

createLineBorder

createRaisedBevelBorder

createLoweredBevelBorder

createBevelBorder

createBevelBorder

createBevelBorder

createRaisedSoftBevelBorder

createLoweredSoftBevelBorder

createSoftBevelBorder

createSoftBevelBorder

createSoftBevelBorder

createEtchedBorder

createEtchedBorder

createEtchedBorder

createEtchedBorder

createTitledBorder

createTitledBorder

createTitledBorder

createTitledBorder

createTitledBorder

createTitledBorder

createEmptyBorder

createEmptyBorder

createCompoundBorder

createCompoundBorder

createMatteBorder

createMatteBorder

createStrokeBorder

createStrokeBorder

createDashedBorder

createDashedBorder

createDashedBorder