Class TopShadowOverlayPainter

java.lang.Object

org.pushingpixels.radiance.theming.api.painter.overlay.TopShadowOverlayPainter

All Implemented Interfaces:

RadianceOverlayPainter, RadianceTrait

public final class TopShadowOverlayPainter
extends Object
implements RadianceOverlayPainter

Overlay painter that paints a few pixel-high drop shadow at the top edge of the relevant decoration area. This class is part of officially supported API.

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	DEFAULT_SHADOW_START_ALPHA
private static final Map<Integer, TopShadowOverlayPainter>	MAP
private static final int	MIN_SHADOW_START_ALPHA
private int	startAlpha

Constructor Summary

Constructors

Modifier	Constructor	Description
private	TopShadowOverlayPainter()	Private constructor to enforce that getInstance(int) is the only way an application can get an instance of this class.

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()	Returns the display name of this trait.
static TopShadowOverlayPainter	getInstance(int strength)	Returns an instance of top shadow overlay painter with the requested strength.
void	paintOverlay(Graphics2D graphics, Component comp, RadianceThemingSlices.DecorationAreaType decorationAreaType, int width, int height, RadianceSkin skin)	Paints the overlay.

Methods inherited from class Object

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

Field Details

MAP

private static final Map<Integer, TopShadowOverlayPainter> MAP

DEFAULT_SHADOW_START_ALPHA

private static final int DEFAULT_SHADOW_START_ALPHA

See Also:

• Constant Field Values

MIN_SHADOW_START_ALPHA

private static final int MIN_SHADOW_START_ALPHA

See Also:

• Constant Field Values

startAlpha

private int startAlpha

Constructor Details

TopShadowOverlayPainter

private TopShadowOverlayPainter()

Private constructor to enforce that getInstance(int) is the only way an application can get an instance of this class.

Method Details

getInstance

public static TopShadowOverlayPainter getInstance(int strength)

Returns an instance of top shadow overlay painter with the requested strength.

Parameters:

strength - Drop shadow strength. Must be in [0..100] range.

Returns:

Top shadow overlay painter with the requested strength.

paintOverlay

public void paintOverlay(Graphics2D graphics,
 Component comp,
 RadianceThemingSlices.DecorationAreaType decorationAreaType,
 int width,
 int height,
 RadianceSkin skin)

Description copied from interface: RadianceOverlayPainter

Paints the overlay.

Specified by:

paintOverlay in interface RadianceOverlayPainter

Parameters:

graphics - Graphics context.

comp - Component.

decorationAreaType - Decoration area type. Must not be null.

width - Width.

height - Height.

skin - Skin for painting the overlay.

getDisplayName

public String getDisplayName()

Description copied from interface: RadianceTrait

Returns the display name of this trait. This method is part of officially supported API.

Specified by:

getDisplayName in interface RadianceTrait

Returns:

The display name of this trait.