org.jvnet.substance.api.painter.highlight

Class FractionBasedHighlightPainter

java.lang.Object

org.jvnet.substance.api.painter.FractionBasedPainter

org.jvnet.substance.api.painter.highlight.FractionBasedHighlightPainter

All Implemented Interfaces:

SubstanceTrait, SubstanceHighlightPainter

public class FractionBasedHighlightPainter
extends FractionBasedPainter
implements SubstanceHighlightPainter

Highlight painter with fraction-based stops and a color query associated with each stop. This class allows creating multi-gradient highlights with exact control over which color is used at every gradient control point.

Author:

Kirill Grouchnikov

Field Summary

Fields inherited from class org.jvnet.substance.api.painter.FractionBasedPainter

colorQueries, fractions

Constructor Summary

Constructors

Constructor and Description
FractionBasedHighlightPainter(java.lang.String displayName, float[] fractions, ColorSchemeSingleColorQuery[] colorQueries) Creates a new fraction-based highlight painter.

Method Summary

Methods

Modifier and Type	Method and Description
void	paintHighlight(java.awt.Graphics2D graphics, java.awt.Component comp, int width, int height, java.util.Set<SubstanceConstants.Side> openSides, SubstanceColorScheme colorScheme1, SubstanceColorScheme colorScheme2, float cyclePos) Paints the highlight.

Methods inherited from class org.jvnet.substance.api.painter.FractionBasedPainter

getColorQueries, getDisplayName, getFractions

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jvnet.substance.api.trait.SubstanceTrait

getDisplayName

Constructor Detail

FractionBasedHighlightPainter

public FractionBasedHighlightPainter(java.lang.String displayName,
                             float[] fractions,
                             ColorSchemeSingleColorQuery[] colorQueries)

Creates a new fraction-based highlight painter.

Parameters:

displayName - The display name of this painter.

fractions - The fractions of this painter. Must be strictly increasing, starting from 0.0 and ending at 1.0.

colorQueries - The color queries of this painter. Must have the same size as the fractions array, and all entries must be non- null.

Method Detail

paintHighlight

public void paintHighlight(java.awt.Graphics2D graphics,
                  java.awt.Component comp,
                  int width,
                  int height,
                  java.util.Set<SubstanceConstants.Side> openSides,
                  SubstanceColorScheme colorScheme1,
                  SubstanceColorScheme colorScheme2,
                  float cyclePos)

Description copied from interface: SubstanceHighlightPainter

Paints the highlight.

Specified by:

paintHighlight in interface SubstanceHighlightPainter

Parameters:

graphics - Graphics context.

comp - Component.

width - Width.

height - Height.

openSides - The sides specified in this set will not be painted. Can be null or empty.

colorScheme1 - The first color scheme.

colorScheme2 - The second color scheme.

cyclePos - Cycle position. Is used for rollover and selection animations. Must be in 0..1 range.