org.jvnet.substance.painter
Class BaseGradientPainter

java.lang.Object
  org.jvnet.substance.painter.BaseGradientPainter

All Implemented Interfaces:

SubstanceGradientPainter, SubstanceTrait

Direct Known Subclasses:

NoiseGradientPainter, SpecularGradientPainter, StandardGradientPainter, WaveDelegateGradientPainter, WaveGradientPainter

public abstract class BaseGradientPainter
extends java.lang.Object
implements SubstanceGradientPainter

Base class for gradient painters. Handles mixed themes. This class is part of officially supported API.

Author:

Kirill Grouchnikov

Constructor Summary

BaseGradientPainter()

Method Summary

protected java.awt.image.BufferedImage

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

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.painter.SubstanceGradientPainter

getContourBackground

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

getDisplayName

Constructor Detail

BaseGradientPainter

public BaseGradientPainter()

Method Detail

getMixContourBackground

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

Returns the background (including border) 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 (including border) that matches the specified parameters if one of the color schemes is MixColorScheme, null otherwise.