Package org.pushingpixels.substance.api.painter.overlay

Class TopShadowOverlayPainter

java.lang.Object

org.pushingpixels.substance.api.painter.overlay.TopShadowOverlayPainter

All Implemented Interfaces:

SubstanceOverlayPainter, SubstanceTrait

public final class TopShadowOverlayPainter
extends java.lang.Object
implements SubstanceOverlayPainter

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.

Method Summary

Modifier and Type	Method	Description
java.lang.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(java.awt.Graphics2D graphics, java.awt.Component comp, SubstanceSlices.DecorationAreaType decorationAreaType, int width, int height, SubstanceSkin skin)	Paints the overlay.

Methods inherited from class java.lang.Object

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

Method Detail

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(java.awt.Graphics2D graphics,
                         java.awt.Component comp,
                         SubstanceSlices.DecorationAreaType decorationAreaType,
                         int width,
                         int height,
                         SubstanceSkin skin)

Description copied from interface: SubstanceOverlayPainter

Paints the overlay.

Specified by:

paintOverlay in interface SubstanceOverlayPainter

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 java.lang.String getDisplayName()

Description copied from interface: SubstanceTrait

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

Specified by:

getDisplayName in interface SubstanceTrait

Returns:

The display name of this trait.