org.jvnet.substance.painter.gradient
Class FlatGradientPainter

java.lang.Object
  org.jvnet.substance.painter.gradient.BaseGradientPainter
      org.jvnet.substance.painter.gradient.StandardGradientPainter
          org.jvnet.substance.painter.gradient.FlatGradientPainter

All Implemented Interfaces:

SubstanceTrait, SubstanceGradientPainter

public class FlatGradientPainter
extends StandardGradientPainter

Gradient painter that returns images with flat appearance. This class is for internal use only.

Author:

Kirill Grouchnikov

Constructor Summary

FlatGradientPainter()
Creates a new flat gradient painter.

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.

Methods inherited from class org.jvnet.substance.painter.gradient.StandardGradientPainter

paintContourBackground

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FlatGradientPainter

public FlatGradientPainter()

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

getMidFillColorTop

public java.awt.Color getMidFillColorTop(SubstanceColorScheme interpolationScheme1,
                                         SubstanceColorScheme 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.

getTopFillColor

public java.awt.Color getTopFillColor(SubstanceColorScheme interpolationScheme1,
                                      SubstanceColorScheme 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.

getMidFillColorBottom

public java.awt.Color getMidFillColorBottom(SubstanceColorScheme interpolationScheme1,
                                            SubstanceColorScheme interpolationScheme2,
                                            double cycleCoef,
                                            boolean useCyclePosAsInterpolation)

Description copied from class: StandardGradientPainter

Computes the color of the middle portion of the fill from the bottom. Override to provide different visual.

Overrides:

getMidFillColorBottom 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 bottom.

getBottomFillColor

public java.awt.Color getBottomFillColor(SubstanceColorScheme interpolationScheme1,
                                         SubstanceColorScheme 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.

getTopShineColor

public java.awt.Color getTopShineColor(SubstanceColorScheme interpolationScheme1,
                                       SubstanceColorScheme interpolationScheme2,
                                       double cycleCoef,
                                       boolean useCyclePosAsInterpolation)

Description copied from class: StandardGradientPainter

Computes the color of the top portion of the shine. Override to provide different visual.

Overrides:

getTopShineColor 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 shine.

getBottomShineColor

public java.awt.Color getBottomShineColor(SubstanceColorScheme interpolationScheme1,
                                          SubstanceColorScheme interpolationScheme2,
                                          double cycleCoef,
                                          boolean useCyclePosAsInterpolation)

Description copied from class: StandardGradientPainter

Computes the color of the bottom portion of the shine. Override to provide different visual.

Overrides:

getBottomShineColor 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 shine.