Class TitledBorder

java.lang.Object

vaadinx.swing.border.AbstractBorder

vaadinx.swing.border.TitledBorder

All Implemented Interfaces:

Serializable, Border

public class TitledBorder
extends AbstractBorder

Port of TitledBorder. Wraps an inner border and adds a title label floating at the top edge.

CSS rendering is split in two: the border part lands via the inside border's own AbstractBorder.applyCss(Element) (LineBorder → border, EmptyBorder → padding, etc.). The title text is written as data-emul-border-title on the element, and the ::before pseudo-element rule is auto-injected once per UI by BorderCss.ensureTitledBorderStyleInjected(UI). The injection is idempotent — sentinel data on the UI gates duplicate writes — and survives even when applyCss is called outside a UI context (no-op then; lands on the next applyCss once a UI is current).

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ABOVE_BOTTOM
static final int	ABOVE_TOP
static final int	BELOW_BOTTOM
static final int	BELOW_TOP
protected Border	border
static final int	BOTTOM
static final int	CENTER
static final int	DEFAULT_JUSTIFICATION	Title justification constants — identical values to JDK.
static final int	DEFAULT_POSITION	Title positioning constants — identical values to JDK.
protected static final int	EDGE_SPACING	Internal padding used by JDK between the title and border line.
static final int	LEADING
static final int	LEFT
static final int	RIGHT
protected static final int	TEXT_INSET_H
protected static final int	TEXT_SPACING
protected String	title
protected Color	titleColor
protected Font	titleFont
protected int	titleJustification
protected int	titlePosition
static final int	TOP
static final int	TRAILING

Constructor Summary

Constructors

Constructor	Description
TitledBorder(String title)
TitledBorder(Border border)
TitledBorder(Border border, String title)
TitledBorder(Border border, String title, int titleJustification, int titlePosition)
TitledBorder(Border border, String title, int titleJustification, int titlePosition, Font titleFont)
TitledBorder(Border border, String title, int titleJustification, int titlePosition, Font titleFont, Color titleColor)

Method Summary

Modifier and Type	Method	Description
void	applyCss(com.vaadin.flow.dom.Element element)	Write this border's CSS onto the target element.
Border	getBorder()
Insets	getBorderInsets(Component c)
String	getTitle()
Color	getTitleColor()
Font	getTitleFont()
int	getTitleJustification()
int	getTitlePosition()
boolean	isBorderOpaque()
void	setBorder(Border border)
void	setTitle(String title)
void	setTitleColor(Color titleColor)
void	setTitleFont(Font titleFont)
void	setTitleJustification(int titleJustification)
void	setTitlePosition(int titlePosition)

Methods inherited from class AbstractBorder

clearBorderCss, getBorderInsets, paintBorder

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_POSITION

public static final int DEFAULT_POSITION

Title positioning constants — identical values to JDK.

See Also:

• Constant Field Values

ABOVE_TOP

public static final int ABOVE_TOP

See Also:

• Constant Field Values

TOP

public static final int TOP

See Also:

• Constant Field Values

BELOW_TOP

public static final int BELOW_TOP

See Also:

• Constant Field Values

ABOVE_BOTTOM

public static final int ABOVE_BOTTOM

See Also:

• Constant Field Values

BOTTOM

public static final int BOTTOM

See Also:

• Constant Field Values

BELOW_BOTTOM

public static final int BELOW_BOTTOM

See Also:

• Constant Field Values

DEFAULT_JUSTIFICATION

public static final int DEFAULT_JUSTIFICATION

Title justification constants — identical values to JDK.

See Also:

• Constant Field Values

LEFT

public static final int LEFT

See Also:

• Constant Field Values

CENTER

public static final int CENTER

See Also:

• Constant Field Values

RIGHT

public static final int RIGHT

See Also:

• Constant Field Values

LEADING

public static final int LEADING

See Also:

• Constant Field Values

TRAILING

public static final int TRAILING

See Also:

• Constant Field Values

EDGE_SPACING

protected static final int EDGE_SPACING

Internal padding used by JDK between the title and border line.

See Also:

• Constant Field Values

TEXT_SPACING

protected static final int TEXT_SPACING

See Also:

• Constant Field Values

TEXT_INSET_H

protected static final int TEXT_INSET_H

See Also:

• Constant Field Values

title

protected String title

border

protected Border border

titlePosition

protected int titlePosition

titleJustification

protected int titleJustification

titleFont

protected Font titleFont

titleColor

protected Color titleColor

Constructor Details

TitledBorder

public TitledBorder(String title)

TitledBorder

public TitledBorder(Border border)

TitledBorder

public TitledBorder(Border border,
 String title)

TitledBorder

public TitledBorder(Border border,
 String title,
 int titleJustification,
 int titlePosition)

TitledBorder

public TitledBorder(Border border,
 String title,
 int titleJustification,
 int titlePosition,
 Font titleFont)

TitledBorder

public TitledBorder(Border border,
 String title,
 int titleJustification,
 int titlePosition,
 Font titleFont,
 Color titleColor)

Method Details

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getBorder

public Border getBorder()

setBorder

public void setBorder(Border border)

getTitlePosition

public int getTitlePosition()

setTitlePosition

public void setTitlePosition(int titlePosition)

getTitleJustification

public int getTitleJustification()

setTitleJustification

public void setTitleJustification(int titleJustification)

getTitleFont

public Font getTitleFont()

setTitleFont

public void setTitleFont(Font titleFont)

getTitleColor

public Color getTitleColor()

setTitleColor

public void setTitleColor(Color titleColor)

getBorderInsets

public Insets getBorderInsets(Component c)

Specified by:

getBorderInsets in interface Border

Overrides:

getBorderInsets in class AbstractBorder

isBorderOpaque

public boolean isBorderOpaque()

Specified by:

isBorderOpaque in interface Border

Overrides:

isBorderOpaque in class AbstractBorder

applyCss

public void applyCss(com.vaadin.flow.dom.Element element)

Description copied from class: AbstractBorder

Write this border's CSS onto the target element. Called by JComponent.setBorder(Border). Concrete border classes override to emit the CSS that represents them (padding for EmptyBorder, border for LineBorder, per-side for MatteBorder, …). The base implementation clears any previously-installed border CSS via AbstractBorder.clearBorderCss(Element) and writes nothing, which is the honest behaviour for a user-authored custom AbstractBorder that didn't override this hook.

Typical override: clearBorderCss(e); set("border", …);. Always clear first so a previous border's keys don't linger.

Overrides:

applyCss in class AbstractBorder