org.jvnet.substance.painter
Class ClassicGradientPainter

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

All Implemented Interfaces:

SubstanceGradientPainter, SubstanceTrait

Direct Known Subclasses:

MatteGradientPainter

public class ClassicGradientPainter
extends StandardGradientPainter

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

Author:

Kirill Grouchnikov

Constructor Summary

ClassicGradientPainter()
Creates a new classic gradient painter.

Method Summary

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.StandardGradientPainter

getBottomFillColor, 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

ClassicGradientPainter

public ClassicGradientPainter()

Creates a new classic gradient 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.

Specified by:

getDisplayName in interface SubstanceTrait

Overrides:

getDisplayName in class StandardGradientPainter

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 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 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 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 middle portion of the fill from the top.