|
JavaTM 2 Platform Standard Ed. 5.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.swing.BorderFactory
public class BorderFactory
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 | |
---|---|
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 |
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 |
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 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 TitledBorder |
createTitledBorder(Border border)
Creates 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 (leading) and using the default font, and text color. |
static TitledBorder |
createTitledBorder(Border border,
String title)
Adds a title to an existing border, specifying the text of the title, using the default positioning (sitting on the top line) and default justification (leading) 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)
Adds 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)
Adds 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)
Adds a title to an existing border, specifying the text of the title along with its positioning, font, and color. |
static TitledBorder |
createTitledBorder(String title)
Creates 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 (leading) and using 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 |
---|
public static Border createLineBorder(Color color)
color
- a Color
to use for the line
Border
objectpublic static Border createLineBorder(Color color, int thickness)
createMatteBorder(int,int,int,int,Color)
.
color
- a Color
to use for the linethickness
- an integer specifying the width in pixels
Border
objectpublic static Border createRaisedBevelBorder()
Border
objectpublic static Border createLoweredBevelBorder()
Border
objectpublic static Border createBevelBorder(int type)
type
- an integer specifying either
BevelBorder.LOWERED
or
BevelBorder.RAISED
Border
objectpublic static Border createBevelBorder(int type, Color highlight, Color shadow)
type
- an integer specifying either
BevelBorder.LOWERED
or
BevelBorder.RAISED
highlight
- a Color
object for highlightsshadow
- a Color
object for shadows
Border
objectpublic static Border createBevelBorder(int type, Color highlightOuter, Color highlightInner, Color shadowOuter, Color shadowInner)
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 areahighlightInner
- a Color
object for the
inner edge of the highlight areashadowOuter
- a Color
object for the
outer edge of the shadow areashadowInner
- a Color
object for the
inner edge of the shadow area
Border
objectpublic static Border createEtchedBorder()
Border
objectpublic static Border createEtchedBorder(Color highlight, Color shadow)
highlight
- a Color
object for the border highlightsshadow
- a Color
object for the border shadows
Border
objectpublic static Border createEtchedBorder(int type)
type
- one of EtchedBorder.RAISED
, or
EtchedBorder.LOWERED
Border
object
IllegalArgumentException
- if type is not either
EtchedBorder.RAISED
or
EtchedBorder.LOWERED
public static Border createEtchedBorder(int type, Color highlight, Color shadow)
type
- one of EtchedBorder.RAISED
, or
EtchedBorder.LOWERED
highlight
- a Color
object for the border highlightsshadow
- a Color
object for the border shadows
Border
objectpublic static TitledBorder createTitledBorder(String title)
title
- a String
containing the text of the title
TitledBorder
objectpublic static TitledBorder createTitledBorder(Border border)
border
- the Border
object to add the title to, if
null the Border
is determined by the
current look and feel.
TitledBorder
objectpublic static TitledBorder createTitledBorder(Border border, String title)
border
- the Border
object to add the title totitle
- a String
containing the text of the title
TitledBorder
objectpublic static TitledBorder createTitledBorder(Border border, String title, int titleJustification, int titlePosition)
border
- the Border
object to add the title totitle
- a String
containing the text of the titletitleJustification
- 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, 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 totitle
- a String
containing the text of the titletitleJustification
- 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, specifying the text of
the title along with its positioning, font, and color.
- Parameters:
border
- the Border
object to add the title totitle
- a String
containing the text of the titletitleJustification
- 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 pixelsleft
- an integer specifying the width of the left side,
in pixelsbottom
- an integer specifying the width of the bottom,
in pixelsright
- 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 borderinsideBorder
- 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 pixelsleft
- an integer specifying the width of the left side,
in pixelsbottom
- an integer specifying the width of the right side,
in pixelsright
- an integer specifying the width of the bottom,
in pixelscolor
- 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 pixelsleft
- an integer specifying the width of the left side,
in pixelsbottom
- an integer specifying the width of the right side,
in pixelsright
- an integer specifying the width of the bottom,
in pixelstileIcon
- the Icon
object used for the border tiles
- Returns:
- the
MatteBorder
object
Overview
Package
Class
Use
Tree
Deprecated
Index
Help
JavaTM 2 Platform
Standard Ed. 5.0
PREV CLASS
NEXT CLASS
FRAMES
NO FRAMES
All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD
DETAIL: FIELD | CONSTR | METHOD
Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples. Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.