- java.lang.Object
-
- javax.swing.border.AbstractBorder
-
- javax.swing.border.TitledBorder
-
- All Implemented Interfaces:
Serializable,Border
- 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.If the border, font, or color property values are not specified in the constructor 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:
- "TitledBorder.border"
- "TitledBorder.font"
- "TitledBorder.titleColor"
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 JavaBeans™ has been added to the
java.beanspackage. Please seeXMLEncoder.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static intABOVE_BOTTOMPosition the title above the border's bottom line.static intABOVE_TOPPosition the title above the border's top line.static intBELOW_BOTTOMPosition the title below the border's bottom line.static intBELOW_TOPPosition the title below the border's top line.protected BorderborderThe border.static intBOTTOMPosition the title in the middle of the border's bottom line.static intCENTERPosition title text in the center of the border line.static intDEFAULT_JUSTIFICATIONUse the default justification for the title text.static intDEFAULT_POSITIONUse the default vertical orientation for the title text.protected static intEDGE_SPACINGSpace between the border and the component's edgestatic intLEADINGPosition 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.static intLEFTPosition title text at the left side of the border line.static intRIGHTPosition title text at the right side of the border line.protected static intTEXT_INSET_HHorizontal inset of text that is left or right justifiedprotected static intTEXT_SPACINGSpace between the border and textprotected StringtitleThe title the border should display.protected ColortitleColorThe color of the title.protected FonttitleFontThe font for rendering the title.protected inttitleJustificationThe justification for the title.protected inttitlePositionThe position for the title.static intTOPPosition the title in the middle of the border's top line.static intTRAILINGPosition 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.
-
Constructor Summary
Constructors Constructor Description TitledBorder(String title)Creates a TitledBorder instance.TitledBorder(Border border)Creates a TitledBorder instance with the specified border and an empty title.TitledBorder(Border border, String title)Creates a TitledBorder instance with the specified border and title.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, 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, Font titleFont, Color titleColor)Creates a TitledBorder instance with the specified border, title, title-justification, title-position, title-font, and title-color.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intgetBaseline(Component c, int width, int height)Returns the baseline.Component.BaselineResizeBehaviorgetBaselineResizeBehavior(Component c)Returns an enum indicating how the baseline of the border changes as the size changes.BordergetBorder()Returns the border of the titled border.InsetsgetBorderInsets(Component c, Insets insets)Reinitialize the insets parameter with this Border's current Insets.protected FontgetFont(Component c)Returns default font of the titled border.DimensiongetMinimumSize(Component c)Returns the minimum dimensions this border requires in order to fully display the border and title.StringgetTitle()Returns the title of the titled border.ColorgetTitleColor()Returns the title-color of the titled border.FontgetTitleFont()Returns the title-font of the titled border.intgetTitleJustification()Returns the title-justification of the titled border.intgetTitlePosition()Returns the title-position of the titled border.booleanisBorderOpaque()Returns whether or not the border is opaque.voidpaintBorder(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.voidsetBorder(Border border)Sets the border of the titled border.voidsetTitle(String title)Sets the title of the titled border.voidsetTitleColor(Color titleColor)Sets the title-color of the titled border.voidsetTitleFont(Font titleFont)Sets the title-font of the titled border.voidsetTitleJustification(int titleJustification)Sets the title-justification of the titled border.voidsetTitlePosition(int titlePosition)Sets the title-position of the titled border.-
Methods declared in class javax.swing.border.AbstractBorder
getBorderInsets, getInteriorRectangle, getInteriorRectangle
-
-
-
-
Field Detail
-
title
protected String title
The title the border should display.
-
border
protected Border border
The border.
-
titlePosition
protected int titlePosition
The position for the title.
-
titleJustification
protected int titleJustification
The justification for the title.
-
titleFont
protected Font titleFont
The font for rendering the title.
-
titleColor
protected Color titleColor
The color of the title.
-
DEFAULT_POSITION
public static final int DEFAULT_POSITION
Use the default vertical orientation for the title text.- See Also:
- Constant Field Values
-
ABOVE_TOP
public static final int ABOVE_TOP
Position the title above the border's top line.- See Also:
- Constant Field Values
-
TOP
public static final int TOP
Position the title in the middle of the border's top line.- See Also:
- Constant Field Values
-
BELOW_TOP
public static final int BELOW_TOP
Position the title below the border's top line.- See Also:
- Constant Field Values
-
ABOVE_BOTTOM
public static final int ABOVE_BOTTOM
Position the title above the border's bottom line.- See Also:
- Constant Field Values
-
BOTTOM
public static final int BOTTOM
Position the title in the middle of the border's bottom line.- See Also:
- Constant Field Values
-
BELOW_BOTTOM
public static final int BELOW_BOTTOM
Position the title below the border's bottom line.- See Also:
- Constant Field Values
-
DEFAULT_JUSTIFICATION
public static final int DEFAULT_JUSTIFICATION
Use the default justification for the title text.- See Also:
- Constant Field Values
-
LEFT
public static final int LEFT
Position title text at the left side of the border line.- See Also:
- Constant Field Values
-
CENTER
public static final int CENTER
Position title text in the center of the border line.- See Also:
- Constant Field Values
-
RIGHT
public static final int RIGHT
Position title text at the right side of the border line.- See Also:
- Constant Field Values
-
LEADING
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.- See Also:
- Constant Field Values
-
TRAILING
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.- See Also:
- Constant Field Values
-
EDGE_SPACING
protected static final int EDGE_SPACING
Space between the border and the component's edge- See Also:
- Constant Field Values
-
TEXT_SPACING
protected static final int TEXT_SPACING
Space between the border and text- See Also:
- Constant Field Values
-
TEXT_INSET_H
protected static final int TEXT_INSET_H
Horizontal inset of text that is left or right justified- See Also:
- Constant Field Values
-
-
Constructor Detail
-
TitledBorder
public TitledBorder(String title)
Creates a TitledBorder instance.- 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 bordertitle- 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 bordertitle- the title the border should displaytitleJustification- the justification for the titletitlePosition- 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 bordertitle- the title the border should displaytitleJustification- the justification for the titletitlePosition- the position for the titletitleFont- the font for rendering the title
-
TitledBorder
@ConstructorProperties({"border","title","titleJustification","titlePosition","titleFont","titleColor"}) 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 bordertitle- the title the border should displaytitleJustification- the justification for the titletitlePosition- the position for the titletitleFont- the font of the titletitleColor- 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.- Specified by:
paintBorderin interfaceBorder- Overrides:
paintBorderin classAbstractBorder- Parameters:
c- the component for which this border is being paintedg- the paint graphicsx- the x position of the painted bordery- the y position of the painted borderwidth- the width of the painted borderheight- the height of the painted border
-
getBorderInsets
public Insets getBorderInsets(Component c, Insets insets)
Reinitialize the insets parameter with this Border's current Insets.- Overrides:
getBorderInsetsin classAbstractBorder- Parameters:
c- the component for which this border insets value appliesinsets- the object to be reinitialized- Returns:
- the
insetsobject
-
isBorderOpaque
public boolean isBorderOpaque()
Returns whether or not the border is opaque.- Specified by:
isBorderOpaquein interfaceBorder- Overrides:
isBorderOpaquein classAbstractBorder- Returns:
- false
-
getTitle
public String getTitle()
Returns the title of the titled border.- Returns:
- the title of the titled border
-
getBorder
public Border getBorder()
Returns the border of the titled border.- Returns:
- the border of the titled border
-
getTitlePosition
public int getTitlePosition()
Returns the title-position of the titled border.- Returns:
- the title-position of the titled border
-
getTitleJustification
public int getTitleJustification()
Returns the title-justification of the titled border.- Returns:
- the title-justification of the titled border
-
getTitleFont
public Font getTitleFont()
Returns the title-font of the titled border.- Returns:
- the title-font of the titled border
-
getTitleColor
public Color getTitleColor()
Returns the title-color of the titled border.- Returns:
- the title-color of the titled border
-
setTitle
public void setTitle(String title)
Sets the title of the titled border.- Parameters:
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- Returns:
- the
Dimensionobject
-
getBaseline
public int getBaseline(Component c, int width, int height)
Returns the baseline.- Overrides:
getBaselinein classAbstractBorder- Parameters:
c-Componentbaseline is being requested forwidth- the width to get the baseline forheight- the height to get the baseline for- Returns:
- the baseline or < 0 indicating there is no reasonable baseline
- Throws:
NullPointerExceptionIllegalArgumentException- if width or height is < 0- Since:
- 1.6
- See Also:
JComponent.getBaseline(int, int)
-
getBaselineResizeBehavior
public Component.BaselineResizeBehavior getBaselineResizeBehavior(Component c)
Returns an enum indicating how the baseline of the border changes as the size changes.- Overrides:
getBaselineResizeBehaviorin classAbstractBorder- Parameters:
c-Componentto return baseline resize behavior for- Returns:
- an enum indicating how the baseline changes as the border is resized
- Throws:
NullPointerException- Since:
- 1.6
- See Also:
JComponent.getBaseline(int, int)
-
-