org.jvnet.substance.painter
Interface SubstanceGradientPainter

All Superinterfaces:

SubstanceTrait

All Known Implementing Classes:

BaseGradientPainter, ClassicGradientPainter, FlatGradientPainter, GlassGradientPainter, GradientWaveGradientPainter, MatteGradientPainter, NoiseGradientPainter, SimplisticGradientPainter, SimplisticSoftBorderReverseGradientPainter, SpecularGradientPainter, SpecularWaveGradientPainter, StandardGradientPainter, SubduedGradientPainter, WaveDelegateGradientPainter, WaveGradientPainter

public interface SubstanceGradientPainter
extends SubstanceTrait

Gradient painter interface for Substance look and feel. This class is part of officially supported API.

Author:

Kirill Grouchnikov

Method Summary

java.awt.image.BufferedImage

getContourBackground(int width, int height, java.awt.Shape contour, boolean isFocused, ColorScheme colorScheme1, ColorScheme colorScheme2, float cyclePos, boolean hasShine, boolean useCyclePosAsInterpolation) Returns the background that matches the specified parameters.

Methods inherited from interface org.jvnet.substance.utils.SubstanceTrait

getDisplayName

Method Detail

getContourBackground

java.awt.image.BufferedImage getContourBackground(int width,
                                                  int height,
                                                  java.awt.Shape contour,
                                                  boolean isFocused,
                                                  ColorScheme colorScheme1,
                                                  ColorScheme colorScheme2,
                                                  float cyclePos,
                                                  boolean hasShine,
                                                  boolean useCyclePosAsInterpolation)

Returns the background that matches the specified parameters.

Parameters:

width - Width of a UI component.

height - Height of a UI component.

contour - Contour of a UI component.

isFocused - Indication whether component owns the focus.

colorScheme1 - The first color scheme.

colorScheme2 - The second color scheme.

cyclePos - Cycle position. Is used for rollover and pulsation effects. Must be in 0..10 range.

hasShine - Indication whether the returned image should have a 3D shine spot in its top half.

useCyclePosAsInterpolation - Indicates the algorithm to use for computing various colors. If true, the cyclePos is used to interpolate colors between different color components of both color schemes. If false, the cyclePos is used to interpolate colors between different color components of the first color scheme.

Returns:

The background that matches the specified parameters.