Home » openjdk-7 » javax » swing » border » [javadoc | source]
javax.swing.border
public class: TitledBorder [javadoc | source]
java.lang.Object
   javax.swing.border.AbstractBorder
      javax.swing.border.TitledBorder

All Implemented Interfaces:
    Border, Serializable

Direct Known Subclasses:
    TitledBorderUIResource

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

If the border, font, or color property values are not specified in the constuctor or by invoking the appropriate set methods, the property values will be defined by the current look and feel, using the following property names in the Defaults Table:

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 applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeansTM has been added to the java.beans package. Please see java.beans.XMLEncoder .

Field Summary
protected  String title     
protected  Border border     
protected  int titlePosition     
protected  int titleJustification     
protected  Font titleFont     
protected  Color titleColor     
public static final  int DEFAULT_POSITION    Use the default vertical orientation for the title text. 
public static final  int ABOVE_TOP    Position the title above the border's top line. 
public static final  int TOP    Position the title in the middle of the border's top line. 
public static final  int BELOW_TOP    Position the title below the border's top line. 
public static final  int ABOVE_BOTTOM    Position the title above the border's bottom line. 
public static final  int BOTTOM    Position the title in the middle of the border's bottom line. 
public static final  int BELOW_BOTTOM    Position the title below the border's bottom line. 
public static final  int DEFAULT_JUSTIFICATION    Use the default justification for the title text. 
public static final  int LEFT    Position title text at the left side of the border line. 
public static final  int CENTER    Position title text in the center of the border line. 
public static final  int RIGHT    Position title text at the right side of the border line. 
public static final  int LEADING    Position title text at the left side of the border line for left to right orientation, at the right side of the border line for right to left orientation. 
public static final  int TRAILING    Position title text at the right side of the border line for left to right orientation, at the left side of the border line for right to left orientation. 
protected static final  int EDGE_SPACING     
protected static final  int TEXT_SPACING     
protected static final  int TEXT_INSET_H     
Constructor:
 public TitledBorder(String title) 
    Creates a TitledBorder instance.
    Parameters:
    title - the title the border should display
 public TitledBorder(Border border) 
    Creates a TitledBorder instance with the specified border and an empty title.
    Parameters:
    border - the border
 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
 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
 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
 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 from javax.swing.border.TitledBorder Summary:
getBaseline,   getBaselineResizeBehavior,   getBorder,   getBorderInsets,   getFont,   getMinimumSize,   getTitle,   getTitleColor,   getTitleFont,   getTitleJustification,   getTitlePosition,   isBorderOpaque,   paintBorder,   setBorder,   setTitle,   setTitleColor,   setTitleFont,   setTitleJustification,   setTitlePosition
Methods from javax.swing.border.AbstractBorder:
getBaseline,   getBaselineResizeBehavior,   getBorderInsets,   getBorderInsets,   getInteriorRectangle,   getInteriorRectangle,   isBorderOpaque,   isLeftToRight,   paintBorder
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.swing.border.TitledBorder Detail:
 public int getBaseline(Component c,
    int width,
    int height) 
    Returns the baseline.
 public BaselineResizeBehavior getBaselineResizeBehavior(Component c) 
    Returns an enum indicating how the baseline of the border changes as the size changes.
 public Border getBorder() 
    Returns the border of the titled border.
 public Insets getBorderInsets(Component c,
    Insets insets) 
    Reinitialize the insets parameter with this Border's current Insets.
 protected Font getFont(Component c) 
 public Dimension getMinimumSize(Component c) 
    Returns the minimum dimensions this border requires in order to fully display the border and title.
 public String getTitle() 
    Returns the title of the titled border.
 public Color getTitleColor() 
    Returns the title-color of the titled border.
 public Font getTitleFont() 
    Returns the title-font of the titled border.
 public int getTitleJustification() 
    Returns the title-justification of the titled border.
 public int getTitlePosition() 
    Returns the title-position of the titled border.
 public boolean isBorderOpaque() 
    Returns whether or not the border is opaque.
 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.
 public  void setBorder(Border border) 
    Sets the border of the titled border.
 public  void setTitle(String title) 
    Sets the title of the titled border.
 public  void setTitleColor(Color titleColor) 
    Sets the title-color of the titled border.
 public  void setTitleFont(Font titleFont) 
    Sets the title-font of the titled border.
 public  void setTitleJustification(int titleJustification) 
    Sets the title-justification of the titled border.
 public  void setTitlePosition(int titlePosition) 
    Sets the title-position of the titled border.