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

Class TopLineOverlayPainter

java.lang.Object

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

All Implemented Interfaces:

RadianceOverlayPainter, RadianceTrait

public final class TopLineOverlayPainter
extends java.lang.Object
implements RadianceOverlayPainter

Overlay painter that paints a single line 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
(package private) ContainerColorTokensSingleColorQuery	containerTokensQuery	Used to compute the color of the line painted by this overlay painter.

Constructor Summary

Constructors

Constructor	Description
TopLineOverlayPainter(ContainerColorTokensSingleColorQuery containerTokensQuery)	Creates a new overlay painter that paints a single line at the top edge of the relevant decoration area

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDisplayName()	Returns the display name of this trait.
void	paintOverlay(java.awt.Graphics2D g, java.awt.Component comp, RadianceThemingSlices.DecorationAreaType decorationAreaType, int width, int height, RadianceSkin skin)	Paints the overlay.

Methods inherited from class java.lang.Object

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

Field Detail

containerTokensQuery

ContainerColorTokensSingleColorQuery containerTokensQuery

Used to compute the color of the line painted by this overlay painter.

Constructor Detail

TopLineOverlayPainter

public TopLineOverlayPainter(ContainerColorTokensSingleColorQuery containerTokensQuery)

Creates a new overlay painter that paints a single line at the top edge of the relevant decoration area

Parameters:

containerTokensQuery - Used to compute the color of the line painted by this overlay painter.

Method Detail

paintOverlay

public void paintOverlay(java.awt.Graphics2D g,
                         java.awt.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:

g - 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: 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.