Package com.github.tadukoo.view.border

Class ShapedEtchedBorder

java.lang.Object

javax.swing.border.AbstractBorder

com.github.tadukoo.view.border.ShapedEtchedBorder

All Implemented Interfaces:

Serializable, Border

public class ShapedEtchedBorder
extends AbstractBorder

Shaped Etched Border mimics the functionality of a EtchedBorder, but uses the ShapeInfo (if present) on the component to draw the border, rather than making a rectangular border, or it can have its own ShapeInfo if desired.

Since:

Alpha v.0.2

Version:

Alpha v.0.2.1

Author:

Logan Ferree (Tadukoo)

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ShapedEtchedBorder.EtchType	An enum representing the Etch type to be used (RAISED or LOWERED) for a border
static class	ShapedEtchedBorder.ShapedEtchedBorderBuilder	Shaped Etched Border Builder is used to create a ShapedEtchedBorder.

Field Summary

Fields

Modifier and Type	Field	Description
private final ShapedEtchedBorder.EtchType	etchType	The type of etching (RAISED or LOWERED)
private final SizablePaint	highlightPaint	The SizablePaint for the highlight
private final SizablePaint	shadowPaint	The SizablePaint for the shadow
private final ShapeInfo	shapeInfo	The ShapeInfo to use on the Border (may be null to use the component's shape)

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ShapedEtchedBorder(ShapeInfo shapeInfo, ShapedEtchedBorder.EtchType etchType, SizablePaint highlightPaint, SizablePaint shadowPaint)	Creates a new Shaped Etched Border with the given parameters

Method Summary

Modifier and Type	Method	Description
static ShapedEtchedBorder.ShapedEtchedBorderBuilder	builder()
Insets	getBorderInsets(Component c)
Insets	getBorderInsets(Component c, Insets insets)
private Paint	getHighlightPaint(Component c, Dimension size)	Returns a Paint to use for the highlight on the given component with the given size.
private Paint	getShadowPaint(Component c, Dimension size)	Returns a Paint to use for the shadow on the given component with the given size.
void	paintBorder(Component c, Graphics g, int x, int y, int w, int h)

Methods inherited from class javax.swing.border.AbstractBorder

getBaseline, getBaselineResizeBehavior, getInteriorRectangle, getInteriorRectangle, isBorderOpaque

Methods inherited from class java.lang.Object

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

Field Details

shapeInfo

private final ShapeInfo shapeInfo

The ShapeInfo to use on the Border (may be null to use the component's shape)

etchType

private final ShapedEtchedBorder.EtchType etchType

The type of etching (RAISED or LOWERED)

highlightPaint

private final SizablePaint highlightPaint

The SizablePaint for the highlight

shadowPaint

private final SizablePaint shadowPaint

The SizablePaint for the shadow

Constructor Details

ShapedEtchedBorder

private ShapedEtchedBorder(ShapeInfo shapeInfo,
 ShapedEtchedBorder.EtchType etchType,
 SizablePaint highlightPaint,
 SizablePaint shadowPaint)

Creates a new Shaped Etched Border with the given parameters

Parameters:

shapeInfo - The ShapeInfo to use on the Border (may be null to use the component's shape)

etchType - The type of etching (RAISED or LOWERED)

highlightPaint - The SizablePaint for the highlight

shadowPaint - The SizablePaint for the shadow

Method Details

builder

public static ShapedEtchedBorder.ShapedEtchedBorderBuilder builder()

Returns:

A builder to create a ShapedEtchedBorder

getBorderInsets

public Insets getBorderInsets(Component c)

Specified by:

getBorderInsets in interface Border

Overrides:

getBorderInsets in class AbstractBorder

getBorderInsets

public Insets getBorderInsets(Component c,
 Insets insets)

Overrides:

getBorderInsets in class AbstractBorder

paintBorder

public void paintBorder(Component c,
 Graphics g,
 int x,
 int y,
 int w,
 int h)

Specified by:

paintBorder in interface Border

Overrides:

paintBorder in class AbstractBorder

getHighlightPaint

private Paint getHighlightPaint(Component c,
 Dimension size)

Returns a Paint to use for the highlight on the given component with the given size.

Parameters:

c - The Component we're putting a border on

size - The size of the space being painted

Returns:

The Paint to use

getShadowPaint

private Paint getShadowPaint(Component c,
 Dimension size)

Returns a Paint to use for the shadow on the given component with the given size.

Parameters:

c - The Component we're putting a border on

size - The size of the space being painted

Returns:

The Paint to use