org.pushingpixels.substance.api.painter.overlay
Class BottomLineOverlayPainter

java.lang.Object
  org.pushingpixels.substance.api.painter.overlay.BottomLineOverlayPainter

All Implemented Interfaces:

SubstanceOverlayPainter, SubstanceTrait

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

Overlay painter that paints a single line at the bottom edge of the relevant decoration area. This class is part of officially supported API.

Since:

version 5.3

Constructor Summary

BottomLineOverlayPainter(ColorSchemeSingleColorQuery colorSchemeQuery)
Creates a new overlay painter that paints a single line at the bottom edge of the relevant decoration area

Method Summary

java.lang.String	getDisplayName() Returns the display name of this trait.
void	paintOverlay(java.awt.Graphics2D graphics, java.awt.Component comp, 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

Constructor Detail

BottomLineOverlayPainter

public BottomLineOverlayPainter(ColorSchemeSingleColorQuery colorSchemeQuery)

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

Parameters:

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

Method Detail

paintOverlay

public void paintOverlay(java.awt.Graphics2D graphics,
                         java.awt.Component comp,
                         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.