diff options
Diffstat (limited to 'libjava/javax/swing/BorderFactory.java')
| -rw-r--r-- | libjava/javax/swing/BorderFactory.java | 674 |
1 files changed, 374 insertions, 300 deletions
diff --git a/libjava/javax/swing/BorderFactory.java b/libjava/javax/swing/BorderFactory.java index 808144f..1cc6cbf 100644 --- a/libjava/javax/swing/BorderFactory.java +++ b/libjava/javax/swing/BorderFactory.java @@ -38,332 +38,406 @@ exception statement from your version. */ package javax.swing; -import java.awt.*; -import java.awt.font.*; -import javax.swing.border.*; - +import java.awt.Color; +import java.awt.Font; +import javax.swing.border.BevelBorder; +import javax.swing.border.Border; +import javax.swing.border.CompoundBorder; +import javax.swing.border.EmptyBorder; +import javax.swing.border.EtchedBorder; +import javax.swing.border.LineBorder; +import javax.swing.border.MatteBorder; +import javax.swing.border.TitledBorder; public class BorderFactory { + /** + * Creates a line border withe the specified color. + * + * @param color A color to use for the line. + * + * @return The Border object + */ public static Border createLineBorder(Color color) - { /* - Creates a line border withe the specified color. - - Parameters: - color - a Color to use for the lineReturns: - the Border object -createLineBorder - */ - return null; - } - -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 linethickness - an int specifying the width in pixelsReturns: - the Border object -createRaisedBevelBorder - */ + { return null; } + /** + * 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). + * + * @param color A color to use for the line. + * @param thickness An int specifying the width in pixels. + * + * @return The Border object + */ + public static Border createLineBorder (Color color, int thickness) + { + return new LineBorder (color, thickness); + } -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 -createLoweredBevelBorder - - */ - return null; - } - -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 -createBevelBorder - - */ - return null; - } - -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.LOWEREDReturns: - the Border object -createBevelBorder - - */ - return null; - } - -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.LOWEREDhighlight - a Color object for highlightsshadow - a Color object for shadowsReturns: - the Border object -createBevelBorder - - */ - return null; - } - -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.LOWEREDhighlightOuter - 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 areaReturns: - the Border object -createEtchedBorder - */ - return null; - } - - -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 - - */ - return null; - } - -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 highlightsshadow - a Color object for the border shadowsReturns: - the Border object -createTitledBorder - - */ - return null; - } - - 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 titleReturns: - the TitledBorder object -createTitledBorder - - */ - return null; - } - - 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 toReturns: - the TitledBorder object -createTitledBorder - - */ - return null; - } - -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 totitle - a String containing the text of the titleReturns: - the TitledBorder object -createTitledBorder - - */ - return null; - } - -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 totitle - a String containing the text of the titletitleJustification - 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 - - */ - return null; - } - -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 totitle - a String containing the text of the titletitleJustification - 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 fontReturns: - the TitledBorder object -createTitledBorder - - */ - return null; - } - -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 totitle - a String containing the text of the titletitleJustification - 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 fonttitleColor - a Color object specifying the title colorReturns: - the TitledBorder object -createEmptyBorder - - */ - return null; - } - -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 - - */ - return null; - } - -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. + /** + * 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.) + * + * @return The Border object + */ + public static Border createRaisedBevelBorder () + { + return new BevelBorder (BevelBorder.RAISED); + } - Parameters: - top - an int specifying the width of the top in pixelsleft - an int specifying the width of the left side in pixelsbottom - an int specifying the width of the right side in pixelsright - an int specifying the width of the bottom in pixelsReturns: - the Border object -createCompoundBorder + /** + * 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.) + * + * @return The Border object + */ + public static Border createLoweredBevelBorder () + { + return new BevelBorder (BevelBorder.LOWERED); + } - */ - return null; - } + /** + * 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.). + * + * @param type An int specifying either BevelBorder.LOWERED or + * BevelBorder.RAISED + * + * @Return The Border object + */ + public static Border createBevelBorder (int type) + { + return new BevelBorder (type); + } -public static CompoundBorder createCompoundBorder() - { /* + /** + * 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. + * + * @param type An int specifying either BevelBorder.LOWERED or + * BevelBorder.RAISED + * @param highlight A Color object for highlights + * @param shadow A Color object for shadows + * + * @return The Border object + */ + public static Border createBevelBorder (int type, Color highlight, + Color shadow) + { + return new BevelBorder (type, highlight, shadow); + } - Create a compound border with a null inside edge and a null outside edge. + /** + * Create a beveled border of the specified type, using the specified colors + * for the inner and outer highlight and shadow areas. + * + * @param type An int specifying either BevelBorder.LOWERED or + * BevelBorder.RAISED + * @param highlightOuter A Color object for the outer edge of the + * highlight area + * @param highlightInner A Color object for the inner edge of the + * highlight area + * @param shadowOuter A Color object for the outer edge of the shadow area + * @param shadowInner A Color object for the inner edge of the shadow area + * + * @return The Border object + */ + public static Border createBevelBorder (int type, Color highlightOuter, + Color highlightInner, + Color shadowOuter, Color shadowInner) + { + return new BevelBorder (type, highlightOuter, highlightInner, shadowOuter, + shadowInner); + } - Returns: - the CompoundBorder object -createCompoundBorder - */ - return null; - } + /** + * Create 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 () + { + return new EtchedBorder (); + } + /** + * Create 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 (int etchType) + { + return new EtchedBorder (etchType); + } -public static CompoundBorder createCompoundBorder(Border outsideBorder, - Border insideBorder) - { /* + /** + * Create a border with an "etched" look using the specified highlighting and + * shading colors. + * + * @param highlight A Color object for the border highlights + * @param shadow A Color object for the border shadows + * + * @return The Border object + */ + public static Border createEtchedBorder (Color highlight, Color shadow) + { + return new EtchedBorder (highlight, shadow); + } - Create a compound border specifying the border objects to use for the outside and inside edges. + /** + * Create a border with an "etched" look using the specified highlighting and + * shading colors. + * + * @param highlight A Color object for the border highlights + * @param shadow A Color object for the border shadows + * + * @return The Border object + */ + public static Border createEtchedBorder (int etchType, Color highlight, + Color shadow) + { + return new EtchedBorder (etchType, highlight, shadow); + } - Parameters: - outsideBorder - a Border object for the outer edge of the compound borderinsideBorder - a Border object for the inner edge of the compound borderReturns: - the CompoundBorder object -createMatteBorder - */ - return null; - } + /** + * 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. + * + * @param title A String containing the text of the title + * + * @return The TitledBorder object + */ + public static TitledBorder createTitledBorder (String title) + { + return new TitledBorder (title); + } + /** + * 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.) + * + * @param border The Border object to add the title to + * + * @return The TitledBorder object + */ + public static TitledBorder createTitledBorder (Border border) + { + return new TitledBorder (border); + } -public static MatteBorder createMatteBorder(int top, - int left, - int bottom, - int right, - Color color) - { /* + /** + * 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. + * + * @param order The Border object to add the title to + * @param title A String containing the text of the title + * + * @return The TitledBorder object + */ + public static TitledBorder createTitledBorder (Border border, String title) + { + return new TitledBorder (border, title); + } - 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.) + /** + * 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. + * + * @param border The Border object to add the title to + * @param title A String containing the text of the title + * @param titleJustification An int specifying the left/right position of + * the title -- one of TitledBorder.LEFT, TitledBorder.CENTER, or + * TitledBorder.RIGHT, TitledBorder.DEFAULT_JUSTIFICATION (left). + * @param 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). + * + * @return The TitledBorder object + */ + public static TitledBorder createTitledBorder (Border border, String title, + int titleJustification, + int titlePosition) + { + return new TitledBorder (border, title, titleJustification, titlePosition); + } - Parameters: - top - an int specifying the width of the top in pixelsleft - an int specifying the width of the left side in pixelsbottom - an int specifying the width of the right side in pixelsright - an int specifying the width of the bottom in pixelscolor - a Color to use for the borderReturns: - the MatteBorder object -createMatteBorder + /** + * 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. + * + * @param border - the Border object to add the title to + * @param title - a String containing the text of the title + * @param titleJustification - an int specifying the left/right position of + * the title -- one of TitledBorder.LEFT, TitledBorder.CENTER, or + * TitledBorder.RIGHT, TitledBorder.DEFAULT_JUSTIFICATION (left). + * @param 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). + * @param 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) + { + return new TitledBorder (border, title, titleJustification, titlePosition, + titleFont); + } - */ - return null; - } + /** + * Add a title to an existing border, specifying the text of the title along + * with its positioning, font, and color. + * + * @param border - the Border object to add the title to + * @param title - a String containing the text of the title + * @param titleJustification - an int specifying the left/right position of + * the title -- one of TitledBorder.LEFT, TitledBorder.CENTER, or + * TitledBorder.RIGHT, TitledBorder.DEFAULT_JUSTIFICATION (left). + * @param 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). + * @param titleFont - a Font object specifying the title font + * @param titleColor - a Color object specifying the title color + * + * @return The TitledBorder object + */ + public static TitledBorder createTitledBorder (Border border, + String title, + int titleJustification, + int titlePosition, + Font titleFont, + Color titleColor) + { + return new TitledBorder (border, title, titleJustification, titlePosition, + titleFont, titleColor); + } -public static MatteBorder createMatteBorder(int top, - int left, - int bottom, - int right, - Icon tileIcon) - { /* + /** + * 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 () + { + return new EmptyBorder (0, 0, 0, 0); + } - 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. + /** + * 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. + * + * @param top An int specifying the width of the top in pixels + * @param left An int specifying the width of the left side in pixels + * @param bottom An int specifying the width of the right side in pixels + * @param right An int specifying the width of the bottom in pixels + * + * @return The Border object + */ + public static Border createEmptyBorder (int top, int left, int bottom, + int right) + { + return new EmptyBorder (top, left, bottom, right); + } - Note: - If the icon doesn't load, the border area is painted gray. + /** + * Create a compound border with a null inside edge and a null outside edge. + * + * @return The CompoundBorder object + */ + public static CompoundBorder createCompoundBorder () + { + return new CompoundBorder (); + } - Parameters: - top - an int specifying the width of the top in pixelsleft - an int specifying the width of the left side in pixelsbottom - an int specifying the width of the right side in pixelsright - an int specifying the width of the bottom in pixelstileIcon - the Icon object used for the border tilesReturns: - the MatteBorder object + /** + * Create a compound border specifying the border objects to use for the + * outside and inside edges. + * + * @param outsideBorder A Border object for the outer edge of the + * compound border + * @param insideBorder A Border object for the inner edge of the + * compound border + * + * @return The CompoundBorder object + */ + public static CompoundBorder createCompoundBorder (Border outsideBorder, + Border insideBorder) + { + return new CompoundBorder (outsideBorder, insideBorder); + } - */ - return null; - } + /** + * 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.) + * + * @param top An int specifying the width of the top in pixels + * @param left An int specifying the width of the left side in pixels + * @param bottom An int specifying the width of the right side in pixels + * @param right An int specifying the width of the bottom in pixels + * @param color A Color to use for the border + * + * @return The MatteBorder object + */ + public static MatteBorder createMatteBorder (int top, int left, int bottom, + int right, Color color) + { + return new MatteBorder (top, left, bottom, right, color); + } + /** + * 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. + * + * @param top An int specifying the width of the top in pixels + * @param left An int specifying the width of the left side in pixels + * @param bottom An int specifying the width of the right side in pixels + * @param right An int specifying the width of the bottom in pixels + * @param tileIcon The Icon object used for the border tiles + * + * @return The MatteBorder object + */ + public static MatteBorder createMatteBorder (int top, int left, int bottom, + int right, Icon tileIcon) + { + return new MatteBorder (top, left, bottom, right, tileIcon); + } } |