org.jvnet.substance.painter
Class MatteGradientPainter

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

public class MatteGradientPainter
extends ClassicGradientPainter

Gradient painter that returns images with matte appearance. This class is part of officially supported API.

Since:
version 4.0
Author:
Kirill Grouchnikov

Field Summary
 
Fields inherited from class org.jvnet.substance.painter.BaseGradientPainter
borderPainter
 
Constructor Summary
MatteGradientPainter()
          Creates a new matte gradient painter.
MatteGradientPainter(boolean useDefaultBorderPainter)
          Creates a new matte gradient painter.
 
Method Summary
 java.awt.Color getBottomFillColor(ColorScheme interpolationScheme1, ColorScheme interpolationScheme2, double cycleCoef, boolean useCyclePosAsInterpolation)
          Computes the color of the bottom portion of the fill.
 java.lang.String getDisplayName()
          Returns the display name of this trait.
 java.awt.Color getMidFillColorTop(ColorScheme interpolationScheme1, ColorScheme interpolationScheme2, double cycleCoef, boolean useCyclePosAsInterpolation)
          Computes the color of the middle portion of the fill from the top.
 java.awt.Color getTopFillColor(ColorScheme interpolationScheme1, ColorScheme interpolationScheme2, double cycleCoef, boolean useCyclePosAsInterpolation)
          Computes the color of the top portion of the fill.
 
Methods inherited from class org.jvnet.substance.painter.ClassicGradientPainter
getBorderPainter
 
Methods inherited from class org.jvnet.substance.painter.StandardGradientPainter
getBottomShineColor, getContourBackground, getMidFillColorBottom, getTopShineColor
 
Methods inherited from class org.jvnet.substance.painter.BaseGradientPainter
getMixContourBackground
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MatteGradientPainter

public MatteGradientPainter()
Creates a new matte gradient painter.


MatteGradientPainter

public MatteGradientPainter(boolean useDefaultBorderPainter)
Creates a new matte gradient painter.

Parameters:
useDefaultBorderPainter - If true, a default border painter will be used.
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.

Specified by:
getDisplayName in interface SubstanceGradientPainter
Specified by:
getDisplayName in interface SubstanceTrait
Overrides:
getDisplayName in class ClassicGradientPainter
Returns:
The display name of this trait.

getTopFillColor

public java.awt.Color getTopFillColor(ColorScheme interpolationScheme1,
                                      ColorScheme interpolationScheme2,
                                      double cycleCoef,
                                      boolean useCyclePosAsInterpolation)
Description copied from class: StandardGradientPainter
Computes the color of the top portion of the fill. Override to provide different visual.

Overrides:
getTopFillColor in class ClassicGradientPainter
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(ColorScheme interpolationScheme1,
                                         ColorScheme interpolationScheme2,
                                         double cycleCoef,
                                         boolean useCyclePosAsInterpolation)
Description copied from class: StandardGradientPainter
Computes the color of the middle portion of the fill from the top. Override to provide different visual.

Overrides:
getMidFillColorTop in class ClassicGradientPainter
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.

getBottomFillColor

public java.awt.Color getBottomFillColor(ColorScheme interpolationScheme1,
                                         ColorScheme interpolationScheme2,
                                         double cycleCoef,
                                         boolean useCyclePosAsInterpolation)
Description copied from class: StandardGradientPainter
Computes the color of the bottom portion of the fill. Override to provide different visual.

Overrides:
getBottomFillColor in class StandardGradientPainter
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.