Class BorderFactory
java.lang.Object
javax.swing.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.- Since:
- 1.2
-
Method Summary
Modifier and TypeMethodDescriptionstatic BordercreateBevelBorder(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 BordercreateBevelBorder(int type, Color highlight, Color shadow) Creates 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) Creates a beveled border of the specified type, using the specified colors for the inner and outer highlight and shadow areas.static CompoundBorderCreates a compound border with anullinside edge and anulloutside edge.static CompoundBordercreateCompoundBorder(Border outsideBorder, Border insideBorder) Creates a compound border specifying the border objects to use for the outside and inside edges.static BordercreateDashedBorder(Paint paint) Creates a dashed border of the specifiedpaint.static BordercreateDashedBorder(Paint paint, float length, float spacing) Creates a dashed border of the specifiedpaint, relativelength, and relativespacing.static BordercreateDashedBorder(Paint paint, float thickness, float length, float spacing, boolean rounded) Creates a dashed border of the specifiedpaint,thickness, line shape, relativelength, and relativespacing.static BorderCreates 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 space but which does no drawing, specifying the width of the top, left, bottom, and right sides.static BorderCreates a border with an "etched" look using the component's current background color for highlighting and shading.static BordercreateEtchedBorder(int type) Creates a border with an "etched" look using the component's current background color for highlighting and shading.static BordercreateEtchedBorder(int type, Color highlight, Color shadow) Creates a border with an "etched" look using the specified highlighting and shading colors.static BordercreateEtchedBorder(Color highlight, Color shadow) Creates a border with an "etched" look using the specified highlighting and shading colors.static BordercreateLineBorder(Color color) Creates a line border with the specified color.static BordercreateLineBorder(Color color, int thickness) Creates a line border with the specified color and width.static BordercreateLineBorder(Color color, int thickness, boolean rounded) Creates a line border with the specified color, thickness, and corner shape.static BorderCreates 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 BorderCreates 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 MatteBordercreateMatteBorder(int top, int left, int bottom, int right, Color color) Creates a matte-look border using a solid color.static MatteBordercreateMatteBorder(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 BorderCreates 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 BorderCreates 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 BordercreateSoftBevelBorder(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 BordercreateSoftBevelBorder(int type, Color highlight, Color shadow) Creates a beveled border of the specified type with softened corners, using the specified highlighting and shadowing.static BordercreateSoftBevelBorder(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 BordercreateStrokeBorder(BasicStroke stroke) Creates a border of the specifiedstroke.static BordercreateStrokeBorder(BasicStroke stroke, Paint paint) Creates a border of the specifiedstrokeandpaint.static TitledBordercreateTitledBorder(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 (determined by the current look and feel), the default justification (leading), and the default font and text color (determined by the current look and feel).static TitledBordercreateTitledBorder(Border border) Creates a new titled border with an empty title, the specified border object, the default text position (determined by the current look and feel), the default justification (leading), and the default font and text color (determined by the current look and feel).static TitledBordercreateTitledBorder(Border border, String title) Adds a title to an existing border, with default positioning (determined by the current look and feel), default justification (leading) and the default font and text color (determined by the current look and feel).static TitledBordercreateTitledBorder(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 TitledBordercreateTitledBorder(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 TitledBordercreateTitledBorder(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.
-
Method Details
-
createLineBorder
-
createLineBorder
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, usecreateMatteBorder(int,int,int,int,Color).- Parameters:
color- aColorto use for the linethickness- an integer specifying the width in pixels- Returns:
- the
Borderobject
-
createLineBorder
Creates a line border with the specified color, thickness, and corner shape.- Parameters:
color- the color of the borderthickness- the thickness of the borderrounded- whether or not border corners should be round- Returns:
- the
Borderobject - Since:
- 1.7
- See Also:
-
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
Borderobject
-
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
Borderobject
-
createBevelBorder
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 eitherBevelBorder.LOWEREDorBevelBorder.RAISED- Returns:
- the
Borderobject
-
createBevelBorder
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 eitherBevelBorder.LOWEREDorBevelBorder.RAISEDhighlight- aColorobject for highlightsshadow- aColorobject for shadows- Returns:
- the
Borderobject
-
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 eitherBevelBorder.LOWEREDorBevelBorder.RAISEDhighlightOuter- aColorobject for the outer edge of the highlight areahighlightInner- aColorobject for the inner edge of the highlight areashadowOuter- aColorobject for the outer edge of the shadow areashadowInner- aColorobject for the inner edge of the shadow area- Returns:
- the
Borderobject
-
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
Borderobject - Since:
- 1.7
-
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
Borderobject - Since:
- 1.7
-
createSoftBevelBorder
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 eitherBevelBorder.RAISEDorBevelBorder.LOWERED.- Parameters:
type- a type of a bevel- Returns:
- the
Borderobject ornullif the specified type is not valid - Since:
- 1.7
- See Also:
-
createSoftBevelBorder
Creates a beveled border of the specified type with softened corners, using the specified highlighting and shadowing. The type is eitherBevelBorder.RAISEDorBevelBorder.LOWERED. The outer edge of the highlight area uses a brighter shade of thehighlightcolor. The inner edge of the shadow area uses a brighter shade of theshadowcolor.- Parameters:
type- a type of a bevelhighlight- a basic color of the highlight areashadow- a basic color of the shadow area- Returns:
- the
Borderobject - Since:
- 1.7
- See Also:
-
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 eitherBevelBorder.RAISEDorBevelBorder.LOWERED. Note: The shadow inner and outer colors are switched for a lowered bevel border.- Parameters:
type- a type of a bevelhighlightOuter- a color of the outer edge of the highlight areahighlightInner- a color of the inner edge of the highlight areashadowOuter- a color of the outer edge of the shadow areashadowInner- a color of the inner edge of the shadow area- Returns:
- the
Borderobject - Since:
- 1.7
- See Also:
-
createEtchedBorder
Creates a border with an "etched" look using the component's current background color for highlighting and shading.- Returns:
- the
Borderobject
-
createEtchedBorder
Creates a border with an "etched" look using the specified highlighting and shading colors.- Parameters:
highlight- aColorobject for the border highlightsshadow- aColorobject for the border shadows- Returns:
- the
Borderobject
-
createEtchedBorder
Creates a border with an "etched" look using the component's current background color for highlighting and shading.- Parameters:
type- one ofEtchedBorder.RAISED, orEtchedBorder.LOWERED- Returns:
- the
Borderobject - Throws:
IllegalArgumentException- if type is not eitherEtchedBorder.RAISEDorEtchedBorder.LOWERED- Since:
- 1.3
-
createEtchedBorder
Creates a border with an "etched" look using the specified highlighting and shading colors.- Parameters:
type- one ofEtchedBorder.RAISED, orEtchedBorder.LOWEREDhighlight- aColorobject for the border highlightsshadow- aColorobject for the border shadows- Returns:
- the
Borderobject - Since:
- 1.3
-
createTitledBorder
Creates a new titled border with the specified title, the default border type (determined by the current look and feel), the default text position (determined by the current look and feel), the default justification (leading), and the default font and text color (determined by the current look and feel).- Parameters:
title- aStringcontaining the text of the title- Returns:
- the
TitledBorderobject
-
createTitledBorder
Creates a new titled border with an empty title, the specified border object, the default text position (determined by the current look and feel), the default justification (leading), and the default font and text color (determined by the current look and feel).- Parameters:
border- theBorderobject to add the title to; ifnulltheBorderis determined by the current look and feel.- Returns:
- the
TitledBorderobject
-
createTitledBorder
Adds a title to an existing border, with default positioning (determined by the current look and feel), default justification (leading) and the default font and text color (determined by the current look and feel).- Parameters:
border- theBorderobject to add the title totitle- aStringcontaining the text of the title- Returns:
- the
TitledBorderobject
-
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- theBorderobject to add the title totitle- aStringcontaining the text of the titletitleJustification- an integer specifying the justification of the title -- one of the following:TitledBorder.LEFTTitledBorder.CENTERTitledBorder.RIGHTTitledBorder.LEADINGTitledBorder.TRAILINGTitledBorder.DEFAULT_JUSTIFICATION(leading)
titlePosition- an integer specifying the vertical position of the text in relation to the border -- one of the following:TitledBorder.ABOVE_TOPTitledBorder.TOP(sitting on the top line)TitledBorder.BELOW_TOPTitledBorder.ABOVE_BOTTOMTitledBorder.BOTTOM(sitting on the bottom line)TitledBorder.BELOW_BOTTOMTitledBorder.DEFAULT_POSITION(the title position is determined by the current look and feel)
- Returns:
- the
TitledBorderobject
-
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- theBorderobject to add the title totitle- aStringcontaining the text of the titletitleJustification- an integer specifying the justification of the title -- one of the following:TitledBorder.LEFTTitledBorder.CENTERTitledBorder.RIGHTTitledBorder.LEADINGTitledBorder.TRAILINGTitledBorder.DEFAULT_JUSTIFICATION(leading)
titlePosition- an integer specifying the vertical position of the text in relation to the border -- one of the following:TitledBorder.ABOVE_TOPTitledBorder.TOP(sitting on the top line)TitledBorder.BELOW_TOPTitledBorder.ABOVE_BOTTOMTitledBorder.BOTTOM(sitting on the bottom line)TitledBorder.BELOW_BOTTOMTitledBorder.DEFAULT_POSITION(the title position is determined by the current look and feel)
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- theBorderobject to add the title totitle- aStringcontaining the text of the titletitleJustification- an integer specifying the justification of the title -- one of the following:TitledBorder.LEFTTitledBorder.CENTERTitledBorder.RIGHTTitledBorder.LEADINGTitledBorder.TRAILINGTitledBorder.DEFAULT_JUSTIFICATION(leading)
titlePosition- an integer specifying the vertical position of the text in relation to the border -- one of the following:TitledBorder.ABOVE_TOPTitledBorder.TOP(sitting on the top line)TitledBorder.BELOW_TOPTitledBorder.ABOVE_BOTTOMTitledBorder.BOTTOM(sitting on the bottom line)TitledBorder.BELOW_BOTTOMTitledBorder.DEFAULT_POSITION(the title position is determined by the current look and feel)
titleFont- aFontobject specifying the title fonttitleColor- aColorobject specifying the title color- Returns:
- the
TitledBorderobject
-
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
Borderobject
-
createEmptyBorder
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
Borderobject
-
createCompoundBorder
Creates a compound border with anullinside edge and anulloutside edge.- Returns:
- the
CompoundBorderobject
-
createCompoundBorder
Creates a compound border specifying the border objects to use for the outside and inside edges.- Parameters:
outsideBorder- aBorderobject for the outer edge of the compound borderinsideBorder- aBorderobject for the inner edge of the compound border- Returns:
- the
CompoundBorderobject
-
createMatteBorder
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- aColorto use for the border- Returns:
- the
MatteBorderobject
-
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- theIconobject used for the border tiles- Returns:
- the
MatteBorderobject
-
createStrokeBorder
Creates a border of the specifiedstroke. The component's foreground color will be used to render the border.- Parameters:
stroke- theBasicStrokeobject used to stroke a shape- Returns:
- the
Borderobject - Throws:
NullPointerException- if the specifiedstrokeisnull- Since:
- 1.7
-
createStrokeBorder
Creates a border of the specifiedstrokeandpaint. If the specifiedpaintisnull, the component's foreground color will be used to render the border.- Parameters:
stroke- theBasicStrokeobject used to stroke a shapepaint- thePaintobject used to generate a color- Returns:
- the
Borderobject - Throws:
NullPointerException- if the specifiedstrokeisnull- Since:
- 1.7
-
createDashedBorder
Creates a dashed border of the specifiedpaint. If the specifiedpaintisnull, the component's foreground color will be used to render the border. The width of a dash line is equal to1. The relative length of a dash line and the relative spacing between dash lines are equal to1. A dash line is not rounded.- Parameters:
paint- thePaintobject used to generate a color- Returns:
- the
Borderobject - Since:
- 1.7
-
createDashedBorder
Creates a dashed border of the specifiedpaint, relativelength, and relativespacing. If the specifiedpaintisnull, the component's foreground color will be used to render the border. The width of a dash line is equal to1. A dash line is not rounded.- Parameters:
paint- thePaintobject used to generate a colorlength- the relative length of a dash linespacing- the relative spacing between dash lines- Returns:
- the
Borderobject - Throws:
IllegalArgumentException- if the specifiedlengthis less than1, or if the specifiedspacingis less than0- Since:
- 1.7
-
createDashedBorder
public static Border createDashedBorder(Paint paint, float thickness, float length, float spacing, boolean rounded) Creates a dashed border of the specifiedpaint,thickness, line shape, relativelength, and relativespacing. If the specifiedpaintisnull, the component's foreground color will be used to render the border.- Parameters:
paint- thePaintobject used to generate a colorthickness- the width of a dash linelength- the relative length of a dash linespacing- the relative spacing between dash linesrounded- whether or not line ends should be round- Returns:
- the
Borderobject - Throws:
IllegalArgumentException- if the specifiedthicknessis less than1, or if the specifiedlengthis less than1, or if the specifiedspacingis less than0- Since:
- 1.7
-