org.jvnet.substance.painter
Class SpecularGradientPainter

java.lang.Object
  extended by org.jvnet.substance.painter.BaseGradientPainter
      extended by org.jvnet.substance.painter.SpecularGradientPainter
All Implemented Interfaces:
SubstanceGradientPainter, SubstanceTrait

public class SpecularGradientPainter
extends BaseGradientPainter

Gradient painter that returns images with 3D appearance and specular shine spot. This class is part of officially supported API.

Author:
Kirill Grouchnikov

Field Summary
 
Fields inherited from class org.jvnet.substance.painter.BaseGradientPainter
borderPainter
 
Constructor Summary
SpecularGradientPainter()
           
 
Method Summary
 java.awt.image.BufferedImage getContourBackground(int width, int height, java.awt.Shape contour, boolean isDark, 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
 

Constructor Detail

SpecularGradientPainter

public SpecularGradientPainter()
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 isDark,
                                                         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.
isDark - 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.