jhelp.util.gui

Class JHelpGradientHorizontal

java.lang.Object

jhelp.util.gui.JHelpGradientHorizontal

All Implemented Interfaces:

JHelpPaint

public class JHelpGradientHorizontal
extends java.lang.Object
implements JHelpPaint

Horizontal gradient with fixed step

Author:

JHelp

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
private SortedArray<JHelpGradientHorizontal.Percent>	percents Gradient steps
private int	width Width of the current shape to fill

Constructor Summary

Constructors

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

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.
JHelpGradientHorizontal.Percent[]	otainPercents() Steps list

Methods inherited from class java.lang.Object

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

Field Detail

percents

private final SortedArray<JHelpGradientHorizontal.Percent> percents

Gradient steps

width

private int width

Width of the current shape to fill

Constructor Detail

JHelpGradientHorizontal

public JHelpGradientHorizontal(int colorStart,
                       int colorEnd)

Create a new instance of JHelpGradientHorizontal

Parameters:

colorStart - Color at start (left)

colorEnd - Color at end (right)

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 JHelpGradientHorizontal.Percent[] otainPercents()

Steps list

Returns:

Steps list