org.jfree.chart.plot
Class CompassPlot

java.lang.Object
  |
  +--org.jfree.chart.plot.Plot
        |
        +--org.jfree.chart.plot.CompassPlot

All Implemented Interfaces:

AxisChangeListener, AxisConstants, DatasetChangeListener, java.util.EventListener, java.io.Serializable

public class CompassPlot

extends Plot

implements java.io.Serializable

A specialised plot that draws a compass to indicate a direction based on the value from a ValueDataset.

Author:

Bryan Scott

See Also:

Serialized Form

Field Summary

static java.awt.Font	DEFAULT_LABEL_FONT The default label font.
static int	NO_LABELS A constant for the label type.
static int	VALUE_LABELS A constant for the label type.

Fields inherited from class org.jfree.chart.plot.Plot

DEFAULT_BACKGROUND_ALPHA, DEFAULT_BACKGROUND_PAINT, DEFAULT_FOREGROUND_ALPHA, DEFAULT_INSETS, DEFAULT_OUTLINE_PAINT, DEFAULT_OUTLINE_STROKE, MINIMUM_HEIGHT_TO_DRAW, MINIMUM_WIDTH_TO_DRAW, ZERO

Fields inherited from interface org.jfree.chart.axis.AxisConstants

BOTTOM, DEFAULT_AXIS_LABEL_FONT, DEFAULT_AXIS_LABEL_INSETS, DEFAULT_AXIS_LABEL_PAINT, DEFAULT_AXIS_VISIBLE, DEFAULT_TICK_LABEL_FONT, DEFAULT_TICK_LABEL_INSETS, DEFAULT_TICK_LABEL_PAINT, DEFAULT_TICK_LABELS_VISIBLE, DEFAULT_TICK_MARK_INSIDE_LENGTH, DEFAULT_TICK_MARK_OUTSIDE_LENGTH, DEFAULT_TICK_MARK_PAINT, DEFAULT_TICK_MARK_STROKE, DEFAULT_TICK_MARKS_VISIBLE, LEFT, RIGHT, TOP

Constructor Summary

CompassPlot()
Default constructor.

CompassPlot(ValueDataset data)
Constructs a new compass plot.

Method Summary

void	addData(ValueDataset data) Adds a dataset to the compass.
void	addData(ValueDataset data, MeterNeedle needle) Adds a dataset to the compass.
void	draw(java.awt.Graphics2D g2, java.awt.geom.Rectangle2D plotArea, ChartRenderingInfo info) Draws the plot on a Java 2D graphics device (such as the screen or a printer).
protected java.awt.Font	getCompassFont(int radius) Returns the font for the compass.
ValueDataset[]	getData() Returns the dataset.
boolean	getDrawBorder() Returns a flag that controls whether or not a border is drawn.
java.awt.Font	getLabelFont() Returns the label font.
int	getLabelType() Returns the label type.
java.util.List	getLegendItemLabels() Deprecated. use getLegendItems().
LegendItemCollection	getLegendItems() Returns the legend items for the plot.
java.lang.String	getPlotType() Returns a short string describing the type of plot.
boolean	isCompatibleHorizontalAxis(Axis axis) Returns true if the axis is compatible with the compass plot, and false otherwise.
boolean	isCompatibleVerticalAxis(Axis axis) Returns true if the axis is compatible with the compass plot, and false otherwise.
void	setDrawBorder(boolean status) Sets a flag that controls whether or not a border is drawn.
void	setLabelFont(java.awt.Font font) Sets the label font.
void	setLabelType(int type) Sets the label type.
void	setSeriesNeedle(int type) Sets the needle type.
void	setSeriesNeedle(int index, int type) Sets the needle for a series.
void	setSeriesNeedle(int index, MeterNeedle needle) Sets the needle for a series.
void	setSeriesOutlinePaint(int series, java.awt.Paint p) Sets the series outline paint.
void	setSeriesOutlineStroke(int series, java.awt.Stroke stroke) Sets the series outline stroke.
void	setSeriesPaint(int series, java.awt.Paint paint) Sets the series paint.
void	zoom(double percent) No zooming is implemented for compass plot, so this method is empty.

Methods inherited from class org.jfree.chart.plot.Plot

addChangeListener, axisChanged, datasetChanged, drawBackground, drawNoDataMessage, drawOutline, equals, getBackgroundAlpha, getBackgroundImage, getBackgroundImageAlignment, getBackgroundPaint, getDataAreaRatio, getDataset, getDatasetGroup, getForegroundAlpha, getInsets, getNoDataMessage, getNoDataMessageFont, getNoDataMessagePaint, getOppositeAxisLocation, getOutlinePaint, getOutlineStroke, getParent, getRectX, getRectY, getRootPlot, getSecondaryDataset, handleClick, isSubplot, notifyListeners, removeChangeListener, setBackgroundAlpha, setBackgroundImage, setBackgroundImageAlignment, setBackgroundPaint, setDataAreaRatio, setDataset, setDatasetGroup, setForegroundAlpha, setInsets, setInsets, setNoDataMessage, setNoDataMessageFont, setNoDataMessagePaint, setOutlinePaint, setOutlineStroke, setParent, setSecondaryDataset

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LABEL_FONT

public static final java.awt.Font DEFAULT_LABEL_FONT

The default label font.

NO_LABELS

public static final int NO_LABELS

A constant for the label type.

See Also:

Constant Field Values

VALUE_LABELS

public static final int VALUE_LABELS

A constant for the label type.

See Also:

Constant Field Values

Constructor Detail

CompassPlot

public CompassPlot()

Default constructor.

CompassPlot

public CompassPlot(ValueDataset data)

Constructs a new compass plot.

Parameters:

data - the dataset for the plot.

Method Detail

getLabelType

public int getLabelType()

Returns the label type. Defined by the constants: NO_LABELS, VALUE_LABELS.

Returns:

The label type.

setLabelType

public void setLabelType(int type)

Sets the label type.

Valid types are defined by the following constants: NO_LABELS, VALUE_LABELS.

Parameters:

type - the type.

getLabelFont

public java.awt.Font getLabelFont()

Returns the label font.

Returns:

the label font.

setLabelFont

public void setLabelFont(java.awt.Font font)

Sets the label font.

Notifies registered listeners that the plot has been changed.

Parameters:

font - the new label font.

getDrawBorder

public boolean getDrawBorder()

Returns a flag that controls whether or not a border is drawn.

Returns:

the flag.

setDrawBorder

public void setDrawBorder(boolean status)

Sets a flag that controls whether or not a border is drawn.

Parameters:

status - the flag status.

setSeriesPaint

public void setSeriesPaint(int series,
                           java.awt.Paint paint)

Sets the series paint.

Parameters:

series - the series index.

paint - the paint.

setSeriesOutlinePaint

public void setSeriesOutlinePaint(int series,
                                  java.awt.Paint p)

Sets the series outline paint.

Parameters:

series - the series index.

p - the paint.

setSeriesOutlineStroke

public void setSeriesOutlineStroke(int series,
                                   java.awt.Stroke stroke)

Sets the series outline stroke.

Parameters:

series - the series index.

stroke - the stroke.

setSeriesNeedle

public void setSeriesNeedle(int type)

Sets the needle type.

Parameters:

type - the type.

setSeriesNeedle

public void setSeriesNeedle(int index,
                            int type)

Sets the needle for a series.

Parameters:

index - the series index.

type - the needle type.

setSeriesNeedle

public void setSeriesNeedle(int index,
                            MeterNeedle needle)

Sets the needle for a series.

Parameters:

index - the series index.

needle - the needle.

getData

public ValueDataset[] getData()

Returns the dataset.

Provided for convenience.

Returns:

The dataset for the plot, cast as a ValueDataset.

addData

public void addData(ValueDataset data)

Adds a dataset to the compass.

Parameters:

data - the new dataset.

addData

public void addData(ValueDataset data,
                    MeterNeedle needle)

Adds a dataset to the compass.

Parameters:

data - the new dataset.

needle - the needle.

draw

public void draw(java.awt.Graphics2D g2,
                 java.awt.geom.Rectangle2D plotArea,
                 ChartRenderingInfo info)

Draws the plot on a Java 2D graphics device (such as the screen or a printer).

Specified by:

draw in class Plot

Parameters:

g2 - the graphics device.

plotArea - the area within which the plot should be drawn.

info - collects info about the drawing.

getPlotType

public java.lang.String getPlotType()

Returns a short string describing the type of plot.

Specified by:

getPlotType in class Plot

Returns:

a string describing the plot.

isCompatibleHorizontalAxis

public boolean isCompatibleHorizontalAxis(Axis axis)

Returns true if the axis is compatible with the compass plot, and false otherwise. Since a compass plot requires no axes, only a null axis is compatible.

Parameters:

axis - the axis.

Returns:

true if the axis is compatible, and false otherwise.

isCompatibleVerticalAxis

public boolean isCompatibleVerticalAxis(Axis axis)

Returns true if the axis is compatible with the compass plot, and false otherwise. Since a compass plot requires no axes, only a null axis is compatible.

Parameters:

axis - the axis.

Returns:

true if the axis is compatible, and false otherwise.

getLegendItems

public LegendItemCollection getLegendItems()

Returns the legend items for the plot. For now, no legend is available - this method returns null.

Overrides:

getLegendItems in class Plot

Returns:

the legend items.

zoom

public void zoom(double percent)

No zooming is implemented for compass plot, so this method is empty.

Overrides:

zoom in class Plot

Parameters:

percent - the zoom amount.

getCompassFont

protected java.awt.Font getCompassFont(int radius)

Returns the font for the compass.

Parameters:

radius - the radius.

Returns:

the font.

getLegendItemLabels

public java.util.List getLegendItemLabels()

Deprecated. use getLegendItems().

Returns a list of legend item labels.

Returns:

a list of legend item labels.