sos.reports
Interface Fill

All Known Implementing Classes:

DefaultFill

public interface Fill

A specification that allows solid, transparent, multi-colored, and gradient painting of lines and backgrounds. The specification includes a list of colors, a list of offsets, and a rotation angle (in radians).

Since:

1.0

See Also:

ReportStyleConstants

Field Summary

static Fill	BLACK A preconstructed fill that paints the entire region with java.awt.Color.BLACK.
static Fill	BLUE A preconstructed fill that paints the entire region with java.awt.Color.BLUE.
static Fill	CYAN A preconstructed fill that paints the entire region with java.awt.Color.CYAN.
static Fill	DARK_GRAY A preconstructed fill that paints the entire region with java.awt.Color.DARK_GRAY.
static Fill	GRAY A preconstructed fill that paints the entire region with java.awt.Color.GRAY.
static Fill	GREEN A preconstructed fill that paints the entire region with java.awt.Color.GREEN.
static Fill	LIGHT_GRAY A preconstructed fill that paints the entire region with java.awt.Color.LIGHT_GRAY.
static Fill	MAGENTA A preconstructed fill that paints the entire region with java.awt.Color.MAGENTA.
static Fill	NONE A preconstructed fill indicating no painting.
static Fill	ORANGE A preconstructed fill that paints the entire region with java.awt.Color.ORANGE.
static Fill	PINK A preconstructed fill that paints the entire region with java.awt.Color.PINK.
static Fill	RED A preconstructed fill that paints the entire region with java.awt.Color.RED.
static Fill	WHITE A preconstructed fill that paints the entire region with java.awt.Color.WHITE.
static Fill	YELLOW A preconstructed fill that paints the entire region with java.awt.Color.YELLOW.

Method Summary

java.awt.Color	getColor(int index) Returns the fill color at the specified index.
int	getColorCount() Returns the number of colors this fill uses.
int	getDirection() Returns the direction of this fill.
double	getOffset(int index) Returns the offset at the specified index.
boolean	isAbsolute(int index) Returns false if the offset at the specified index should be interpreted relative to the previous offset.

Field Detail

NONE

public static final Fill NONE

A preconstructed fill indicating no painting.

BLACK

public static final Fill BLACK

A preconstructed fill that paints the entire region with java.awt.Color.BLACK.

BLUE

public static final Fill BLUE

A preconstructed fill that paints the entire region with java.awt.Color.BLUE.

CYAN

public static final Fill CYAN

A preconstructed fill that paints the entire region with java.awt.Color.CYAN.

DARK_GRAY

public static final Fill DARK_GRAY

A preconstructed fill that paints the entire region with java.awt.Color.DARK_GRAY.

GRAY

public static final Fill GRAY

A preconstructed fill that paints the entire region with java.awt.Color.GRAY.

GREEN

public static final Fill GREEN

A preconstructed fill that paints the entire region with java.awt.Color.GREEN.

LIGHT_GRAY

public static final Fill LIGHT_GRAY

A preconstructed fill that paints the entire region with java.awt.Color.LIGHT_GRAY.

MAGENTA

public static final Fill MAGENTA

A preconstructed fill that paints the entire region with java.awt.Color.MAGENTA.

ORANGE

public static final Fill ORANGE

A preconstructed fill that paints the entire region with java.awt.Color.ORANGE.

PINK

public static final Fill PINK

A preconstructed fill that paints the entire region with java.awt.Color.PINK.

RED

public static final Fill RED

A preconstructed fill that paints the entire region with java.awt.Color.RED.

WHITE

public static final Fill WHITE

A preconstructed fill that paints the entire region with java.awt.Color.WHITE.

YELLOW

public static final Fill YELLOW

A preconstructed fill that paints the entire region with java.awt.Color.YELLOW.

Method Detail

getColorCount

public int getColorCount()

Returns the number of colors this fill uses.

Returns:

the number of fill colors

getDirection

public int getDirection()

Returns the direction of this fill.

Returns:

this fill's direction (one of SwingConstants.EAST, SwingConstants.SOUTH, SwingConstants.SOUTH_EAST, and SwingConstants.NORTH_EAST)

getColor

public java.awt.Color getColor(int index)

Returns the fill color at the specified index.

Parameters:

index - index of the color to retrieve

Returns:

this fill's color at index

Throws:

java.lang.IndexOutOfBoundsException - if index < 0 or index >= getColorCount

getOffset

public double getOffset(int index)

Returns the offset at the specified index.

Parameters:

index - index of the offset to retrieve

Returns:

this fill's offset at index

Throws:

java.lang.IndexOutOfBoundsException - if index < 0 or index >= getColorCount

isAbsolute

public boolean isAbsolute(int index)

Returns false if the offset at the specified index should be interpreted relative to the previous offset.

Parameters:

index - index of the offset in consideration

Returns:

true if the offset at index is a percentage of the entire fill area