Serializable
, Border
BorderUIResource.TitledBorderUIResource
public class TitledBorder extends AbstractBorder
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:
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.beans
package. Please see XMLEncoder
.
Modifier and Type | Field | Description |
---|---|---|
static final int |
ABOVE_BOTTOM |
Position the title above the border's bottom line. |
static final int |
ABOVE_TOP |
Position the title above the border's top line. |
static final int |
BELOW_BOTTOM |
Position the title below the border's bottom line. |
static final int |
BELOW_TOP |
Position the title below the border's top line. |
protected Border |
border |
The border. |
static final int |
BOTTOM |
Position the title in the middle of the border's bottom line. |
static final int |
CENTER |
Position title text in the center of the border line. |
static final int |
DEFAULT_JUSTIFICATION |
Use the default justification for the title text. |
static final int |
DEFAULT_POSITION |
Use the default vertical orientation for the title text. |
protected static final int |
EDGE_SPACING |
Space between the border and the component's edge |
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. |
static final int |
LEFT |
Position title text at the left side of the border line. |
static final int |
RIGHT |
Position title text at the right side of the border line. |
protected static final int |
TEXT_INSET_H |
Horizontal inset of text that is left or right justified |
protected static final int |
TEXT_SPACING |
Space between the border and text |
protected String |
title |
The title the border should display. |
protected Color |
titleColor |
The color of the title. |
protected Font |
titleFont |
The font for rendering the title. |
protected int |
titleJustification |
The justification for the title. |
protected int |
titlePosition |
The position for the title. |
static final int |
TOP |
Position the title in the middle of the border's top line. |
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. |
Constructor | Description |
---|---|
TitledBorder |
Creates a TitledBorder instance. |
TitledBorder |
Creates a TitledBorder instance with the specified border and an empty title. |
TitledBorder |
Creates a TitledBorder instance with the specified border and title. |
TitledBorder |
Creates a TitledBorder instance with the specified border, title, title-justification, and title-position. |
TitledBorder |
Creates a TitledBorder instance with the specified border, title, title-justification, title-position, and title-font. |
TitledBorder |
Creates a TitledBorder instance with the specified border, title, title-justification, title-position, title-font, and title-color. |
Modifier and Type | Method | Description |
---|---|---|
int |
getBaseline |
Returns the baseline. |
Component.BaselineResizeBehavior |
getBaselineResizeBehavior |
Returns an enum indicating how the baseline of the border changes as the size changes. |
Border |
getBorder() |
Returns the border of the titled border. |
Insets |
getBorderInsets |
Reinitialize the insets parameter with this Border's current Insets. |
protected Font |
getFont |
Returns default font of the titled border. |
Dimension |
getMinimumSize |
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 |
Paints the border for the specified component with the specified position and size. |
void |
setBorder |
Sets the border of the titled border. |
void |
setTitle |
Sets the title of the titled border. |
void |
setTitleColor |
Sets the title-color of the titled border. |
void |
setTitleFont |
Sets the title-font of the titled border. |
void |
setTitleJustification |
Sets the title-justification of the titled border. |
void |
setTitlePosition |
Sets the title-position of the titled border. |
getBorderInsets, getInteriorRectangle, getInteriorRectangle
protected String title
protected Border border
protected int titlePosition
protected int titleJustification
protected Font titleFont
protected Color titleColor
public static final int DEFAULT_POSITION
public static final int ABOVE_TOP
public static final int TOP
public static final int BELOW_TOP
public static final int ABOVE_BOTTOM
public static final int BOTTOM
public static final int BELOW_BOTTOM
public static final int DEFAULT_JUSTIFICATION
public static final int LEFT
public static final int CENTER
public static final int RIGHT
public static final int LEADING
public static final int TRAILING
protected static final int EDGE_SPACING
protected static final int TEXT_SPACING
protected static final int TEXT_INSET_H
public TitledBorder(String title)
title
- the title the border should displaypublic TitledBorder(Border border)
border
- the borderpublic TitledBorder(Border border, String title)
border
- the bordertitle
- the title the border should displaypublic TitledBorder(Border border, String title, int titleJustification, int titlePosition)
border
- the bordertitle
- the title the border should displaytitleJustification
- the justification for the titletitlePosition
- the position for the titlepublic TitledBorder(Border border, String title, int titleJustification, int titlePosition, Font titleFont)
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@ConstructorProperties({"border","title","titleJustification","titlePosition","titleFont","titleColor"}) public TitledBorder(Border border, String title, int titleJustification, int titlePosition, Font titleFont, Color titleColor)
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 titlepublic void paintBorder(Component c, Graphics g, int x, int y, int width, int height)
paintBorder
in interface Border
paintBorder
in class AbstractBorder
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 borderpublic Insets getBorderInsets(Component c, Insets insets)
getBorderInsets
in class AbstractBorder
c
- the component for which this border insets value appliesinsets
- the object to be reinitializedinsets
objectNullPointerException
- if the specified insets
is null
public boolean isBorderOpaque()
isBorderOpaque
in interface Border
isBorderOpaque
in class AbstractBorder
public String getTitle()
public Border getBorder()
public int getTitlePosition()
public int getTitleJustification()
public Font getTitleFont()
public Color getTitleColor()
public void setTitle(String title)
title
- the title for the borderpublic void setBorder(Border border)
border
- the borderpublic void setTitlePosition(int titlePosition)
titlePosition
- the position for the borderpublic void setTitleJustification(int titleJustification)
titleJustification
- the justification for the borderpublic void setTitleFont(Font titleFont)
titleFont
- the font for the border titlepublic void setTitleColor(Color titleColor)
titleColor
- the color for the border titlepublic Dimension getMinimumSize(Component c)
c
- the component where this border will be drawnDimension
objectpublic int getBaseline(Component c, int width, int height)
getBaseline
in class AbstractBorder
c
- Component
baseline is being requested forwidth
- the width to get the baseline forheight
- the height to get the baseline forNullPointerException
- if Component
is null
IllegalArgumentException
- if width or height is < 0public Component.BaselineResizeBehavior getBaselineResizeBehavior(Component c)
getBaselineResizeBehavior
in class AbstractBorder
c
- Component
to return baseline resize behavior forNullPointerException
- if Component
is null
protected Font getFont(Component c)
c
- the component
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/border/TitledBorder.html