com.stimware.graphworkbench.spi

Interface ColorModel

public interface ColorModel

A model for generating colors given an integer index. The colors are generated according to some internal formula and have a period at which they sequence repeats.

Color Models are initialised using a string descriptor, which defines the start and end colors for the gradient. Multiple gradients can be defined in one descriptor. A simple descriptor example is as follows:

(length=1,start=black,end=white)

For simple gradients, any non zero length can be used and is not significant. This attains meaning when multiple gradients are described, eg.

(length=1,start=black,end=red)(length=2,start=red,end=yellow)

This will define two gradients, with the second one being double the length of the first. These lengths are only relative, so any numeric value can be used.

The colors can be defined using the name, eg. "yellow" or a hex triplet, eg. "#ffff00".

Method Summary

Methods

Modifier and Type	Method and Description
java.awt.Color	getColor(int index) Get a color at a specified index.
void	setPeriod(int period) Set the period at which the colors need to repeat.

Method Detail

setPeriod

void setPeriod(int period)

Set the period at which the colors need to repeat.

Parameters:

period - the period of repetition

getColor

java.awt.Color getColor(int index)

Get a color at a specified index. The behaviour is undefined if the index is not between zero and the period.

Parameters:

index - the index

Returns:

the color at the index