org.jvnet.substance.painter.gradient
Class StandardGradientPainter

java.lang.Object
  extended by org.jvnet.substance.painter.gradient.BaseGradientPainter
      extended by org.jvnet.substance.painter.gradient.StandardGradientPainter
All Implemented Interfaces:
SubstanceTrait, SubstanceGradientPainter
Direct Known Subclasses:
ClassicGradientPainter, FlatGradientPainter, GlassGradientPainter, SimplisticGradientPainter, SubduedGradientPainter

public class StandardGradientPainter
extends BaseGradientPainter

Gradient painter that returns images with subtle 3D gradient appearance. This class is part of officially supported API.

Author:
Kirill Grouchnikov

Constructor Summary
StandardGradientPainter()
           
 
Method Summary
 java.awt.Color getBottomFillColor(SubstanceColorScheme interpolationScheme1, SubstanceColorScheme interpolationScheme2, double cycleCoef, boolean useCyclePosAsInterpolation)
          Computes the color of the bottom portion of the fill.
 java.awt.Color getBottomShineColor(SubstanceColorScheme interpolationScheme1, SubstanceColorScheme interpolationScheme2, double cycleCoef, boolean useCyclePosAsInterpolation)
          Computes the color of the bottom portion of the shine.
 java.lang.String getDisplayName()
          Returns the display name of this trait.
 java.awt.Color getMidFillColorBottom(SubstanceColorScheme interpolationScheme1, SubstanceColorScheme interpolationScheme2, double cycleCoef, boolean useCyclePosAsInterpolation)
          Computes the color of the middle portion of the fill from the bottom.
 java.awt.Color getMidFillColorTop(SubstanceColorScheme interpolationScheme1, SubstanceColorScheme interpolationScheme2, double cycleCoef, boolean useCyclePosAsInterpolation)
          Computes the color of the middle portion of the fill from the top.
 java.awt.Color getTopFillColor(SubstanceColorScheme interpolationScheme1, SubstanceColorScheme interpolationScheme2, double cycleCoef, boolean useCyclePosAsInterpolation)
          Computes the color of the top portion of the fill.
 java.awt.Color getTopShineColor(SubstanceColorScheme interpolationScheme1, SubstanceColorScheme interpolationScheme2, double cycleCoef, boolean useCyclePosAsInterpolation)
          Computes the color of the top portion of the shine.
 void paintContourBackground(java.awt.Graphics g, java.awt.Component comp, int width, int height, java.awt.Shape contour, boolean isFocused, SubstanceColorScheme colorScheme1, SubstanceColorScheme colorScheme2, float cyclePos, boolean hasShine, boolean useCyclePosAsInterpolation)
          Paints the background that matches the specified parameters.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StandardGradientPainter

public StandardGradientPainter()
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.

paintContourBackground

public void paintContourBackground(java.awt.Graphics g,
                                   java.awt.Component comp,
                                   int width,
                                   int height,
                                   java.awt.Shape contour,
                                   boolean isFocused,
                                   SubstanceColorScheme colorScheme1,
                                   SubstanceColorScheme colorScheme2,
                                   float cyclePos,
                                   boolean hasShine,
                                   boolean useCyclePosAsInterpolation)
Description copied from interface: SubstanceGradientPainter
Paints the background that matches the specified parameters.

Parameters:
g - Graphics context.
comp - Component to paint.
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..1 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.

getTopFillColor

public java.awt.Color getTopFillColor(SubstanceColorScheme interpolationScheme1,
                                      SubstanceColorScheme interpolationScheme2,
                                      double cycleCoef,
                                      boolean useCyclePosAsInterpolation)
Computes the color of the top portion of the fill. Override to provide different visual.

Parameters:
interpolationScheme1 - The first interpolation scheme.
interpolationScheme2 - The second interpolation scheme.
cycleCoef - Cycle coefficient.
useCyclePosAsInterpolation - Indicates whether the cycle coefficient should be used as the interpolation parameter.
Returns:
The color of the top portion of the fill.

getMidFillColorTop

public java.awt.Color getMidFillColorTop(SubstanceColorScheme interpolationScheme1,
                                         SubstanceColorScheme interpolationScheme2,
                                         double cycleCoef,
                                         boolean useCyclePosAsInterpolation)
Computes the color of the middle portion of the fill from the top. Override to provide different visual.

Parameters:
interpolationScheme1 - The first interpolation scheme.
interpolationScheme2 - The second interpolation scheme.
cycleCoef - Cycle coefficient.
useCyclePosAsInterpolation - Indicates whether the cycle coefficient should be used as the interpolation parameter.
Returns:
The color of the middle portion of the fill from the top.

getMidFillColorBottom

public java.awt.Color getMidFillColorBottom(SubstanceColorScheme interpolationScheme1,
                                            SubstanceColorScheme interpolationScheme2,
                                            double cycleCoef,
                                            boolean useCyclePosAsInterpolation)
Computes the color of the middle portion of the fill from the bottom. Override to provide different visual.

Parameters:
interpolationScheme1 - The first interpolation scheme.
interpolationScheme2 - The second interpolation scheme.
cycleCoef - Cycle coefficient.
useCyclePosAsInterpolation - Indicates whether the cycle coefficient should be used as the interpolation parameter.
Returns:
The color of the middle portion of the fill from the bottom.

getBottomFillColor

public java.awt.Color getBottomFillColor(SubstanceColorScheme interpolationScheme1,
                                         SubstanceColorScheme interpolationScheme2,
                                         double cycleCoef,
                                         boolean useCyclePosAsInterpolation)
Computes the color of the bottom portion of the fill. Override to provide different visual.

Parameters:
interpolationScheme1 - The first interpolation scheme.
interpolationScheme2 - The second interpolation scheme.
cycleCoef - Cycle coefficient.
useCyclePosAsInterpolation - Indicates whether the cycle coefficient should be used as the interpolation parameter.
Returns:
The color of the bottom portion of the fill.

getTopShineColor

public java.awt.Color getTopShineColor(SubstanceColorScheme interpolationScheme1,
                                       SubstanceColorScheme interpolationScheme2,
                                       double cycleCoef,
                                       boolean useCyclePosAsInterpolation)
Computes the color of the top portion of the shine. Override to provide different visual.

Parameters:
interpolationScheme1 - The first interpolation scheme.
interpolationScheme2 - The second interpolation scheme.
cycleCoef - Cycle coefficient.
useCyclePosAsInterpolation - Indicates whether the cycle coefficient should be used as the interpolation parameter.
Returns:
The color of the top portion of the shine.

getBottomShineColor

public java.awt.Color getBottomShineColor(SubstanceColorScheme interpolationScheme1,
                                          SubstanceColorScheme interpolationScheme2,
                                          double cycleCoef,
                                          boolean useCyclePosAsInterpolation)
Computes the color of the bottom portion of the shine. Override to provide different visual.

Parameters:
interpolationScheme1 - The first interpolation scheme.
interpolationScheme2 - The second interpolation scheme.
cycleCoef - Cycle coefficient.
useCyclePosAsInterpolation - Indicates whether the cycle coefficient should be used as the interpolation parameter.
Returns:
The color of the bottom portion of the shine.