org.jvnet.substance.painter
Class WaveDelegateGradientPainter

java.lang.Object
  extended by org.jvnet.substance.painter.BaseGradientPainter
      extended by org.jvnet.substance.painter.WaveDelegateGradientPainter
All Implemented Interfaces:
SubstanceGradientPainter, SubstanceTrait
Direct Known Subclasses:
GradientWaveGradientPainter, SpecularWaveGradientPainter

public abstract class WaveDelegateGradientPainter
extends BaseGradientPainter

Base class for gradient painters that overlays wave gradient on top of some other gradient painter.This class is part of officially supported API. The implementation borrows heavily from this.

Author:
Kirill Grouchnikov., Chris Campbell.

Nested Class Summary
static interface WaveDelegateGradientPainter.ColorSchemeTransformation
          Transformation on a color scheme.
 
Field Summary
protected  SubstanceGradientPainter delegate
          Mandatory delegate painter.
protected  java.lang.String painterName
          Display name of this painter.
protected  WaveDelegateGradientPainter.ColorSchemeTransformation transformation
          Optional scheme transformation - may be null.
 
Fields inherited from class org.jvnet.substance.painter.BaseGradientPainter
borderPainter
 
Constructor Summary
WaveDelegateGradientPainter(java.lang.String painterName, WaveDelegateGradientPainter.ColorSchemeTransformation transformation, SubstanceGradientPainter delegate)
          Creates a new wave-overlaying painter.
 
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.
 java.lang.String getDisplayName()
          Returns the display name of this trait.
 
Methods inherited from class org.jvnet.substance.painter.BaseGradientPainter
getBorderPainter, getMixContourBackground
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

painterName

protected java.lang.String painterName
Display name of this painter.


transformation

protected WaveDelegateGradientPainter.ColorSchemeTransformation transformation
Optional scheme transformation - may be null.


delegate

protected SubstanceGradientPainter delegate
Mandatory delegate painter.

Constructor Detail

WaveDelegateGradientPainter

public WaveDelegateGradientPainter(java.lang.String painterName,
                                   WaveDelegateGradientPainter.ColorSchemeTransformation transformation,
                                   SubstanceGradientPainter delegate)
Creates a new wave-overlaying painter.

Parameters:
painterName - Painter display name.
transformation - Optional scheme transformation. If null, the result will be identical to using the delegate painter.
delegate - Delegate painter.
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.

Returns:
The display name of this trait.

getContourBackground

public 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)
Description copied from interface: SubstanceGradientPainter
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.