Java Platform 1.2
Beta 4

Class com.sun.java.swing.border.TitledBorder

java.lang.Object
  |
  +--com.sun.java.swing.border.AbstractBorder
        |
        +--com.sun.java.swing.border.TitledBorder
Direct Known Subclasses:
BorderUIResource.TitledBorderUIResource

public class TitledBorder
extends AbstractBorder
A class which implements an arbitrary border with the addition of a String title in a specified position and justification.

Warning: serialized objects of this class will not be compatible with future swing releases. The current serialization support is appropriate for short term storage or RMI between Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.

See Also:
Serialized Form

Field Summary
static int ABOVE_BOTTOM
           
static int ABOVE_TOP
           
static int BELOW_BOTTOM
           
static int BELOW_TOP
           
protected  Border border
           
static int BOTTOM
           
static int CENTER
           
static int DEFAULT_JUSTIFICATION
           
static int DEFAULT_POSITION
           
protected static int EDGE_SPACING
           
static int LEFT
           
static int RIGHT
           
protected static int TEXT_INSET_H
           
protected static int TEXT_SPACING
           
protected  String title
           
protected  Color titleColor
           
protected  Font titleFont
           
protected  int titleJustification
           
protected  int titlePosition
           
static int TOP
           
 
Constructor Summary
TitledBorder(Border border, String title, int titleJustification, int titlePosition, Font titleFont, Color titleColor)
          Creates a TitledBorder instance with the specified border, title, title-justification, title-position, title-font, and title-color.
TitledBorder(Border border, String title, int titleJustification, int titlePosition, Font titleFont)
          Creates a TitledBorder instance with the specified border, title, title-justification, title-position, and title-font.
TitledBorder(Border border, String title, int titleJustification, int titlePosition)
          Creates a TitledBorder instance with the specified border, title, title-justification, and title-position.
TitledBorder(Border border, String title)
          Creates a TitledBorder instance with the specified border and title.
TitledBorder(Border border)
          Creates a TitledBorder instance with the specified border and an empty title.
TitledBorder(String title)
          Creates a TitledBorder instance which uses an etched border.
 
Method Summary
 Border getBorder()
          Returns the border of the titled border.
 Insets getBorderInsets(Component c, Insets insets)
          Reinitialize the insets parameter with this Border's current Insets.
 Insets getBorderInsets(Component c)
          Returns the insets of the border.
protected  Font getFont(Component c)
           
 Dimension getMinimumSize(Component c)
          Returns the minimum dimensions this border requires in order to fully display the border and title.
 String getTitle()
          Returns the title of the titled border.
 Color getTitleColor()
          Returns the title-color of the titled border.
 Font getTitleFont()
          Returns the title-font of the titled border.
 int getTitleJustification()
          Returns the title-justification of the titled border.
 int getTitlePosition()
          Returns the title-position of the titled border.
 boolean isBorderOpaque()
          Returns whether or not the border is opaque.
 void paintBorder(Component c, Graphics g, int x, int y, int width, int height)
          Paints the border for the specified component with the specified position and size.
 void setBorder(Border border)
          Sets the border of the titled border.
 void setTitle(String title)
          Sets the title of the titled border. param title the title for the border
 void setTitleColor(Color titleColor)
          Sets the title-color of the titled border.
 void setTitleFont(Font titleFont)
          Sets the title-font of the titled border.
 void setTitleJustification(int titleJustification)
          Sets the title-justification of the titled border.
 void setTitlePosition(int titlePosition)
          Sets the title-position of the titled border.
 
Methods inherited from class com.sun.java.swing.border.AbstractBorder
getInteriorRectangle , getInteriorRectangle
 
Methods inherited from class java.lang.Object
clone , equals , finalize , getClass , hashCode , notify , notifyAll , toString , wait , wait , wait
 

Field Detail

title

protected String title

border

protected Border border

titlePosition

protected int titlePosition

titleJustification

protected int titleJustification

titleFont

protected Font titleFont

titleColor

protected Color titleColor

DEFAULT_POSITION

public static final int DEFAULT_POSITION

ABOVE_TOP

public static final int ABOVE_TOP

TOP

public static final int TOP

BELOW_TOP

public static final int BELOW_TOP

ABOVE_BOTTOM

public static final int ABOVE_BOTTOM

BOTTOM

public static final int BOTTOM

BELOW_BOTTOM

public static final int BELOW_BOTTOM

DEFAULT_JUSTIFICATION

public static final int DEFAULT_JUSTIFICATION

LEFT

public static final int LEFT

CENTER

public static final int CENTER

RIGHT

public static final int RIGHT

EDGE_SPACING

protected static final int EDGE_SPACING

TEXT_SPACING

protected static final int TEXT_SPACING

TEXT_INSET_H

protected static final int TEXT_INSET_H
Constructor Detail

TitledBorder

public TitledBorder(String title)
Creates a TitledBorder instance which uses an etched border.
Parameters:
title - the title the border should display

TitledBorder

public TitledBorder(Border border)
Creates a TitledBorder instance with the specified border and an empty title.
Parameters:
border - the border

TitledBorder

public TitledBorder(Border border,
                    String title)
Creates a TitledBorder instance with the specified border and title.
Parameters:
border - the border
title - the title the border should display

TitledBorder

public TitledBorder(Border border,
                    String title,
                    int titleJustification,
                    int titlePosition)
Creates a TitledBorder instance with the specified border, title, title-justification, and title-position.
Parameters:
border - the border
title - the title the border should display
titleJustification - the justification for the title
titlePosition - the position for the title

TitledBorder

public TitledBorder(Border border,
                    String title,
                    int titleJustification,
                    int titlePosition,
                    Font titleFont)
Creates a TitledBorder instance with the specified border, title, title-justification, title-position, and title-font.
Parameters:
border - the border
title - the title the border should display
titleJustification - the justification for the title
titlePosition - the position for the title
titleFont - the font for rendering the title

TitledBorder

public TitledBorder(Border border,
                    String title,
                    int titleJustification,
                    int titlePosition,
                    Font titleFont,
                    Color titleColor)
Creates a TitledBorder instance with the specified border, title, title-justification, title-position, title-font, and title-color.
Parameters:
border - the border
title - the title the border should display
titleJustification - the justification for the title
titlePosition - the position for the title
titleFont - the font of the title
titleColor - the color of the title
Method Detail

paintBorder

public void paintBorder(Component c,
                        Graphics g,
                        int x,
                        int y,
                        int width,
                        int height)
Paints the border for the specified component with the specified position and size.
Parameters:
c - the component for which this border is being painted
g - the paint graphics
x - the x position of the painted border
y - the y position of the painted border
width - the width of the painted border
height - the height of the painted border
Overrides:
paintBorder in class AbstractBorder

getBorderInsets

public Insets getBorderInsets(Component c)
Returns the insets of the border.
Parameters:
c - the component for which this border insets value applies
Overrides:
getBorderInsets in class AbstractBorder

getBorderInsets

public Insets getBorderInsets(Component c,
                              Insets insets)
Reinitialize the insets parameter with this Border's current Insets.
Parameters:
c - the component for which this border insets value applies
insets - the object to be reinitialized
Overrides:
getBorderInsets in class AbstractBorder

isBorderOpaque

public boolean isBorderOpaque()
Returns whether or not the border is opaque.
Overrides:
isBorderOpaque in class AbstractBorder

getTitle

public String getTitle()
Returns the title of the titled border.

getBorder

public Border getBorder()
Returns the border of the titled border.

getTitlePosition

public int getTitlePosition()
Returns the title-position of the titled border.

getTitleJustification

public int getTitleJustification()
Returns the title-justification of the titled border.

getTitleFont

public Font getTitleFont()
Returns the title-font of the titled border.

getTitleColor

public Color getTitleColor()
Returns the title-color of the titled border.

setTitle

public void setTitle(String title)
Sets the title of the titled border. param title the title for the border

setBorder

public void setBorder(Border border)
Sets the border of the titled border.
Parameters:
border - the border

setTitlePosition

public void setTitlePosition(int titlePosition)
Sets the title-position of the titled border.
Parameters:
titlePosition - the position for the border

setTitleJustification

public void setTitleJustification(int titleJustification)
Sets the title-justification of the titled border.
Parameters:
titleJustification - the justification for the border

setTitleFont

public void setTitleFont(Font titleFont)
Sets the title-font of the titled border.
Parameters:
titleFont - the font for the border title

setTitleColor

public void setTitleColor(Color titleColor)
Sets the title-color of the titled border.
Parameters:
titleColor - the color for the border title

getMinimumSize

public Dimension getMinimumSize(Component c)
Returns the minimum dimensions this border requires in order to fully display the border and title.
Parameters:
c - the component where this border will be drawn

getFont

protected Font getFont(Component c)

Java Platform 1.2
Beta 4

Submit a bug or feature
Submit comments/suggestions about new javadoc look
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.
Copyright 1993-1998 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.
This documentation was generated with a post-Beta4 version of Javadoc.