Package org.pushingpixels.substance.api.painter.decoration

Class MatteDecorationPainter

java.lang.Object

org.pushingpixels.substance.api.painter.decoration.MatteDecorationPainter

All Implemented Interfaces:

SubstanceDecorationPainter, SubstanceTrait

public class MatteDecorationPainter
extends java.lang.Object
implements SubstanceDecorationPainter

Implementation of SubstanceDecorationPainter that uses matte painting on decoration areas.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DISPLAY_NAME	The display name for the decoration painters of this class.

Constructor Summary

Constructors

Constructor	Description
MatteDecorationPainter()

Method Summary

Modifier and Type	Method	Description
protected void	fill(java.awt.Graphics2D graphics, SubstanceColorScheme scheme, int offsetY, int x, int y, int width, int height)	Fills the relevant part with the gradient fill.
java.lang.String	getDisplayName()	Returns the display name of this trait.
void	paintDecorationArea(java.awt.Graphics2D graphics, java.awt.Component comp, SubstanceSlices.DecorationAreaType decorationAreaType, int width, int height, SubstanceSkin skin)	Paints the decoration area as a fully filled rectangle.
void	paintDecorationArea(java.awt.Graphics2D graphics, java.awt.Component comp, SubstanceSlices.DecorationAreaType decorationAreaType, java.awt.Shape contour, SubstanceColorScheme colorScheme)	Paints the decoration area as a specified shape.

Methods inherited from class java.lang.Object

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

Field Detail

DISPLAY_NAME

public static final java.lang.String DISPLAY_NAME

The display name for the decoration painters of this class.

See Also:

Constant Field Values

Constructor Detail

MatteDecorationPainter

public MatteDecorationPainter()

Method Detail

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.

paintDecorationArea

public void paintDecorationArea(java.awt.Graphics2D graphics,
                                java.awt.Component comp,
                                SubstanceSlices.DecorationAreaType decorationAreaType,
                                int width,
                                int height,
                                SubstanceSkin skin)

Description copied from interface: SubstanceDecorationPainter

Paints the decoration area as a fully filled rectangle.

Specified by:

paintDecorationArea in interface SubstanceDecorationPainter

Parameters:

graphics - Graphics context.

comp - Component.

decorationAreaType - Decoration area type. Must not be null.

width - Width.

height - Height.

skin - Skin for painting the decoration area.

fill

protected void fill(java.awt.Graphics2D graphics,
                    SubstanceColorScheme scheme,
                    int offsetY,
                    int x,
                    int y,
                    int width,
                    int height)

Fills the relevant part with the gradient fill.

Parameters:

graphics - Graphics.

scheme - Color scheme to use.

offsetY - Vertical offset.

x - X coordinate of the fill area.

y - Y coordinate of the fill area.

width - Fill area width.

height - Fill area height.

paintDecorationArea

public void paintDecorationArea(java.awt.Graphics2D graphics,
                                java.awt.Component comp,
                                SubstanceSlices.DecorationAreaType decorationAreaType,
                                java.awt.Shape contour,
                                SubstanceColorScheme colorScheme)

Description copied from interface: SubstanceDecorationPainter

Paints the decoration area as a specified shape.

Specified by:

paintDecorationArea in interface SubstanceDecorationPainter

Parameters:

graphics - Graphics context.

comp - Component.

decorationAreaType - Decoration area type. Must not be null.

contour - Contour to fill.

colorScheme - Color scheme for painting the decoration area.