jhelp.util.gui

Class JHelpGradientVertical

java.lang.Object

jhelp.util.gui.JHelpGradientVertical

All Implemented Interfaces:

JHelpPaint

public class JHelpGradientVertical
extends java.lang.Object
implements JHelpPaint

Vertical gradient with fixed step

Author:

JHelp

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	JHelpGradientVertical.Percent Represents a step

Field Summary

Fields

Modifier and Type	Field and Description
private int	height Height of the current shape to fill
private SortedArray<JHelpGradientVertical.Percent>	percents Gradient steps

Constructor Summary

Constructors

Constructor and Description
JHelpGradientVertical(int colorStart, int colorEnd) Create a new instance of JHelpGradientVertical

Method Summary

Methods

Modifier and Type	Method and Description
void	addColor(int percent, int color) Add a color step
void	initializePaint(int width, int height) Called when the gradient is about to be used Parent documentation: Initialize the shape.
int	obtainColor(int x, int y) Compute a pixel color Parent documentation: Compute color to use for a specific point.
JHelpGradientVertical.Percent[]	otainPercents() Steps list

Methods inherited from class java.lang.Object

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

Field Detail

height

private int height

Height of the current shape to fill

percents

private final SortedArray<JHelpGradientVertical.Percent> percents

Gradient steps

Constructor Detail

JHelpGradientVertical

public JHelpGradientVertical(int colorStart,
                     int colorEnd)

Create a new instance of JHelpGradientVertical

Parameters:

colorStart - Color a start (up)

colorEnd - Color at end (down)

Method Detail

addColor

public void addColor(int percent,
            int color)

Add a color step

Parameters:

percent - Percent of the step

color - Step color

initializePaint

public void initializePaint(int width,
                   int height)

Called when the gradient is about to be used

Parent documentation:
Initialize the shape.
It is called just before fill shape with this paint.

Specified by:

initializePaint in interface JHelpPaint

Parameters:

width - Area width

height - Area height

See Also:

JHelpPaint.initializePaint(int, int)

obtainColor

public int obtainColor(int x,
              int y)

Compute a pixel color

Parent documentation:
Compute color to use for a specific point.
Coordinate are relative to the bounding box upper left corner

Specified by:

obtainColor in interface JHelpPaint

Parameters:

x - X position

y - Y position

Returns:

Computed color

See Also:

JHelpPaint.obtainColor(int, int)

otainPercents

public JHelpGradientVertical.Percent[] otainPercents()

Steps list

Returns:

Steps list